Enable™ Version 10 Product Information Management (PIM) Administration Guide Revised 8/2/2019 • Enable 10.0 Release Enable Suite: o EnterworksInstallPackage_20190423_1624 o EnterworksDB_20190423_1624 o EnterworksDBScripts_20190423_1624 • Enable Patch: o EnableServer_10.0_Patch_20190423_1549 • Enable Builds: o Enable10 10.0.11 Build 20190703_1055 o EnableServer 10.0 Build 20190703_1055 EnterWorks ® , Acquisition Inc. a Winshuttle Company 46040 Center Oak Plaza Suite 115 Sterling, VA 20166
Transcript
Enable™ Version 10
Product Information Management (PIM)
Administration Guide
Revised 8/2/2019
• Enable 10.0 Release Enable Suite:
o EnterworksInstallPackage_20190423_1624 o EnterworksDB_20190423_1624 o EnterworksDBScripts_20190423_1624
• Enable Patch:
o EnableServer_10.0_Patch_20190423_1549
• Enable Builds:
o Enable10 10.0.11 Build 20190703_1055 o EnableServer 10.0 Build 20190703_1055
EnterWorks®, Acquisition Inc. a Winshuttle Company
Server Maintenance ................................................................................................. 370
Enable 10 PIM Administration Guide
Page 10 of 371 Revised 8/2/2019
1 Document Conventions
This EnterWorks document uses the following typographic conventions:
Convention Usage
pathnames Pathnames are shown with backslashes, as for Windows systems.
Courier New
font
Denotes sample code, for example, Java, IDL, and command line information. May be used to denote filenames and pathnames, calculations, code samples, registry keys, path and file names, URLs, messages displayed on the screen. If italicized and in angle brackets (< >), it denotes a variable.
Calibri Font (bold) When used in body text, it denotes an object, area, list item, button, or menu option within the graphical user interface; or a database name or database-related object. (Examples: the Save button; the Product tab; the Name field; the SKU repository) Can also be used to denote text that is typed in a text box. (Example: Type “trackingNo” in the Name field)
Blue underlined text Words, phrases or numbers in blue are active links that can be clicked. Clicking these active links will bring the user to the required information, steps, pages chapters, or URL.
There’s a reason why EnterWorks receives the highest customer satisfaction scores from firms including Gartner® and Forrester® ─ our customers are our top priority.
EnterWorks provides a full spectrum of customer support. Check your maintenance contract for the level of support purchased. The first time you contact customer support, you’ll receive a customer identification number. Keep this number for future reference when using the EnterWorks customer support service.
How to reach us Comments
On the Web:
https://enterworkssupport.zendesk.com
For detailed discussions of hardware, software, configuration issues, or Helpdesk credentials, contact your EnterWorks representative.
This document outlines procedures for administering an organization’s Enable® Product Information Management (PIM) system. It covers configuration activities such as modifying the taxonomy, code sets, models, hierarchies, users, groups, and security. Some of these activities can be assigned to one or more advanced users, such as maintaining code set data, but any structural changes should be handled by the system administrator. This document also covers system maintenance activities, such as archiving log files, monitoring scheduled jobs, and stopping/starting services.
A system administrator (a user assigned to the Administration security group) has access to all Enable system features and functions, but not all Enable functionality is covered in this document. Please refer to the following documents for additional information.
For an introduction to Enable’s basic components and how they interact, see Enable 10 Basics.
For Windows installation steps, see the Enable 10 PIM Installation Guide.
For Linux installation steps, see the Enable 10 PIM Linux Installation Guide.
For user functionality, see the Enable 10 PIM User Guide.
For publication functionality, see the Enable 10 PIM Publication Guide.
The Enable solution is configured for each organization’s unique product requirements; not all
functionality is applicable to every organization. If a capability or feature described in this
document is not available in your Enable configuration, contact the Enable account manager or
product manager.
Enable 10 PIM Administration Guide
Page 13 of 371 Revised 8/2/2019
4 User Interfaces
Enable 10 supports two user interfaces:
• Enable 2020 UI: The user interface introduced in Enable 9 and used extensively in Enable 10.
• Enable Classic UI: The user interface in use in Enable 8, and still used for some functions in Enable 9 and Enable 10.
Functionality is being transitioned from the Enable Classic UI to the Enable 2020 UI. Consequently, some functions can be performed using only the Enable 2020 UI, some using only the Enable Classic UI, and some can be performed using either UI.
Most functions can be performed via the Enable 2020 UI. Functions that require the use of the Enable Classic UI will require the user to either:
• Log out of the Enable 2020 UI and log into the Enable Classic UI. (This may require you to close and reopen your browser.)
• Remain logged into the Enable 2020 UI and use a different browser application to log into the Enable Classic UI.
The content in this document assumes that functionality is performed in the Enable 2020 UI. The documentation of any functionality requiring the use of the Enable Classic UI will note the fact and will include instructions on how to perform the function in the Enable Classic UI.
For a complete description of the Enable Classic UI, see the Enable 8 PIM Administration Guide and Enable 8 PIM User Guide.
Supported Browsers
The Enable UIs are browser agnostic. They have been designed and constructed to work independently of the browsers used to access them and so support most browsers.
5 Logging into Enable
Logging into Enable 2020 UI
To log into the Enable 2020 UI, perform the following steps:
1. Open the web browser.
2. Enter the Enable 10 URL:
http://<servername>.home/enable2020/
3. The Enable 2020 Login screen appears.
Enable 10 PIM Administration Guide
Page 14 of 371 Revised 8/2/2019
4. Select a Language, enter the Login ID and Password, and click the Sign In button.
5. The user’s Dashboard will appear.
Logging into Enable Classic UI
To log into the Enable Classic UI, perform the following steps:
1. Open the web browser.
2. Enter the Enable URL :
http://<servername>/webcm/
3. The Enable Classic Login screen appears.
The Enable 2020 Login Screen
The Enable Classic UI Login Screen
Enable 10 PIM Administration Guide
Page 15 of 371 Revised 8/2/2019
4. Select a Language, enter the Login ID and Password, and click the Logon button.
5. The Enable Classic Startup screen appears.
Depending upon the user’s permissions, the startup screen may look different. The screen shown here contains all features and functions. The Home Page tab is shown on system entry. Since reports are user specific, an example of three possible report widgets or internal web applications is shown.
For a complete description of the Home Page and functionality available via the Enable Classic UI, see the Enable 8 PIM Administration Guide and the Enable 8 PIM User Guide.
User Dashboard/Home Page
The Enable 2020 UI and the Enable Classic UI have separate landing pages:
• Enable 2020 UI lands on the user Dashboard.
• Enable Classic UI lands on the user Home Page.
The user Dashboard and Home Page are distinct and separate from one another. Modifying one does not change the other. For a detailed guide on using the Enable Classic UI, see the Enable 9 PIM Administration Manual and the Enable PIM v8 User Manual.
The Enable Classic Startup Screen
Enable 10 PIM Administration Guide
Page 16 of 371 Revised 8/2/2019
6 User Dashboard
When a user logs into Enable using the Enable 2020 UI, they are taken to a User Dashboard (also referred to as Dashboard). If the use of personal User Dashboards is enabled, the user will be taken to their personal User Dashboard. If not, they are taken to the User Dashboard of one of the user groups they belong to.
Users can customize their personal User Dashboard by adding or deleting widgets, then saving the Dashboard layout. Users can also select to view their personal Dashboard or the Dashboard of one of the user groups they belong to.
Below is a high-level map of the regions on the Dashboard.
Enable 10 PIM Administration Guide
Page 17 of 371 Revised 8/2/2019
Enable 2020 Dashboard
Enable 10 PIM Administration Guide
Page 18 of 371 Revised 8/2/2019
Select a Dashboard
To switch to a different Dashboard, open the Dashboard Selector dropdown list in the far left of the Activity Bar. A list of Dashboards available to the user will be displayed – the user’s personal Dashboard (if available) and a Dashboard for each group the user belongs to. Select the desired Dashboard.
Note that the user retains all the permissions granted to them, from all their user groups, no matter which Dashboard they are viewing. For instance, if the user belongs to the Project Management user group and the Sales user group, they will always have all the permissions granted to the Project Management user group and the Sales user group, no matter which group’s Dashboard they are viewing.
Customize Dashboard Layout
Users are able to customize their personal Dashboard. Users with sufficient permissions can customize the Dashboard of any user group they belong to.
To customize a Dashboard, use the Dashboard Selector to select the desired Dashboard. (See Select a Dashboard.)
Dashboard Selector
Enable 10 PIM Administration Guide
Page 19 of 371 Revised 8/2/2019
Modify the Dashboard as you wish, by adding, deleting, or changing the size or position of one or more Widgets on your Dashboard. (See Widgets.)
To save a Dashboard configuration, click the Save Layout button on the Dashboard’s Activity Bar. If the user logs off or switches user groups before saving their Dashboard, all changes to that Dashboard will be lost.
WARNING: Remember to click the Save Layout button to save any changes to the Dashboard or all changes (new or deleted Widgets, Widget sizes, Widget positions) will be lost.
7 Widgets
This section describes widgets designed by administrators. For more details regarding widgets, their configuration, and their uses, see the Enable 10 PIM User Guide.
Generate Import Export Template Widget
The Generate Import Export Template Widget allows the user to generate an empty file to be used to import data into an Enable repository. The administrator configures the file by selecting an Import Template to define the columns in the file, and decides which category attributes will be included along with the global attributes specified by the Import Template. The administrator can also configure the widget to allow the user to choose which category attributes to include.
To configure a Generate Import Export Template Widget, first configure a new blank widget. For more information on adding and configuring new widgets, see the Enable 10 PIM User Guide.
Select the Widget Settings icon in the upper right of the new widget’s Activity Bar. Note that a widget’s Activity Bar will not be displayed unless the cursor is hovering over the top of the widget.
A Widget Configuration window will appear. Select Generate Import Export Template Widget from the Type dropdown list on the far right of the Widget Configuration window. The Generate Import Export Template configuration options will appear.
Generate Import Export Template
Enable 10 PIM Administration Guide
Page 21 of 371 Revised 8/2/2019
The Generate Import Export Template options are:
• Title: The title of the widget. It is helpful if the title of a widget reflects the source of the data as well as the widget’s type, for instance “Generate Import Export Template”.
• Repository: The repository the template will be generated for.
• Preference: The Preference View to use when generating the template. If a Preference View is specified, the only category attributes that will be presented for inclusion are those that are in the Preference View.
• Output Format: The format of the template:
o CSV (Comma Separated Values) o Excel Workbook (xlsx)
• Excel Workbook (xlsx) with Format:
o The columns of required attributes are highlighted. o A worksheet named Lists displays any code sets.
o Attributes of type code set will display dropdown menus for user to select a value from the code set.
• Template: The import template that will be used to define the global attributes that will be included in the generated template, and the set of category attributes that are available to be included.
Note that if a Preference View is specified in the Preference option, the selected Preference View acts as a filter. Only category attributes that are in both the selected import template and the selected Preference View will be presented for inclusion in the generated template.
• File Split By Category: If selected, if category attributes are to be included in the generated template, instead of generating one template that lists all the category attributes from all the selected taxonomy nodes, a separate file is generated for each taxonomy node. Each file would include all specified global attributes and only those category attributes that are assigned to the taxonomy node.
For example, if you have four different nodes that each have ten category attributes (with no overlap), not setting this option would produce a file with all the selected global attributes and 40 category attributes. If the File Split by Category option is set, four files would be produced, one for each node, that contain all the specified global attributes and the ten category attributes associated with that node.
• Show Taxonomy in Widget: If selected, the Include Category Attributes from Taxonomy Node selection panel will appear on the widget and the user will be able to select which category attributes to include in the generated template. If it is not checked, the user will not be able to change the list of category attributes to be included in the template.
• Download Button Label: The label to be used in the widget’s button that triggers the generation of the template.
• Include Category Attributes from Taxonomy selection panel: This is used to define the initial list of category attributes the user will be able to select for inclusion in the template if the Include Category Attributes from Taxonomy box is selected.
Enable 10 PIM Administration Guide
Page 23 of 371 Revised 8/2/2019
Modify the configuration options as desired. Click Apply to save the changes to the widget and close the Widget Configuration window. Click Cancel to close the Widget Configuration window without saving the changes.
Shortcuts Widget
The Shortcuts Widget can be used to set up quick links to certain functions so users can easily access them via the Dashboard instead of navigating to them via the Feature Sidebar.
Include Category Attributes from Taxonomy
Enable 10 PIM Administration Guide
Page 24 of 371 Revised 8/2/2019
The Shortcuts repository contains a record for each selection (or Shortcuts link) in the Shortcuts Widget. To manage the Shortcuts Widget, open the Shortcuts repository and add, delete, and edit its records.
For details on the how to manage records in a repository, see the Enterworks 2020 User Guide.
7.2.1 Open the Shortcuts Repository
To open the Features Sidebar, select the Scheduled Activities folder, and select the Shortcuts repository.
Shortcut Widget
Enable 10 PIM Administration Guide
Page 25 of 371 Revised 8/2/2019
The Shortcuts repository will open.
For details on the how to manage records in a repository, see the Enterworks 2020 User Guide.
Open the Shortcuts Repository
Enable 10 PIM Administration Guide
Page 26 of 371 Revised 8/2/2019
7.2.2 Delete a Shortcuts Link
To delete a Shortcuts link from the Shortcuts Widget:
1. Open the Shortcuts repository. (See Open the Shortcuts Repository).
2. Select the record for the shortcut you wish to delete.
3. Click the Delete button in the Shortcuts repository’s Activity Bar.
7.2.3 Add a Shortcuts Link
To add a shortcut link to the Shortcuts Widget:
1. Open the Shortcuts repository. (See Open the Shortcuts Repository).
2. Click the Add button in the Shortcuts Repository View’s Activity Bar.
The Shortcuts Repository
The Shortcuts Repository Activity Bar
Enable 10 PIM Administration Guide
Page 27 of 371 Revised 8/2/2019
3. A new record will be created in the Shortcuts repository and opened in the Detail Editor Tab where you can customize the link accordingly. See Edit a Shortcuts Link for instructions on editing the new Shortcuts link’s record.
7.2.4 Edit a Shortcuts Link
To customize a shortcut link in the Shortcuts Widget, edit the shortcut link’s record in the Shortcut Repository. (For details on the how to manage records in a repository, see the Enterworks 2020 User Guide.)
1. Open the Shortcuts repository. (See Open the Shortcuts Repository).
2. Select the record for the shortcut you wish to edit.
3. Click the Edit button in the Shortcuts repository’s Activity Bar. The selected record will be opened in the Detail Editor Tab.
Edit a Shortcut Link Record
Enable 10 PIM Administration Guide
Page 28 of 371 Revised 8/2/2019
The shortcut’s record has three tabs:
• Summary: The record’s summary attributes. These attributes appear in all shortcut records.
• Details: The attributes shown on the Details tab vary according to the value of the Shortcut Type attribute (in the Summary tab).
• State: The attributes in the State tab are not editable by the user. Enable uses them to report on the state of the record.
The tables in the following sections describe the options on the Summary and Detail tabs for each Shortcut Type.
Customize the shortcut link record to as desired. To save the record and exit the Detail Editor Tab, click the Save button on the left end of editor’s Activity Bar. To exit without saving your changes, close the Detail Editor Tab’s tab.
If the shortcut link does not appear in the Shortcuts Widget or it does not perform correctly, check the values of the shortcut’s record attributes. Errors in attribute values may cause the shortcut to malfunction without providing an error notification to the user. For instance, if the value of the Preference Listing attribute in a Repository Listing type shortcut is misspelled, clicking the shortcut’s link in the Shortcuts Widget will have no effect – the specified repository will not be opened.
Summary Tab Attributes
Summary Tab
(required values are marked with a *)
Attribute Purpose Value(s)
Shortcut Type* Defines the type of shortcut. See Shortcut Types for descriptions of the available shortcut types.
Name* The name that will appear in the Shortcuts Widget.
Left Side of Detail Editor Tab's Activity Bar
Enable 10 PIM Administration Guide
Page 29 of 371 Revised 8/2/2019
Summary Tab
(required values are marked with a *)
Attribute Purpose Value(s)
Description A description of the shortcut. The description helps document the purpose of the shortcut. It does not appear anywhere other than in the editor.
Group Name Limits the shortcut’s visibility to users within the specified user group(s).
Id The shortcut’s ID. The Id will be generated by the system when the record is saved.
Display Order Where the shortcut will appear in the list of shortcuts.
If not specified, the default Display Order (last) is used.
Widget Group May not appear. This attribute is not currently used in most Enable installations.
Shortcut Types
Shortcut Type Shortcut Purpose
Repository Listing Opens the specified repository in a Repository View.
Record Edit Opens the specified record in the Detail Editor Tab.
Record Copy Opens a new copy of the specified record in the Detail Editor Tab.
Record New Creates a new record and opens it in the Detail Editor Tab.
Enable 10 PIM Administration Guide
Page 30 of 371 Revised 8/2/2019
Shortcut Type Shortcut Purpose
Generate Template Generates a template for the specified repository.
Jasper Report Tab Displays the specified Jasper Report in a new tab.
Jasper Report Dialog Displays the specified Jasper Report in a dialog box.
Jasper Report Window Displays the specified Jasper Report in a new window.
Custom Tab Displays the specified URL in a new tab.
Custom Dialog Displays the specified URL in a dialog box.
Custom Window Displays the specified URL in a new window.
7.2.4.2.1 Custom Tab/Dialog/Window Shortcut Types
The Custom Tab, Custom Dialog, and Custom Window shortcut types allow the administrator to create a link to a tab, dialog box, or window displaying the contents of the specified URL.
In the table below, required values are marked with an *.
Attribute Purpose Notes
Custom URL* The URL to display in the tab, dialog box or window.
Additional URL Parameters
Any additional parameters necessary for the URL.
This value will be appended to the URL specified.
Width The width of the dialog box or window.
Does not appear if shortcut type is Custom Tab.
Height The height of the dialog box or window.
Does not appear if shortcut type is Custom Tab.
Enable 10 PIM Administration Guide
Page 31 of 371 Revised 8/2/2019
7.2.4.2.2 Generate Template Shortcut Type
The Generate Template shortcut type allows the administrator to define a link to a dialog box that enables the user to generate an Import/Export template.
In the table below, required values are marked with an *.
Attribute Purpose
Repository Name* The name of the repository.
Width The width of the Generate Template dialog box.
Height The height of the Generate Template dialog box.
The Jasper Report Tab, Jasper Report Dialog, and Jasper Report Window shortcut types allow the administrator to create a link to a Jasper Report displayed in a tab, dialog box, or window.
In the table below, required values are marked with an *.
Attribute Purpose Notes
Custom URL* The URL to display in the tab, dialog box or window.
Additional URL Parameters
Any additional parameters necessary for the URL.
This value will be appended to the URL specified.
Width The width of the dialog box or window.
Does not appear if shortcut type is Custom Tab.
Height The height of the dialog box or window.
Does not appear if shortcut type is Custom Tab.
7.2.4.2.4 Record Edit/Copy/New Shortcut Types
The shortcut types related to records are:
Enable 10 PIM Administration Guide
Page 32 of 371 Revised 8/2/2019
• Record Edit: Opens the specified record in the Detail Editor Tab for editing.
• Record Copy: Copies the specified record and opens the copy in the Detail Editor Tab for editing.
• Record New: Creates a new record and opens it in the Detail Editor Tab for editing.
In the table below, required values are marked with an *.
Attribute Purpose Notes
Repository Name* The name of the repository.
Preference Listing The preference view to be used to display the contents of the repository. If no Preference Listing is selected, the default preference view will be shown.
Saved Set The Saved Set to be displayed in the repository view.
Saved Search The Saved Search to be performed in the repository view.
Search Attribute An attribute to use as a search filter.
In order for this attribute to be used, all the following attributes must be specified:
• Search Attribute
• Search Operator
• Search Value
Search Operator The relationship between the Search Attribute and the Search Value.
In order for this attribute to be used, all the following attributes must be specified:
• Search Attribute
• Search Operator
• Search Value
Enable 10 PIM Administration Guide
Page 33 of 371 Revised 8/2/2019
Attribute Purpose Notes
Search Value The attribute value to search for. In order for this attribute to be used, all the following attributes must be specified:
• Search Attribute
• Search Operator
• Search Value
Record Identifier The identifier of the record to be edited.
Preference Detail The Preference View to be used in the Detail Editor Tab.
Attribute Tab The attribute tab the record appears on.
7.2.4.2.5 Repository Listing Shortcut Type
Repository Listing shortcuts open the specified repository in a Repository View.
In the table below, required values are marked with an *.
Attribute Purpose Notes
Repository Name* The name of the repository.
Preference Listing The preference view to be used to display the contents of the repository. If no Preference Listing is selected, the default preference will be shown.
Saved Set The Saved Set to be displayed in the repository view.
Saved Search The Saved Search to be performed in the repository view.
Enable 10 PIM Administration Guide
Page 34 of 371 Revised 8/2/2019
Attribute Purpose Notes
Search Attribute An attribute to use as a search filter.
In order for this attribute to be used, all the following attributes must be specified:
• Search Attribute
• Search Operator
• Search Value
Search Operator The relationship between the Search Attribute and the Search Value.
In order for this attribute to be used, all the following attributes must be specified:
• Search Attribute
• Search Operator
• Search Value
Search Value The attribute value to search for. In order for this attribute to be used, all the following attributes must be specified:
• Search Attribute
• Search Operator
• Search Value
System Health Widget
The System Health widget is designed to help a systems administrator monitor the components of the Enable system. Therefore, it is recommended this widget be added to the Administrator Dashboard.
Enable 10 PIM Administration Guide
Page 35 of 371 Revised 8/2/2019
7.3.1 Configuring System Health Widget
To configure a System Health Widget, first configure a new blank Widget. For more information on adding and configuring new Widgets, see the Enable 2020 User Guide.
Select the Widget Settings icon in the upper right of the new Widget’s Activity Bar. Note that a Widget’s Activity Bar will not be displayed unless the cursor is hovering over the top of the Widget.
A Widget Configuration window will appear. Select System Health from the Type dropdown list on the far right of the Widget Configuration window. The System Health Widget configuration options will appear.
System Health Widget
Enable 10 PIM Administration Guide
Page 36 of 371 Revised 8/2/2019
The configuration options for the System Health Widget allow you to select the status to be included in the widget’s display.
System Options Notes
EPIM Tomcat Master Monitor the process that manages the Enable UI and API calls.
EPIM Jboss Master Monitor the process that coordinates background operations handled by the Jboss Slaves.
EPIM Jboss Slaves Monitor the processes that perform the background processes (e.g., imports, exports, validations, mass edits, etc.).
Configuration Options for the System Health Widget
Enable 10 PIM Administration Guide
Page 37 of 371 Revised 8/2/2019
System Options Notes
EPIM Database Monitor the connection to the EPIM database.
EPIM Job Monitor Monitor the Job Monitor, reporting the number of queued, active, and recently failed jobs.
EPIM Application File System Access
Verify the file system is accessible and is not out of disk space for Tomcat.
EPIM Web File System Access Verify each of the Jboss Slave processes can access the file system and are not out of disk space.
EPX Tomcat Monitor the EPX Tomcat process
EPX Jboss Monitor the JBoss process that orchestrates the movement of work items from activity to activity.
EPX BIC Manager Monitor the EPX BIC Manager, which processes all automatic activities in workflows.
EPX EPX User The EPX user that is used to launch a work item on the Ping-Enable workflow. Needs to be a member of the EnableWorkflowInitiators group
EPX EPX Password Password for the EPX user.
EPX Workflow Process Name The name of a simple EPX workflow to be used to verify work items are processing. The system health refresh causes a work item to be created on this process. The work item is created using the specified EPX User and EPX Password.
EPX Starting Point Activity Name
The name of the starting point activity in the workflow identified by Workflow Process Name on which to create the work item.
EPX End Point Activity Name The name of the ending point activity in the workflow identified by Workflow Process Name. The system health refresh checks this activity to verify that the work item created on the starting point activity above arrives within a few seconds, which indicates EPX processing is working correctly.
Enable 10 PIM Administration Guide
Page 38 of 371 Revised 8/2/2019
System Options Notes
EPX File System Verify that the EPX process can update the file system and has not run out of disk space.
Enable Enable Web If IIS is configured, monitor the connectivity to IIS
Edit the configuration options as desired. Click Apply to save the changes to the widget and close the Widget Configuration window. Click Cancel to close the Widget Configuration window without saving the changes.
To add the System Health Widget to your default Dashboard, click the Save Layout button on the Dashboard’s Activity Bar.
Workflow Task Manager Widget
A discussion of the Workflow Task Manager Widget is found in the Enable 10 PIM User Guide.
8 Templates
The Template functions allow users to define and save configurations for the import, export, syndication, exchange, and publication of Enable repository data. The following sections describe each type of template in more detail.
Templates may be used in both scheduled and manually triggered activities. For additional information regarding the use of templates during scheduled activities, see Job Scheduling. For additional information regarding the use of templates during manually triggered activities, see the Enable 10 PIM User Guide.
Import Templates
The Import Template functions are used to develop templates that can be used to import data into one or more Enable repositories.
Templates may be used in both scheduled and manually triggered activities. For additional information regarding the use of import templates during scheduled activities, see Job Scheduling. For additional information regarding the use of import templates during manually triggered activities, see the Enable 10 PIM User Guide.
Enable 10 PIM Administration Guide
Page 39 of 371 Revised 8/2/2019
8.1.1 View Import Templates
The list of available Import Templates for a repository can be viewed from the Import Templates pane which appears at the bottom of the repository’s Repository Dashboard’s list of configuration panes (see Repository Dashboard).
8.1.2 Create an Import Template
While users with sufficient permissions can create and edit import templates, it is recommended that the system administrator verifies and tests them to make sure they work correctly. Import templates should be tested with one or two records on your development environment before using it on your production system.
To create an import template, open the Repository Dashboard for one of the repositories the template will be used to import data into (see Repository Dashboard). Go to the Import Templates pane at the bottom of the Repository Dashboard by either scrolling down to the pane or by clicking the Import Templates button on the top right of the Repository Dashboard.
Import Templates Pane
Enable 10 PIM Administration Guide
Page 40 of 371 Revised 8/2/2019
Click the Add button in the Import Template pane’s Activity Bar. An empty import template will be opened in the Manage Import Template editor tab.
Edit the template as described in Edit an Import Template. To save the import template, open the Attribute Mapping page of the Manage Import Template editor and click Save. To exit the Manage Import Template editor without saving, close the Manage Import Template editor tab.
8.1.3 Edit an Import Template
While users with sufficient permissions can create and edit import templates, it is recommended that the system administrator verifies and tests them to make sure they work correctly. Import templates should be tested with one or two records on your development environment before using it on your production system.
Import Templates Pane
Manage Import Template Details
Enable 10 PIM Administration Guide
Page 41 of 371 Revised 8/2/2019
To edit an import template, open the Repository Dashboard for one of the repositories the template will be used to import data into (see Repository Dashboard). Go to the Import Templates pane at the bottom of the Repository Dashboard by either scrolling down to the pane or by clicking the Import Templates button on the top right of the Repository Dashboard.
Select the import template and click the Edit button in the Import Template pane’s Activity Bar. The import template will be opened in the Manage Import Template editor tab.
The Manage Import Template editor has three pages of configuration options:
• Import Template Details
• Import Template Related Repositories
Import Templates Pane
Manage Import Template Details
Enable 10 PIM Administration Guide
Page 42 of 371 Revised 8/2/2019
• Import Template Attribute Mapping
Edit the configuration options as desired. To save your changes to the import template, open the Attribute Mapping page of the Manage Import Template editor and click Save. To exit the Manage Import Template editor without saving, close the Manage Import Template editor tab.
Import Template Details
The Manage Import Template editor opens in the Details page.
The Import Template Details page contains the following configuration settings:
• Name: (Required) The name of the import template. This field can support multi-language translations.
• Description: (Optional) A description of the import template. This field can support multi-language translations.
• TypeCode: Standard or Category as defined below.
Manage Import Template Details
Enable 10 PIM Administration Guide
Page 43 of 371 Revised 8/2/2019
Option Pros Cons
Standard (All versions of Enable.)
Able to use VTL scripts or triggers to alter records that have been imported.
Default system configuration limits an import file to 1000 columns or less (depending on the data types of the columns).
The limit can be changed by modifying the max.file.download.size setting in the sharedConfig.properties
file.
Category (Enable 9 and later only.)
Able to import files with a virtually unlimited number of columns. (Typically, in files with a large number of columns, most columns are mapped to category attributes.)
Not able to use VTL scripts or triggers to alter records that have been imported.
• Advanced Import Class Path: Specifies a class path for the JAVA class that will be invoked upon using the import template.
• Contents Replacement: If the Contents Replacement checkbox is marked, all records in the root repository will be replaced with the imported records. This option is only available if the import only affects the root repository (no link repository records can be replaced).
WARNING: This option should be used only if all repository records are to be deleted and replaced with the data being imported.
In order to use the Contents Replacement function, the repository must include a status attribute that will be used to mark records that existed in the repository prior to the import but were not replaced with a record from the import file. This status attribute is defined with the special function indicator of Status. The value indicated in Inactive Status Value is entered into the status attribute in records that were not replaced.
• Inactive Status Value: (Required if Contents Replacement is marked): Defines the value to be entered in the status attribute used to indicate records that were not replaced when a file was imported.
Enable 10 PIM Administration Guide
Page 44 of 371 Revised 8/2/2019
Edit the Details page’s configuration options as desired. Click Next to continue to the Related Repositories page.
Import Template Related Repositories
The Related Repositories page allows the user to specify which repositories to include in the import.
Click the down arrow icons to expand the repository tree to expose any linked repositories.
To include a repository in the import template, click the checkbox to the left of its name.
Edit the Related Repositories page’s configuration options as desired. Click Next to continue to the Attribute Mapping page.
Import Template Attribute Mapping
The Attribute Mapping page allows the user to specify which attributes will be included in the import template.
Import Template Related Repositories
Enable 10 PIM Administration Guide
Page 45 of 371 Revised 8/2/2019
To add, delete or change the order of the target attributes, click the Manage Attributes button on the Attribute Mapping page’s Activity Bar.
Manage Import Template Attribute Mapping
Enable 10 PIM Administration Guide
Page 46 of 371 Revised 8/2/2019
The Manage Target Attributes dialog will open.
The configuration options for the Manage Target Attributes dialog are as follows:
• Repository: The Repository dropdown will list the target repositories included on the Related Repositories page. The Target Attribute list will display the chosen repository’s attributes for inclusion in the template.
Manage Import Template Manage Attribute Mapping
Manage Import Template Manage Target Attributes
Enable 10 PIM Administration Guide
Page 47 of 371 Revised 8/2/2019
• Attribute Filter: Repositories can have thousands of attributes. To filter the Target Attribute list, type in consecutive alpha-numeric characters that appear in the desired attribute name(s). The Target Attribute list will display all attributes in all tabs that contain the filter string.
• Current Attributes: Expand or filter the Target Attribute list to display the attributes to be added to the Current Attributes list.
Use the right arrow and left arrow buttons to include or exclude target attributes in the Current Attributes list.
Use the up arrow and down arrow buttons to sequence the attributes as desired. Note that the order of the target attributes does not need to match the order the source columns are listed in the source file. Specifying the order of the targeted attributes may be useful If the generated import template will be used to create an export template.
To save the Current Attribute list and return to the Attribute Mapping page, click the Add button, or click the Cancel button to exit without saving.
The configuration options for each target attribute listed on the Attribute Mapping page can be edited by clicking its value. The options are:
• Source Column: The name of the column in the source file that will be mapped to the target attribute. Note that this name must match the name of the column in the source file.
Manage Import Template Manage Attribute Mapping
Enable 10 PIM Administration Guide
Page 48 of 371 Revised 8/2/2019
• Target Attribute: The name of the column in the target file that the source column will be mapped to.
• Target Repository: The repository that contains the target attribute.
• Is Key: Specifies if the attribute is a primary key. Enable will use primary key(s) to determine if a record already exists in the target repository and it should be updated, or if a new record needs to be created.
• Default Value: If the source file does not include a value for a record’s attribute, the default value will be stored.
The only column in a source file that is required is the primary key.
To save the configuration options for the import template click Save.
8.1.4 Create an Import Template: Map Attributes using an Import File
Using the Enable Classic UI, an import template’s attributes can be mapped through the use of an import file.
1. Log into the Enable Classic UI.
2. Click on the Import & Export feature (in the left frame of the main window) and the Import Templates function.
3. In the Action drop-down menu, click New to set up a new import template.
Open Import Templates
Enable 10 PIM Administration Guide
Page 49 of 371 Revised 8/2/2019
4. Enter a template Name. Note that this field can support multi-language translations.
5. Enter a template Description (optional). Note that this field can support multi-language translations.
6. Select the Target Root Repository from the drop-down list.
7. The Content Replacement checkbox can be used to replace all repository records with the import. This option is only available if the import only affects the root repository (no link repository records can be replaced).
WARNING: This option should be used only if all repository records are to be deleted and replaced with the data being imported.
Select New Import Template
Select Target Root Repository
Enable 10 PIM Administration Guide
Page 50 of 371 Revised 8/2/2019
8. Click the tree button on the left of the repository to see any additional linked repositories. The button will go away at the last child repository.
9. Click the checkbox next to the repositories to be included in the import template.
10. Click the Return button to go back to the Import Template Editor.
11. Click the Next button to go to the Import Template Editor window.
12. Open the Utilities dropdown and select Import Template.
Select Related Repositories
Enable 10 PIM Administration Guide
Page 51 of 371 Revised 8/2/2019
13. Click the Browse button to create the import template based on a previously created export file.
14. Click the Ok button.
15. Click the Save button.
Elect to use an Import File to Map Attributes
Select Browse to Select Export File
The Import Template is Saved
Enable 10 PIM Administration Guide
Page 52 of 371 Revised 8/2/2019
16. Click the Ok button
17. The Import Templates window will open. Click the Reload button on the bottom left of the list to see the new template.
Export Templates
The Export Template function allows a user to define and save an export configuration for future use. It is recommended that the system administrator assists users in creating advanced export templates, especially those that export data from multiple repositories.
Templates may be used in both scheduled and manually triggered activities. For additional information regarding the use of export templates during scheduled activities, see Job Scheduling. For additional information regarding the use of export templates during manually triggered activities, see the Enable 10 PIM User Guide.
8.2.1 View Export Templates in Enable 2020 UI
The list of available export templates for a repository can be viewed from the Export/Exchange/Publication/Syndication Templates pane which appears at the bottom of the repository’s Repository Dashboard’s list of configuration panes (see Repository Dashboard).
Reload the Import Templates Tab to See the New Import Template
Enable 10 PIM Administration Guide
Page 53 of 371 Revised 8/2/2019
8.2.2 View Export Templates in Enable Classic UI
To view existing Export Templates in the Enable Classic UI:
1. Log in to the Enable Classic UI.
2. From the Feature Bar, open the Import & Export tab, and select Export Templates.
3. A list of the existing export template folders is displayed across the center screen. Click a folder to open it and display its existing Export Templates.
Defining an export template is performed in the Enable Classic UI. To create an export template:
1. Log in to the Enable Classic UI.
2. Open the list of Export Templates, (see View Export Templates in Enable Classic UI).
Open Folders to Show Export Templates
Enable 10 PIM Administration Guide
Page 55 of 371 Revised 8/2/2019
NOTE: The template list displayed above can be filtered by using the Name, Root Repository, and/or Type fields with the Apply button.
3. The Action drop-down menu:
o New - New templates can be created by selecting the New option from the Action drop-down menu.
o Edit - Existing templates can be modified by selecting the Edit option from the Action drop-down menu.
o Edit Mappings - Existing or new field mappings can be defined by selecting the Edit Mappings option from the Action drop-down menu.
o Delete - Existing templates can be removed by selecting the Delete option from the Action drop-down menu.
4. The Utilities drop-down menu:
This option provides the ability to Import an existing template or to Export an existing template, if required. These options are used to move import or export templates from one environment to another, such as, exporting a template from the Development environment and importing it into the QA environment.
5. To define a new Export Template, open the Action drop-down menu and click New.
Open Folders to Show Export Templates
Enable 10 PIM Administration Guide
Page 56 of 371 Revised 8/2/2019
To edit an existing Export Template, select the template, open the Action drop-down menu and click Edit.
6. The Export Template Editor is shown:
7. Edit the configuration options as desired.
o Name: (Required; Multi-language) The Export Template’s Name o Description: (Optional; Multi-language) A description about the Export
Template. o Output Type: (Required) XLS, XLSX, CSV, InDesign CSV, Mapped CSV, or XML.
Create a New Template
Export Template Editor
Enable 10 PIM Administration Guide
Page 57 of 371 Revised 8/2/2019
o Validation Level: The minimum validation level that any record must meet to be included in the export.
o Root Repository: (Required) The primary repository that will be the source for content.
o Advanced Callout Function: A feature that when configured, will allow the calling of customized processing blocks to manipulate data before it is written to the export file.
o Advanced Callout Class Path: A feature that when configured, will allow the calling of customized processing blocks to manipulate data before written to the file. This is the Java class path customized processing.
o Available Link Relationships: Select any additional linked repositories that have attributes needed in the export file. To select any child repository, the parent must be selected.
o Split File Control: Indicates if the generated output file will be split based on taxonomy or hierarchy.
o Output File Alias Format Type: Select any one of the alias, i.e. prefix, suffix or none.
o Output File Layout: Mapping of columns to be exported based on the root repository and available link relationship repositories.
8. Click on the Edit button next to the label Available Link Relationships and the relationship tree is shown.
Enable 10 PIM Administration Guide
Page 58 of 371 Revised 8/2/2019
9. Expand the relationship tree to find the linked relationships that contain the attributes to be included in the syndication/export template. Click the checkbox next to the repositories and the Edit Included Links of Template screen is shown.
Available Link Relationships
Select Attributes to Include in the Export
Enable 10 PIM Administration Guide
Page 59 of 371 Revised 8/2/2019
10. To include an attribute in the export file, select it and use the arrow buttons to move the attribute to the Selected Attribute list.
To exclude an attribute from the export file, select it and use the arrow buttons to move the attribute to the Available Attribute list.
11. Select the images to include in the export (if required) in the same manner. To include images, it is necessary to select at least one image content, image type, and image priority.
12. Click the Save button to go back to the Repository Tree screen.
13. Click the Return button on the Export Template Editor.
14. Click the Edit button to the right of the Split File Control label to create multiple files based on taxonomy (dynamic) attributes. The Split File Control Editor will appear.
Export Template Editor
Enable 10 PIM Administration Guide
Page 60 of 371 Revised 8/2/2019
15. Edit the Split File Control options as desired. Click Save to save your changes and return to the Export Template Editor.
16. To edit the output layout, click the Output File Layout Edit button. The Manage Output File Layout window to appear.
17. To modify the column alias for an attribute (the name that will appear at the top of the column in the output file), select the attribute, open the Action dropdown, and select Set Alias. Edit as desired and click the Save button to save your changes.
Split File Control Editor
Manage Output File Layout Editor
Enable 10 PIM Administration Guide
Page 61 of 371 Revised 8/2/2019
To modify the order of the attribute columns in the output file, open the Action dropdown, and select Set Order. Edit as desired and click the Save button to save your changes.
18. From the Export Template Editor screen, to save your changes to the Export Template, click the Save button, or click the Cancel button to exit without saving your changes.
Syndication Templates
The Syndication Template function is used to develop templates that can be used once or multiple times to export data from one or more Enable repositories for syndication. Use a syndication template instead of an export template if you need to do any data transformations before exporting it or if you need to validate the data before exporting it (using validation levels or required field filters). It is recommended that the system administrator assists users in managing syndication templates.
Templates may be used in both scheduled and manually triggered activities. For additional information regarding the use of syndication templates during scheduled activities, see Job Scheduling. For additional information regarding the use of syndication templates during manually triggered activities, see the Enable 10 PIM User Guide.
8.3.1 View Syndication Templates in Enable 2020 UI
The list of available syndication templates for a repository can be viewed from the Export/Exchange/Publication/Syndication Templates pane which appears at the bottom of the repository’s Repository Dashboard’s list of configuration panes (see Repository Dashboard).
8.3.2 View Syndication Templates in Enable Classic UI
To view existing Syndication Templates in the Enable Classic UI:
2. From the Feature Bar, open the Import & Export tab, and select Syndication Templates.
3. A list of the existing Syndication Template folders is displayed across the center screen. Click a folder to open it and display its existing Syndication Templates.
Open Syndication Templates
Open Folders to Show Export Templates
Enable 10 PIM Administration Guide
Page 63 of 371 Revised 8/2/2019
8.3.3 Manage Syndication Templates
Syndication templates are viewed, defined, and edited in the Enable Classic UI, in the same manner in which Export templates are created, with the exception that the only available output formats are CSV, XLS, and XLSX.
To create/edit a syndication template using the Enable Classic UI:
1. Log onto the Enable Classic UI.
2. Open the Syndication Templates list, (see View Syndication Templates in Enable Classic UI).
NOTE: The Syndication Template list displayed above can be filtered by using the Name, Root Repository, and/or Type fields with the Apply button.
a. The Action drop-down menu:
i. New - New templates can be created by selecting the New option from the Action drop-down menu.
ii. Edit - Existing templates can be modified by selecting the Edit option from the Action drop-down menu.
iii. Edit Mappings - Existing or new field mappings can be defined by selecting the Edit Mappings option from the Action drop-down menu.
List of Syndication Templates
Enable 10 PIM Administration Guide
Page 64 of 371 Revised 8/2/2019
iv. Delete - Existing templates can be removed by selecting the Delete option from the Action drop-down menu.
b. The Utilities drop-down menu:
This option provides the ability to Import an existing template or to Export an
existing template, if required. These options are used to move import or export
templates from one environment to another, such as, exporting a template from
the Development environment and importing it into the QA environment.
3. Select the New option under the Action drop-down list.
4. The Syndication Template Editor screen is then shown.
Enable 10 PIM Administration Guide
Page 65 of 371 Revised 8/2/2019
5. Name: (Required; Multi-language) A name for the Syndication Template.
6. Description: (Optional; Multi-language) A description for the template.
7. Select the Output Type from the drop-down list. The options are:
a. Excel 2003 (xls) b. Excel 2007 (xls) c. Excel 2010 (xlsx) d. Comma Separated Values (csv)
8. Select the Validation Level for the export (if applicable).
9. Select the Root Repository from the drop-down list.
10. Click the Available Linked Relationships button to select any additional linked repositories that have attributes needed in the syndication export file. To select any child repository, the parent must be selected.
Enable 10 PIM Administration Guide
Page 66 of 371 Revised 8/2/2019
11. Click the Edit Details button to optionally identify that all or some of the dynamic attributes should be appended to end of export file as shown below.
Enable 10 PIM Administration Guide
Page 67 of 371 Revised 8/2/2019
12. Click the Save button (above) to go back to the Syndication Template Editor links:
13. Click Return to go back to the Syndication Template Editor:
Enable 10 PIM Administration Guide
Page 68 of 371 Revised 8/2/2019
14. Optionally, click the Edit button next to the Split File Control label to create multiple files based on taxonomy (dynamic) attributes.
15. Click the Save button to go back to the Syndication Template Editor.
16. Use the Advanced Call Out Function and Advanced Call Out Class Path for export file transformations (opt.).
17. Click the Save button to go back to the Syndication Template list.
Enable 10 PIM Administration Guide
Page 69 of 371 Revised 8/2/2019
18. Select the Syndication Template that was just created.
19. Select the Edit Mappings option from the Action drop-down list to define (or modify) the export file and identify where the data for the export is coming from in Enable.
20. Select the New option from the Action drop-down list to define a new column mapping.
21. The Create New Syndication Template Mapping screen is shown.
Enable 10 PIM Administration Guide
Page 70 of 371 Revised 8/2/2019
22. Enter the export column name in the Display name field.
23. Click the Required Indicator checkbox, if applicable.
24. Select the Repository that contains the field to export.
25. Select the Catalog Node that contains dynamic attributes, if applicable. Click the magnifying glass to show a list of nodes:
Enable 10 PIM Administration Guide
Page 71 of 371 Revised 8/2/2019
26. The list can be filtered by using the Filter: field below the attribute list.
27. Select the source attribute (field) that will populate the target column. The field will be displayed in the right mapping box.
28. See the Enable Advanced Mapping Guide for detailed instructions on using the Velocity Template Language (VTL) for transformation of data from Enable, if required.
Enable 10 PIM Administration Guide
Page 72 of 371 Revised 8/2/2019
NOTE: To concatenate fields together for export, choose multiple fields to include in the Mapping window, then add any separation characters, if required. The fields can be reordered within the window.
29. Click the Preview tab to see what the mapping will look like, use the fields on the bottom to enter test data into the fields.
30. Click the Builder tab and click the Save button to go back to the Syndication Template Editor screen.
Enable 10 PIM Administration Guide
Page 73 of 371 Revised 8/2/2019
31. One or more existing mapping items can be edited, copied or deleted by selecting one or more mapping line items and selecting the desired action from the Action drop-down menu.
32. To reorder the fields in the export template, select the Set Sequence option from the Action drop-down list.
Enable 10 PIM Administration Guide
Page 74 of 371 Revised 8/2/2019
33. Drag and drop the fields to set the order of the fields in the export file.
34. Click the Ok button.
8.3.4 Delete a Syndication Template
To delete a syndication template, follow the directions for deleting an export template, (see Delete an Export Template).
Exchange Templates
Exchange templates are used to import XML files.
Templates may be used in both scheduled and manually triggered activities. For additional information regarding the use of exchange templates during scheduled activities, see Job Scheduling. For additional information regarding the use of exchange templates during manually triggered activities, see the Enable 10 PIM User Guide.
8.4.1 Manage Exchange Templates
Exchange templates are created in the same manner in which Export templates are created, with the exception that the only available format is XML Exchange. (See Export/ Templates.)
Enable 10 PIM Administration Guide
Page 75 of 371 Revised 8/2/2019
Publication Templates
For more detailed information regarding publication templates, contact your Enable account representative.
Templates may be used in both scheduled and manually triggered activities. For additional information regarding the use of publication templates during scheduled activities, see Job Scheduling. For additional information regarding the use of publication templates during manually triggered activities, see the Enable 10 PIM User Guide.
Publication Templates are created in the same manner as Export Templates. For more information, see Export/ Templates.
9 Multiple Language Support
Depending on system configuration and user permissions, a user can enter language translations for attribute values and system-level objects.
Browser Specific Language Setting
During login, the user can select the language that will be used in their Enable session by choosing the desired language from the Language dropdown list in the Login window. The list of languages supported are defined in the Language List.
Enable 10 PIM Administration Guide
Page 76 of 371 Revised 8/2/2019
Language Selector Dropdown
Enable 10 PIM Administration Guide
Page 77 of 371 Revised 8/2/2019
Certain aspects of the Enable interface are displayed in the language specified by the browser in use. For example, the Choose File button shown below is displayed in English because the browser’s language is set to English.
For complete integration when logging in with a different language, change the browser specified language through the browser settings.
Language List
The Language List defines the set of languages Enable will maintain and indicates which language is the default language.
Language Selection
Enable 10 PIM Administration Guide
Page 78 of 371 Revised 8/2/2019
9.2.1 Access the Language List Function
The Language List function is accessed through the Enable Classic UI.
1. Log into the Enable Classic UI.
2. Select the Languages function under the System Feature in the left feature bar.
3. Another way to access the Languages function is by using the Quick Links dropdown list on the top-right of the screen and selecting the System Configuration option.
Enable 10 PIM Administration Guide
Page 79 of 371 Revised 8/2/2019
4. Then click on the Languages link under the Data Model Management tab and Model section.
5. The Language List screen is displayed, as shown below.
Enable 10 PIM Administration Guide
Page 80 of 371 Revised 8/2/2019
9.2.2 Manage the Language List
The Language List is managed through the Enable Classic UI.
1. Log into the Enable Classic UI.
2. From the Language List screen, click on the New option under the Action dropdown list to add a new language option.
a. Current Languages can be edited using the Edit option. b. Current Languages can be deleted using the Delete option. c. The Language list can be sequenced using the Sequence option. d. Multiple Languages can be enabled or disabled using the Enable/Disable
Languages option.
NOTE: Only Active Languages can be sequenced; deactivated languages are displayed first.
Enable 10 PIM Administration Guide
Page 81 of 371 Revised 8/2/2019
3. The Language Editor window is displayed.
4. Enter the Language Name.
5. Enter the Language Extension. Use a standard language code like ISO 639-1 or ISO 639-2/T in order to sufficiently differentiate the language for maintenance.
6. Click the Enable checkbox, if applicable.
7. Select the user Group that will have the ability to update fields in this language. Move the group(s) from the left to the right using the arrows in the middle.
Enable 10 PIM Administration Guide
Page 82 of 371 Revised 8/2/2019
8. Click the Save button.
Attribute Value Translations
9.3.1 Designate an Attribute as Multi-Language
To designate an attribute as a Multi-Language attribute, edit the attribute’s definition (see Edit a Profile Attribute) and set the Is Multi Language checkbox.
Enable 10 PIM Administration Guide
Page 83 of 371 Revised 8/2/2019
9.3.2 Manage Attribute Language Translations
When editing the value of an attribute, if the value is defined as a Multi-language attribute, a
Multi-Language icon will appear to the right of the attribute’s edit box. To manage translated text for the attribute, click the Multi-Language icon. An Edit Multi-Language pop-up window will appear.
Select Is Multi-Language in the Manage Attribute Dialog
Enable 10 PIM Administration Guide
Page 84 of 371 Revised 8/2/2019
The Language dropdown list at the top of the Edit Multi-Language window allows the user to elect to see the text edit boxes for all the supported languages or to see only one. If a desired language is not supported, it must be added to the Language List (see Manage the Language List).
Edit the translations as desired. Click the Apply button to save your changes, or click the Cancel button to exit without saving your changes.
Translating Data Model Entities
Enable data model objects have translatable multi-language fields, such as their name and description. For translating entire data model objects and their attributes, use the Export and Import multi-languages functions described in this section.
9.4.1 Exporting Data Model Entities for Translation
Exporting data model entities for translation is performed in the Enable Classic UI.
To access the Multi-Language function:
Edit Multi-Language Fields
Enable 10 PIM Administration Guide
Page 85 of 371 Revised 8/2/2019
1. Log into the Enable Classic UI.
2. From the Feature Bar, open the System tab, and select Export Multi-Languages.
3. The Multi-Language Export window will open.
Open Multi-Language Export
Enable 10 PIM Administration Guide
Page 86 of 371 Revised 8/2/2019
The Export Multi-Languages window has four sections
• Select Languages: This section allows you select which language(s) are available for translation. Only active languages are available for translation.
• Profile: Selecting profiles exports a profile’s name, description fields as well as every profile’s attribute name and description fields.
• Code Set: Selecting code set exports a code set’s name and description field along with each code sets codes description field
• Selecting Other Sub-Systems: Other Sub-systems cover the rest of the data models that can be translated, which include:
Multi-Language Export Window
Enable 10 PIM Administration Guide
Page 87 of 371 Revised 8/2/2019
o Attribute Groups o Attribute Tabs o Code Set Folders o Data Sources o File Definitions o Groups o Import Template Folders o Languages o Repositories o Repository folders o Templates o User Preferences
The sub-systems Messages contain all EPIM interface labels and messages; steps for this translation are in Translating Enable Labels and Messages.
Once you have finished selecting language(s) and data model(s), simply click the Export button at the bottom right of the page, this will generate a link that downloads a csv file for the data model(s) selected.
The generated link can come in either one of two background colors.
A successful export will generate a link similar to the picture below with a green background.
An unsuccessful export will generate a link similar to the picture below with a yellow background, information is added to describe what failed to export.
Clicking the link will download a csv zip file. The steps below cover how to add translations to these files.
1. Extract file(s) to your computer
2. Open a new Excel file.
3. Select the Data tab.
4. In the Get External Data section of the data tab, select From Text.
5. In the file explorer that appears navigate to the extracted data model file(s).
6. In the Text Import Wizard that appears select the Delimited radio button. In the file origin dropdown list select Unicode (UTF-8). An example is shown below:
Enable 10 PIM Administration Guide
Page 88 of 371 Revised 8/2/2019
7. Click Next and in the following window, in the Delimiter section verify that only the Comma checkbox is selected. An example is shown below:
8. Click Finish. Place the data in the upper left corner cell (A:1) and click Ok.
The image below is the general format for each exported data model object.
Enable 10 PIM Administration Guide
Page 89 of 371 Revised 8/2/2019
9. From this point, translate the default language column values into the language column(s) selected for translation. Pictured above is an example of German translations for a profile named Area and its attributes.
NOTE: The default language will always display with its own column and values.
10. For Chinese, Korean, Japanese and languages that are made primarily of special characters, follow these extra steps, otherwise simply save as a csv file.
a. Save file as Unicode text. b. Close Excel. c. Open Unicode file with Notepad++. d. Select all text and crtl-F. e. Select the Replace tab. f. In the search mode section, select the Extended radio button. g. In the section Find what, enter “\t” and in Replace with section, enter “,”. Click
Replace All. h. Save with .csv extension.
NOTE: The file must be saved in UTF-8 format. To verify open the file in notepad++ and check the encoding. Convert file to UTF-8 if it is not already and save the file again. An example is shown below.
Enable 10 PIM Administration Guide
Page 90 of 371 Revised 8/2/2019
9.4.2 Import Data Model Translations into EPIM via Enable Classic UI
Translated data model object csv files can be integrated through the Import Multi-Language function located in the System feature bar. A data model object csv file can be imported from your local machine by selecting the From Local tab, or from the application server by selecting the From Server tab.
1. To import translated data model csv files simply click Choose File, select the csv file, then click Import.
2. A new job is created from the import. Navigate to the job monitor and open the log file for the import job. An example of a successful import log file is shown below.
3. If the import job was successful simply clear the data cache, log out and log back in with the language selected for translation and navigate to the data model object modified to view the results of your translation.
Enable 10 PIM Administration Guide
Page 91 of 371 Revised 8/2/2019
4. For complete integration, change the Browser specified language. Steps to do so are outlined in the Browser Specific Language Setting section of this manual.
NOTE: Log file import failures may occur, due to incorrect formatting of csv file, repeat
formatting steps if such an error appears in the log file.
Translating Enable Labels and Messages
EPIM allows all labels and messages to be translated into the active languages in the Language List. Labels are the field names, headers, page names, and button labels. Messages include confirmation and error messages displayed as a consequence of user actions.
To translate all the labels that make up the EPIM interface use the “Export Multi-Languages” function and export “Messages” from the “Other Sub-systems” section.
1. Navigate to “Export Multi-Languages” function.
2. Select desired languages for translation then select Messages from the Other Subsystems section.
3. Click Export and click on the generated link.
4. Extract file(s) to your computer.
5. Open a new Excel file.
6. Select the data tab.
7. In the Get External Data section of the data tab, select From Text.
8. In the file explorer that appears navigate to the extracted data model file(s
9. In the Text Import Wizard that appears, select the Delimited radio button. In the file origin dropdown list, select Unicode (UTF-8). An example is shown below:
Enable 10 PIM Administration Guide
Page 92 of 371 Revised 8/2/2019
10. Click Next. In the following window, in the Delimiter section, verify that only the Comma checkbox is selected. An example is shown below:
11. Click Finish. Place the data in cell A:1 and click Ok.
12. Add your translations for the language you have chosen to export.
Enable 10 PIM Administration Guide
Page 93 of 371 Revised 8/2/2019
13. Save the file as Unicode (UTF-8) text.
a. If the file name is changed, the new file name must include “Messages” in the file name.
Enable 10 PIM Administration Guide
Page 94 of 371 Revised 8/2/2019
14. For languages that are not made up of mostly special characters, follow regular formatting. Execute the following steps for languages that are mostly special characters. Examples include Chinese, Japanese and Korean.
a. Open the file in Notepad++. b. All the characters should appear normally. If not, then stop and start from the
beginning . c. Select all text and click crtl-F. d. Select the Replace tab. e. In the search mode section, select the Extended radio button . f. In the Find what section, enter “\t”. In the Replace with section enter text “,”
then click Replace All. g. In the Find what”section, enter “,,”. In the Replace with section, enter “"",,”
then click Replace All. h. In the encoding menu section of Notepad++, convert file to UTF-8. i. Save file with .csv file extension.
15. Use the Import Multi-Languages function to import the translated file. Steps for importing can be found in section Import Data Model Translations into EPIM.
16. Inspect the Log file for the import job. An example of a successful import log file is shown below.
17. Remotely log into the application server and navigate to where the log file indicates the property files are generated. In the example above, the location is on the second line: D:/Enterworks/shared/conf/eMessages_de.properties
18. Two files are generated from the import for each language. Copy both files that pertain to the language(s) imported. An example is shown below.
Enable 10 PIM Administration Guide
Page 95 of 371 Revised 8/2/2019
19. Paste the copied files into every tomcat and Jboss instance. An example is shown below for a multiple Jboss instances.
20. In the Enable application, clear the data cache for the added translations to take effect.
21. For complete integration change of the browser specified language, steps are outlined in the Browser Specific Language Setting section of this manual.
NOTE: Log file import failures may occur, due to incorrect formatting of csv file, repeat formatting steps if such an error appears in the log file
10 Data Validation
When attribute values are saved, Enable automatically conducts basic data validation, such as checking that the type of data being stored matches the attribute’s defined data type, that the value’s size falls within the attribute’s defined data size, and ensuring that an attribute value is present if the attribute value is required. If more complex data validation is needed, Enable provides the ability to define specific validation rules and to define validation levels which specify which validation rules to apply given a particular use of the data.
Additional information about validation rules and levels can be found in Enable 10 Basics and the Enable 10 PIM User Guide.
Define Validation Levels
Validations levels are defined during system configuration. The definitions include the number of validation levels and their names. For more information regarding defining validation levels, see Configure Validation Levels.
Manage Validation Rules
Details on managing validation rules are distributed in various sections of this document:
Enable 10 PIM Administration Guide
Page 96 of 371 Revised 8/2/2019
• Validation rules are created/deleted and assigned to attributes at the profile level, (see Manage Validation Rules).
• For a validation rule to go into effect for a particular repository, it must be assigned to that repository, (see Manage Repository Validation Rules).
• Manually validating records and setting record validation levels is done in a Repository View, (see the Enable 10 PIM User Guide).
• Setting the validation levels for templates is done by editing the templates, (see Templates).
11 Manage Digital Assets
Digital assets, such as an organization’s digital images, audio files, video files, PDF documents, Microsoft Office documents, and other file types, as well as, the metadata associated with these digital assets are stored in the DAM repositories. After the digital asset objects are stored, they can be associated with any repository that has been set up as Digital Asset enabled by the Systems Administrator. This section will only cover activities normally handled by a System Administrator.
Digital Assets can be managed via both the Enable 2020 UI and the Enable Classic UI.
Managing Digital Assets
Bulk Importing Digital Assets
The basic import process can be lengthy if you are processing a lot of digital assets. Enable’s Bulk Uploading feature utilizes an automatic upload folder located on the Enable Web Server to quickly upload digital assets.
The upload directory is defined in the SourceFolder property in the DamConfig
repository. To access this value, open the DamConfig repository in a Repository View. The first record shows the Source Folder’s path on the server.
Enable 10 PIM Administration Guide
Page 97 of 371 Revised 8/2/2019
To import multiple digital assets:
1. Stage the files to be uploaded in a local directory.
2. To automatically assign the files to nodes in a DamHierarchy, define a directory
structure that mirrors the DamHierarchy structure and place the files in the appropriate folder. Files placed in the upload directory will be uploaded without setting or changing the DamHierarchy assignments. New nodes will be created in the DamHierarchy structure if the directory structure does not match it exactly. For example, if a file is uploaded into a directory <dropfolder>\Furniture\Office\Desks, the DamHierarchy setting for
the assets being loaded will be set to the Furniture.Office.Desks node.
3. Log into the server and follow the source path to the Mass Upload folder (or access the upload folder if it has been configured as a shared directory on the network).
4. Copy the local files (including the directories) into the upload folder. The folder is checked every 15 seconds (or as configured by the System Administrator) for new items, and when they are found they are automatically uploaded. Results of the upload processing can be viewed in the log file for the Asset Monitor process.
Batch Importing Digital Asset Metadata
The Import function in the DamMaster also allows importing CSV or Excel files containing
metadata for existing digital assets including links to other repositories. This is useful when you want to update information for many assets. This functionality is recommended only for System Administrators and should be tested on a development or QA box before running on the production server.
1. Open DamMaster in a Repository View.
Dam Config -- SourceFolder
Enable 10 PIM Administration Guide
Page 98 of 371 Revised 8/2/2019
2. Click the More button on the Repository View’s Activity Bar to open the More dropdown list, and select Import.
3. The Import tab will open. Import files into DamMaster as you would any other repository. For more information on importing files, see the Enable 10 PIM User Guide.
12 Promotion from Staging to Production
For an overview of the use of Staging and Production repositories, see Enable 10 Basics.
Manual Promotion
There are several ways to manually promote records from the Enable 2020 UI:
• Promote Selected Records
• Promote a Saved Set
• Promote All Records in a Repository
The method of obtaining configuration options for a promotion depends on the nature of the promotion.
• Promoting via the Promote Selected Records or Promote Saved Set options: configuration options are obtained from the sharedConfig.properties file.
• Promoting via the Promote All Records option: The UI will prompt the user to enter the configuration properties.
Open the More Dropdown and Click Import
Enable 10 PIM Administration Guide
Page 99 of 371 Revised 8/2/2019
12.1.1 Promote Selected Records
To promote one or more selected records:
1. Open the desired repository in a Repository View. (For instructions on opening a repository in a Repository View, see the Enable 10 PIM User Guide.)
2. Select one or more records to be promoted and open the More dropdown list from the Repository View’s Activity Bar.
3. Select Promote Selected Records. Configuration options are obtained from the sharedConfig.properties file and the selected records are promoted. A
message will appear at the bottom of the screen that states the completion status of the promotion.
12.1.2 Promote a Saved Set
To promote a Saved Set of records, either use the Promote Saved Set option or the Promote All Records options (see Promote All Records in a Repository). To promote using the Promote Save Set option:
Promote Selected Records
Enable 10 PIM Administration Guide
Page 100 of 371 Revised 8/2/2019
1. Open the desired repository in a Repository View. (For instructions on opening a repository in a Repository View, see the Enable 10 PIM User Guide.)
2. If a Saved Set containing the records to be promoted does not already exist, create it. (For instructions on opening a repository in a Repository View, see the Enable 10 PIM User Guide.)
3. Apply the Saved Set by clicking the Saved Set’s name, and open the More dropdown list from the Repository View’s Activity Bar.
4. Select Promote Saved Set. Configuration options are obtained from the sharedConfig.properties file and the records will be promoted. A message will
appear at the bottom of the screen that states the completion status of the promotion.
12.1.3 Promote All Records in a Repository
All the records in a repository can be manually promoted from a Repository View. To do so:
1. Open the desired repository in a Repository View. (For instructions on opening a repository in a Repository View, see the Enable 10 PIM User Guide.)
Promote Saved Set of Records
Enable 10 PIM Administration Guide
Page 101 of 371 Revised 8/2/2019
1. Open the More dropdown list from the Repository View’s Activity Bar.
2. Select Promote All Records. A Promote Job dialog will open.
Promote All Records in a Repository
Promote Job Configuration Options
Enable 10 PIM Administration Guide
Page 102 of 371 Revised 8/2/2019
3. Select the Promotion Configuration to be used. The list of Promotion Configurations is drawn from the sharedConfig.properties file.
4. To promote all new or changed records, select the All New or Changed Records radio button.
5. To promote only those records in a Saved Set, select the All Records from Saved Set radio button and select the desired Saved Set from the list.
6. Select the desired promotion type.
7. Select the desired validation option.
8. Click OK. A background job will be launched that will validate and promote the designated records from the designated repository.
12.1.4 Review Difference from Production
Viewing differences between the staging record and the production record is performed in Enable Classic.
1. Select a single record from the listing. From the Utilities menu, select Utilities→ Diff Production Record.
2. The Differences viewer will open. It defaults to only showing the attributes that are different. Use the dropdown selection to control what attributes to show.
Enable 10 PIM Administration Guide
Page 103 of 371 Revised 8/2/2019
Package Promotions
For an overview of the Package Promotion process, see Enable 10 Basics.
12.2.1 Package Promotion Repository
The Package Promotion repository defines the promotion packages for Enable. It has the following attributes:
Attribute Description
Display Attributes List of attributes to display when referencing a record in this repository (instead of primary key).
Id Unique identifier for each Package element.
Package Dependent Indicates a record in this repository can only be promoted if the entire package containing this record is valid if Yes.
Enable 10 PIM Administration Guide
Page 104 of 371 Revised 8/2/2019
Attribute Description
Package Level Level for package with top level being 1.
Package Name Name of promotion package.
Parent ID ID of Parent Package Element (empty if root).
Parent Link Relationship Name Name of link relationship associating this repository with its parent (blank if the top level).
Promote Warnings Records having only Warning validation errors will be promoted for this repository if Yes.
Promotion Attribute Comma-delimited list of attributes to be updated in each package record from the values of the corresponding work item properties (defined in Promotion Property).
Promotion Configuration Name
Name of promotion configuration if repository is to be promoted as part of the package promotion processing. This name must match a promotion configuration in the sharedConfig.properties configuration file.
Promotion Property Comma-delimited list of work item properties to be used to update the corresponding attributes (defined in Promotion Attribute) for each record in the package.
Promotion Raise Validation Level
Raise the validation level for records in this repository if Yes.
Repository Name Name of repository.
Enable 10 PIM Administration Guide
Page 105 of 371 Revised 8/2/2019
Attribute Description
Status Only process if Active. Inactive records will prevent children repositories from being processed.
Update Package Errors Update the Package Errors attribute in the root repository if Yes. The Package Errors attribute must be defined and have a Validation Rule specifying the attribute must be empty.
12.2.2 Define a Data Package
The following steps are used to set up a data package to control the promotion of related records. This functionality is only available to System Administrators.
1. In the Feature Sidebar, open the Repository tab, open the Scheduled Activities group, and open the Promotions repository.
Enable 10 PIM Administration Guide
Page 106 of 371 Revised 8/2/2019
2. The Promotions repository will open.
Open Promotions
Promotions Repository
Enable 10 PIM Administration Guide
Page 107 of 371 Revised 8/2/2019
3. Click the Add new record button in the Repository View’s Activity Bar. The Package Promotions repository will be opened in the Detail Editor Tab.
4. In the Package Name field, enter the name of the package.
NOTE: All package level records for the same package must have the exact same Package
Name value.
5. In the Repository Name, enter the name of the repository to which this level. Each repository can only be listed once for a package.
6. In the Package Level field, enter the package level for this repository.
The top level repository is level 0. The repositories that link to the top level must be defined as level 1. Repositories that link to the Level 1 repositories must be defined as level 2 and so on. Levels must be consecutive (i.e., if there is a level 3, there must be a levels 2, 1, and 0).
7. If this is not the top level, in the Parent Link Relationship Name field, enter the name of the Link Relationship that connects this repository to its parent.
For example, if Level 0 is Product and Level 1 is Item, and the Link Relationship “Product to Item Staging” defines the relationship between Product and Item, set the field to “Product to Item Staging” (without the quotes).
8. If records in this repository should only be promoted if the entire package containing them gets promoted, set the Package Dependent to “Yes”, otherwise set it to “No”.
A New Promotions Record
Enable 10 PIM Administration Guide
Page 108 of 371 Revised 8/2/2019
9. In the Promotion Configuration Name field, enter the name of the promotion configuration for this repository. This name should be copied from the sharedConfig.properties file.
10. If warning validation errors are to be ignored, set the Promote Warnings attribute to Yes.
11. If attributes other than (or in addition to) the primary key attribute(s) should be used to identify a repository record in the Package Promotion reports, enter the names of the attributes in the Display Attributes field (one per line).
12. If values from the Package Promotion work item should be used to update attributes in this repository, add the names of the work item properties and the repository attributes to the Promotion Attributes table. Whenever a package promotion is initiated, the values from the work item will be set in each package record from this repository before the promotion processing (validation and promotion) begins.
13. If a package record from this repository should be flagged with an error when the package promotion fails, set the Update Package Errors attribute to Yes.
14. Click Save to save your changes.
15. Repeat the above steps to define all levels for a package.
13 Job Scheduling
Content relevant to Enable 10 and the Enable 2020 UI is still being developed. The documentation currently included in this section pertains to Enable 8 and the Enable Classic UI. While much of the following information is still accurate for Enable 10, directions for performing operations using the Enable 2020 UI are not provided. For information regarding the Enable 2020 UI, please contact your Enable account representative.
Scheduling Imports
Scheduled Imports are comprised of several Enable Server repositories and an EPX workflow. Together, they provide the means of processing imports on a scheduled basis as well as the means to pre-process the submitted files before actually importing them into Enable.
Two Enable Server repositories are used to support Scheduled Import processing: Scheduled Imports and Scheduled Import Jobs.
Note that when the repositories are opened in a Repository View, the default Preference View does not show all attributes.
Enable 10 PIM Administration Guide
Page 109 of 371 Revised 8/2/2019
13.1.1 System Log Directory Scheduled Imports Repository
All scheduled imports are defined in the Scheduled Imports repository. Each record in this repository represents one scheduled import.
Note that when the repository is opened in a Repository View, the default Preference View does not show all attributes.
Each attribute from this repository is described in the following table:
Attribute Description
Category Attribute Association Name
The name of the Category Attribute Association object to be updated when the Import Type is “Cat Attr Assoc”.
Code Set Full Replacement
If set to “Yes”, the code set import file fully replaces the existing code set. This means that existing nodes not included in the import file will be deleted from the code set.
Code Set Name Name of the code set to be updated when the Import Type is “Code Set”.
Delete Saved Set If set to “Yes”, the specified Saved Set should be deleted before adding records for the current import to the saved set.
Dependent Keys List of keys to be passed to each dependent operation. The keys must match attribute names in the dependent repository. The corresponding value in the Dependent Values attribute is then used to set the value of the key attribute when the Job is created. The value can reference attributes from the source job by surrounding the attribute name with double-pipe characters. For example, if an export is dependent on an import and that export should specify the same user, the Dependent Key would be set to “Manager Login” and the value would be “||Manager Login||”. Conversely, if the same dependent Export needs to be set to the admin user regardless of its initial definition, the Dependent Key would be set to “Manager Login” and the Dependent Values set to “admin”.
Enable 10 PIM Administration Guide
Page 110 of 371 Revised 8/2/2019
Attribute Description
Dependent Operation Name of dependent Import, Export, or Promotion to be initiated upon successful completion of this job.
Dependent Operation Immediate
Initiate the dependent operation immediately if “Yes”. Otherwise the operation will be queued and processed by the scheduler, which may take several minutes to start.
Dependent Operation Type
Type of dependent operation: Promotion, Import, or Export
Dependent Values Values corresponding to the Dependent Keys that are passed to the dependent operations. Values may reference attributes by surround the attribute name with double-pipe characters. For example, to reference the Import Job number, the Dependent Values might contain: “Job||Export Job||”. If Export Job in the current record is set to 1234, the resulting value will be “Job1234”
Description Description of scheduled import. It is strongly recommended that the Description be populated with all the details for the import, including any job that launches this job, any pre-processing performed, and what jobs this job launches. If ParameterX attributes are used, each should be detailed as to their content and purpose.
Display Attributes [DEPRECATED] Comma-delimited list of attributes to include in e-mails
Effective Primary Key [DEPRECATED] Comma-delimited list of attributes to serve as the primary key for this import.
Email Body Override e-mail body for successful jobs. Attributes in the job record can be referenced by surrounding them with double-pipe characters (e.g., ||Manager Login|| is replaced with the value of the Manager Login attribute).
Enable 10 PIM Administration Guide
Page 111 of 371 Revised 8/2/2019
Attribute Description
Email Notify Failure Send an Import Failed e-mail to the owner if Yes and the import fails to process successfully.
Email Notify Success Send an Import Successful e-mail to the owner if Yes and the import processes successfully.
Email Subject Subject for success e-mail. May contain references to any other job attribute by surrounding it with double-pipe characters (e.g., ||Manager Login|| is replaced with the value of the attribute Manager Login).
Email To Email address(es) to which success/failure notifications will be sent. If not defined, the e-mail address(es) associated with the Manager Login user/group will be used.
Error Dependent Keys Optional keys for arguments to be passed to any Dependent jobs (as properties) when this job fails with an error.
Error Dependent Operation
List of Promotions, Imports, and/or Exports (based on Dependent Operation Type) that should be triggered on successful completion of this one.
Error Dependent Operation Immediate
Execute dependent operation immediately if Yes when this job fails with an error.
Error Dependent Operation Type
List of operation types for each Dependent Operation when this job fails with an error.
Export – launch an export job
Import – launch an import job
Promotion – launch a promotion job
Enable 10 PIM Administration Guide
Page 112 of 371 Revised 8/2/2019
Attribute Description
Error Dependent Values Optional values for dependent keys when this job fails with an error.
Group Lock Action Group locks allow for multiple concurrent jobs to all attach to the same lock. The lock is not freed until all processes have detached from it.
Action to be taken with the lock identified in Group Lock Name:
Attach – the import will attach to the specified lock. Processing for the import will begin immediately.
Free – the import will detach from the named lock (presumably set by a previous job that invoked this import) once the import processing has completed. The lock is not completely freed until all attached processes have detached.
Attach And Free – the import will attach to the named lock and begin processing and detach from the named lock once processing has completed.
No Lock – the import will not attach to a group lock.
Group Locks will always acquire the designated lock, even if another process has acquired or attached to the same lock. If multiple jobs attach to the same lock via Group Lock, the lock is not free until all of the processes have freed the lock.
Group Lock Name Name of the group lock.
Ignore Missing File When an Import is executed and the specified file cannot be found, the Failure e-mail will be suppressed if this flag is set to “Yes”.
Import Directory Name Fully qualified path to directory where import file can be found.
Import File Name Name of file to be imported.
Enable 10 PIM Administration Guide
Page 113 of 371 Revised 8/2/2019
Attribute Description
Import File Sort Specifies whether the matching files (if Import File Name includes a wildcard character) should be sorted before selecting a file.
File Ascending – sort file names in ascending order
File Descending – sort file names in descending order
Import Format [DEPRECATED] Format of the import file.
Import Language Specifies the language to be used for the import. If blank, the default language is used. If set to a non-default language, the multi-language fields for this language are updated.
Import Name Logical name for the Import.
Import Now The import file is to be processed immediately if set to “Yes”.
This flag is immediately set to No once a record for this import has been created in the Scheduled Import Jobs repository. This flag will be set to Yes any time the import is to be processed outside of the scheduled time. The immediate processing of the import file will not alter the next scheduled date and time. For example, if the import is scheduled to be processed nightly at 1:30 a.m. and a user requests an immediate import at 11:00 p.m. by setting this flag to “Yes”, the file will be processed at 11 p.m. and then again at 1:30 a.m.
Import Option Name Name of import option to be applied to this import. The code set Import Options contains a complete list of available options. The description for each code identifies what the option does and what values can be specified.
Import Option Value Value for the corresponding import option to be applied to this import.
Enable 10 PIM Administration Guide
Page 114 of 371 Revised 8/2/2019
Attribute Description
Import Priority Priority of import controls order which jobs are checked. The lower the number, the higher the priority.
Import Type Identifies the type of import:
Template – the import uses an Import Template
Repository – the import uses a View Mapping for a specific repository
Code Set – the import is for a Code Set
Custom – the import only performs the assigned pre-processing module
Inactive Records Identifies action to be taken with Inactive records when the import type is Template and is configured as a full replacement import (which will flag records not present in the file as being inactive):
No Action – don’t do anything
Delete – delete inactive records from Staging and Production after the import has completed
Reactivate – reactivate inactive records if they are present in the import file
Inactive View Name of snapshot table view for the target repository. This view is used when processing inactive records in a full replacement template import.
Include Timestamp Include date and time in Import_<job>.log file if Yes. This can be helpful in troubleshooting pre-processing for an import as it shows how long processing steps took (providing the appropriate messages are being reported).
Last Import Datetime Date and time of when this import was last initiated (scheduled or manual).
Enable 10 PIM Administration Guide
Page 115 of 371 Revised 8/2/2019
Attribute Description
Last Scheduled Import Datetime
Date and time of when scheduled import was last processed
Lock Action Action to be taken with the lock identified in Lock Name:
Acquire – the import will wait until the named lock is acquired. Processing for the import will not begin until then.
Free – the import will free the named lock (presumably set by a previous job that invoked this import) once the import processing has completed.
Acquire And Free – the import will wait until the named lock is acquired and will free the named lock once processing has completed.
No Lock – the import will not wait for any lock before processing.
Locks will only be acquired if they are currently free. If the designated lock has been attached to by multiple jobs using the Group Lock, the lock does not become free until all of those jobs have freed the lock.
Lock Name Name of the lock to acquire or free (depending upon Lock Action). If more than one import shares the same lock, then they will be processed serially. The name may contain references to other properties by surrounding each property name with double-pipe characters. For example, to ensure only one instance of an import is processed at a time for each user, the Lock Name can be set to: “Import||Manager Login||”. This will produce a lock name of “Importjdoe” for John Doe and “Importjsmith” for John Smith.
If the referenced lock is associated with the Group Lock in other jobs, the lock will not be considered free until all the Group Lock jobs have detached from the lock.
Manager Login Login of the PIM user or Enable role assigned to this import. This user (or group of users if a role is specified) will receive e-mails generated for processing imports.
Enable 10 PIM Administration Guide
Page 116 of 371 Revised 8/2/2019
Attribute Description
Move Import File The import file is moved to the designated import directory and renamed to include a date/time stamp if Yes. The import file is left in its original location and processed from there if No.
Next Import Datetime Date and time of next scheduled import in the format “mm/dd/yyyy hh:mm:ss”. Enable will initiate the processing of the import file when this value is in the past. The value is updated to the next scheduled time (using the Import Period) as soon as the processing commences.
Parameter1-5 Five attributes that can serve as parameters when jobs are connected through the Dependent Operation attributes. They are not used directly by the Import processing but can be referenced in other attributes (e.g., ||Parameter2||).
Preprocess Class Fully-qualified path, identifying the Preprocess class to be invoked for this import. It must be a subclass of com.enterworks.services.BaseCustomProcessFile
Preprocess File Import file must be preprocessed using the designated class and arguments if “Yes”.
Preprocess Keys Argument keys identifying the Preprocess Argument Values to be passed to the designated preprocess module.
Preprocess Values Values for corresponding Preprocess Argument Keys to be passed to the designated preprocess module. Values can contain references to properties from this job by surrounding the property name with double-pipe characters. For example, to pass the Import Job, the value would be set to “||Import Job||”
Repository Name Name of target repository.
Enable 10 PIM Administration Guide
Page 117 of 371 Revised 8/2/2019
Attribute Description
Repository Timeout (Minutes)
Maximum number of minutes allowed for processing a Repository Import. This timeout specifies how long the Scheduled Import processing will wait for the import to complete processing. If a timeout is reached, the job is flagged with an error and the designated user or group is notified. The actual job may still complete successfully, but any dependent jobs will not be triggered.
Repository View Mapping
Name of mapping view for Repository Import. Mappings are either manually defined in the Enable 10 PIM UI or by manually performing an import using the Enable 10 PIM Repository interface and selecting the option to Save Mapping.
Run As Manager Login Run the import using the login designated in Manager Login if Yes. When enabled, the Manager Login must be set to a user and not a group. This option ensures the import is subject to the security of the designated login and also identifies the records being created/updated by that login (vs. system).
Saved Set Name of Saved Set to be created if specified.
Schedule Days Identifies the days of the week if Schedule Type is “Days of Week”
Schedule Exclude Dates Code Set
If set to a code set listing dates as code values, the scheduling logic will skip to the next scheduled date if the calculated date is one of the dates in the code set.
Schedule Period Number of time units (based on Schedule Type) after Last Scheduled Date before the next scheduled import is initiated. For example, an import that is to be processed daily could be set to type DAYS and have a period of 1 or be set to type MINUTES and have a period of 1440. The scheduled imports are not affected by any manually initiated imports
Enable 10 PIM Administration Guide
Page 118 of 371 Revised 8/2/2019
Attribute Description
Schedule Type Type of schedule:
MINUTES – the Schedule Period identifies the number of minutes before re-invoking the import.
DAYS – the Schedule Period identifies the number of days before re-invoking the import.
DAYS OF WEEK – specific days of the week on which the import is to be executed (which is specified by the attribute Schedule Days).
WEEKS – the Schedule Period identifies the number of weeks before re-invoking the import.
MONTHS – the Schedule Period identifies the number of months before re-invoking the import.
Scheduled Folder Logical folder in which the scheduled job is assigned for organization purposes. If set, and the Scheduled Folder hierarchy is selected in the repository list view, this import job can be found by clicking a node in the Scheduled Folder hierarchy.
Scheduled Folder Sequence
Used to control the order of scheduled jobs in the Scheduled Folders
Scheduled Import Set to “Yes” if the import is to be scheduled. Each time the scheduled import is processed, the Next Import Datetime is updated based on the Schedule Type and Scheduled Period along with the previous value for Next Import Datetime. For example, if the Schedule Type is set to DAYS OF WEEK and Scheduled Days is set to Monday, Wednesday, and Friday and the Next Import Datetime is set to 10/3/2014 02:00:00 (2:00 am on Friday, October 3rd), the Next Import Datetime attribute will be updated to 10/6/2014 02:00:00 (2:00 am on Monday, October 6th).
Skip File Check Skip checking for and moving a file if Yes. Requires Preprocess File = Yes and Preprocess Class is defined. The assigned class is responsible for ensuring a file is created.
Enable 10 PIM Administration Guide
Page 119 of 371 Revised 8/2/2019
Attribute Description
Skip If Busy Skip this Import if Scheduled and there is already an active job for the same import. This ensures only one scheduled import job is running at any given time.
Source FTP FTP Server name if Source Type is FTP
Source FTP Delete File From Server
Delete file from FTP server if Yes (default)
Source FTP File Name Name of source file if Source Type is FTP. The file name may contain wildcards (‘*’) which may result in multiple files being retrieved. If multiple files are expected, the Import File Name should also have wild cards and the Scheduled Import should be configured to call itself as a dependent operation to ensure each file is processed.
Source FTP List Gaps Number of gaps in the data returned by the LIST command for the FTP server between the start of each line and the name of the file. This is used by Enable to know how to extract the name of the file.
Source FTP Path Fully qualified directory path on the FTP server if Source Type is FTP.
Source FTP Port FTP Server port (21 default, 22 SFTP)
Source FTP User FTP Server user name if Source Type is FTP
Source FTP User Password
FTP Server user password if Source Type is FTP
Source Type Type of Source for Import (File or FTP). Default is File
Enable 10 PIM Administration Guide
Page 120 of 371 Revised 8/2/2019
Attribute Description
Status Status of import record:
Active – record is active
Retired/Inactive – record is not active
Template Name Name of Import Template name if Import Type is “Template”
Template Timeout (Minutes)
Number of minutes before the processing for a Template import is flagged as timing out, at which point an e-mail will be sent to the designated user or group. The import template processing may still finish successfully, but any dependent jobs will not be initiated.
13.1.2 Scheduled Import Jobs Repository
The Scheduled Import Jobs repository contains records representing the currently active or recently completed import jobs. Whenever an import is initiated, the details for that import are copied from the Imports repository. This record is subsequently updated to reflect the current status of the import.
Note that when the repository is opened in a Repository View, the default Preference View does not show all attributes.
In addition to the attributes define in the Scheduled Imports repository, the Scheduled Import Jobs repository also has the following attributes:
Attribute Description
# Created The total number of records created
# Deleted The total number of records deleted
# Errors The total number of errors encountered during the import processing.
Enable 10 PIM Administration Guide
Page 121 of 371 Revised 8/2/2019
Attribute Description
# Processed The total number of records processed
# Updated The total number of existing records that were updated
Import Errors Lists the details for the cause of the import to fail (when the Import Status is “Error”).
Import Job Unique number for the import job.
Import Status Status of current or last import. Possible values include:
Aborted – the import has been aborted by a user
New – the import is new
Processing – the import file is being processed. While in this state, no additional import can be initiated for this import record.
Completed – import processing has completed successfully
Error – the import failed. The Import Status must be changed to New or Completed for it to be processed again (if scheduled)
Job Log File Name of the Scheduled Import job log file (e.g., Import_<job>.log)
Last Submitted By Login ID of last user who submitted a file for this target.
System Log Directory Contains the directory for where the Enable import logs are created.
System Log File Name of the Enable import log file.
Enable 10 PIM Administration Guide
Page 122 of 371 Revised 8/2/2019
13.1.3 Scheduled Import Configuration Properties
The Scheduled Import behavior is controlled by several configuration properties:
Property Description
import.baseDirectory Full path to the directory where the Scheduled Import files will be placed (e.g., Enterworks/shared/Imports). If the Enable is configured in a distributed environment, a network directory path should be specified.
import.expireActiveDays Number of days before import jobs that still show “Processing” are deleted from the Scheduled Import Jobs repository.
import.expireCompletedDay
s
Number of days before import jobs that have completed or failed are deleted from the Scheduled Import Jobs repository.
import.logDirectory Full path to the directory where the Enable import logs are placed (e.g., Enterworks/logs/EnableServer/import).
Scheduling Exports
Scheduled Exports must be pre-defined and configured using the following high-level steps:
1. Create an Export Template, User Preference or define the SQL Query depending upon the type of export being created.
2. Create a new record in the Scheduled Exports Repository, specifying the mapping or template created in the first step.
The details for these steps are provided in the following sections.
13.2.1 Scheduled Export Repository
All scheduled exports are defined in the Scheduled Exports repository.
Note that when the repository is opened in a Repository View, the default Preference View does not show all attributes.
Enable 10 PIM Administration Guide
Page 123 of 371 Revised 8/2/2019
Each attribute from this repository is described in the following table:
Attribute Description
Additional Conditions Additional SQL conditions to filter Delta records. Alias 'v' can be used to reference the view. For example: v.[Portal Status] in ('Submitted - Request Pending', 'Reviewed')
Additional Conditions (AND/OR)
This allows the user to select if all or any one of the conditions (if multiple) should be used to filter records
Compress File Compress the export file into a zip file if “Yes”.
Created Attribute Name Name of attribute representing the creation date for the record.
Custom Source File Name Sets the file name for a Custom export for the registered post-processing class (since no file was generated by Enable). It is the responsibility of the post-process class to actually generate the file.
Delta Export <blank> - No Filtering of records
Add – Include only new records since last export
Change - Include only changed records since last export
Add or Change - Include only new or changed records since last export
Full – Include all records subject to Additional Conditions
Delta Export Offset Number of minutes to offset the Delta export end time to give concurrent updates time to complete. The value should be set based on the Enable batch size and database performance. For example, if the batch size is 200 and it may take the SQL Server database 30 seconds to save all 200 records, an offset of 1 or 2 minutes should be ample.
Enable 10 PIM Administration Guide
Page 124 of 371 Revised 8/2/2019
Attribute Description
Dependent Keys List of keys to be passed to each dependent operation. The keys must match attribute names in the dependent repository. The corresponding value in the Dependent Values attribute is then used to set the value of the key attribute when the Job is created. The value can reference attributes from the source job by surrounding the attribute name with double-pipe characters. For example, if an export is dependent on an import and that export should specify the same user, the Dependent Key would be set to “Manager Login” and the value would be “||Manager Login||”. Conversely, if the same dependent Export needs to be set to the admin user regardless of its initial definition, the Dependent Key would be set to “Manager Login” and the Dependent Values set to “admin”.
Dependent Operation Name of dependent Import, Export, or Promotion to be initiated upon successful completion of this job.
Dependent Operation Immediate
Initiate the dependent operation immediately if “Yes”. Otherwise the operation will be queued and processed by the scheduler.
Dependent Operation Type
Type of dependent operation: Promotion, Import, or Export
Dependent Values Values corresponding to the Dependent Keys that are passed to the dependent operations. Values may reference attributes by surround the attribute name with double-pipe characters. For example, to reference the Import Job number, the Dependent Values might contain: “Job||Export Job||”. If Export Job in the current record is set to 1234, the resulting value will be “Job1234”
Enable 10 PIM Administration Guide
Page 125 of 371 Revised 8/2/2019
Attribute Description
Description Optional description for export. It is strongly recommended that the Description be populated with all the details for the export, including any job that launches this job, any pre-processing performed, and what jobs this job launches. If ParameterX attributes are used, each should be detailed as to their content and purpose.
Email Body Override e-mail body for successful jobs. Attributes in the job record can be referenced by surrounding them with double-pipe characters (e.g., ||Manager Login|| is replaced with the value of the Manager Login attribute).
Email Notify Failure Send an Export Failed e-mail to the owner if Yes and the export fails to process successfully.
Email Notify Success Send an Export Successful e-mail to the owner if Yes and the export processes successfully.
Email Subject Subject for success e-mail. May contain references to any other job attribute by surrounding it with double-pipe characters (e.g., ||Manager Login|| is replaced with the value of the attribute Manager Login).
Email To Email address(es) to which success/failure notifications will be sent. If not defined, the e-mail address(es) associated with the Manager Login user/group will be used.
Empty File Action Identifies the action to be taken if the export file is empty.
• Continue - continue processing;
• Error - treat empty file as failed export;
• Stop - stop processing (no dependent operations)
Enable 10 PIM Administration Guide
Page 126 of 371 Revised 8/2/2019
Attribute Description
Error Dependent Keys Optional keys for arguments to be passed to any Dependent jobs (as properties) when this job fails with an error.
Error Dependent Operation
List of Promotions, Imports, and/or Exports (based on Dependent Operation Type) that should be triggered on successful completion of this one.
Error Dependent Operation Immediate
Execute dependent operation immediately if Yes when this job fails with an error.
Error Dependent Operation Type
List of operation types for each Dependent Operation when this job fails with an error.
• Export – launch an export job
• Import – launch an import job
Promotion – launch a promotion job
Error Dependent Values Optional values for dependent keys when this job fails with an error.
Export Encoding File Encoding for Export (UTF-8, Windows-1251, etc.)
Export Execution Datetime
Date and time at which this export was last executed.
Export File Name Name of file to be generated by the export. This attribute can include references to other attributes by surrounding the attribute name with double-pipe characters. For example, to include the job number in the export file name, the file name could be “MyFile_||Export Job||.csv”
Export Include Images [DEPRECATED] Include images with the export if Yes.
Enable 10 PIM Administration Guide
Page 127 of 371 Revised 8/2/2019
Attribute Description
Export Include Null Values Include Null Values in XML Export if Yes.
Export Language Language to generate for export.
Export Name Name of the export.
Export Now Process the export immediately if Yes.
Export Priority Relative priority for the export determines the order of exports ready to be processed. The lower the number, the higher the priority.
Export Template Name of Export Template (if Export Type is Template)
Export Type Type of export:
• Repository – export of a single repository using the designated User Preference
• View – SQL export against the Enable 10 PIM database.
• DataMart – SQL export against the Data Mart database
• Export Template – export using the designated Export Template
• Custom – relies on the PostProcessing module to generate a file.
• Validate – performs a validation on the designated repository and saved set.
Enable 10 PIM Administration Guide
Page 128 of 371 Revised 8/2/2019
Attribute Description
Group Lock Action Group locks allow for multiple concurrent jobs to all attach to the same lock. The lock is not freed until all processes have detached from it.
Action to be taken with the lock identified in Group Lock Name:
• Attach – the import will attach to the specified lock. Processing for the export will begin immediately.
• Free – the import will detach from the named lock (presumably set by a previous job that invoked this import) once the export processing has completed. The lock is not completely freed until all attached processes have detached.
• Attach And Free – the export will attach to the named lock and begin processing and detach from the named lock once processing has completed.
• No Lock – the export will not attach to a group lock.
Group Locks will always acquire the designated lock, even if another process has acquired or attached to the same lock. If multiple jobs attach to the same lock via Group Lock, the lock is not free until all of the processes have freed the lock.
Group Lock Name Name of the group lock.
Image Context [DEPRECATED] List of Image Contexts to be included if Export Include Images is Yes.
ImageType [DEPRECATED] List of image types to be included if Export Include Images is Yes (e.g., Original, Thumbnail, Detail, Low, or Web)
Include Status [DEPRECATED] Identifies export records to be included matching the designated list of Status values (e.g., Active, Inactive, Retired, or Reactivated)
Enable 10 PIM Administration Guide
Page 129 of 371 Revised 8/2/2019
Attribute Description
Include Timestamp Include date and time in Export_<job>.log file if Yes. This can be helpful in troubleshooting post-processing for an export as it shows how long processing steps took (providing the appropriate messages are being reported).
Last Export Datetime Date and time of when the export was last executed.
Last Export Update Datetime
Date and time of when last DELTA export was executed
Last Scheduled Export Datetime
Date and time the export was last scheduled
Linked Repository Name Optional list of repositories included in the Export Template
Linked Repository Saved Set
Saved set to be used for each corresponding linked repository to identify which linked records are to be included.
Linked Repository Search Config
List of predefined searches on the linked repositories to be applied to limit the records in the export.
Linked Search Repository Name
For more information on Linked Search Repository Name, contact your Enable account representative.
Enable 10 PIM Administration Guide
Page 130 of 371 Revised 8/2/2019
Attribute Description
Lock Action Action to be taken with the lock identified in Lock Name:
• Acquire – the import will wait until the named lock is acquired. Processing for the import will not begin until then.
• Free – the import will free the named lock (presumably set by a previous job that invoked this import) once the import processing has completed.
• Acquire And Free – the import will wait until the named lock is acquired and will free the named lock once processing has completed.
• No Lock – the import will not wait for any lock before processing.
Locks will only be acquired if they are currently free. If the designated lock has been attached to by multiple jobs using the Group Lock, the lock does not become free until all of those jobs have freed the lock.
Lock Name Name of the lock to acquire or free (depending upon Lock Action). If more than one import shares the same lock, then they will be processed serially. The name may contain references to other properties by surrounding each property name with double-pipe characters. For example, to ensure only one instance of an import is processed at a time for each user, the Lock Name can be set to: “Import||Manager Login||”. This will produce a lock name of “Importjdoe” for John Doe and “Importjsmith” for John Smith.
Manager Login Login ID of the user or the name of the Enable role who will receive notification e-mails for the export.
Next Export Datetime Date and time the export will be processed if Scheduled Export is “Yes”.
Enable 10 PIM Administration Guide
Page 131 of 371 Revised 8/2/2019
Attribute Description
Output Null Extended Value
[DEPRECATED] Include extended attributes that are empty or null if “Yes”.
Output to File Generate an export file if Yes for Export Template type
Output to Table Saved the publication table if Yes for Export Template type
Parameter1-5 Five attributes that can serve as parameters when jobs are connected through the Dependent Operation attributes. They are not used directly by the export processing but can be referenced in other attributes.
Postprocess Class Fully-qualified path, identifying the Postprocess class to be invoked for this import. It must be a subclass of com.enterworks.services.BaseCustomProcessFile
Postprocess File Export file must be postprocessed after being generated using the designated class and arguments if “Yes”.
Postprocess Keys Argument keys identifying the Postprocess Argument Values to be passed to the designated postprocess module.
Postprocess Values Values for corresponding Postprocess Argument Keys to be passed to the designated postprocess module. Values can contain references to properties from this job by surrounding the property name with double-pipe characters. For example, to pass the Export Job, the value would be set to “||Export Job||”
Publication As Of Date Effective date for Export Template type if not the current date and time.
Publication Hierarchy Hierarchy used by the Export Template
Enable 10 PIM Administration Guide
Page 132 of 371 Revised 8/2/2019
Attribute Description
Repository Format Format for Repository type export (e.g., CSV, XLS, XML, or DB)
Repository Name Name of repository for Repository or Template exports
Repository Preference User Preference to be used for Repository export.
Repository Timeout (Minutes)
Number of minutes before a Repository type export has timed out.
Root Repository Saved Sets
Saved set for root repository in Template export.
Root Repository Search Configs
List of predefined searches on the root repository to be applied to limit the records in the export.
Saved Set Saved set for Repository type export.
Schedule Days Identifies the days of the week if Schedule Type is Days of Week
Schedule Exclude Dates Code Set
If set to a code set listing dates as code values, the scheduling logic will skip to the next scheduled date if the calculated date is one of the dates in the code set.
Schedule Period Number of minutes between exports if Scheduled Export is “Yes”.
Enable 10 PIM Administration Guide
Page 133 of 371 Revised 8/2/2019
Attribute Description
Schedule Type Type of schedule:
• MINUTES – the Schedule Period identifies the number of minutes before re-invoking the export.
• DAYS – the Schedule Period identifies the number of days before re-invoking the export.
• DAYS OF WEEK – specific days of the week on which the export is to be executed.
• WEEKS – the Schedule Period identifies the number of weeks before re-invoking the export.
• MONTHS – the Schedule Period identifies the number of months before re-invoking the export.
Scheduled Export Export is scheduled if “Yes”.
Scheduled Folder Logical folder in which the scheduled job is assigned for organization purposes. If set, and the Scheduled Folder hierarchy is selected in the repository list view, this import job can be found by clicking a node in the Scheduled Folder hierarchy.
Scheduled Folder Sequence
Used to control the order of scheduled jobs in the Scheduled Folders
Skip if Busy Skip the scheduled export if the same named export is already busy processing if Yes. This can be used to prevent a backlog of exports if an export has been delayed or takes longer than the schedule period to complete.
Status Status of export (Active, Inactive, Retired)
Target Email Email address if Target Type is Email
Enable 10 PIM Administration Guide
Page 134 of 371 Revised 8/2/2019
Attribute Description
Target FTP FTP server name or IP address if Target Type is FTP
Target FTP User FTP user name
Target FTP User Password FTP user password
Target Overwrite File Overwrite output file (vs. append) if Yes
Target Path Directory location for export file if Export Type is File
Target Type Type of target (Email, FTP, File)
Transmission Option Identifies the transmission option to be invoked upon completion of the export file generation.
Updated Attribute Name [DEPRECATED] Name of attribute represented date and time the data in a record was last updated.
View Format Format for View or Data Mart Export Type:
• TAB – values separated by tab characters
• COMMA – values separated by commas. If a value contains a comma or double-quote, the entire value is surrounded by double quotes and any double-quotes in the value are escaped by another double quote. For example, the value: Monsters, Inc. Size=3” x 4” is converted to: “Monsters, Inc. Size=3”” x 4”””
• ~ - values separated by the tilde character
• * - values separated by the asterisk character
• | - values separated by the pipe character
Enable 10 PIM Administration Guide
Page 135 of 371 Revised 8/2/2019
Attribute Description
View Name Name of View for Export Type View or DataMart (if View SQL is not defined).
View SQL SQL Query for Export Types of View or DataMart. The value can contain references to other attributes by surrounding them with double-pipe characters.
For example, to filter data by the user who initiated the import, the SQL would be:
SELECT * FROM RepositoryView WHERE [Updated
By] = ‘||Manager Login||’
If the View export is a Delta export, then the snapshot table view columns Created and/or Last Updated can be compared to the ‘[DELTA_DATETIME]’ keyword which is converted to the date and time the export was last executed.
For example, to create a Delta (Add) export for the repository named “RepositoryView”, the SQL would be:
SELECT * from RepositoryView WHERE Created
> ‘[DELTA_DATETIME]’
To create a Delta (Add or Update) export, the SQL would be:
SELECT * from RepositoryView WHERE Created
> ‘[DELTA_DATETIME]’ OR Last_Updated >
‘[DELTA_DATETIME]’
13.2.2 Scheduled Export Jobs Repository
The Scheduled Export Jobs repository contains records representing the currently active or recently completed export jobs. Whenever an export is initiated, the details for that export are copied from the Scheduled Exports repository. This record is subsequently updated to reflect the current status of the export.
Note that when the repository is opened in a Repository View, the default Preference View does not show all attributes.
In addition to the attributes define in the Scheduled Exports repository, the Scheduled Export Jobs repository also has the following attributes:
Enable 10 PIM Administration Guide
Page 136 of 371 Revised 8/2/2019
Attribute Description
# Errors Total number of records with errors.
# Exported Total number of records exported.
# Processed Total number of records for the export file that were processed.
Download Link URL to download the export file. Requires setting up a virtual directory in IIS
Export Errors Error messages encountered during export if there is a failure.
Export Job Unique number for the Export job.
Export Status Status of the Export job
• New – the job has been created but a work item has not been assigned (this is either due to this job being launched as a Dependent job with the Dependent Operation Immediate set to No, or a configuration error preventing a work item from being created for this job).
• Queued – the job has been queued and is waiting for a lock to be freed
• Processing – the job is processing
• Completed – the job completed successfully
• Error – the job failed with an error. This could be a timeout, abort by user, or some unexpected processing error.
Submitted By Login ID of the user who submitted the Export Job.
Enable 10 PIM Administration Guide
Page 137 of 371 Revised 8/2/2019
Attribute Description
System Log Directory Directory containing the system (Enable) log file for the export (not set for View, Data Mart, or Custom exports)
System Log File Name of the system (Enable) log file for the export (not set for View, Data Mart, or Custom exports).
Target FTP Port FTP Server port (21 default, 22 SFTP).
13.2.3 Creating a Scheduled Repository Export
A user with authority creates a Scheduled Repository export by performing the following steps:
1. Open a Repository View for the repository for which a Repository Export is to be generated.
2. Select or create the User Preference view that defines the attributes to be included in the export as columns.
3. In the Feature Sidebar, open the Repository tab, open the Scheduled Activities group, and open the Scheduled Exports repository.
Enable 10 PIM Administration Guide
Page 138 of 371 Revised 8/2/2019
4. Click the Add button on the Repository View’s Activity Bar. A new Scheduled Export record appears in the Detail Editor Tab.
Open Scheduled Exports
Scheduled Exports -- Add a Record
Enable 10 PIM Administration Guide
Page 139 of 371 Revised 8/2/2019
5. For details on the attributes for a Scheduled Export record, see Scheduled Export Repository.
6. Enter a Name for the export.
7. Enter the login ID of the user who will receive e-mails for this export in the Manager Login field.
8. Select Repository in the Export Type dropdown selection list.
9. Click the Export Details sub-tab.
10. Select the repository in the Repository Name dropdown selection list.
11. Optionally enter the name of the Saved Set to export a subset of the records.
12. Click the Export Type - Repository sub-tab.
13. Select the output format in the Repository Format dropdown selection list.
14. Click the Export Target sub-tab.
15. Enter the target details:
o Target File o Target Email o Target FTP
A New Scheduled Exports Record
Enable 10 PIM Administration Guide
Page 140 of 371 Revised 8/2/2019
16. Enter the Export File Name, the name of the export file.
17. To overwrite an existing file, set Target Overwrite File to “Yes”.
18. Click the Schedule sub-tab.
19. Set the Schedule Export field to “Yes”.
20. Set the Schedule Type to the desired type and the Schedule Period to the desired interval (based on the selected type).
For example:
o To produce an export nightly, set the Schedule Type to Days and the Period to 1. o To produce an export for every 2 weeks, set the Export Type to Weeks and the
Scheduled Period to 2.
If the Schedule Type is set to Days Of Week, the Schedule Period is not used. Instead the days listed in Schedule Days determine which days of the week the export will be triggered.
21. To enter a Scheduled Days value:
a. Click the at the bottom of the Schedule Days list.
b. A Schedule Days dialog will open.
Add a Schedule Day
Enable 10 PIM Administration Guide
Page 141 of 371 Revised 8/2/2019
c. The Available Days list is on the left; the Scheduled Days list is on the right.
Select days and use the right arrow and left arrow to move them to the desired list.
d. Click Apply to save your changes and exit, or Cancel to exit without saving your changes.
22. Set the Next Export Datetime field to the date and time when the export is to run. For Schedule Types other than Minutes, the time portion of this field will determine the time of day the export will be triggered.
If the date and time are in the past, the export will be initiated immediately and the Next Export Datetime will be used in conjunction with the Schedule Type and Schedule Period to calculate the next time the export should be initiated.
23. Save the new Scheduled Exports record by clicking the Save button in the upper left of the Repository View.
When the current date and time passes the Next Export Datetime, the Repository Export will be initiated. Once triggered, the Next Export Datetime will be updated using the Schedule Type and Schedule Period.
13.2.4 Creating a Scheduled View/DataMart Export
A user with authority creates a scheduled View or DataMart export by performing the following steps:
1. Open a Repository View for the repository for which a Scheduled View or Scheduled DataMart export is to be generated.
2. In the Feature Sidebar, open the Repository tab, open the Scheduled Activities group, and open the Scheduled Exports repository.
Select the Schedule Days.
Enable 10 PIM Administration Guide
Page 142 of 371 Revised 8/2/2019
3. Click the Add button on the Repository View’s Activity Bar. A new Scheduled Export record appears in the Detail Editor Tab.
Open Scheduled Exports
Scheduled Exports -- Add a Record
Enable 10 PIM Administration Guide
Page 143 of 371 Revised 8/2/2019
4. For details on the attributes for a Scheduled Export record, see Scheduled Export Repository.
5. Enter a Name for the export.
6. Enter the login ID of the user who will receive e-mails for this export in the Manager Login field.
7. In the Export Type dropdown, select View for a SQL View or DataMart for Data. A View export will be against the Enable 10 PIM snapshot table views. A DataMart export will be against the Data Mart database.
8. Open the Export Details tab and open the Export Type - View/Datamart sub-tab.
9. In the View SQL field, enter the SELECT SQL query.
10. In the View Format field, select TAB, COMMA or ~ to specify the character to be used as a delimiter.
A New Scheduled Exports Record
Enable 10 PIM Administration Guide
Page 144 of 371 Revised 8/2/2019
11. Click the Export Target sub-tab.
12. Enter the target details:
o Target File o Target Email o Target FTP
13. Enter the Export File Name, the name of the export file.
14. To overwrite an existing file, set Target Overwrite File to “Yes”.
15. Click the Schedule sub-tab.
16. Set the Schedule Export field to “Yes”.
17. Set the Schedule Type to the desired type and the Schedule Period to the desired interval (based on the selected type).
For example:
o To produce an export nightly, set the Schedule Type to Days and the Period to 1. o To produce an export for every 2 weeks, set the Export Type to Weeks and the
Scheduled Period to 2.
If the Schedule Type is set to Days Of Week, the Schedule Period is not used. Instead the days listed in Schedule Days determine which days of the week the export will be triggered.
18. To enter a Scheduled Days value:
a. Click the at the bottom of the Schedule Days list.
b. A Schedule Days dialog will open.
Add a Schedule Day
Enable 10 PIM Administration Guide
Page 145 of 371 Revised 8/2/2019
c. The Available Days list is on the left; the Scheduled Days list is on the right.
Select days and use the right arrow and left arrow to move them to the desired list.
d. Click Apply to save your changes and exit, or Cancel to exit without saving your changes.
19. Set the Next Export Datetime field to the date and time when the export is to run. For Schedule Types other than Minutes, the time portion of this field will determine the time of day the export will be triggered.
If the date and time are in the past, the export will be initiated immediately and the Next Export Datetime will be used in conjunction with the Schedule Type and Schedule Period to calculate the next time the export should be initiated.
20. Save the new Scheduled Exports record by clicking the Save button in the upper left of the Repository View.
When the current date and time passes the Next Export Datetime, the Repository Export will be initiated. Once triggered, the Next Export Datetime will be updated using the Schedule Type and Schedule Period.
13.2.5 Creating a Scheduled Template Export
A user with authority creates a Scheduled Export Template by performing the following steps:
1. Log into Enable.
2. If the Export Template does not already exist, create it, taking note of its name. (For information regarding creating Export Templates, see Export Templates.)
Select the Schedule Days.
Enable 10 PIM Administration Guide
Page 146 of 371 Revised 8/2/2019
3. In the Feature Sidebar, open the Repository tab, open the Scheduled Activities group, and open the Scheduled Exports repository.
Open Scheduled Exports
Scheduled Exports -- Add a Record
Enable 10 PIM Administration Guide
Page 147 of 371 Revised 8/2/2019
4. Click the Add button on the Repository View’s Activity Bar. A new Scheduled Export record appears in the Detail Editor Tab.
5. For details on the attributes for a Scheduled Export record, see Scheduled Export Repository.
6. Enter a Name for the export.
7. Enter the login ID of the user who will receive e-mails for this export in the Manager Login field.
8. Select Template in the Export Type dropdown selection list.
9. Open the Export Details sub-tab.
10. Select the root repository in the Repository dropdown selection list.
11. Open the Export Type – Template Publication sub-tab.
12. Enter the name of the defined Export Template.
13. Set Output to File to Yes.
14. Open the Export Target tab.
15. Enter the target details:
A New Scheduled Exports Record
Enable 10 PIM Administration Guide
Page 148 of 371 Revised 8/2/2019
o Target File o Target Email o Target FTP
16. Enter the Export File Name, the name of the export file.
17. To overwrite an existing file, set Target Overwrite File to “Yes”.
18. Click the Schedule sub-tab.
19. Set the Schedule Export field to “Yes”.
20. Set the Schedule Type to the desired type and the Schedule Period to the desired interval (based on the selected type).
For example:
o To produce an export nightly, set the Schedule Type to Days and the Period to 1. o To produce an export for every 2 weeks, set the Export Type to Weeks and the
Scheduled Period to 2.
If the Schedule Type is set to Days Of Week, the Schedule Period is not used. Instead the days listed in Schedule Days determine which days of the week the export will be triggered.
21. To enter a Scheduled Days value:
a. Click the at the bottom of the Schedule Days list.
b. A Schedule Days dialog will open.
Add a Schedule Day
Enable 10 PIM Administration Guide
Page 149 of 371 Revised 8/2/2019
c. The Available Days list is on the left; the Scheduled Days list is on the right.
Select days and use the right arrow and left arrow to move them to the desired list.
d. Click Apply to save your changes and exit, or Cancel to exit without saving your changes.
22. Save the new Scheduled Exports record by clicking the Save button in the upper left of the Repository View.
When the current date and time passes the Next Export Datetime, the Repository Export will be initiated. Once triggered, the Next Export Datetime will be updated using the Schedule Type and Schedule Period.
13.2.6 Scheduled Export Configuration Properties
Note that when the repository is opened in a Repository View, the default Preference View does not show all attributes.
The Scheduled Export behavior is controlled by several configuration properties:
Property Description
export.directoryName Full path to the directory where the Scheduled Export files will be placed (e.g., D:/Enterworks/shared/Exports)
Select the Schedule Days.
Enable 10 PIM Administration Guide
Page 150 of 371 Revised 8/2/2019
Property Description
export.epimDirectoryName Enable directory for export files (e.g., D:/Enterworks/shared/export)
export.expireActiveDays Number of days before export jobs that still show “Processing” are deleted from the Scheduled Export Jobs repository.
export.expireCompletedDays Number of days before export jobs that have completed or failed are deleted from the Scheduled Export Jobs repository.
export.logDirectoryName Full path to the directory containing the Enable export log files (e.g., D:/Enterworks/logs/EnableServer/e
xport)
export.publicationDirectoryN
ame
Full path to the directory containing the Enable publication files (e.g., D:/Enterworks/shared/publication
export.publicationLogDirecto
ryName
Full path to the directory containing the Enable publication log files (e.g., D:/Enterworks/logs/EnableServer/p
ublish
Implementing Pre- or Post-Processing
The Scheduled Imports provides the option to pre-process files before the files are actually imported and the Scheduled Exports provides the option to post-process files after they have been exported. In both cases, the actual processing is handled by a Java class that is an extension of the BaseCustomProcessFile class found in the Services.jar file (or in an application-specific JAR file). The following pre-defined pre/post-processing blocks are available:
Enable 10 PIM Administration Guide
Page 151 of 371 Revised 8/2/2019
Classpath Description
com.enterworks.services.
exports.MoveDamAssets
Copies the DAM assets for the records in the export file to the Portal PIM. The export file must include the FilePath attribute which is removed from the final file after processing.
com.enterworks.services.
exports.
MoveDamAssetsAndUpdateAt
tributesForItemsInFile
Moves the DAM assets to the Internal PIM and produces an import file to update the designated attributes to the specified values for each record in the file. The export file must include the FilePath attribute which is removed from the final file after processing.
com.enterworks.services.
exports.
ProcessPublicationMergeA
utomatedSortTemplate
Converts a Publication Merge and Automated Sort template export in CSV format to XLS with the category attributes reduced to only those in the taxonomy node (assumes all records are for the same taxonomy node) and inserts placeholders for the Publication Merge and Automated Sort entries.
com.enterworks.services.
imports.
DAMLinksFullReplace
Treats the import file as a full replacement for the designated target repository (DAMLink repository may link assets to more than one repository). Any record found in the DAMLink repository but not in the file (for the designated repository) will be flagged as Inactive. If the import is configured to delete inactive records, those records will be physically removed from the DAMLink repository.
com.enterworks.services.
imports.EncodeFile
Converts the import file from one encoding to another.
com.enterworks.services.
imports.
PreProcessAddFields
Adds attributes and values to the import file before loading.
Enable 10 PIM Administration Guide
Page 152 of 371 Revised 8/2/2019
Classpath Description
com.enterworks.services.
imports.
PreProcessImageLinksFile
Preprocesses a generic DAM Link file that contains one or more business keys, the file name, and the image context, priority, and caption. The business keys are replaced with a single ID value.
com.enterworks.services.
imports.
ProcessImagePackage
Processes a single file or a zip file containing one or more image files. If the submitted file has the csv extension, it is passed on for import processing by ePIM. If the submitted file has the zip extension, the contents of the zip file are processed. Any valid image files are copied to the designated image directory. If the submitted file is a valid image file, it is copied to the designated image directory.
com.enterworks.services.
imports. PromoteSavedSet
Promotes the valid records in the designated saved set to Production.
com.enterworks.services.
imports.
SplitDynamicAttributesFi
le
Preprocess import file containing category attributes, splitting the file into multiple parts to avoid exceeding database maximums. The file is split based on the part lists in the Enterworks.properties configuration file. Each part must include the primary key plus some attributes with a total column count of less than 1000.
com.enterworks.services.
imports.
SplitDynamicAttributesFr
omKeyValuePairFile
Reprocess import file containing category attributes in key/value pairs, combines multiple lines (if for the same target record), then splitting the file into multiple parts to avoid exceeding database maximums. The file is split based on the part lists in the configuration file. Each part must include the primary key plus some attributes with a total column count of less than 1000.
com.enterworks.services.
imports.
UncompressZipFile
Decompresses zip file before processing.
Enable 10 PIM Administration Guide
Page 153 of 371 Revised 8/2/2019
When configuring a Scheduled Import or Export with a pre/post-processing block,
1. Open the Scheduled Import or Scheduled Export repository.
2. Open the record for the Import or Export.
3. Open the Import Details or Export Details tab, and open the Import Preprocess Options or Export PostProcess Options sub-tab.
4. Set Preprocess File or Postprocess File to Yes.
5. Enter the full class path for the processing block class and click the calculate button on the Pre-process Class or Post-process Class field.
6. The define arguments window will open showing a description for what the block does along with what arguments can be set and the current values.
Enable 10 PIM Administration Guide
Page 154 of 371 Revised 8/2/2019
7. The argument values can be changed and saved by clicking Update Attributes.
13.3.1 Pre/Post-Processing Block
Each processing block class must implement the processFile method. This method is called when there is an import or export file to be processed:
HashMap args, HashMap inactiveRecords, TreeMap primaryKey, and
StringBuffer msgs)
Arguments:
Data Type Argument Description
String directoryName Fully-qualified path to the directory containing the file to be processed. The file to be returned must also be placed in this same directory.
String fileName Name of the file to be processed.
Enable 10 PIM Administration Guide
Page 155 of 371 Revised 8/2/2019
Data Type Argument Description
HashMap args Map of any pre/post processing arguments defined in the Scheduled Import/Export.
HashMap inactiveRecords Map containing the primary keys of any records in the repository having a Status of Inactive. This is only set for imports and only if the Inactive Records flag is set to Reactivate.
TreeMap primaryKey The primary key for the repository.
StringBuffer msgs Medium for returning error messages to be displayed with the job.
The method must return either the name of the processed file or null if the processing block failed.
If the processing block class has configurable arguments, there are three methods that must be implemented:
• String getDescription() – returns a detailed description of what the processing block does.
• void defineArguments() – builds the list of arguments that can be configured. Each argument is defined by calling the method:
• void addArgument(String arg, String description) – adds an argument to the list of arguments/properties that can be set for the class in the Scheduled Import or Scheduled Export record:
Enable 10 PIM Administration Guide
Page 156 of 371 Revised 8/2/2019
Data Type Argument Description
String Arg Name of argument. This name will be used to retrieve the actual value for the argument. Each defined argument must be uniquely named
String description Detailed description for the argument. It should include possible values (if finite set) or range of values, default if left blank, etc.
The BaseCustomProcessFile class has a set of methods that help minimize the amount of coding required in a processing block class:
o Updates the Scheduled Import Job record with the specified details. This call should be made if the pre -processing is going to take a considerable amount of time to complete. The call should be made no more than once every several minutes.
o Updates the Scheduled Export Job record with the specified details. This call should be made if the post-processing is going to take a considerable amount of time to complete. The call should be made no more than once every several minutes.
o Updates the Scheduled Export Job record with the specified details, including a URL for downloading the processed file. This call should be made after processing of the file has completed.
o Parses the header line using the designated delimiter. If the delimiter is a comma, then special processing is done for commas and quotes embedded in the header names.
o Parses a line from the file using the defined header and delimiter. Returns a HashMap where each key matches a column name and its value is the corresponding value from the file.
• void removeSpaces(HashMap parsedLine)
o Removes leading and trailing white space from each parsed value.
o Extracts the contents of a zip file and returns a list of unzipped files.
Enable 10 PIM Administration Guide
Page 159 of 371 Revised 8/2/2019
Scheduling Promotions
Staging records can be promoted manually via the UI, by the Package Promotion workflow, or automatically using the following Scheduled Promotions functionality.
13.4.1 Scheduled Promotions Repository
All scheduled promotions are defined in the Promotions repository. Each attribute from this repository is described in the following table.
When a scheduled promotion is activated (either manually or by schedule), the records in the designated repository are validated and promoted to Production, providing the validation requirements are met.
Note that when the repository is opened in a Repository View, the default Preference View does not show all attributes.
Attribute Description
Dependent Keys List of keys to be passed to each dependent operation. The keys must match attribute names in the dependent repository. The corresponding value in the Dependent Values attribute is then used to set the value of the key attribute when the Job is created. The value can reference attributes from the source job by surrounding the attribute name with double-pipe characters. For example, if an export is dependent on a promotion and that export should specify the same user, the Dependent Key would be set to “Manager Login” and the value would be “||Manager Login||”. Conversely, if the same dependent Export needs to be set to the admin user regardless of its initial definition, the Dependent Key would be set to “Manager Login” and the Dependent Values set to “admin”.
Dependent Operation Name of dependent Import, Export, or Promotion to be initiated upon successful completion of this job.
Dependent Operation Immediate
Initiate the dependent operation immediately if Yes. Otherwise the operation will be queued and processed by the scheduler.
Enable 10 PIM Administration Guide
Page 160 of 371 Revised 8/2/2019
Attribute Description
Dependent Operation Type
Type of dependent operation: Promotion, Import, or Export
Dependent Values Values corresponding to the Dependent Keys that are passed to the dependent operations. Values may reference attributes by surround the attribute name with double-pipe characters. For example, to reference the Import Job number, the Dependent Values might contain: “Job||Export Job||”. If Export Job in the current record is set to 1234, the resulting value will be “Job1234”
Description Description for promotion.
Group Lock Action Group locks allow for multiple concurrent jobs to all attach to the same lock. The lock is not freed until all processes have detached from it.
Action to be taken with the lock identified in Group Lock Name:
• Attach – the promotion will attach to the specified lock. Processing for the import will begin immediately.
• Free – the promotion will detach from the named lock (presumably set by a previous job that invoked this promotion) once the import processing has completed. The lock is not completely freed until all attached processes have detached.
• Attach And Free – the promotion will attach to the named lock and begin processing and detach from the named lock once processing has completed.
• No Lock – the promotion will not attach to a group lock.
Group Locks will always acquire the designated lock, even if another process has acquired or attached to the same lock. If multiple jobs attach to the same lock via Group Lock, the lock is not free until all of the processes have freed the lock.
Enable 10 PIM Administration Guide
Page 161 of 371 Revised 8/2/2019
Attribute Description
Group Lock Name Name of the group lock.
Last Promotion Datetime Date and time of when this promotion was last initiated (scheduled or manual).
Lock Action Action to be taken with the lock identified in Lock Name:
• Acquire – the promotion will wait until the named lock is acquired. Processing for the promotion will not begin until then.
• Free – the promotion will free the named lock (presumably set by a previous job that invoked this promotion) once the promotion processing has completed.
• Acquire And Free – the promotion will wait until the named lock is acquired and will free the named lock once processing has completed.
• No Lock – the promotion will not wait for any lock before processing.
Locks will only be acquired if they are currently free. If the designated lock has been attached to by multiple jobs using the Group Lock, the lock does not become free until all of those jobs have freed the lock.
Lock Name Name of the lock to acquire or free (depending upon Lock Action). If more than one promotion shares the same lock, then they will be processed serially. The name may contain references to other properties by surrounding each property name with double-pipe characters.
If the referenced lock is associated with the Group Lock in other jobs, the lock will not be considered free until all the Group Lock jobs have detached from the lock.
Manager Login [DEPRECATED]
Enable 10 PIM Administration Guide
Page 162 of 371 Revised 8/2/2019
Attribute Description
Next Promotion Datetime Date and time when the promotion (if scheduled) will be launched.
Parameter1-5 Five attributes that can serve as parameters when jobs are connected through the Dependent Operation attributes. They are not used directly by the export processing but can be referenced in other attributes.
Promote Now Perform the promotion now if set to Yes. Processing of the promotion will reset this flag to No.
Promote Warnings Promote records that have only validation warnings to Production if Yes.
Promotion Configuration Name
Configuration name for the promotion. Must match a named configuration in the EPIM sharedConfig.properties file.
Promotion Errors Detailed error messages if promotion processing failed.
Promotion Priority Relative priority for each promotion (the lower the number, the higher the priority).
Promotion Production Repository
Name of Production repository into which records are to be promoted.
Promotion Skip Validation Skips the validation step and relies on current validation status if Yes.
Promotion Staging Repository
Name of Staging repository from which records are to be promoted.
Enable 10 PIM Administration Guide
Page 163 of 371 Revised 8/2/2019
Attribute Description
Promotion Timeout (Minutes)
Number of minutes the Promotion job will wait for the Enable promotion to complete. The default is 600 (10 hrs)
Saved Set Name of saved set containing items to be promoted. All items are promoted if empty.
Schedule Days Identifies the days of the week if Schedule Type is Days of Week
Schedule Exclude Dates Code Set
If set to a code set listing dates as code values, the scheduling logic will skip to the next scheduled date if the calculated date is one of the dates in the code set.
Schedule Period Number of minutes after Last Scheduled Date before the next scheduled promotion is initiated. For example, a promotion that is to be processed daily would have a schedule period of 1440. The scheduled promotions are not affected by any manually initiated promotions
Schedule Type Type of schedule:
• MINUTES – the Schedule Period identifies the number of minutes before re-invoking the promotion.
• DAYS – the Schedule Period identifies the number of days before re-invoking the promotion.
• DAYS OF WEEK – specific days of the week on which the promotion is to be executed.
• WEEKS – the Schedule Period identifies the number of weeks before re-invoking the promotion.
• MONTHS – the Schedule Period identifies the number of months before re-invoking the promotion.
Enable 10 PIM Administration Guide
Page 164 of 371 Revised 8/2/2019
Attribute Description
Scheduled Folder Logical folder in which the scheduled job is assigned for organization purposes. If set, and the Scheduled Folder hierarchy is selected in the repository list view, this import job can be found by clicking a node in the Scheduled Folder hierarchy.
Scheduled Folder Sequence
Used to control the order of scheduled jobs in the Scheduled Folders
Scheduled Promotion Set to Yes if the promotion is to be scheduled. Each time the scheduled promotion is processed, the Next Promotion Datetime is updated based on the Schedule Period.
Status Status of the Promotion
• Active – the promotion is active and will be processed when conditions are met
• Inactive – the promotion is inactive and will not be processed.
13.4.2 Promotion Jobs Repository
The Promotion Jobs repository contains records representing the currently active or recently completed promotion jobs. Whenever a promotion is initiated, the details for that promotion are copied from the Promotions repository. This record is subsequently updated to reflect the current status of the promotion.
Note that when the repository is opened in a Repository View, the default Preference View does not show all attributes.
In addition to the attributes define in the Promotions repository, the Promotion Jobs repository also has the following attributes:
Enable 10 PIM Administration Guide
Page 165 of 371 Revised 8/2/2019
Attribute Description
# Errors Total number of records with errors.
# Processed Total number of records processed
# Updated Total number of records updated in Production
Promotion Execution Datetime
Date and time of when this promotion was executed.
Promotion Job Unique number for this job.
Promotion Status Status of promotion job
• New – a new job that hasn’t started yet due either to it being launched as a Dependent job with the Dependent Operation Immediate set to No, or encountering an error when launching the work item.
• Processing – the Promotion is currently processing
• Completed – the Promotion has completed successfully
Note that when the repository is opened in a Repository View, the default Preference View does not show all attributes.
The Scheduled Import behavior is controlled by several configuration properties:
Enable 10 PIM Administration Guide
Page 166 of 371 Revised 8/2/2019
Property Description
promote.expireActiveDays Number of days before import jobs that still show “Processing” are deleted from the Scheduled Import Jobs repository.
promote.expireCompletedDays Number of days before import jobs that have completed or failed are deleted from the Scheduled Import Jobs repository.
14 Manage Channel Readiness
Channel readiness is a measure of how ready a channel is to be syndicated to its target, that is to say, how many of the required record attribute values have reached a validation level sufficient to be syndicated to their target. For more details regarding Channel Readiness, see Enable 10 Basics and the Enable 10 PIM User Guide.
The interface to the Channel Readiness function is comprised of the Channel Readiness tab and the Channel Readiness widget. The configuration and use of both are described in the Enable 10 PIM User Guide.
Initial Configuration of Channel Readiness
The steps for initial configuration of the Channel Readiness functionality are as follows:
1. Create a user group for users who will be able to access and use the Channel Readiness widget and the Channel Readiness tab. (See Add a User Group.)
2. Add the users to the group.
3. Ensure that the user group has necessary permissions in the affected repositories. (See Object Security.)
4. Add a Channel Readiness widget to the Channel Manager user group’s Dashboard.
5. Add a Channel Readiness Shortcut to the Shortcut widget. (See Shortcuts Widget.)
a. Name: Enter “Channel Readiness”. b. Type: Channel Readiness. c. Select the configuration as desired. If it is configured as an admin then the
widget will allow users to edit channels. If it is configured as inbound then the widget will only show inbound channels, otherwise it will show only outbound channels.
Enable 10 PIM Administration Guide
Page 167 of 371 Revised 8/2/2019
6. Click Save to save your edits, or close the tab to exit without saving.
7. The Channel Readiness shortcut should be available in the Shortcut widget.
Configuring Scheduled Statistic Update
For information regarding configuring the interval for scheduled statistics updates, see the Enable 10 Installation Guide or the Enable 10 Linux Guide.
Open Channel Readiness
To open Channel Readiness:
1. Open the Feature Sidebar by clicking the Features Sidebar icon on the far left of the Tab Bar.
2. Open the Administration tab, open the Channel Readiness folder and select Inbound or Outbound.
The Channel Readiness View tab will appear.
Open Channel Readiness
Enable 10 PIM Administration Guide
Page 168 of 371 Revised 8/2/2019
Update Channel Statistics
After each update to a Channel, be it modifying the Channel itself or updating records for the channel, the Channel Statistics must be updated.
In order to update a Channel’s statistics, the Channel must first be configured with a Saved Set and an Export Template.
To update Channel Statistics:
3. Open the Channel Readiness tab.
a. To open the Channel Readiness tab, first open the Feature Sidebar by clicking
the Features Sidebar icon on the far left of the Tab Bar. b. Open the Administration tab, open the Channel Readiness folder and select
Inbound or Outbound.
4. The Channel Readiness View will appear.
Channel Readiness View
Open Channel Readiness
Enable 10 PIM Administration Guide
Page 169 of 371 Revised 8/2/2019
5. Update the Channel Statistics by clicking the Channel Information icon next to the Channel’s name. If the Channel is inbound, the Inbound Channel Information icon will appear to the left of the new Channel’s name. If the Channel is outbound, the Outbound Channel Information icon will appear to the right of the new Channel’s name. A Job Specification window will appear.
Update Channel Statistics Outbound
Update Channel Statistics Inbound
Enable 10 PIM Administration Guide
Page 170 of 371 Revised 8/2/2019
6. The Job Specification window notes the repository affected, the Saved Set of records to be validated, the Export Template to use, and the number of record attributes selected.
Click the Update Statistics button to update the statistics and return to the Channel Readiness View. Click the Cancel button to return to the Channel Readiness View without updating the statistics.
7. If Update Statistics was selected, a Confirmation window will appear that asks if Enable should start the Channel Analysis.
Select Run to run the Channel Analysis and return to the Channel Readiness View. Click the Cancel button to return to the Channel Readiness View without running the Channel Analysis.
A Channel Analysis job is created and placed in the Job Queue. To view the job’s progress, open the Job Monitor from the Features Sidebar’s System tab or open a Job Monitor Widget in the Dashboard.
Upon completion of the Channel Analysis, the Channel Readiness tab must be refreshed to show the Channel Analysis Statistics. Close the Channel Readiness tab and reopen it to display the updated Channel Analysis Statistics.
Add a Channel
Channels are typically configured by system administrators, though they can be built by other permitted users.
Channels can only be built with repositories that have been defined as Pre-Staging, Staging or Production repositories.
Update Statistics for Syndication Channel
Enable 10 PIM Administration Guide
Page 171 of 371 Revised 8/2/2019
All aspects of a Channel, except for the Channel’s repository, can be edited by following the steps detailed below. Once a Channel has been edited, the Channel’s statistics must be updated for the changes to take effect.
To add a Channel:
1. Open Channel Readiness, (see Open Channel Readiness).
2. Select the Add button from the Channel Readiness View’s Activity Bar. An empty Channel window will appear.
3. Edit the Add Channel options as desired:
o Channel Name: Enter the name of the Channel to be defined. o Repository dropdown: Select the desired repository. o Inbound toggle:
• Red (off) = Outbound Channel
Channel Readiness View
Add a Channel
Enable 10 PIM Administration Guide
Page 172 of 371 Revised 8/2/2019
• Green (on) = Inbound Channel
4. Click Save to save the Channel and return to the Channel Readiness View. To exit the Add Channel window without creating a Channel, select the Channels button on the Channel Readiness View’s Activity Bar.
The Channel Readiness View will list the new Channel with errors noting that the Channel has not been completely defined yet.
Edit a Channel
All aspects of a Channel, except for the Channel’s repository, can be edited by following the steps detailed below. Once a Channel has been edited, the Channel’s statistics must be updated for the changes to take effect.
To edit a Channel:
To add a Channel:
1. Open Channel Readiness, (see Open Channel Readiness).
Channels with Configuration Errors
Enable 10 PIM Administration Guide
Page 173 of 371 Revised 8/2/2019
2. Select the Channel (it will be highlighted blue).
3. Click the Edit button on the Channel Readiness View’s Activity Bar. The Edit Channel window will appear.
The Edit Channel window has several tabs. Select the relevant tabs to edit the Channel options as desired. In order for the contents of a tab to be saved, they must have been edited.
o Channel Name tab: Enter the name of the Channel. o Saved Sets tab: Select the name of the Saved Set to use. o Export Template tab: The name of the Export Template to use. o Attributes tab: Select the record attribute values to be validated. o Validation Rules tab: Select the validation rules to apply to the selected
attributes o Transmission Options tab: Select a transmission option in order for the Channel
to be able to be syndicated.
4. After saving any changes, select the Channels button on the Channel Readiness Activity Bar to return to the Channel Readiness View.
Channel Readiness View
Edit Channel Name
Enable 10 PIM Administration Guide
Page 174 of 371 Revised 8/2/2019
5. The new Channel should display with no errors. If not, refresh the Channel Readiness
View by clicking the Refresh button on the far right of the Channel Readiness View tab’s Activity Bar. If the Channel still does not display, make sure that the new Channel was created in the desired direction (Inbound or Outbound) and that the Channel Readiness View is looking at the correct direction.
6. Update the Channel Statistics by clicking the Update Statistics button to the right of the new Channel’s name (it looks like an index card). For more detailed directions on updating the Channel Statistics, see the Enable 10 PIM User Guide.
7. Upon completion of the Channel Analysis, the Channel Readiness tab must be refreshed to show the updated Channel Analysis Statistics. Close the Channel Readiness tab and reopen it to display the updated Channel Analysis Statistics.
Delete a Channel
To delete a Channel:
1. Select the Channel you want to delete, and click the Delete button on the Channel Readiness tab’s Activity Bar.
2. The Channel will have been deleted.
15 Data Model Management
For a high-level description of the elements of the Enable data model and how those elements interact and are used, see Enable 10 Basics.
As described below, some aspects of the data model can be modified at any time without performing any additional steps, but the modification of others can impacts other system components, such as existing repository records and the snapshot table.
Delete a Channel
Enable 10 PIM Administration Guide
Page 175 of 371 Revised 8/2/2019
Any time the data model is changed, clear the cache to assure processes are using the most current content and data model configurations. (See Clear Data Cache.)
15.1.1 Effects of Data Model Changes on Existing Records and Snapshot Tables
The table below details the effects on existing record attribute values and snapshot tables when the data model is changed.
Type of Edit to Profile Effects on Repository Attributes and the Snapshot Table
Change an attribute’s data type.
Existing repository attribute values will not be changed.
If the attribute is in the snapshot table (is defined as relational), the snapshot table will be automatically rebuilt with the new datatype.
Make an attribute repeatable.
Existing repository attribute values will not be changed. Subsequent edits to existing repository records treat the attribute as repeatable, and if new values are added, the attribute value will contain multiple values separated by the designated delimiter.
The snapshot table’s column data type for that attribute will be set to VARCHAR(MAX) regardless of the original data type (and size if VARCHAR) of the attribute.
The snapshot table will be automatically rebuilt and the repeatable attribute’s Snapshot column will contain the record attribute’s set of values, separated by the designated delimiter.
Add or remove an attribute in the snapshot table.
Existing repository attribute values will not be changed.
A column will be added or removed from the snapshot table. If added, the column will be populated from the repository’s attribute values. If deleted, the column is simply removed.
Enable 10 PIM Administration Guide
Page 176 of 371 Revised 8/2/2019
Type of Edit to Profile Effects on Repository Attributes and the Snapshot Table
Add a default value to a profile attribute.
The repository attribute values in existing repositories will not be changed. In order for a repository’s attribute default value to change, it must be changed manually in the attribute definition for that repository.
Repositories created after the profile attribute’s default value has changed will copy the profile attribute’s default value to their repository attribute’s default value.
The snapshot table will not be automatically rebuilt.
Delete a code from a code set.
Attribute values in existing records will not be changed. When the repository is next validated, any attribute values containing the deleted code will be flagged as invalid.
The snapshot table will not be automatically rebuilt.
Change a code in a code set.
Affected records in repositories and snapshot tables that use the code set will be updated.
Expert Mode
Expert Mode is a feature available to users with sufficient permissions that allows them to access some features of Enable from locations in the Enable 2020 UI where they are not typically accessible. Some of these include:
• Access data modeling features in the Taxonomy Editor.
• Access a repository’s Repository Dashboard directly from the Feature Sidebar.
To enable or disable Expert Mode, open the Feature Sidebar, open the System tab, and select Expert Mode. When Expert Mode is enabled, a checkmark will appear.
Enable 10 PIM Administration Guide
Page 177 of 371 Revised 8/2/2019
Manage Folders
15.3.1 Create a Folder
To create a folder:
1. Open the Feature Sidebar, open the Administration tab, and open the Folders group. A list of folder types will appear.
Enable/Disable Expert Mode
Enable 10 PIM Administration Guide
Page 178 of 371 Revised 8/2/2019
2. Select the type of folder to be created. The Folder – Repository will open. It lists all the existing folders of that type.
3. To delete a folder, select the folder and click the Delete button on the Folder tab’s Activity Bar.
Open the List of Folder Types
List of Repository Folders
Enable 10 PIM Administration Guide
Page 179 of 371 Revised 8/2/2019
4. To add a folder, click the Add button on the Folder tab’s Activity Bar. A new folder will appear in the list. Enter the folder’s name.
5. To edit the name or description of a folder, click the desired field. The field will open for inline editing and the record will be selected. To stop editing a field, un-select the record.
Manage Profiles
A profile defines the structure of one or more repositories and the collection of attributes contained within. For an overview of profiles, see Enable 10 Basics.
15.4.1 Open Profiles Tab
To view the list of profiles defined in Enable, open the Profiles tab:
1. Open the Feature Sidebar, open the Administration tab, open the Model folder, and select Profiles.
Add a Folder
Enable 10 PIM Administration Guide
Page 180 of 371 Revised 8/2/2019
2. The Profiles tab will open, displaying the profiles defined in Enable.
Open Profile Tab
Enable 10 PIM Administration Guide
Page 181 of 371 Revised 8/2/2019
3. To open a profile for editing in a Manage Profile tab, click the Edit button on the Profiles tab’s Activity Bar.
Profiles Tab
Manage Profile Tab
Enable 10 PIM Administration Guide
Page 182 of 371 Revised 8/2/2019
15.4.2 Delete a Profile
To delete a profile:
1. Open the Profiles tab as described in Open Profiles Tab.
2. Select the profile to be deleted.
3. Click the Delete button on the Profile tab’s Activity Bar.
4. A confirmation window will appear asking you if you wish to delete the selected details. Click Yes to delete the profile; click No to keep the profile and exit the delete profile function.
15.4.3 Add a Profile
To add a profile:
1. Open the Profiles tab as described in Open Profiles Tab.
2. Click the Add button on the Profile tab’s Activity Bar.
3. A new profile will be created and opened in a Manage Profile tab. The Details page will be open to allow you to edit the new profile’s basic details.
Profile Tab's Activity Bar
Profile Tab's Activity Bar
Enable 10 PIM Administration Guide
Page 183 of 371 Revised 8/2/2019
4. Edit the basic details as desired. For a discussion on the configuration options for profiles, see Edit a Profile in a Manage Profile Tab.
The field Is Valid is used for creating a Master Repository. If Is Valid is not Yes, the profile will not appear when creating a Master Repository. Set Is Valid to Yes, whether or not you are creating a Master Repository.
5. When you have finished editing the profile’s details, to create the profile, click the Save button in the Details page’s Activity Bar. To exit without creating the profile, close the Manage Profile tab.
6. If you saved the profile, you will now be able to edit the profile as described in Edit a Profile in a Manage Profile Tab.
15.4.4 Edit a Profile in a Manage Profile Tab
The Enable 2020 UI provides two means of editing a profile:
• Edit the profile in a Manage Profile tab.
• Users who are permissioned to use the Expert Mode can edit a profile via the Taxonomy/Hierarchy editor (see Manage Taxonomies and Hierarchies).
When a profile is edited, all repositories based on the profile will reflect the changes, whether they are in Pre-Staging, Staging, or Production. The data already stored in the repositories will not be changed because attribute values are stored in an XML structure. However, editing a profile may cause the snapshot tables of all repositories based on that profile to be updated or rebuilt. For more information, see Effects of Data Model Changes on Existing Records and Snapshot Tables.
Manage Profile Details Page
Enable 10 PIM Administration Guide
Page 184 of 371 Revised 8/2/2019
To edit a profile, you must first open it in the Manage Profile tab. This can be done either via the Repository Dashboard (see Repository Dashboard), or via the Profiles tab (see Open Profiles Tab.
The Manage Profile tab has six pages of configuration options for a profile. xxxx
• Details: The name, description, type of profile, and whether it is valid. (See Manage Profile Details.)
• Properties: Profile attributes have metadata such as data type, size, etc. Properties are custom metadata that the administrator can define. (See Manage Profile Properties.)
• Attributes: The record attributes defined in repositories using this profile. (See Manage Profile Attributes.)
• Rule List: The validation rules available for repositories using this profile. (See Manage Validation Rules.)
• Tabs: The profile’s attribute tabs. (See Tabs .)
• Groups: The profile’s attribute groups. (See Groups.)
Each configuration page is described in a following section.
To select a configuration page, click its corresponding button on the Manage Profile tab’s Page Bar.
Manage Profile Tab
Enable 10 PIM Administration Guide
Page 185 of 371 Revised 8/2/2019
Once you are finished editing the profile’s configuration options, to save your configuration changes, click the Save button on the Manage Profile’s Activity Bar. To exit without saving your changes, close the Manage Profile tab.
Manage Profile Details
To edit a profile’s details, select the Details button on the Manage Profile tab’s Page Bar. The Details page will open.
The configuration options on the Details page are:
• Name: The name of the profile.
• Description: A description of the profile.
• Type: The profile type. See Profile Types.
Manage Profile Tab's Pages
Manage Profile Details Page
Enable 10 PIM Administration Guide
Page 186 of 371 Revised 8/2/2019
• Is Valid: The field Is Valid is used for creating a Master Repository. If Is Valid is not Yes, the profile will not appear when creating a Master Repository. Set Is Valid to Yes, whether or not you are creating a Master Repository.
15.4.4.1.1 Profile Types
Profile Types
Type Description
EPIM Used for generic repositories. Most profiles are of this type.
ICON Used to define an Icon repository for use in the publication process where it holds definitions and rules for translating specific attribute values into icon filenames.
DAM_LINK Used to define the repository for DAM links which holds the link relationship attributes for relating digital assets to the related data records (for example, digital assets to items).
DAM_MASTER Used to define the repository to hold the DAM Master attributes for the Digital Asset metadata.
DAM_CONFIG Used to define the repository to hold the configuration attributes for the DAM process.
DAM_VARIANTS Used to hold the configuration definitions for the variants created in the DAM.
DAM_VARIANTS_SIZE Used to hold the configuration definitions for the variants created in the DAM.
ENABLE_READY Deprecated.
Enable 10 PIM Administration Guide
Page 187 of 371 Revised 8/2/2019
Profile Types
Type Description
EXTENDED_DEF Deprecated.
EXTENDED_ATTR Deprecated.
EXTENDED_DATA Deprecated.
HIERARCHY_CATALOG Used to define the repository for use in linking data to the hierarchy.
PUBLISH_PLAN Deprecated.
CODE_SET_METADATA Used to define the repository that extends code sets with custom attributes.
Manage Profile Properties
The Properties page is used to manage a profile’s attribute properties. Attribute properties are metadata for an attribute. For example, an attribute property called Portal_Use_Flag could be used to identify any attribute that needs to be sent to an external portal.
Profile attribute properties define:
• The initial values for a repository’s attribute properties when the repository is created.
• A set of attribute property rules the repository may use. (For a repository to use a profile’s attribute property rule, the rule must be added to the repository’s configuration.)
To edit a profile’s attribute’s properties, select the Properties button on the Manage Profile tab’s Page Bar. The Properties page will open.
Enable 10 PIM Administration Guide
Page 188 of 371 Revised 8/2/2019
The Properties page has four action buttons on its Activity Bar:
• Add: To add a property, click the Add button in the Properties Page’s Activity Bar. A new property will be created. Edit the property as described below.
• Edit: One of two ways to edit a property (see below). Using the Edit button allows you to edit the Name, Data Type and Default Value of the property.
• Delete: To delete a property, select the property and click the Delete button in the Properties Page’s Activity Bar.
• Reorder: Used to change the order of the properties.
There are two ways to edit a profile’s attribute property:
• The Edit button on the Activity Bar.
• Inline editing on the Properties page.
To edit a property inline, double-click the field you wish to edit. Depending on the type of field being edited, you will either get a dropdown list that lets you choose a value or you will be able to enter the value.
The configuration fields of a profile property are Name, Data Type, and Default Value. These configuration options are the same as the Name, Data Type, and Default Value configuration options for attributes. For more information regarding these configuration options, see Attribute Configuration Fields.
Manage Profile Attributes
The Attributes page is used to manage profile attributes.
To edit a profile’s attributes, select the Attributes button on the Manage Profile tab’s Page Bar. The Attributes page will open.
Attribute Properties Configuration Page
Enable 10 PIM Administration Guide
Page 189 of 371 Revised 8/2/2019
The Attributes page has four action buttons on its Activity Bar:
• Add: Adds an attribute to the profile. See Add Attributes.
• Edit: Opens the attribute in a Manage Attribute window for editing. See Edit Attributes.
• Delete: Removes an attribute from the profile. To delete an attribute, select the attribute and click the Delete button in the Attributes page’s Activity Bar.
• Save: To save changes made to the attributes via inline editing. This button will not be functional until a change is made. To exit without saving changes made via inline editing, close the Manage Profile tab.
15.4.4.3.1 Add a Profile Attribute
To add a profile attribute, click the Add button in the Attributes Page’s Activity Bar. A new attribute will be created. Edit the attribute as described in Edit Profile Attributes.
15.4.4.3.2 Edit a Profile Attribute
There are two ways to edit a profile attribute:
• Inline editing on the Attributes page.
• Using the Edit button on the Activity Bar to open an attribute in the Manage Attribute window.
To edit an attribute inline, double-click the field you wish to edit. Depending on the type of field being edited, you will either get a dropdown list that lets you choose a value or you will be able to enter the value. Some fields cannot be edited inline; they are only editable in the Manage Attribute window.
Profile Attributes Page
Enable 10 PIM Administration Guide
Page 190 of 371 Revised 8/2/2019
To edit an attribute in a Manage Attribute window, select an attribute and click the Edit button on the Attribute Page’s Activity Bar. The attribute will be opened in a Manage Attribute window.
Only the standard set of configuration fields will appear in the Manage Attribute window. Any profile properties can only be edited inline (see Manage Profile Properties). x
For details on the configuration fields available for attributes, see Profile Attribute Configuration Fields.
Edit the attribute configuration fields as desired. Click Apply to save the changes and exit the Manage Attribute window; click Cancel to exit the Manage Attribute window without saving.
The following describes the configuration fields for profile attributes.
• Name (Required) and Description (Optional): The name and description fields for
attributes are translatable. To add translations, click the multi-language icon corresponding to either the name or description to open the multi-language editor (shown below). After the user is done adding translations, click the Save button on the multi-language editor page and click OK on the Define Attribute Details page to save your translations.
• Restricted Name: (Required) The relational database snapshot column name. Typically this is comprised of only alphanumeric and underscore characters. The auto-conversion function will change any blank characters to underscores.
• Data Type: (Required) Data type is one of the required fields for an attribute. By defining the Data Type you are defining what values the field can store and what functionality can be performed.
• Data Type specific: The appearance of the following characteristics depends on the Data Type selected for the attribute.
o Data Precision: Appears for Data Types: BIGINT, CURRENCY, DECIMAL, INTEGER. Indicates the number of digits the value can have.
o Data Scale: Appears for Data Type: Currency, Decimal. Indicates how many digits are to the right of the decimal point.
o Data Size: Appears for Data Type: VARCHAR. Indicates the maximum number of characters in the data field.
• Default Value: (Optional) Specifies a default value for the profile’s attribute property. This will not affect any existing repositories’ attribute property.
• Group: (Required) A group organizes a repository’s attributes in a meaningful manner via tabs within a repository’s Detail Editor Tab.
• Associated Group: (Optional) An Associated Group is a set of Is Repeatable attributes that are associated with each other. When the record appears in the Detail Editor Tab, the attributes in the Associated Group will appear as a table on the screen.
• Code Set: (Optional) Code sets are comprised of predefined values. The predefined values are used to give a selection to the user so that an attribute can be defined. (See Enable 10 Basics for more information on code sets.)
• Control Type: (Optional) Control types specify behavioral rules in which data can be entered. The graphical interface for an attribute is conditionally dependent upon the specified control type; which at times can be paired with the Is Repeatable option to help further determine the graphical interface. For instance, the use of a check box or radio button is dependent upon the Is Repeatable option.
Enable 10 PIM Administration Guide
Page 192 of 371 Revised 8/2/2019
The following table describes each control type within the Enable system.
Control Types Description
HTML Editor Allows the user to format data via a WYSIWYG editor.
Numeric Attribute field that only permits numerical characters.
Check Box or Radio Check boxes are a series of small boxes which a user can select one or many particular values relative to an attribute. Radio buttons also offer a set of values relative to an attribute however, only one of which can be selected at a time.
Repository List Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Repository names within the Enable system.
Code Set List Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all code set names within the Enable system.
Taxonomy List Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Taxonomy names within the Enable system.
Hierarchy List Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Hierarchy names within the Enable system.
Code Set – Taxonomy and Hierarchy List
Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of a combined list of all Taxonomy and Hierarchy names within the Enable system.
Enable 10 PIM Administration Guide
Page 193 of 371 Revised 8/2/2019
Control Types Description
Profile List Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Profile names within the Enable system.
User List Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all User names within the Enable system.
Group List Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Group names within the Enable system.
Import Template List Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Import Template names within the Enable system.
Export Template List Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Export Template Names within the Enable system.
Export Style Map List Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Export Style Map names within the Enable system.
Publication Template List
Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Publication Template names within the Enable system.
Publication Style Map List
Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Publication Style Map names within the Enable system.
Enable 10 PIM Administration Guide
Page 194 of 371 Revised 8/2/2019
Control Types Description
Syndication Template List
Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Syndication Template List names within the Enable system.
Export, Publication and Syndication Template List
Allows the user to choose a single value via a dropdown or multiple values via a multi-select box of all Export, Publication, and Syndication Template List names within the Enable system.
Custom Dropdown List
Allows a user to specify values via a specified SQL query. The values are displayed via a dropdown list or multi-select list.
• Special Function Indicator: (Optional) Allows the user to specify that the attribute serves a special function, such as a Taxonomy Node Link or that it is a status indicator. The available selections for this characteristic are based on the type of profile being defined.
• Category Attribute Association: (Optional) This is only used for Taxonomy Attributes. It identifies the Category Attribute Association Object to be used.
• Is Variant: A configuration dependent variable. For more information, contact your Enable account representative.
• Copywriter: A configuration dependent variable. For more information, contact your Enable account representative.
• Is Multi-Language: Indicates if this attribute is to use the Multi-Language capability. For more information on the Multi-Language capability, see Multiple Language Support.
• Is Global/Category/Dynamic: (Required) : Indicates if this attribute is a Global Attribute, Category Attribute or Dynamic Attribute. Note that the attribute will only be displayed in the Category Attribute tree if it is a Category Attribute.
• Is Required: (Optional) Allows the attribute to be defined as a required element for each record within a repository.
• Is Primary Key: (Optional) Indicates this attribute contains the record’s unique identifier.
• Auto-sequenced Attribute: (Optional) This indicates that the attribute is the repository’s sequence attribute and its value will be automatically generated by Enable
Enable 10 PIM Administration Guide
Page 195 of 371 Revised 8/2/2019
unless it is supplied by the user or an import when the record is created. There can be only one Auto-sequenced Attribute per repository.
• Is Repeatable: Indicates if a record can have multiple values for this attribute. When checked, a field appears to the right to specify the delimiter between values (default is a comma).
Note that other attribute definition fields may be present, depending on system configuration.
15.4.4.3.3 Delete an Attribute
To delete an attribute, select the attribute and click the Delete button in the Attributes Page’s Activity Bar.
15.4.4.3.4 Manage Summary Attributes, Tabs and Groups
The display order of tabs, groups and attributes are maintained separately for the Enable 2020 UI and the Enable Classic UI. Setting the order in one user interface will not affect the order in the other interface.
15.4.4.3.4.1 Manage Summary Attributes
Summary attributes are managed at the repository level. Different repositories based on the same profile can have different summary attributes. For details on managing Summary Attributes, see Manage Summary Attributes.
15.4.4.3.5 Manage Attribute Tabs
Attribute tabs provide a way to organize attribute groups to make it easier to edit attribute values in a record. Attribute tabs are managed at the profile level. Changes made to a profile’s attribute tabs affect all the repositories based on that profile.
There are two ways to manage a profile’s attribute tabs:
• Through a Tabs tab.
• Through the Hierarchy/Taxonomy editor, (see Edit a Profile in the Taxonomy Editor).
This section of the document will discuss managing tabs through a Manage Tabs tab. There are several ways to open a profile’s Tabs tab/pane:
• Open a repository based on the profile in a Repository Dashboard, scroll to the Manage Profile pane, and click the Tabs tab.
• Open a repository based on the profile in a Repository Dashboard, scroll to the Tabs pane.
Enable 10 PIM Administration Guide
Page 196 of 371 Revised 8/2/2019
• Open the profile in a Profile tab, (see Open Profiles Tab) and click the Tabs tab.
Note that whether the tabs are displayed in a Tabs pane or Tabs tab, the steps to manage then are the same.
15.4.4.3.5.1 Add or Edit an Attribute Tab
To add or edit an attribute tab, first open the profile’s Tabs pane or tab, (see Manage Attribute Tabs).
To add an attribute tab, click the Add button on the Tabs pane’s Activity Bar.
To edit an attribute tab, select the tab, and click the Edit button on the Tabs pane’s Activity Bar.
The Add/Edit Tab dialog will open.
The Add/Edit Tab dialog has two multi-language configuration options: Name and Description.
When you are finished editing the configuration options, click the Apply button on the bottom of the dialog to save the edited tab and exit the Add Tab dialog, or click the Cancel button to exit the Add Tab dialog without saving the edited tab.
Repository Dashboard's Tabs Pane
Add/Edit Tab Dialog
Enable 10 PIM Administration Guide
Page 197 of 371 Revised 8/2/2019
15.4.4.3.5.2 Delete an Attribute Tab
To add or edit an attribute tab, first open the profile’s Tabs pane or tab, (see Manage Attribute Tabs).
Select the tab and click the Delete button on the Tabs pane/tab’s Activity Bar.
15.4.4.3.5.3 Reorder Groups in a Tab
For directions on reordering the groups in a tab, see Reorder Attribute Tabs and Groups.
15.4.4.3.6 Manage Attribute Groups
Attribute groups provide a way to organize attributes to make it easier to edit attribute values in a record. All attributes groups must belong to an attribute tab. Attribute groups are managed at the profile level.
There are two ways to manage a profile’s attribute groups:
• Through a Manage Profile tab.
• Through the Hierarchy/Taxonomy editor, (see Edit a Profile in the Taxonomy Editor).
This section of the document will discuss managing tabs through a Manage Groups tab. There are several ways to open a profile’s Groups tab/pane:
• Open a repository based on the profile in a Repository Dashboard, scroll to the Manage Profile pane, and click the Groups tab.
Repository Dashboard's Tabs Pane
Enable 10 PIM Administration Guide
Page 198 of 371 Revised 8/2/2019
• Open a repository based on the profile in a Repository Dashboard, scroll to the Groups pane.
• Open the profile in a Profile tab, (see Open Profiles Tab) and click the Groups tab.
15.4.4.3.6.1 Assigning Attributes to Groups and Tabs
The following procedure describes how to assign an attributes to a group or tab.
1. Open the repository in a Repository Dashboard by opening the Feature Sidebar, opening the Administration tab, opening the Model folder, and selecting Repositories.
Groups Pane
Enable 10 PIM Administration Guide
Page 199 of 371 Revised 8/2/2019
2. The Repository tab will open and display a list of the repositories in Enable.
3. Select the repository you wish to open in the dashboard, and click the Dashboard button on the Activity Bar.
4. Scroll to the Manage Profile pane.
An attribute’ group assignment can be managed by either:
o Double-clicking the attribute’s Group field and selecting a group (or no group) from the dropdown list.
o Selecting the attribute, clicking the Edit button in the Manage Profile pane’s Activity Tab, and selecting the group from the Group dropdown list.
An attribute’s Tab assignment can be managed by:
o Double-clicking the attribute’s Tab field and selecting a tab (or no tab) from the dropdown list.
Open Model Repositories
Enable 10 PIM Administration Guide
Page 200 of 371 Revised 8/2/2019
15.4.4.3.6.2 Add or Edit an Attribute Group
To add or edit an attribute group, first open the profile’s Groups pane or tab, (see Manage Attribute Groups).
To add an attribute group, click the Add button on the Groups pane’s Activity Bar.
To edit an attribute group, select the group, and click the Edit button on the Groups pane’s Activity Bar.
The Add/Edit Group dialog will open.
Groups Pane
Enable 10 PIM Administration Guide
Page 201 of 371 Revised 8/2/2019
The configuration options in the Add/Edit Group dialog are:
• Name: (Required) A multi-language field.
• Description: (Optional) A multi-language field.
• Collapsed: (Required – defaults to Collapsed) Use the dropdown to select Collapsed or Expanded. This indicates, when a record is edited, whether the group will be displayed expanded or collapsed within the tab.
• Attribute Tab: (Required) All groups must belong to an attribute tab. Use the dropdown to select the group’s attribute tab.
• Group Type: (Required) The Add/Edit Group dialog is also used to edit link relationship groups and variant groups. Use the dropdown to select Attribute.
When you are finished editing the configuration options, click the Apply button on the bottom of the dialog to save the edited group and exit the Add Group dialog, or click the Cancel button to exit the Add Group dialog without saving the edited group.
15.4.4.3.6.3 Delete an Attribute Group
To delete an attribute group, first open the profile’s Groups pane or tab, (see Manage Attribute Groups).
Add/Edit Group Dialog
Enable 10 PIM Administration Guide
Page 202 of 371 Revised 8/2/2019
To delete an attribute group, select it and click the Delete button on the Groups pane’s Activity Bar.
15.4.4.3.6.4 Reorder Attributes in a Group
For directions on reordering the attributes in a group, see Reorder Attribute Tabs and Groups.
15.4.4.3.7 Reorder Attribute Tabs and Groups
The attribute groups in an attribute tab and the attributes in an attribute group can be reordered in the Reorder dialog. To open a profile in a Reorder dialog, open one of the repositories based on the profile in a Repository Dashboard (see Repository Dashboard) and either:
• Scroll to the Tabs pane and click the Reorder button on the Tabs pane’s Activity Bar.
• Scroll to the Manage Profile pane, click the Tabs tab, and click the Reorder button on the Tabs page’s Activity Bar.
Groups Pane
Enable 10 PIM Administration Guide
Page 203 of 371 Revised 8/2/2019
The controls for reordering tabs and the controls for reordering groups is the same.
Select either the Tabs tab or the Groups tab. To change the order of the groups in a tab or to change the order of attributes in a group, select one or more groups or attributes that you want
to move and click the up arrow button and down-arrow button to move them as desired.
To move a group or attribute far up or down the list, you can select all the attributes/groups above or below it and move them in the opposite direction.
To save your changes and exit the Reorder dialog, click the Apply button. To exit without saving your changes, click the Cancel button.
15.4.4.3.8 Make an Attribute a Search Filter
To make an attribute a search filter, use the Advanced Search feature, (see the Enable 10 PIM User Guide.)
15.4.4.3.9 Modeling Category Attributes
For a details regarding managing category attributes, see the Enable 10 PIM User Guide.
Reorder Tabs and Groups
Enable 10 PIM Administration Guide
Page 204 of 371 Revised 8/2/2019
15.4.4.3.10 Manage Dynamic Attributes
For a description of Dynamic Attributes, see Enable 10 Basics.
Dynamic attributes are managed in the attribute definition by indicating that the attribute is a dynamic attribute and selecting its association object. See Manage Profile Attributes.
Manage Validation Rules
The Manage Profile tab’s Rule List page is where validation rules are managed.
To open the Rule List, click the Rule List button on the Manage Profile tab’s Page Bar.
There are three sub-pages of configuration fields in the Rule List page:
• Add: To add a new validation rule. Clicking this creates a new validation rule that is edited in the same manner as existing validation rules. See Edit a Validation Rule.
• Edit: To edit an existing validation rule. Selecting a validation rule and clicking the Edit button opens a validation rule in the Manage Rule dialog for editing. See Edit a Validation Rule.
• Delete: To delete a validation rule, select the validation rule and click the Delete button.
15.4.4.4.1 Edit a Validation Rule
There are three steps to building a validation rule:
1. Define the list of attributes the rule will apply to, for instance: Brand and Product Name. (See Validation Rule Attributes.)
2. Define the rule, for instance: the attributes to which the rule applies must not be null. (See Validation Rule Details.)
Manage Profile Rule List
Enable 10 PIM Administration Guide
Page 205 of 371 Revised 8/2/2019
3. Define the list of conditions that when some or all of them are met, the rule will be applied, for instance: apply the rule if Product ID is not null. (See Validation Rule Conditions.)
Note that the order of the sub-pages on the Manage Rule page is not the same as the order of the steps listed above. Once a new rule is named, the rule’s configuration options can be edited in any order.
As an example, simple validation rules are in the form:
<assigned attribute> must <operator> (<assigned value>) (if <condition attribute> <condition operator> (<condition value>) is true)
where parenthesis indicate that portion of the rule is optional.
Examples of simple validation rules are:
Country Code must Equal EN if Product ID > 100
Product ID must be Greater Than 100 if Country Code Equals EN
Product ID must be Not Empty
15.4.4.4.1.1 Validation Rule Types
A rule’s validation type determines which configuration options are needed for the rule and how the rule will be applied. The table below describes the validation rule types.
Rule Type Definition Notes
Bulk Callout A bulk callout validation rule is a SQL query-based validation that is performed once on the set of records being validated.
See Bulk Callout.
Calculate Concatenates values from multiple attributes.
Enable 10 PIM Administration Guide
Page 206 of 371 Revised 8/2/2019
Rule Type Definition Notes
Call Out Java-based process that performs a specific validation on the record (and the assigned attribute). Some callout validation rules are pre-defined and available for immediate use. The majority of the callout validation rules are developed for a specific Enable implementation.
See Callout.
Hierarchy Validation
Performs a comparison to any linked hierarchy to ensure any linked records are valid.
For example, if this repository record is linked to a hierarchy node, but later that node is removed from the hierarchy definition, this rule may result in that record being flagged as invalid due to the now-orphaned link.
Normalization For more information regarding the Normalization Rule Type, contact your Enable account representative.
Pre-Save Callout
See Pre-Save Callout. See Pre-Save Callout.
Enable 10 PIM Administration Guide
Page 207 of 371 Revised 8/2/2019
Rule Type Definition Notes
Simple Simple validation rule where the designated operation (and possible value(s)) are applied to the assigned attribute.
This is the most common validation rule and is used to perform validations such as an attribute having to have a value or having to be empty, having a specific value (e.g., Gross Weight must be greater than or equal to Net Weight, etc.)
UCC GTIN Algorithm
Verifies the value conforms to the UCC GTIN format.
UCC GLN Algorithm
Verifies the value conforms to the UCC GLN format.
UCC UPC-12 Algorithm
Verifies the value conforms to the UCC UPC-12 format.
UCC UPC-11 Algorithm
Verifies the value conforms to the UCC UPC-11 format.
VTL-like Pre-Save Callout that executes a VTL script to update the record.
This is not a validation rule but a pre-save callout that will alter the repository record as it’s being created or updated.
15.4.4.4.1.1.1 Bulk Callout
A Bulk Callout validation rule is a SQL query-based validation that is performed once for whatever group of records are being validated, such that:
1. Individual record: the SQL is limited to just that record.
2. Saved set: the SQL is limited to the records in the saved set.
3. Full repository: the SQL query is run against the entire repository.
In each case, the results of the query are the records that violate the rule, which are listed in a temporary table. They are placed in the table so that when each record in the group is being validated, the temporary table is consulted instead of running the SQL again. When each
Enable 10 PIM Administration Guide
Page 208 of 371 Revised 8/2/2019
record is validated for its other rules, the error table is consulted for any bulk callout violations. If there are any, their messages are added to the list of errors for that particular attribute.
The basic interface is that the callout needs to return one row for each record that has an error. The first column of the row is the internal ID of the record and the second column is the error message. The query itself needs to be formulated to find and return the offending rows.
Each query should be wrapped by the following outer query:
SELECT InternalRecordId, ErrorMessage
From (
<<… Actual query here >>
) as T1 WHERE 1=1
Example queries:
2 Stage record must have Manufacturer:
select InternalRecordId,
cast([Manufacturer] as nvarchar(30)) + ' has no reference
in Manufacturer repository' as ErrorMessage
from item where Manufacturer is not null
and InternalRecordId not in
(select i.InternalRecordId from Item i inner join
Manufacturer b on i.[Manufacturer]=b.[Manufacturer Name])
must have the same Taxonomy:'+m.Taxonomy as ErrorMessage
from Item m, (select distinct a.internalRecordId internalId
from item a inner join Item b on a.[SKU Group]=b.[SKU
Group]
where a.[sku group] != 'DISCONTINUED' and a.Taxonomy !=
b.Taxonomy) t1 where m.InternalRecordId=t1.InternalId
4 Marketing Ad must have a Main image:
select InternalRecordId,
'Marketing Ad: ' + [Marketing Ad ID] + ' has no Main image'
as ErrorMessage
from PIM_MarketingAd_Staging
where InternalRecordId not in
Enable 10 PIM Administration Guide
Page 209 of 371 Revised 8/2/2019
(select ma.InternalRecordId from PIM_MarketingAd_Staging ma
inner join DAMLink dl on ma.[Marketing Ad ID]=dl.[PK1]
where dl.[Image Context] = 'Main')
If a bulk callout validation rule is to be conditionally applied, the conditions for that application must be encoded in the SQL – the rule conditions will be ignored. This is because those conditions are based on the current record, but the bulk callout must validate all records in the
15.4.4.4.1.1.2 Callout
A Callout is a Java-based process that performs a specific validation on a record (and the assigned attribute). Some callout validation rules are pre-defined and available for immediate use. The majority of the callout validation rules are developed for a specific Enable implementation.
The following callout rules are pre-defined in Enable:
• AttributesCalc
• AttributesPriceUpdate
• AttributesSearchAndUpdate
• AttributesSearchAndCalculate
• CheckAttributeCodeSetName
• IsLengthLessThan
• MatchesPattern – compares the value to a REGEX pattern. If the value does not match one of the defined patterns, the attribute is flagged as invalid. A common application is to define the different formats for a phone number (e.g., 1 (909) 555-1212, (714) 555-1212 x 1234, 818-555-1212, etc.)
• NoBlanks – flags a value if it contains any spaces
• NoInvalidCharacters – flags a value as invalid if it contains any of the designated characters.
• ValidReference – flags a record as invalid if a corresponding record is not found in a linked repository (NOTE: This has been supplanted by a Bulk Callout which is a more-efficient to perform such a validation)
• ValidCharacters – flags a value as invalid if it contains anything but the designated characters
• ValidDimensions
• PIMWebServiceGetRepoAttrData
• UpdateDistinctChildValues
Enable 10 PIM Administration Guide
Page 210 of 371 Revised 8/2/2019
• UpdateParentWithDistinctChildValues
• <custom> - Custom callout validation rules can be implemented to perform any needed specialized validation, providing those callouts follow the prescribed interface in the form of a Java class. Examples of callout rules:
o inheritance – the outcome of the validation is dependent upon the content of a linked parent record according to configured inheritance rules
o comparison to data outside of enable, such as using an API to access a web service (NOTE: while such operations are possible, they are very expensive in terms of performance impact)
o complex logic that cannot be expressed in SQL (bulk callout) or simple validation rule. NOTE: many of the callouts listed above originated as complex rules needed for an implementation but were recognized as having general applicability so where assimilated into the product.
15.4.4.4.1.1.3 Pre-Save Callout
Pre-Saved Callouts are not a validation rule; they are used to perform a pre-save calculation on the record before the record is created or updated. For example, a Pre-Save Callout could conditionally define a default value for an attribute or calculate a primary key based on other attribute values. If it is a compiled class, it may define a primary key using data in an external table or repository, for instance, selecting a number from a pool of available numbers, then removing the number from the pool.
Pre-Save Callouts include:
• VTLUpdatePreSaveCallout – updates the record using the VTL script defined in the callout properties
• AttributeVTLCaclulatePreSaveCallout
• PriceCopyPreSaveCallout
• AttributesSearchAndUpdatePrice
• GroovyPreSave – executes a Java-based Groovy script defined in the callout properties
• NodeJSPreSave
• <custom> - any Java class that follows the Pre-Save Callout interface can be implemented to perform a pre-save operation.
15.4.4.4.1.2 Validation Rule Details
To edit a validation rule’s details, select the Details tab on the Manage Rule editor’s Page Bar. The Details page will open.
Enable 10 PIM Administration Guide
Page 211 of 371 Revised 8/2/2019
The configuration options on the Manage Rule editor’s Details page are:
Configuration Option
Required or Optional
Definition For Rule Type(s)
Name Required The name of the rule. All
Type Required Type of validation rule. (See Validation Rule Types.)
All
Severity Required Specifies the severity of the validation error assigned to the attribute If the value of the assigned attribute violates this rule.
All
Level If not specified will default to highest Validation Level.
The validation level this attribute is assigned to. Note that if the Level is not specified, it will default to the highest level.
All
Operator Required The operator compared with the assigned attribute.
Simple
Value Required The value the assigned attribute is compared to.
Simple
Manage Validation Rule Details
Enable 10 PIM Administration Guide
Page 212 of 371 Revised 8/2/2019
Configuration Option
Required or Optional
Definition For Rule Type(s)
Formula Required How the assigned attributes will be altered.
Calculate
VTL-like
Call Out Required The JAVA class process that will alter the assigned attribute. (See Callout and Pre-Save Callout.)
Call Out
Pre-save Call Out
Class Path Required Specifies the class path for the JAVA class process that will alter the assigned attribute. (See Callout and Pre-Save Callout.)
Call Out
Pre-save Call Out
Bulk Rule Text
Required The text of the SQL query performed on the set of records being validated.
Bulk Callout
When you are finished editing the validation rule’s details, click the Next button on the bottom of the Details page. Note that any changes you make will not be saved until you click the Apply button on the Attributes page.
15.4.4.4.1.3 Validation Rule Conditions
Validation rule conditions are defined as follows:
If <condition attribute> <condition operator> (<condition value>) is true then apply the validation rule.
To a manage validation rule’s conditions, select the Conditions page on the Manage Rule editor’s Page Bar. The Conditions page will open.
Enable 10 PIM Administration Guide
Page 213 of 371 Revised 8/2/2019
The configuration options on the Condition page are:
Configuration Option
Required or Optional
Definition
Any Conditions Valid
Optional Indicates that all the conditions listed must be met for the rule to be applied.
All Conditions Valid
Optional Indicates that if any of the conditions listed are met, the rule will be applied.
Attribute Required The <attribute> used to define the condition.
Operator Required The <operator> used to define the condition.
Value Required for some Operators
The <value> used to define the condition.
To create a condition, select the plus icon to the right of the condition. Edit the condition’s configuration options, then click the plus icon on the condition below the condition you are creating. The condition you are creating will be added to the list of conditions.
To edit a condition, click the pencil icon to the right of the condition.
To delete a condition, click the garbage can icon to the right of the condition.
Manage a Validation Rule's Conditions
Enable 10 PIM Administration Guide
Page 214 of 371 Revised 8/2/2019
When you are finished editing the validation rule’s conditions, click the Next button on the bottom of the Conditions page. Note that any changes you make will not be saved until you click the Apply button on the Attributes page.
15.4.4.4.1.4 Validation Rule Attributes
To assign the attributes that will use the validation rule, select the Attributes tab on the Manage Rule editor’s Page Bar. The Attributes page will open.
To assign an attribute to a validation rule, click the Assign button on the Attribute page’s Activity Bar. A list of the available attributes will appear.
Select the attribute(s) to be assigned to the validation rule.
Click the Save button to assign the attributes and return to the Attributes page.
Warning: If you do not click the Save button before clicking the Apply button on the bottom of the list, the attributes will not be assigned.
Manage a Validation Rule's Assigned Attributes
The List of Attributes Available to be Assigned to the Validation Rule
Enable 10 PIM Administration Guide
Page 215 of 371 Revised 8/2/2019
Click the Back button to return to the Attributes page without assigning the attributes.
Click the Apply button at the bottom of the Attributes page to Apply any edits to the validation rule and return to the Manage Profile pane in the repository’s Repository Dashboard. Click the Cancel button at the bottom of the Attributes page to return to the Manage Profile pane in the repository’s Repository Dashboard without saving your edits.
Manage Repositories
15.5.1 Create a Repository
Use the Enable Classic UI to create a repository:
1. Log into the Enable Classic UI.
2. Open the Repositories tab by opening the Feature Bar, opening the Model tab, and selecting Repositories. The Repositories tab will open.
3. On the Repositories tab Activity Bar, open the Action drop-down and select New. A New Repository window will appear.
Repositories Tab
Enable 10 PIM Administration Guide
Page 216 of 371 Revised 8/2/2019
4. Edit the new repository’s configuration options as desired.
o Name: (Required) Name of the new repository. o Description: A description of the new repository. o Profile: (Required) The profile to be used to define the new repository. o Pre-Staging/Staging/Production: If this repository will be used in a Pre-
Staging(optional)/Staging/Production sequence, indicate which one of these the repository will be. Otherwise, leave the field empty.
o Repository Type:
• Hierarchy Catalog Repository View: Shows all the records from a hierarchy properties repository.
• Web Product Root: Pertains only to the Split/Clone functionality. Enables the Split/Clone menu option from the Action menu on repository.
• Web Product: Pertains only to the Split/Clone functionality. Enables the Clone menu option on the Action menu.
• Option Type: Pertains only to the Split/Clone functionality. Allows a user to select multiple variant attributes to split or to enter a count for cloning a product repository record.
• Option: Pertains only to the Split/Clone functionality.
• <empty>: If the repository is not one of the types listed above, leave the field empty.
o Show Tab: Whether or not the repository’s name will appear in the Feature Bar.
New Repository Tab
Enable 10 PIM Administration Guide
Page 217 of 371 Revised 8/2/2019
o Tab Name: (Required) The name of the repository’s tab when it is opened in a Repository View and the name that will appear in the Feature Bar if Show Tab is selected.
o Sequence: (Required) The sequence object to be used to track record sequence numbers. Repositories can share sequence objects, which means that each record in the repositories has a unique sequence number across all the repositories using that object. Either select an already defined sequence or click the Manage button to define a new sequence:
• Name: (Required) The name of the sequence.
• GTIN Prefix: If you want your sequence number to be an auto-generated GTIN then put your GTIN prefix here.
• Starting Sequence: (Required) The first number in the sequence.
• Current Max Sequence: This is a displayed value only; not a configuration option. It displays what is currently the highest number in the sequence.
o Auto-Generate Sequence: If selected, when a record is created, its sequence number will be automatically generated. If not selected, when a record is created, its sequence number must be manually entered.
o Derive Indicator Digit: Deprecated – no longer in use. o Transmission Option: Defines the method of transmitting data exported from
the repository, such as the protocol used, modifications to the resulting file name, destination, and any necessary destination-imposed user authentication. Transmission options can be used by more than one repository. Either select an already defined transmission option, or click the Manage button to define a new option.
5. When you have finished editing the configuration options, select Next. The New Repository Attribute Configuration window will appear. Edit the repository attribute properties as desired.
Enable 10 PIM Administration Guide
Page 218 of 371 Revised 8/2/2019
6. When you are finished editing the repository’s attribute properties, select Next. The final configuration options appear.
New Repository Profile Configuration Options
Final Repository Configuration Options
Enable 10 PIM Administration Guide
Page 219 of 371 Revised 8/2/2019
7. The settings on this page are deprecated and are to be left empty.
o Automatically Publish Ready Records: This configuration option is deprecated. Ignore this field and all subfields.
• Auto Publish Interval (in hours): Deprecated.
• Auto Publish Start: Deprecated.
• Now: Deprecated.
• Specified Date: Deprecated.
o Track Record Changes: This setting is deprecated. All record changes are now tracked automatically.
8. Select Finish to save the repository and exit the New Repository tab or select Cancel to exit the tab without creating the repository.
15.5.2 Delete a Repository
Use the Enable Classic UI to delete a repository:
1. Log into the Enable Classic UI.
2. Open the Repositories tab by opening the Feature Bar, opening the Administration tab, and selecting Repositories. The Repositories tab will open.
Repositories Tab
Enable 10 PIM Administration Guide
Page 220 of 371 Revised 8/2/2019
3. Select the repository to be deleted.
4. On the Repositories tab’s Activity Bar, open the Action drop-down and select Delete. The repository will be deleted.
15.5.3 Repository Dashboard
The Repository Dashboard provides a system administrator the ability to manage different aspects of a repository all in one place, rather than having to traverse several menus and tabs to manage each of the aspects separately. The Repository Dashboard does not replace the ability to access to those aspects through the Feature Sidebar and Widgets; it provides an alternative path of access.
The aspects a system administrator can manage in the Repository Dashboard include the repository’s profile, groups, tabs, summary attributes, validation model, association group, link relations, templates and security filters.
Open a Repository Dashboard
There are two methods of opening a repository’s dashboard: via Expert Mode and via the Model.
Repository Dashboard
Enable 10 PIM Administration Guide
Page 221 of 371 Revised 8/2/2019
15.5.3.1.1 Open a Repository Dashboard Via the Expert Mode
Permitted users can enable Expert Mode, then open a repository in a Repository Dashboard by clicking the icon to the right of the repository’s name in the Features Sidebar’s Content folder.
1. Enable the Expert Mode, (see Expert Mode).
2. Open the Feature Sidebar, open the Repository tab, and open the repository’s folder to expose the repository’s name.
Open a Repository Dashboard via Expert Mode
Enable 10 PIM Administration Guide
Page 222 of 371 Revised 8/2/2019
3. Click the open icon to the right of the repository’s name. The repository’s Repository Dashboard will be opened.
15.5.3.1.2 Open a Repository Dashboard Via the Model
To open a repository in a Repository Dashboard:
1. Open the Feature Sidebar, open the Administration tab, open the Model folder, and select Repositories.
2. The Repository tab will open and display a list of the repositories in Enable. A scrolling ribbon menu across the top of the tab displays the list of repository folders. Selecting a folder will cause only the repositories in that folder to appear in the repository list.
3. Select the repository you wish to open in the dashboard, and click the Dashboard button on the Activity Bar.
Open Model Repositories
Enable 10 PIM Administration Guide
Page 223 of 371 Revised 8/2/2019
4. The repository will be opened in a Repository Dashboard.
Repository Dashboard Buttons
Across the top of the Repository Dashboard is a series of large buttons. Each button refers to a specific item associated with the repository, displays a count of that item, and when clicked will scroll the display to the functional area that controls that item. These items are:
• Tabs
Select a Repository to Open in a Repository Dashboard
Repository Dashboard
Enable 10 PIM Administration Guide
Page 224 of 371 Revised 8/2/2019
• Groups
• Attributes
• Link Relations
• Import Templates
• Export Templates
Repository Dashboard Panes
The Repository Dashboard is made up of several different functional areas or panes. Each pane controls a repository aspect and it is formatted similarly to any widgets, dialog boxes or displays for that aspect that are accessed through the Feature Sidebar or User Dashboard.
Repository Pane Item Buttons (shown on a narrow screen)
Enable 10 PIM Administration Guide
Page 225 of 371 Revised 8/2/2019
Each pane has controls similar to those found on widgets, including Refresh , Open In Tab
, page controls, and scrollbars. Hovering over the pane’s Title Bar reveals the Refresh and Open in Tab icons.
When editing a value in a Repository Dashboard pane, the Multilingual icon indicates fields that can contain different values based on the language selected.
The Tabs Pane
Multilingual Icon
Enable 10 PIM Administration Guide
Page 226 of 371 Revised 8/2/2019
Below is a summary of the panes appearing in the Repository Dashboard. The following sections of this document detail the functioning of each pane.
The Association Groups pane allows you to manage a repository’s Association Group. For more information on managing an Association Group, see Manage Association Groups.
Enable 10 PIM Administration Guide
Page 228 of 371 Revised 8/2/2019
15.5.3.3.2 Attribute Security Filter Pane
The Attribute Security Filter pane allows you to manage a repository’s attribute security filters. For more information on managing a repository’s attribute security filters, see Attribute Security Filter Management.
The Groups pane allows you to manage a repository’s export, Exchange, publication and syndication templates. For more information on managing these templates, see Export Templates and Syndication Templates.
15.5.3.3.4 Groups Pane
The Groups pane allows you to manage a repository’s groups. For more information on managing a repository’s groups, see Manage Attribute Groups.
The Import Templates pane allows you to manage a repository’s import templates. For more information on managing a repository’s import templates, see Import Templates.
Groups Pane
Import Templates Pane
Enable 10 PIM Administration Guide
Page 231 of 371 Revised 8/2/2019
15.5.3.3.6 Link Relation Pane
The Link Relation pane allows you to manage a repository’s link relations. For more information on managing a repository’s link relations, see Repository Link Management.
15.5.3.3.7 Manage Profile Pane
The Manage Profile pane allows you to manage a repository’s profile. Selecting the Open in Tab icon opens the Manage Profile tab (which can also be accessed from Features Sidebar > Administration > Model > Profiles).
For more information on managing a repository’s profile, see Manage Profiles.
Link Relation Pane
Enable 10 PIM Administration Guide
Page 232 of 371 Revised 8/2/2019
15.5.3.3.8 Record Security Filter Pane
The Record Security Filter pane allows you to manage a repository’s record security filters. For more information on managing a repository’s record security filters, see Record Security Filter Management.
Manage Profile Pane
Record Security Filter Pane
Enable 10 PIM Administration Guide
Page 233 of 371 Revised 8/2/2019
15.5.3.3.9 Repository Security Pane
The Repository Security pane allows you to manage a repository’s security. For more information on managing a repository’s security filters, see Repository Security Management.
15.5.3.3.10 Summary Attribute Pane
The Summary Attribute pane allows you to manage a repository’s summary attributes. For more information on managing a repository’s summary attributes, see Manage Summary Attributes.
Repository Security Pane
Enable 10 PIM Administration Guide
Page 234 of 371 Revised 8/2/2019
15.5.3.3.11 Tabs Pane
The Tabs pane allows you to manage a repository’s tabs. For more information on managing a repository’s tabs, see Manage Profiles.
List of Summary Attributes
Enable 10 PIM Administration Guide
Page 235 of 371 Revised 8/2/2019
15.5.3.3.12 Validation Model Pane
The Validation Model pane allows you to manage a repository’s Validation Model. For more information on managing a Validation Model, contact your Enable account representative.
Tabs Pane
Enable 10 PIM Administration Guide
Page 236 of 371 Revised 8/2/2019
15.5.4 Manage Summary Attributes
To manage a repository’s summary attributes, open the repository in a Repository Dashboard (see Repository Dashboard) and scroll to the Summary Attribute pane.
Validation Model
Enable 10 PIM Administration Guide
Page 237 of 371 Revised 8/2/2019
To specify if an attributes is or is not a summary attribute, toggle the Manage button on the Summary Attribute pane’s Activity bar to On (green). The display will change to the Management page.
List of Summary Attributes in the Summary Attributes Pane
Manage Summary Attributes
Enable 10 PIM Administration Guide
Page 238 of 371 Revised 8/2/2019
Attributes in the repository and any linked repositories can be added to the set of the repository’s summary attributes. Use the Repository dropdown to select the desired repository. The available attributes will be listed in the Available Attributes list below the Repository dropdown.
The list of Current Summary Attributes appears on the right of the display.
To add or remove an attribute from the summary attributes, select it and click the right-arrow
icon to add an attribute to the Current Summary Attributes list and the left-arrow icon to remove it. If an attribute from a linked repository is added, the name of the linked repository will appear in square brackets [ ].
To save your changes, click the Save button on the Management page’s Activity Bar. To return to the list of summary attributes, toggle the Manage button to Off (red).
15.5.5 Manage Repository Validation Rules
The list of validation rules maintained by a repository’s profile are available for use by the repository, but are not automatically added to a repository’s list of validation rules.
Managing a repository’s validation rules is performed in the Enable Classic UI. To add or remove a profile validation rule from a repository’s list of validation rules:
1. Log into the Enable Classic UI, open the Content tab, and open the folder of the repository to be managed. Click the triangle icon to the right of the repository’s name, click the Edit button, and select Rule Properties.
Enable 10 PIM Administration Guide
Page 239 of 371 Revised 8/2/2019
2. The repository’s Rule Properties dialog will appear.
Open the Repository's Rule Properties
Enable 10 PIM Administration Guide
Page 240 of 371 Revised 8/2/2019
3. To add a validation rule to the repository, select the rule and use the down arrow button between the Rule Available and Rule Selected lists to move the rule to the Rule Selected list.
To add all the validation rules to the repository, click the double down arrow button between the Rule Available and Rule Selected lists to move all the rules to the Rule Selected list.
To remove a validation rule from the repository, select the rule and use the up arrow button between the Rule Available and Rule Selected lists to move the rule to the Rule Available list.
To remove all validation rules from the repository, use the double up arrow button between the Rule Available and Rule Selected lists to move all the rules to the Rule Available list.
To reorder the list of the repository’s validation rules, select one or more rules in the Rule Selected list, then click the double up or double down button to the right of the Rule Selected list.
4. When the Rule Selected list has been edited as desired, click the Save button to save the changes and exit, or click the Cancel button to exit without saving the changes.
Repository Rule Properties
Enable 10 PIM Administration Guide
Page 241 of 371 Revised 8/2/2019
15.5.6 Repository Link Management
For a description of repository links and link relationships, see Enable 10 Basics.
WARNING: Be careful modifying the definition of existing link relationships, as they are fundamental in many of the Enable functions. Link relationships must have unique names and if repository has a staging and production versions, then the relationship must be created on both repositories.
Designate Linked Attributes to be Displayed
A repository can specify attributes of a linked repository to be displayed in the Detail Editor Tab or the Repository Dashboard.
WARNING: Be careful modifying the definition of existing link relationships, as they are fundamental in many of the Enable functions. Link relationships must have unique names and if repository has a staging and production versions, then the relationship must be created on both repositories.
To manage the selection of linked attributes:
1. Log into Enable as a user with Administrative privileges.
2. Open the repository in the Repository Dashboard, (see Repository Dashboard). Scroll to the Link Relation pane.
Repository Link Relation Pane
Enable 10 PIM Administration Guide
Page 242 of 371 Revised 8/2/2019
3. Select the desired link relationship and click the Edit button on the Link Relation pane’s Activity Bar. The link relation will be opened in a Manage Link Relation tab, in the Details page.
NOTE: Do not change existing link names, otherwise the Enable views, export templates and other features that reference the link may break..
4. Click the Next button to scroll to the Join Condition page. The join is from parent repository to child repository.
Manage Link Relation Details
Manage Link Relation Join Condition
Enable 10 PIM Administration Guide
Page 243 of 371 Revised 8/2/2019
5. Click the Next button to scroll to the Child Preference page.
6. The Child Preference page defines how the link table is shown when the child repository is opened for editing in the Detail Editor Tab. The Parent Preference page is identical to
Top of Child Preference Page
Bottom of Manage Link Child Preference Page
Enable 10 PIM Administration Guide
Page 244 of 371 Revised 8/2/2019
the Child Preference page, but it defines how the link table is shown when the parent repository is opened for editing in the Detail Editor Tab. The pages are edited the same.
The configuration options on a Preference page are:
o Numbers of Records Per Page o Window Display Height o Show Link in Detail Editor Tab: Indicate whether the link table is shown. o Placement Group: Select an existing Placement Group (also called an Attribute
Tab) to define which Detail Editor Tab tab will include the link table. To generate a new Placement Group, click the Manage button on the right, see (Manage Attribute Groups).
o Edit Button Label Description: If toggled, it allows you to edit the labels on the action buttons.
o Show Buttons: When the checkbox next to an action button is checked, the button will be displayed in the Detail Editor Tab. If the Edit Button Label Description toggle is set to On (indicator is pushed to the right), you will be able to edit text fields to the right of the buttons; they are the labels displayed on the buttons when they are shown in the Detail Editor Tab. The action buttons are:
• Reorder
• Refresh
• Open Link Table In Window: Deprecated.
• Edit in New Window:
• Edit
• Add New
• Remove Link
• Delete
• Clone
• Copy
• Open in New Tab
• Open in New Window: Deprecated.
• Add Link:
o Source (Including linked repositories): Enable allows you to select attributes to display from the linked repository as well as attributes from the linked repository’s linked repositories.
The Available Attributes list (on the left) contains attributes that can be added to the Display These Attributes list (on the right). The Source dropdown selects which repository’s attributes are currently listed in the Available Attributes list.
Use the left arrow and right arrow buttons to add or remove attributes from the Display These Attributes list.
Use the up arrow and down arrow buttons to the right of the Display These Attributes list to order the attributes are displayed.
Enable 10 PIM Administration Guide
Page 245 of 371 Revised 8/2/2019
7. When the Child Preference has been edited as desired, click the Next button to scroll to the Parent Preference.
8. Edit the Parent Preference in the same manner as the Child Preference.
9. When the Parent Preference has been edited as desired, click the Apply button to save your changes to the link relation. To exit without saving your changes, close the Manage Link Relation tab.
Manage Linked Data Custom Controls
Custom controls are buttons that appear to the right of an attribute that activate a custom JSP user interface control, such as a button that when clicked, opens the attribute in a new window for editing.
Managing custom controls for selected linked data is performed in the Enable Classic UI. To do so:
1. Log into the Enable Classic UI as a user in the Administrator group.
2. From the Quick Links dropdown, select Repositories, and select the desired repository.
3. From the Action Menu, click Edit, then select Attribute Properties.
Edit a Repository's Attribute Properties
Enable 10 PIM Administration Guide
Page 246 of 371 Revised 8/2/2019
4. The Attribute Properties window appears.
5. If a calculation indicator will be displayed for an attribute:
a. Select a Calculation Indicator:
i. <none>: No calculation indicator will be displayed. This is the default for any attribute for which no calculations are to be performed.
ii. Open as Dialog: This opens the selected JSP page as a dialog prompt.
iii. No User Interface: This opens the selected JSP page in the background. There will not to be any kind of user-input on the form.
iv. Hidden Window: Similar to No User Interface. No pop-up is shown.
v. Control with Window: A pop-up window will appear that has a button for the attribute. The attribute will not be updated.
vi. Control with Hidden Window: A hidden pop-up window will appear that has a button for the attribute. The attribute will not be updated.
Left Side of the Attribute Properties Window
Right Side of the Attribute Properties Window
Enable 10 PIM Administration Guide
Page 247 of 371 Revised 8/2/2019
vii. Calculated Attribute: The attribute value may be updated by the custom control. This is used for an attribute that is going to be updated by a pop-up page but there is not a button to open the page.
b. Calculation Label: Specifies the text that is to appear when the user hovers over the button to the right of the field.
c. Calculation URL: A drop-down containing the JSP files. Selecting one specifies which JSP page is to be invoked when the define button is pressed.
6. When you are finished editing the custom controls, click the Save button to save your changes and exit. Click the Cancel button to exit without saving your changes. Default mapping messages will indicate updates or snapshot update.
Manage Taxonomies and Hierarchies
This section describes how to register a hierarchy for use, import and export hierarchies to, from and within environments (such as migrating a hierarchy from a Dev server to a QA server), and copying a hierarchy. Managing a taxonomy is achieved in the same manner.
15.6.1 Open Taxonomy/Hierarchy in Manager
Taxonomies and hierarchies are both managed just about exactly the same way. This section is written to address taxonomies but almost all of it is the same for hierarchies. Any content for hierarchies that is different will be noted.
There are two ways to open a taxonomy in the Taxonomy Manager or (or a hierarchy in the Hierarchy Manager):
• Via the Model tab.
• Via a repository.
Open Taxonomy/Hierarchy via the Model Tab
A new taxonomy or hierarchy may need to have been populated with the codes for at least one node to be visible in the Model – Taxonomy/Model – Hierarchy tabs, as well as to be able to be opened in a Manager from those tabs. If that is the case, see
To open a taxonomy (or hierarchy):
1. Open the Feature Sidebar, open the Administration group, open the Model tab, and select Taxonomy (or Hierarchy).
Enable 10 PIM Administration Guide
Page 248 of 371 Revised 8/2/2019
2. The Model – Taxonomy tab will open, displaying a list of the existing taxonomies.
3. Select the desired taxonomy and click the Manage button on the Model – Taxonomy tab’s Activity Bar. The taxonomy will be opened in the Taxonomy Manager.
Open the Model -- Taxonomy Tab
Model -- Taxonomy Tab
Enable 10 PIM Administration Guide
Page 249 of 371 Revised 8/2/2019
Open Taxonomy/Hierarchy via a Repository
To view and manage a taxonomy/hierarchy through its repository:
1. Open the affected repository by opening the Feature Sidebar, selecting the desired folder, and selecting the desired repository. The repository will be opened in a Repository View. For more detailed information on repositories, see the Enable 10 PIM User Guide.
Taxonomy Manager/Editor
Repository View Grid View
Enable 10 PIM Administration Guide
Page 250 of 371 Revised 8/2/2019
2. Click the Hierarchy button on the Repository View’s Activity Bar.
3. The Hierarchy/Taxonomy Sidebar will appear. Select the taxonomy or hierarchy, then
click the Manage button in the Hierarchy/Taxonomy Sidebar’s Activity Bar.
4. The taxonomy or hierarchy will open in the Taxonomy or Hierarchy Manager.
Open the Hierarchy Sidebar
Open a Taxonomy in Manager
Enable 10 PIM Administration Guide
Page 251 of 371 Revised 8/2/2019
15.6.2 Edit a Profile in the Taxonomy Manager
For a high-level overview of taxonomies and category attributes and how they are used, see Enable 10 Basics and the Enable 10 PIM User Guide.
The Enable 2020 UI provides two means of editing a profile:
• Edit a Profile in a Manage Profile Tab.
• Users who are permissioned to use the Expert Mode can edit a profile via the Taxonomy/Hierarchy editor.
When a profile is edited, all repositories based on the profile will reflect the changes, whether they are in Pre-Staging, Staging, or Production. The data already stored in the repositories will not be changed because attribute values are stored in an XML structure. However, editing a profile may cause the snapshot tables of all repositories based on that profile to be updated or rebuilt. For more information, see Effects of Data Model Changes on Existing Records and Snapshot Tables.
To manage a profile via the Taxonomy Manager:
1. Open for editing the taxonomy for one of the repositories based on the profile, (see Open Taxonomy/Hierarchy in Manager.)
Taxonomy Manager
Enable 10 PIM Administration Guide
Page 252 of 371 Revised 8/2/2019
The Taxonomy Editor’s Category Attribute Tree (on the right of the Taxonomy Manager screen) displays all attribute tabs and attribute groups, as well as the attributes themselves.
Add/Edit an Attribute Tab
Adding or editing an attribute tab in the Taxonomy Manager requires the user to be in Expert Mode, (see Expert Mode). To add or edit an attribute tab via the Taxonomy Manager:
1. Open in the Taxonomy Manager the taxonomy for a repository based on the profile to be edited, (see Open Taxonomy/Hierarchy in Manager).
Taxonomy Manager
Enable 10 PIM Administration Guide
Page 253 of 371 Revised 8/2/2019
2. Hover over an existing tab in the Category Attribute Tree (on the right of the Taxonomy Manager’s screen). If the user has sufficient permissions, a Manage Tab icon will appear.
3. Click the Manage Tab icon and a dropdown list will appear that allows the user to:
o Create a new Attribute Tab (New Tab). o Edit an existing Attribute Tab (Edit Tab). o Add a new Attribute Group (Add Group).
Taxonomy Editor
Manage Tab Icon
Enable 10 PIM Administration Guide
Page 254 of 371 Revised 8/2/2019
4. To add an Attribute Tab, select New Tab. An Add Tab pop-up window will appear that allows the user to enter a name and description for the new Attribute Tab.
To edit an Attribute Tab, select Edit Tab. An Edit Tab pop-up window will appear that allows the user to change the name and/or description for the Attribute Tab.
Except for the titles of the windows, the Add Tab window and the Edit Attribute window are the same.
5. Edit the name and description of the Attribute Tab as desired.
Taxonomy Editor: Manage Attribute Tabs
Taxonomy Editor: Add/Edit Attribute Tab
Enable 10 PIM Administration Guide
Page 255 of 371 Revised 8/2/2019
6. Click Apply to save the changes and return to the Taxonomy Manager. Click Cancel or the Close icon to return to the Taxonomy Manager without creating the new Attribute Tab (if New Tab was selected) or saving changes to the Attribute Tab (if Edit Tab was selected).
7. After any change to the taxonomy, clear the cache and refresh displays to ensure the change has been propagated throughout the system and displays are accurately reflecting system status.
Add an Attribute Group
Adding an attribute group in the Taxonomy Manager requires the user to be in Expert Mode, (see Expert Mode). To add an Attribute Group via the Taxonomy Manager, first open in the Taxonomy Manager the taxonomy for a repository based on the profile to be edited, (see Open Taxonomy/Hierarchy in Manager).
Attribute Groups are added through the Add Group pop-up window. There are two ways to access the Add Group window:
• Via the Manage Tab icon (found by hovering over an existing Attribute Tab).
• Via the Manage Group icon (found by hovering over an existing Attribute Group).
It doesn’t matter which Attribute Group or Attribute Tab is used to access the Add Group window; the user will be able to choose any Attribute Tab for the new Attribute Group to belong to. Note: If the user does not have sufficient permissions, the Manage Tab icon will not appear.
The first way to bring up the Add Group window is to:
1. Hover over an Attribute Tab in the Category Attribute Tree and click the Manage Tab icon. A dropdown list will appear that allows the user to:
o Create a new Attribute Tab (New Tab). o Edit an existing Attribute Tab (Edit Tab). o Add a new Attribute Group (Add Group).
Enable 10 PIM Administration Guide
Page 256 of 371 Revised 8/2/2019
2. Select Add Group. An Add Group pop-up window will appear.
The second way to access the Add Group pop-up window is to:
1. hover over an existing group and click the Manage Group icon. A dropdown list will appear that allows the user to:
o Create a new Attribute Group (Add Group). o Edit an existing Attribute Group (Edit Group). o Add a new attribute (New Attribute).
Taxonomy Editor: Manage Attribute Tabs/Add Attribute Group
Taxonomy Editor: Add an Attribute Group
Enable 10 PIM Administration Guide
Page 257 of 371 Revised 8/2/2019
2. Select Add Group. An Add Group pop-up window will appear.
Taxonomy Editor: Manage Attribute Tabs/Add Attribute Group
Enable 10 PIM Administration Guide
Page 258 of 371 Revised 8/2/2019
Once the Add Group window is open:
3. Edit the Add Group window values as desired:
o Name: (Required) The name of the new Attribute Group. o Description: A description of the new Attribute Group. o Collapsed dropdown list: This value determines if the new Attribute Group
should be Collapsed or Expanded when initially displayed. o Attribute Tab dropdown list: (Required) Select the Attribute Tab in which the
new Attribute Group will be displayed. Note that the selected Attribute Tab does not have to be the Attribute Tab that was selected to bring up the Add Group window.
o Group Type dropdown list: Select the type of Attribute Group to be created. There are three types of Attribute Groups:
• Attribute: For a collection of attributes.
• Link Relationship: For displaying the records of a linked repository.
• Variant: For qualifying the Category Attributes as Variants.
4. Click Apply to save the changes and return to the Taxonomy Manager. Click Cancel or the Close icon to return to the Taxonomy Manager without creating the new Attribute Group.
5. After any change to the taxonomy, clear the cache and refresh displays to ensure the change has been propagated throughout the system and displays are accurately reflecting system status.
Taxonomy Editor: Add an Attribute Group
Enable 10 PIM Administration Guide
Page 259 of 371 Revised 8/2/2019
Edit an Attribute Group
Editing an attribute group in the Taxonomy Manager requires the user to be in Expert Mode, (see Expert Mode). To edit an existing Attribute Group in the Taxonomy Manager, first open in the Taxonomy Manager the taxonomy for a repository based on the profile to be edited, (see Open Taxonomy/Hierarchy in Manager.)
1. To edit an existing Attribute Group, hover over the Attribute Group in the Category Attribute Tree. If the user has sufficient permissions, a Manage Tab icon will appear. Click the Manage Group icon. A dropdown list will appear that allows the user to:
o Create a new Attribute Group (Add Group). o Edit an existing Attribute Group (Edit Group). o Add a new attribute (New Attribute).
2. Select Edit Group. An Edit Group pop-up window will appear.
o Name: (Required) The name of the Attribute Group. o Description: A description of the Attribute Group. o Collapsed dropdown list: This value determines if the Attribute Group should be
Collapsed or Expanded when initially displayed. o Attribute Tab dropdown list: (Required) Select the Attribute Tab in which the
Attribute Group will be displayed. Note that the Attribute Group can be moved from one Attribute Tab to another by modifying the value selected in the Attribute Tab dropdown.
o Group Type dropdown list: The type of the Attribute Group. There are three types of Group Types:
• Attribute: For a collection of attributes.
• Link Relationship: For displaying a linked repositories records.
• Variant: For qualifying the Category Attributes as Variants.
4. Click Apply to save the changes and return to the Taxonomy Manager. Click Cancel or the Close icon to return to the Taxonomy Manager without creating the new Attribute Group.
5. After any change to the taxonomy, clear the cache and refresh displays to ensure the change has been propagated throughout the system and displays are accurately reflecting system status.
Add/Edit an Attribute
Adding or editing an attribute in the Taxonomy Manager requires the user to be in Expert Mode, (see Expert Mode). To add or edit an attribute via the Taxonomy Manager, first open the taxonomy in the Taxonomy Manager, (see Open Taxonomy/Hierarchy in Manager). See
Taxonomy Editor: Edit Group
Enable 10 PIM Administration Guide
Page 261 of 371 Revised 8/2/2019
the Enable 10 PIM User Guide for instructions on opening a taxonomy in the Taxonomy Manager.
To create or add an attribute:
1. Hover over the Attribute Group (in the Category Attribute Tree) in which the attribute is to belong. If the user has sufficient permissions, a Manage Tab icon will appear.
2. Click the Manage Group icon. A dropdown list will appear that allows the user to:
o Create a new Attribute Group (Add Group). o Edit an existing Attribute Group (Edit Group). o Add a new attribute (New Attribute).
3. To create an attribute, select New Attribute. A New Attribute pop-up window will appear. Except for the titles of the windows, the Edit Attribute window and the New Attribute window are the same. Skip to the step below on editing attributes.
4. To edit an existing attribute, hover over the attribute (in the Category Attribute Tree).
5. Click the Edit Attribute icon. An Edit Attribute pop-up window will appear.
Except for the titles of the windows, the Edit Attribute window and the New Attribute window are the same.
6. Edit the attribute characteristics as described in Profile Attribute Configuration Fields.
Edit Attribute
Taxonomy Editor: Add/Edit Attribute Window
Enable 10 PIM Administration Guide
Page 263 of 371 Revised 8/2/2019
7. Click the Apply button to save your changes or click the Cancel button to exit without saving your changes.
8. After any change to the taxonomy, clear the cache and refresh displays to ensure the change has been propagated throughout the system and displays are accurately reflecting system status.
15.6.3 Manage Taxonomies/Hierarchies
Open Taxonomy/Hierarchy List Tab
Taxonomies and hierarchies are both managed just about exactly the same way. This section is written to address taxonomies but almost all of it is the same for hierarchies. Any content for hierarchies that is different will be noted.
To open the list of existing taxonomies in a Model – Taxonomy tab, open the Feature Sidebar, open the Administration tab, open the Model folder, and select Taxonomy. (For a hierarchy, select Hierarchy instead of Taxonomy.)
The Model – Taxonomy tab will open.
Open Model – Taxonomy Tab
Enable 10 PIM Administration Guide
Page 264 of 371 Revised 8/2/2019
Create/Edit a Taxonomy/Hierarchy
Taxonomies and hierarchies are both managed just about exactly the same way. This section is written to address taxonomies but almost all of it is the same for hierarchies. Any content for hierarchies that is different will be noted.
To create or edit a taxonomy:
1. Open the Model – Taxonomy tab, (see Open Taxonomy/Hierarchy List Tab.)
2. Note that a taxonomy is specialized form of a code set. Editing a taxonomy is similar to editing a code set.
Model – Taxonomy Tab
Model Taxonomy Tab
Enable 10 PIM Administration Guide
Page 265 of 371 Revised 8/2/2019
To add a taxonomy, click the Add button in the Model – Taxonomy tab’s Activity Bar. A new taxonomy will be opened in an Add Code Set window. The Add Code Set window is the same as the Edit Code Set window. Continue to the next step.
To edit a taxonomy, select the taxonomy and click the Edit button in the Model – Taxonomy tab’s Activity Bar. The taxonomy will be opened in an Edit Code Set window. The Edit Code Set window is the same as the Add Code Set window. Continue to the next step.
3. The Edit Code Set window opens on the Details page. The configuration options are:
o Name: (Required) The name of the taxonomy. o Description: (Optional) A description of the taxonomy. o Code Set Folder: (Required; cannot be changed once set.) The code set folder
that holds the code sets created while managing the taxonomy. The folder must be already created before attempting to create a taxonomy. If the code set folder is not specified, an error may be generated when you attempt to save the taxonomy.
o Properties Repository: (Optional – Deprecated). A repository to hold taxonomy properties; deprecated in favor of managing properties in the Property page of the Edit Code Set window (the next page).
o Path Code: The manner in which the taxonomy node’s path is stored. For more information, see Enable 10 Basics.
o Path Format: Specifies the format of how the path is stored:
Edit Details of a Taxonomy or Hierarchy
Enable 10 PIM Administration Guide
Page 266 of 371 Revised 8/2/2019
• Delimited: Node names are separated by a period.
• Fixed: Node names are known by their position in the path.
o Source: (Required.) The source of the codes and descriptions:
• Detail Editor Tab: You will enter the node levels on the Model – Taxonomy’s Levels page.
• From an Existing Set: The codes will be copied from an existing taxonomy or code set.
• Import from a file: The codes will be imported from a file.
• Auto-build from Selected Attributes: The taxonomy will be automatically populated.
o Include Owner: An owner to maintain the code set. o User: The user name of the owner. If Include Owner is checked, this field is
required.
4. Select Next to move to the Property page.
5. Properties are optional. They are custom metadata fields that can be added to a taxonomy. The configuration options for properties are:
o Property Name: (Required) The name that will appear as the header of the property’s metadata column.
o Datatype: (Required) The data type of the property’s value. o Default Value: (Optional) A default value for the property. o Code Set: (Optional) If the property values are drawn from a code set, select the
name of the code set to be used. o Display Order: (Optional) Indicate the order the properties will be displayed.
6. After any properties have been edited as desired, click the Next button to go to the Levels page.
Edit a Taxonomy’s Property Page
Enable 10 PIM Administration Guide
Page 267 of 371 Revised 8/2/2019
7. The levels defined here are what determines the “depth” of your taxonomy tree. If you define three levels, your taxonomy will have a parent level, child level, and grandchild level.
8. To add a level, click on the Level Name field and enter the name of the level.
Click the button to the right of the Filler Value to add your level to the taxonomy definition and to open an editor for the next level.
Click on the button to the right of the Filler Value to remove a level.
If the taxonomy’s path is Fixed, the number of characters in the node name must be specified.
9. When the taxonomy configuration options have been edited as desired, click the Save button to save the taxonomy, or click the Cancel button to exit without saving the taxonomy.
The display will revert to the Model – Taxonomy list of code sets. If a taxonomy has been added, it should appear. If the new taxonomy does not appear, clear the data cache or click the Refresh button.
To populate the taxonomy, import the taxonomy (see Import a Taxonomy/Hierarchy) or open the taxonomy in the Taxonomy Manager (see Open Taxonomy/Hierarchy in Manager). See the Enable 10 PIM User Guide for more information on managing taxonomies.
Edit Taxonomy Levels
Enable 10 PIM Administration Guide
Page 268 of 371 Revised 8/2/2019
Delete a Taxonomy/Hierarchy
Taxonomies and hierarchies are both managed just about exactly the same way. This section is written to address taxonomies but almost all of it is the same for hierarchies. Any content for hierarchies that is different will be noted.
To delete a taxonomy:
1. Open the Model – Taxonomy tab, (see Open Taxonomy/Hierarchy List Tab.)
2. Select the taxonomy to delete and click the Delete button on the Model – Taxonomy tab’s Activity Bar. The taxonomy will be deleted.
Import a Taxonomy/Hierarchy
Taxonomies and hierarchies are both managed just about exactly the same way. This section is written to address taxonomies but almost all of it is the same for hierarchies. Any content for hierarchies that is different will be noted.
The Import feature work may only work on taxonomies and hierarchies whose Source has been defined as Import from a file. (See Create/Edit a Taxonomy /Hierarchy.)
The easiest way to determine the format of an import *.csv file is to export the taxonomy/hierarchy in a &.csv file. The exported *.csv file can then be modified and reimported to update the taxonomy/hierarchy. This is useful if there’s a large number of changes that need to be made. Also, instead of modifying the *.csv file directly, the file can be opened with Excel, modified, and saved as a *.csv file. The steps to import the file are shown below.
1. Open the Model – Taxonomy tab, (see Open Taxonomy/Hierarchy List Tab.)
Model Taxonomy Tab
Enable 10 PIM Administration Guide
Page 269 of 371 Revised 8/2/2019
2. Select the taxonomy for the file to be imported into and click the Import button on the Model – Taxonomy tab’s Activity Bar. The Import window will open. (In the image below, the window is mis-labeled Export.)
3. The configuration options for the Import window are:
o File Name: (Required) Click the Choose File button to select a file to import. o Import Type: Indicates the arrangement of the data elements in the file being
imported. PIMLoad is most often used. o Import File Type:
• CSV: Comma Separated Values. Typically this indicates the delimiter between fields is a comma, but this can be overridden by the Import File Delimiter.
• XLS: Excel (1997 – 2003)
• XLSX: Excel Workbook
Model Taxonomy Tab
Import a Taxonomy
Enable 10 PIM Administration Guide
Page 270 of 371 Revised 8/2/2019
o Import File Delimiter: Select the delimiter used in the file. o File Action:
• Add Code: If selected, codes in the import file that do not exist in the target taxonomy will be added to the target taxonomy.
• Update Codes: If selected, if a code in the target taxonomy has a matching code in the import file, the code in the target taxonomy will be updated with the new code from the import file.
• Delete Codes: If selected, if a code in the target taxonomy does not have a matching code in the import file, the code in the target taxonomy will be deleted.
4. To begin the import, select the Import button. The import will begin. A status message will appear at the bottom of the display to indicate the completion status of the import.
Importing a Hierarchy in Enable Classic
The easiest way to determine the format of an import *.csv file is to export the hierarchy as shown above. The exported *.csv file can then be modified and reimported to update the hierarchy. This is useful if there’s a large number of changes that need to be made. Also, instead of modifying the *.csv file directly, the file can be opened with Excel, modified, and saved as a *.csv file. The steps to import the file are shown below.
1. Log into Enable Classic.
2. Navigate to the Model Feature in the Feature bar and click on the Hierarchy function option.
3. Select the hierarchy record that you want to import data into and select the Import option under the Utilities dropdown menu.
Enable 10 PIM Administration Guide
Page 271 of 371 Revised 8/2/2019
4. Check the Import options to make sure the import will function as you desire. Click the Next button.
5. Add or remove levels, if required.
Enable 10 PIM Administration Guide
Page 272 of 371 Revised 8/2/2019
6. Click the Next button.
7. Click the Browse button and navigate to the input file.
8. Click the Open button.
Enable 10 PIM Administration Guide
Page 273 of 371 Revised 8/2/2019
Export a Taxonomy/Hierarchy
Taxonomies and hierarchies are both managed just about exactly the same way. This section is written to address taxonomies but almost all of it is the same for hierarchies. Any content for hierarchies that is different will be noted.
1. Open the Model – Taxonomy tab, (see Open Taxonomy/Hierarchy List Tab.)
Model Taxonomy Tab
Enable 10 PIM Administration Guide
Page 274 of 371 Revised 8/2/2019
1. Select the taxonomy to be exported and click the Export dropdown on the Model – Taxonomy tab’s Activity Bar.
2. Select the format for the export from the Export dropdown.
• CSV: Comma Separated Values
• XLS: Excel (1997 – 2003)
• XLSX: Excel Workbook
The download window will appear and ask where or how to save the export file. Save as desired.
Copy a Hierarchy in Enable Classic
In the event a hierarchy needs to be copied, a user with administrator permissions can create a copy through the Hierarchy Manager/Editor in a repository that uses the hierarchy. This copy function will copy an existing hierarchy and all repository items attached to nodes to a new hierarchy.
NOTE: After the copy is complete, each hierarchy is separate and changes to one hierarchy do
not affect the other hierarchy.
To copy a hierarchy:
1. Log into Enable Classic.
2. Open the Feature Bar, open the Content tab, open the repository’s group, and select the repository to open it.
Enable 10 PIM Administration Guide
Page 275 of 371 Revised 8/2/2019
3. Click on the Hierarchy tab located between Search and Saved Sets Tabs.
4. Select a hierarchy from the Choose Hierarchy dropdown.
5. Click the Copy button (to the right of the plus sign icon). A dialog will appear that asks you to name the copy of the hierarchy.
6. Enter a name for the new hierarchy.
7. Click Copy to create a copy of the hierarchy or click Cancel to exit without creating a copy.
Associate a Taxonomy with a Profile
This section only addresses taxonomies, not hierarchies. For details on registering a hierarchy with a repository, see Register a Hierarchy with a Profile.
Copy the Hierarchy via the Hierarchy Editor/Manager.
Name the New Copy of the Hierarchy
Enable 10 PIM Administration Guide
Page 276 of 371 Revised 8/2/2019
To associate a taxonomy with a profile, edit the profile to create a taxonomy node attribute and assign that attribute to the taxonomy code set. The attribute value in a particular record will hold the taxonomy path/node for that record. For more information on taxonomies, see Enable 10 Basics.
1. Open the repository’s profile for editing in a Manage Profile tab, either via Open Profiles Tab or by opening the repository’s Repository Dashboard and scrolling to the Manage Profile pane.
2. Add an attribute, (see Add a Profile Attribute), with these options:
o Data Type: VARCHAR o Data Size: Must be large enough to hold your taxonomy path. o Code Set: A taxonomy is a specialized code set. Select the name of the desired
taxonomy from the Code Set dropdown. o Special Function Indicator: Taxonomy Node Link.
3. Save the attribute.
4. To assign a record its place in the taxonomy, open the repository in a Repository View, and select the taxonomy attribute of the desired record. An Edit window will appear.
Assign Taxonomy to an Attribute
Enable 10 PIM Administration Guide
Page 277 of 371 Revised 8/2/2019
5. Use the arrow buttons to expand or collapse the taxonomy’s nodes. Select the desired node and click the Apply button to enter the node’s taxonomy into the record’s taxonomy attribute.
Register a Hierarchy with a Profile
This section addresses only hierarchies, not taxonomies. For details on associating a taxonomy with a repository, see Associate a Taxonomy with a Profile.
In order for a repository to use a hierarchy, the hierarchy must be registered with that repository’s profile. If the hierarchy was created by opening the repository in a Repository View and from there accessing the Hierarchy Manager, the hierarchy has been automatically registered with that profile.
However, if the hierarchy was created independently of a repository (via the Model – Hierarchy tab) or if the hierarchy needs to be used by repositories based on other profiles, the hierarchy must be registered with those profiles.
A hierarchy must have at least some populated nodes to be registered – it cannot be registered when it is empty. After the hierarchy is registered, nodes can be added or removed from the hierarchy through the Hierarchy Manager. For more information on hierarchies, see Enable 10 Basics.
In order for a repository to be able to access a hierarchy, the repository’s profile must have an attribute defined for the hierarchy. The attribute value in a particular record will hold the hierarchy path/node for that record. The attribute must also be assigned to the hierarchy’s code set.
Select the Taxonomy Node
Enable 10 PIM Administration Guide
Page 278 of 371 Revised 8/2/2019
To edit the repository’s profile to create a taxonomy node attribute and assign that attribute to the hierarchy code set:
1. Open the repository’s profile for editing in a Manage Profile tab, either via Open Profiles Tab or by opening the repository’s Repository Dashboard and scrolling to the Manage Profile pane.
2. Add an attribute, (see Add a Profile Attribute), with these options:
o Data Type: VARCHAR o Data Size: Must be large enough to hold your taxonomy path. o Code Set: A taxonomy is a specialized code set. Select the name of the desired
taxonomy from the Code Set dropdown. o Special Function Indicator: Taxonomy Node Link. (If the hierarchy is a
restricted hierarchy, set Special Function Indicator to Category Node Link.)
3. Save the attribute.
4. The Model – Hierarchy tab will open and display a list of the hierarchies defined in Enable.
To register a hierarchy with a repository, select the repository and use the right arrow
button to move its name from the Unregistered Views column to the Registered Views column.
Select the Profiles that can View the Hierarchy
Enable 10 PIM Administration Guide
Page 279 of 371 Revised 8/2/2019
To unregister a hierarchy with a repository, select the repository and use the left arrow
button to move its name from the Registered Views column to the Unregistered Views column.
5. Click the Save button to save your changes and exit, or click the Cancel button to exit without saving your changes.
15.6.4 Add or Edit a Hierarchy Node’s Metadata in Enable Classic
Metadata properties can be added or changed from the Hierarchy tab. To do so, it is necessary that the codeSet_metadata type repository is already set up and attached to the hierarchy with these settings:
• Set profile: [name]HierarchyProperties
• Profile type is CODE_SET_METADATA
• Metadata repository: [name]HierarchyProperties
To add to or change the metadata, follow these steps:
1. Log into the Enable Classic UI.
2. Open the repository node and select the Hierarchy tab, then select the desired hierarchy.
3. Select one of the nodes (such as "ttttt" in the example below) and click the pencil
button just above the hierarchy drop-down selection list in order to "edit" this node.
1. The Hierarchy page pops up. Select a node and click the i button to the right of the +Add button in order to edit the properties.
2. A new record editor pops up with the contents of the [name]HierarchyProperties record (if it already exists) or a blank record (if new).
Enable 10 PIM Administration Guide
Page 280 of 371 Revised 8/2/2019
3. Change or enter data and click Save.
4. Open up the [name]HierarchyProperties repository to verify.
Manage Association Groups
To create, edit or delete an association group, open a repository in a Repository Dashboard and use the buttons in the Association Group pane’s Activity Bar.
Enable 10 PIM Administration Guide
Page 281 of 371 Revised 8/2/2019
To add or remove an attribute from an association group, edit the attribute and use the Associated Group dropdown to select or de-select and association group. See Manage Profile Attributes.
Association Group Pane
Add or Remove an Attribute to an Association Group
Enable 10 PIM Administration Guide
Page 282 of 371 Revised 8/2/2019
Manage Code Sets
Code sets are created by system administrators. The data in them are usually maintained by one or more users. See the Enable 10 PIM User Guide for details on maintaining code set data.
15.8.1 Open List of Code Sets
There are two ways to find an existing code set.
• Find the code set by opening the Feature Sidebar, opening the Administration tab, opening the Code Set group, and selecting the folder the code set is stored in. The Code Sets tab will open to display a list of the code sets in that folder.
• Open the Model – Code Set tab to display a list of all existing code sets and select the code set.
To open the Model – Code Set tab to see the list of all existing code sets:
1. Open the Feature Sidebar, open the Administration tab, open the Model folder, and select Code Set.
Enable 10 PIM Administration Guide
Page 283 of 371 Revised 8/2/2019
2. The Model – Code Set tab will open, displaying a list of all the existing code sets.
Open Model Code Set
Enable 10 PIM Administration Guide
Page 284 of 371 Revised 8/2/2019
3. Either scroll through the list of code sets to find the one you want or use the sub-tabs at the top of the screen to open the folder the code set is stored in.
15.8.2 Create or Edit a Code Set
Before you can create a code set, you must have already established a code set folder – the folder the code set is to be stored in.
To create or edit a code set, perform the following steps.
1. Open the list of code sets in a Model – Code Set tab, (see Open List of Code Sets).
2. The Add Code Set and Edit Code Set pages are identical and edited in the same manner.
To edit a code set, select the code set and click the Edit button on the Model – Code Set tab’s Activity Bar. The Details page of the Edit Code Set dialog will appear.
Model - Code Set: List of Code Sets
Model - Code Set: List of Code Sets
Enable 10 PIM Administration Guide
Page 285 of 371 Revised 8/2/2019
To add a code set, click the Add button on the Model – Code Set tab’s Activity Bar. The Details page of the Add Code Set dialog will appear.
3. Edit the configuration options as desired.
o Name: (Required) The name of the code set. o Description: (Optional) A description of the code set. o Code Set Folder: (Required; cannot be changed once set.) The folder used to
store the code set. The folder must be already created before attempting to create a code set. If the code set folder is not specified, an error may be generated when you attempt to save the code set.
o Properties Repository: (Optional – Deprecated). A repository to hold code set properties; deprecated in favor of managing properties in the Property page of the Add Code set window (the next page).
o Source:
• Detail Editor Tab: You will add or codes as by returning to the Model – Code Set tab and clicking the Edit Codes button on the Model – Code Set tab’s Activity Bar.
• From an Existing Set: The codes will be copied from an existing code set or code set.
• Import from a file: The codes will be imported from a file.
• Auto-build from Selected Attributes: Automatically populate the code set.
The Add Code Set Dialog
Enable 10 PIM Administration Guide
Page 286 of 371 Revised 8/2/2019
o Include Owner: An owner to maintain the code set. o User: The user name of the owner. If Include Owner is checked, this field is
required.
4. Select Next to move to the Property page.
5. Properties are optional. They are custom metadata fields that can be added to a code set. The configuration options for properties are:
o Property Name: (Required) The name that will appear as the header of the property’s metadata column.
o Datatype: (Required) The data type of the property’s value. o Default Value: (Optional) A default value for the property. o Code Set: (Optional) If the property values are drawn from a code set, select the
name of the code set to be used. o Display Order: (Optional) Indicate the order the properties will be displayed.
6. After any properties have been edited as desired, click the Save button to save the code set or click the Cancel button to exit without saving the code set.
The display will revert to the Model – Code Set list of code sets. If a code set has been added, it should appear. If the new code set does not appear, clear the data cache or click the Refresh button.
To add codes to the new code set, follow the directions in Edit Code Set Codes .
15.8.3 Edit Code Set Codes
To edit the name, details or properties of a code set, select the code set and click the Edit button on the Model – Code Set tab’s Activity Bar. Follow the directions in Create or Edit a Code Set.
To edit a code set’s list of codes:
Edit Code Set Property Page
Enable 10 PIM Administration Guide
Page 287 of 371 Revised 8/2/2019
1. Open the list of code sets in a Model – Code Set tab, (see Open List of Code Sets).
2. Select the code set and click the Edit Codes on the Model – Code Set tab’s Activity Bar. The Codes tab will open, displaying a list of existing codes.
3. To add a code, click the Add button on the Codes tab’s Activity Bar. A new code will be created.
Model - Code Set: List of Code Sets
List of a Code Set's Codes
Enable 10 PIM Administration Guide
Page 288 of 371 Revised 8/2/2019
4. To edit a new or existing code, click the field and it will open for inline editing. To stop editing a record, click its checkbox (on, off, or on and off).
15.8.4 View Code Set History or Audit History
To view the history or audit history of a code set:
1. Open the list of code sets in a Model – Code Set tab, (see Open List of Code Sets).
2. Click on the desired code set and click the Edit Codes button in the Model – Code Set tab’s Activity Bar. The Codes tab will open.
Edit a New Code
Model - Code Set: List of Code Sets
Enable 10 PIM Administration Guide
Page 289 of 371 Revised 8/2/2019
3. To see a history of the all the codes in the code set, click the History or Audit History button in the Model – Code Set tab’s Activity Bar.
4. To see the history of one or more codes, select them then click the History or Audit History button in the Model – Code Set tab’s Activity Bar.
15.8.5 To Import Code Set
To import values into a code set:
1. Open the list of code sets in a Model – Code Set tab, (see Open List of Code Sets).
List of a Code Set's Codes
History of a Code Set's Codes
Enable 10 PIM Administration Guide
Page 290 of 371 Revised 8/2/2019
2. Select the code set to import into and click the Import button on the Model – Code Set tab’s Activity Bar.
3. The configuration fields are:
o File Name: (Required) Choose file to import. o Import Type o Import File Type o Select Import File Delimiter o File Action:
• Add Codes: Add the codes to the code set.
• Update Codes: Add codes that aren’t already in the code set; update codes that are already in the code set.
Model - Code Set: List of Code Sets
Import Code Set Values
Enable 10 PIM Administration Guide
Page 291 of 371 Revised 8/2/2019
• Delete Codes: Delete all codes in the code set and replace them with the new codes.
4. Edit the configuration options as desired, then click the Import button to start the import or click Cancel to exit without importing the file.
15.8.6 To Export a Code Set
To export codes from a code set:
1. Open the list of code sets in a Model – Code Set tab, (see Open List of Code Sets).
2. Select the desired code set and click the Export dropdown on the Model – Code Set tab’s Activity Bar.
3. Select the desired output type. A window will appear that asks where to store the file. Select the folder. The download will begin.
Manage Snapshot Tables
Repository records are stored in XML. Accessing or manipulating attribute values requires parsing the XML, which can be time-consuming. Snapshot tables are database tables that are used to store attribute values that need to be accessed quickly. There is one snapshot table per repository. To include an attribute in a snapshot table, in the repository, specify that the attribute is relational.
The benefit of using snapshot tables is that data can be manipulated quickly. The downside of using snapshot tables is that when an attribute value change, it must be updated in two places. Additionally, the more attributes added to a snapshot table, the longer it takes to access its attributes.
Model - Code Set: List of Code Sets
Enable 10 PIM Administration Guide
Page 292 of 371 Revised 8/2/2019
For an attribute to be included in a repository’s snapshot table, it must be defined as relational. This is done at the repository level so that repositories based on the same profile can have different attribute columns in their snapshot tables. When the first attribute in a repository is defined as relational, the repository’s snapshot table is created. Any additional attributes defined as relational will be added to the snapshot table. If the definition for an included attribute is later changed to not relational, the column will be removed from the snapshot table.
Managing snapshot tables and defining attributes as relational is done using the Enable Classic UI. To define a repository’s attribute as relational:
1. Log into the Enable Classic UI as a user assigned to the Administrator group.
2. Select Repositories from the Quick Links dropdown list on the top right of the screen or Model/Repositories from the left Feature bar.
3. From the Repository list, single-click to select the repository that contains the attribute(s) to add to the snapshot table.
Select Repositories from the Model Tab Select Repositories from the Quick Links
Enable 10 PIM Administration Guide
Page 293 of 371 Revised 8/2/2019
1. Select the Edit/Attribute Properties from the Action dropdown menu.
4. The Attributes Properties window will appear.
Select the Repository
Edit Attribute Properties
Enable 10 PIM Administration Guide
Page 294 of 371 Revised 8/2/2019
5. Check or uncheck the Relational checkbox for each attribute to be added to or removed from the snapshot table.
6. The attributes have been defined as desired, click the Save button at the bottom of the screen to save your changes and close the Attribute Properties window, or click Cancel to exit without saving.
Migrating the Enable Data Model
In order to migrate the Enable Data Model from one Enable server to another, for example, from Development to QA or QA to Production, the following procedure must be performed.
The types of migrations and when they need to be performed are described in the table below:
Define Attributes as Relational to Include them in the Snapshot Table
Enable 10 PIM Administration Guide
Page 295 of 371 Revised 8/2/2019
Migration When Performed
Enable Data Model Migration Code set definition changes
Addition, modification (e.g., character length, data type, etc.) or removal of attributes to any profiles
Hierarchy or Taxonomy changes (e.g., addition of new nodes)
Change to attribute order, group, or tab assignments.
Repository Migration Addition of attributes that have been added to the snapshot table.
Change of default values.
Change of assignment of Pop-Up controls and pages.
Update Snapshot Table Views Automatic on an as-needed basis.
Restart of EnterWorks Services
After any of the above steps are performed.
The Enable Data Model Migration function is performed in the Enable Classic UI. Perform the following steps to migrate the Enable data model from one Enable server to another.
NOTE: Before performing these steps, be sure there is a backup of the target Enable database in case migration failures necessitate restoring the database from the backup.
1. Log in to the source Enable (e.g., QA) Classic UI as a system administrator.
2. Click on the Migration option on the feature bar and select Migrate Out function. The Migrate Objects Out page appears.
3. Enter the name for the Migration file in the Zip and Specification file name fields. The actual file name will include a time-based number to ensure uniqueness.
4. Optionally select an existing Migration Specification file. This will pre-select the objects to be migrated.
5. Click Next. The Select Objects to Migrate page appears.
Enable 10 PIM Administration Guide
Page 296 of 371 Revised 8/2/2019
6. Click the checkbox next to any Profile in the Profiles section that has changes to be migrated. For example, if the character length of an attribute in the SKU Group repository has been increased, check the checkbox next to SKU Group.
7. If any Association groups (including order) have been changed, click the Check link at the top of the Association Groups section.
8. If any code set has been added or modified, click the checkbox next to that code set (or alternatively click the Check link at the top of the Code Set section).
9. If any changes have been made to the hierarchies or taxonomies, check its checkbox in the Hierarchies or Taxonomy section.
10. If any changes have been made to any transmission options, check its checkbox in the Transmission Options section.
11. If any changes or additions have been made to any Attribute Security Filters, check its checkbox in the Attribute Security Filters section.
12. If any changes or additions have been made to any Record Security Filters, check its checkbox in the Record Security Filters section.
13. If any changes or additions have been made to any repositories, check its checkbox in the Repositories section.
14. If any changes have been made to an Export/Publication/Syndication templates, check its checkbox in the Templates section.
15. If any changes or additions have been made to any Template Folders, check its checkbox in the Template Folders section. If the sequence has been changed on the folders, click the Check link to check all repository folders.
16. If any changes have been made to a Style Map, check its checkbox in the Style Maps section.
17. If any changes have been made to Style Map Folders, check its checkbox in the Style Map Folders section.
18. If any changes have been made to any import templates, check its checkbox in the Import Templates section.
19. Click Migrate.
20. Open the Job Monitor. The new migration job appears at the top of the list.
21. Repeatedly click Refresh to monitor the progress of the migration, until the Status shows “Completed”.
22. Copy the .zip and .msf files from the \Enterworks\shared\migration folder on
the source system (e.g., QA) to the same location on the target system (e.g., PROD).
23. Log into the target Enable (e.g., PROD) Classic UI as user system.
Enable 10 PIM Administration Guide
Page 297 of 371 Revised 8/2/2019
24. Click on the Migration option on the feature bar and select Migrate In function. The Migrate Objects In page appears.
25. Select the .zip and .msf files that were just copied to the migration folder and click Next. The Select Objects to Migrate page appears.
26. Click the Overwrite All Check link. The checkboxes for all objects in the migration are checked.
27. Click Migrate.
28. Open the Job Monitor. The new migration job appears at the top of the list.
29. Repeatedly click Refresh to monitor the progress of the migration, until the Status shows “Completed”.
30. Click the Log File icon for the Migration Log for the Migrate In job in the Job Monitor page. A window containing the migration log file contents appears.
31. Review the contents of the log to ensure the expected objects were migrated. If the errors are substantial and cannot be quickly remedied, abort the migration attempt by restoring the target Enable database from the backup.
16 System Administration
Clear Data Cache
Any time there are changes to the data model (e.g., Profiles, code sets, Taxonomies, Hierarchies, etc.), the Data Cache must be cleared to ensure the changes go into effect.
1. Log into Enable as a user who belongs to a user group with access to System and Clear Cache capabilities. (See Object Security.)
2. Open the Features Sidebar, open the System tab, and select Clear Cache.
Enable 10 PIM Administration Guide
Page 298 of 371 Revised 8/2/2019
3. Any users currently on system will get the latest data upon reloading a tab window.
Users, Groups & Security Management
To efficiently manage the Enable users’ security, EnterWorks recommends that system security is managed at the group level, meaning users are added to Enable then assigned to user groups according to the types of system responsibilities and access they are meant to have (or “roles” they can perform). (Examples of user groups are: Administrator, Product Manager, Publications Manager, or Syndication Manager. These groups are designed around each organization’s specific business processes.) Permissions are then granted to the user groups that controls which functions their members are allowed to perform and which objects they can access.
Clear Cache
Enable 10 PIM Administration Guide
Page 299 of 371 Revised 8/2/2019
16.2.1 Enable Users
User authentication can be locally managed by Enable, managed by Microsoft’s Active Directory (LDAP or LDAPS), or corporately managed via Single Sign-On. For more information on user authentication, see Enable 10 Basics.
User accounts can be created in one of two ways:
• Created locally via the Enable 2020 UI.
• Created in Active Directory and from there, automatically created in Enable: This method is discouraged due to its complexity:
o Each group a user is assigned to in Active Directory must have a corresponding group in Enable whose name is spelled exactly the same.
o Local group assignment only occurs when the user account is initially created. Any changes in group assignment either locally or by Active Directory will not be transmitted to the other system.
Once user accounts are created on Enable (either via LDAP/S or via Enable 2020 UI), their user group assignments are maintained locally, in Enable.
Manage User Accounts Locally
To create or delete a user account locally in Enable:
1. Log into Enable 2020 as an Administrator.
2. Open the Users tab: open the Feature Sidebar, open the Administration tab, open the Users and Groups folder, and select Users.
Enable 10 PIM Administration Guide
Page 300 of 371 Revised 8/2/2019
3. The Users tab will open. It displays a list of all the Enable users.
Open the Users Tab
Enable 10 PIM Administration Guide
Page 301 of 371 Revised 8/2/2019
4. To delete a user, select the user and click the Delete User on the Users tab’s Activity Bar. Skip the rest of this steps.
To add a user, complete the rest of these steps.
5. Select the Add User button from the Users tab’s Activity Bar. A new user entry will be added to the top of the list of users.
6. Double-click the attribute values to edit the user account.
Attribute Required
Login Required.
Password Required.
First Name Required.
Middle Name Optional.
Last Name Required.
The Users Tab
Enable 10 PIM Administration Guide
Page 302 of 371 Revised 8/2/2019
Attribute Required
LDA Required. Defaults to “No”.
Use Security Context Required. Defaults to “No”.
Security Context Not Required
Optional fields such as Company, Employee Number, . . . , Address, . . . , Country
Not Required
System maintained fields such as Created By, Creation Date, . . . ID.
Not Editable
7. After values have been entered for the required attributes, the new user record will automatically be sorted alphabetically into the list of users. Be careful not to accidently edit the first user in the list because your new user was automatically sorted without you noticing.
Manage Users with Active Directory
When Active Directory is configured and the user is identified as an “Is LDAP” user, Enable will validate the user password using Active Directory authentication.
The use of LDAP versus secure LDAP (LDAPS) depends on system configuration.
The LDAP protocol and port choices may also differ between development, test, QA, staging, and production based on environmental and operational requirements.
16.2.1.2.1 Configuring the Active Directory
1. Log into the Enable Classic UI as a user with Administrative privileges.
2. Click on the Users and Group feature bar.
3. Open Users and click on menu Utilities→ LDAP Configuration.
Enable 10 PIM Administration Guide
Page 303 of 371 Revised 8/2/2019
4. Check the LDAP Enabled checkbox to enable Active Directory.
5. Select Microsoft Active Directory as Provider.
6. Do not change the Context, it will update automatically.
7. Select SUBTREE_SCOPE option in the Search Scope dropdown list.
8. Enter the LDAP Server Host according to the protocol used:
• LDAP: <hostname>
• LDAPS: ldaps://<hostname>
9. Enter the LDAP Server Port. This can be the server’s port or the default value for the protocol used.
• LDAP: the default port is 389.
• LDAPS: the default port is 636.
10. Optionally, enter Search Base using standard LDAP terms.
11. Enter the full domain name for the User Context Search Base.
12. Enter the short domain name for User Default Domain.
LDAP Configuration
Enable 10 PIM Administration Guide
Page 304 of 371 Revised 8/2/2019
13. Click Save.
16.2.1.2.2 Add an Active Directory User via Enable Classic UI
For information regarding adding an Active Directory user from the Enable Classic UI, contact your Enable account representative.
16.2.1.2.3 Automatically Add an Enable User from Active Directory
To automatically add a user from Active Directory, there must exist in Enable a group whose name matches exactly the name of the Active Directory user’s group name.
When the user first logs on to Enable, if the user is authenticated, Enable will automatically add the user to the local database.
After the user has been added to the local system, any changes to the Active directory group membership will not be reflected in Enable. You must manually move the user to the appropriate group in Enable.
16.2.1.2.4 Change a Local User to an Active Directory User
To change a user’s authentication from local to Active Directory:
1. Log into Enable as an Administrator.
Enable 10 PIM Administration Guide
Page 305 of 371 Revised 8/2/2019
2. Open the Users tab: open the Feature Sidebar, open the Administration tab, open the Users and Groups folder, and select Users.
3. The Users tab will open. It displays a list of all the Enable users.
Open the Users Tab
Enable 10 PIM Administration Guide
Page 306 of 371 Revised 8/2/2019
4. Double-click the user’s LDA attribute and set the attribute value to Yes. A status message will appear at the bottom of the window, announcing that the user’s account has been updated.
16.2.2 Enable User Groups
Add a User Group
To create user group:
1. Open the Groups tab by opening the Feature Sidebar, opening the Administration tab, opening the Users and Groups folder, and selecting Groups.
The Users Tab
Enable 10 PIM Administration Guide
Page 307 of 371 Revised 8/2/2019
2. The Groups tab will appear which lists all the defined user groups. Click the Add Group button on the Groups tab’s Activity Bar.
Open the Groups Tab
Enable 10 PIM Administration Guide
Page 308 of 371 Revised 8/2/2019
3. A new group entry will be added to the top of the list of users.
4. Double-click the attribute values to edit the group as desired.
Delete a User Group
To delete user group:
1. Open the Groups tab by opening the Feature Sidebar, opening the Administration tab, opening the Users and Groups folder, and selecting Groups.
Add Group
Enable 10 PIM Administration Guide
Page 309 of 371 Revised 8/2/2019
2. The Groups tab will appear which lists all the defined user groups. Click the Delete button on the Groups tab’s Activity Bar.
Open the Groups Tab
Enable 10 PIM Administration Guide
Page 310 of 371 Revised 8/2/2019
3. A confirmation window will appear, asking if you wish to delete the group. Click Yes to delete the group.
Manage User Group Memberships
Users can be added or removed from groups through two methods:
• Manage Group Membership in the Users Tab
• Manage Group Membership in the Groups Tab
16.2.2.3.1 Manage Group Membership in the Users Tab
To manage group membership in the Users tab:
1. Open the Users tab by opening the Features Sidebar, opening the Administration tab, opening the Users and Groups folder, and selecting Users.
Delete a Group
Enable 10 PIM Administration Guide
Page 311 of 371 Revised 8/2/2019
2. The Users tab will open.
Open the Users Tab
Enable 10 PIM Administration Guide
Page 312 of 371 Revised 8/2/2019
3. Select the desired user and click the Assign Group button on the Users tab’s Activity Bar. The User – Groups dialog will open.
The Users Tab
Enable 10 PIM Administration Guide
Page 313 of 371 Revised 8/2/2019
4. To add the user to a group, select the group from the Available Groups column and click
the right-arrow button to move the group to the Selected Groups column.
To remove the user from a group, select the group from the Selected Groups column
and click the left-arrow button to move the group to the Available Groups column.
5. Click the Apply button to save your changes and exit, or click the Cancel button to exit without saving your changes.
16.2.2.3.2 Manage Group Membership in the Groups Tab
To manage group membership in the Groups tab:
1. Open the Groups tab by opening the Features Sidebar, opening the Administration tab, opening the Users and Groups folder, and selecting Groups. The Groups tab will open.
Assign a User to Groups
Enable 10 PIM Administration Guide
Page 314 of 371 Revised 8/2/2019
2. Select the desired user and click the Assign User button on the Groups tab’s Activity Bar. The Groups - Users dialog will open.
3. To add the user to a group, select the user from the Available Users column and click
the right-arrow button to move the user to the Selected Users column.
4. To remove the user from a group, select the user from the Selected Users column and
click the left-arrow button to move the user to the Available Users column.
Assign User to Group from Groups Tab
Assign Users to a Group
Enable 10 PIM Administration Guide
Page 315 of 371 Revised 8/2/2019
5. Click the Apply button to save your changes and exit, or click the Cancel button to exit without saving your changes.
Assigning Group Capabilities
Group Capabilities are functions that members of the group will be able to perform.
To edit the group’s Capabilities:
1. Open the Groups tab by opening the Features Sidebar, opening the Administration tab, opening the Users and Groups folder, and selecting Groups.
Open the Groups Tab
Enable 10 PIM Administration Guide
Page 316 of 371 Revised 8/2/2019
2. The Groups tab will open.
3. Select the group whose Capabilities you wish to edit, and click the Capability button on the Groups tab’s Activity Bar. The Capability tab will open.
Add Group Capabilities
Enable 10 PIM Administration Guide
Page 317 of 371 Revised 8/2/2019
4. Use the buttons on the tab’s Activity bar to expand and collapse the Capability Tree as desired.
5. Check and uncheck Capabilities to grant them or revoke them for the user group.
6. To save your changes, click the Save button on the Capability tab’s Activity Bar.
7. To exit the Capability tab, close the tab.
Assign Profile Tab Visibility to a Group
For users of a group to be able to see a profile’s attribute tab when they are viewing a repository based on that profile, they must have Visibility for that tab enabled. Note that setting a tab’s visibility does not change the security settings for the tab; it only makes the tab visible.
To grant Visibility for a tab:
1. Open the Groups tab by opening the Features Sidebar, opening the Administration tab, opening the Users and Groups folder, and selecting Groups.
Select Group Capabilities
Enable 10 PIM Administration Guide
Page 318 of 371 Revised 8/2/2019
2. The Groups tab will open.
Open the Groups Tab
Enable 10 PIM Administration Guide
Page 319 of 371 Revised 8/2/2019
3. Select the group whose Visibilities you wish to edit, and click the Display Attribute Tabs button on the Groups tab’s Activity Bar. The Set Display Attributes tab will open.
4. Use the buttons on the tab’s Activity bar to expand and collapse the Profile Tab Tree as desired.
Define Visibility
Select Profile Visibility
Enable 10 PIM Administration Guide
Page 320 of 371 Revised 8/2/2019
5. Check and uncheck profile tabs to grant or revoke visibility to the user group.
6. To save your changes, click the Save button on the Set Display Attributes tab’s Activity Bar.
7. To exit the Set Display Attributes tab, close the tab.
16.2.3 Impersonate a User
The Impersonate User capability allows a user with proper credentials to impersonate another role to carry out Enable tasks using the roles’ security credentials. The actions of the impersonator are logged and auditable. For more information on the Impersonate User capability, see Enable 10 Basics. For information on using the Impersonate User capability, see the Enable 10 PIM User Guide.
Note that the impersonator must have read access for the users they impersonate. Also, for security reasons, users who belong to an Administrator group are prevented from being able to impersonate a System Administrator.
Configure the Impersonator
Note: Users who belong to an Administrator group are prevented from being able to impersonate a System Administrator. In that case, the Impersonate Config window will not include the Available Users by Group and Selected Users can be Impersonated lists
The Enable Classic UI is used to give the impersonator the ability to impersonate a user. To enable this feature:
1. Log into the Enable Classic UI.
2. From the Feature Bar, open Users and Groups, and select Users to open the Users tab.
3. Select the user who will be able to impersonate, open the Action drop-down, and select Impersonate Config.
Enable 10 PIM Administration Guide
Page 321 of 371 Revised 8/2/2019
4. An Impersonate Config window will appear.
5. Check the Impersonate Enabled checkbox to enable the user to impersonate other users. Clear the checkbox to disable their ability to impersonate other users.
6. Select a user group the member belongs to.
7. To add a user who can be impersonated, select their name from the Available Users list and click the right-arrow icon to move the user to the Selected Users can be Impersonated list.
8. To remove a user who can be impersonated, select their name from Selected Users can be Impersonated list and click the left-arrow icon to move the user to the Available Users list.
Action Drop-down Impersonate Config
Configure Impersonator
Enable 10 PIM Administration Guide
Page 322 of 371 Revised 8/2/2019
9. Select OK to save your changes and exit, or select Cancel to exit the dialog without saving your changes.
Object Security
For an overview of object security, see Enable 10 Basics.
16.3.1 Attribute Security Filter Management
For more information on attribute security filters, see Enable 10 Basics.
A repository’s attribute security filters are managed in at the profile level – all repositories based on a profile will have access to all the profile’s attribute security filters.
To manage attribute security filters:
1. Open the repository’s Repository Dashboard, (see Repository Dashboard).
2. Scroll down the Repository Dashboard to the Attribute Security Filter pane.
3. To delete an attribute security filter, select it and click the Delete button on the Attribute Security Filter pane’s Activity Bar.
4. To add an attribute security filter:
Attribute Security Filter Pane
Enable 10 PIM Administration Guide
Page 323 of 371 Revised 8/2/2019
a. Click the Add button on the Attribute Security Filter pane’s Activity Bar. The new filter will be opened in a Manage Security Filter tab.
b. Edit the new attribute security filter as described in Edit an Attribute Security Filter.
Edit an Attribute Security Filter
To edit a repository’s attribute security filter:
1. Open the repository’s Repository Dashboard, (see Repository Dashboard).
2. Scroll down the Repository Dashboard to the Attribute Security Filter pane.
3. Select the desired attribute security filter and click the Edit button on the Attribute Security Filter pane’s Activity Bar. The attribute security filter will be opened in a Manage Security Filter tab, in the Details page.
Attribute Security Filter Pane
Enable 10 PIM Administration Guide
Page 324 of 371 Revised 8/2/2019
4. The Details page has two configuration fields:
o Name: (Required) The name of the attribute security filter. It is a good practice to make the name of the security filter indicate its function.
o Profile: (Not editable.) Since we are editing the security filter through a Repository Dashboard, the repository’s profile is already known.
Edit the name of the attribute security filter as desired, then click the Next button. The Attributes tab will open.
Attribute Security Filter Details
Enable 10 PIM Administration Guide
Page 325 of 371 Revised 8/2/2019
5. The repository’s attributes are displayed in their attribute tabs. Expand the attribute tabs to display the security settings for the attributes.
The Read column of checkboxes controls read access for the list of attributes; the Edit column controls edit access.
6. Check an attribute’s checkbox to grant read or write access; uncheck it to remove access.
7. There are three toggles in the Attributes’ page’s Activity Bar:
o Show All: Toggle this to On (green) to expand all attribute tabs and show all attributes. Toggle this to Off (red) to collapse all tabs and hide all attributes.
o Read All Check: Toggle this to On (green) to enable read access on all attributes, whether they are currently displayed or not. Toggle this to Off (red) to remove read access on all attributes, whether they are currently displayed or not.
Attribute Security Filter Attributes
Enable 10 PIM Administration Guide
Page 326 of 371 Revised 8/2/2019
o Edit All Check: Toggle this to On (green) to enable edit access on all attributes, whether they are currently displayed or not. Toggle this to Off (red) to remove edit access on all attributes, whether they are currently displayed or not.
8. If you have selected a profile that includes an attribute with a data type of code set, if the definition of the code set is set to Include Owners, an additional column titled Owner Edit will appear. A check in this column means that only the user defined as the owner of the code value will have edit permission to item data containing that value.
9. To save your changes, click the Apply button.
10. When you are finished editing the filter, close the Manage Security Filter tab.
The attribute security filter is now ready to be used for setting user group access to a repository’s attributes. (See Repository Security Management.)
16.3.2 Record Security Filter Management
For more information on record security filters, see Enable 10 Basics.
A repository’s record security filters are managed in the repository’s Repository Dashboard. To do so:
1. Open the repository’s Repository Dashboard, (see Repository Dashboard).
2. Scroll down the Repository Dashboard to the Record Security Filter pane.
3. To delete a record security filter, select it and click the Delete button on the Record Security Filter pane’s Activity Bar.
Record Security Filter Pane
Enable 10 PIM Administration Guide
Page 327 of 371 Revised 8/2/2019
4. To add a record security filter:
a. Click the Add button on the Record Security Filter pane’s Activity Bar. The new filter will be opened in a Manage Security Filter tab.
b. Edit the new record security filter as described Edit a Record Security Filter.
Edit a Record Security Filter
To edit a record security filter:
1. Open the repository’s Repository Dashboard, (see Repository Dashboard).
2. Scroll down the Repository Dashboard to the Record Security Filter pane.
3. Select the record security filter to be edited and select the Edit button on the Record Security Filter pane’s Activity Bar. The filter will be opened in a Manage Record Security Filter tab, in the Details page.
Record Security Filter Pane
Enable 10 PIM Administration Guide
Page 328 of 371 Revised 8/2/2019
4. Edit the details of the record security filter as desired:
o Name: (Required) The name of the record security filter. It is a good practice to use names that reflect the nature of the filter.
o Description: (Optional) A description of the filter. o Profile: (Required but not editable) Since we are creating the record security
filter from a Repository Dashboard, Enable already knows which profile to use. o Checkboxes to indicate if of the search conditions defined in the Filter
Conditions, all must be met or if it is sufficient if any of them are met.
5. When the details have been edited as desired, click the Next button. The Filter Conditions tab will open.
6. To delete a filter condition, select it and click the Delete button on the Manage Security Filter tab’s Activity Bar.
7. To add a filter condition, click the Add button on the Filter Conditions tab’s Activity Bar. A list of available attributes will be displayed.
Manage Record Security Filter Details
Enable 10 PIM Administration Guide
Page 329 of 371 Revised 8/2/2019
8. Select the attribute the to use in the search condition and click the Apply button. The attribute will be added to the Filter Conditions tab.
Select the Attribute
Enable 10 PIM Administration Guide
Page 330 of 371 Revised 8/2/2019
9. Once the attribute to be searched is defined, edit the rest of the search condition configuration fields:
o Order: The order to apply the filter conditions. o Search Value: The attribute value to be searched for in the indicated attribute. o Search Type (Contains or Exact Match): Indicates if a record’s attribute value
has to exactly match the Search Value or does it have to contain the Search Value.
o Category: If the Category checkbox is selected, the Category dropdown will display a set of values specific to the user, such as the user name.
10. To save your changes, click the Apply button. To exit the Manage Record Security Filter tab, close the tab.
16.3.3 Repository Security Management
Security access for a repository is managed in a Repository Security pane, which appears in the repository’s Repository Dashboard, (see Repository Dashboard), and can also be accessed by
Record Security Filter Search Conditions
Enable 10 PIM Administration Guide
Page 331 of 371 Revised 8/2/2019
selecting the repository in the Repository list and clicking the Manage Security button in the Repository list’s Activity Bar.
11. Record security filters, (see Record Security Filter Management), are optional. They specify search conditions to select a set of records. If no record security filter is specified, the set of selected records is all records.
Attribute security filters, (see Attribute Security Filter Management), are required. They determine of the set of selected records, which attributes are made visible to users. If no attribute security filter is specified, the default filter will be used – it makes no attributes available to users.
For each user group, select the appropriate attribute security filter, and optionally, a record security filter.
12. Scroll down through the user groups and for each group, check and uncheck the checkboxes in the permissions columns to define the group’s access permissions for the attributes visible as determined by the indicated attribute security filter and record security filter.
13. To save your changes, click the Save button in the Repository Security pane’s Activity Bar. To exit the Repository Security pane, close the Repository Security tab.
16.3.4 Profile Security Management
To manage a profile’s security:
1. Open the Manage Profile tab by opening the Feature Sidebar, opening the Administration tab, opening the Model folder, and selecting Profiles.
Repository Security Pane
Enable 10 PIM Administration Guide
Page 332 of 371 Revised 8/2/2019
2. The Profiles tab will open, displaying the profiles defined in Enable. Select the profile whose security is to be managed and click the Security button on the Manage Profile tab’s Activity Bar. The Security window will appear.
Open Profile Tab
Enable 10 PIM Administration Guide
Page 333 of 371 Revised 8/2/2019
3. For each user group, check and uncheck the Read, Write, and Delete checkboxes to grant or revoke permissions.
4. To save your changes and exit, click the Apply button. To exit without saving, click the Cancel button.
16.3.5 Taxonomy and Hierarchy Security Management
To manage security for a taxonomy or hierarchy:
1. Open the repository in a Repository View, and click the Hierarchy button on the Repository View’s Activity Bar.
Profile Security Window
Enable 10 PIM Administration Guide
Page 334 of 371 Revised 8/2/2019
2. The Hierarchy/Taxonomy Sidebar will appear. Select the desired hierarchy or
taxonomy, then click the Manage button in the Hierarchy/Taxonomy Sidebar’s Activity Bar.
Open the Hierarchy Sidebar
Open a Hierarchy or Taxonomy in Manager
Enable 10 PIM Administration Guide
Page 335 of 371 Revised 8/2/2019
3. The hierarchy or taxonomy will open in an editor. Click the Security button in the editor’s Activity Bar.
4. A Manage Security window will open.
5. For each user group, check and uncheck the Read, Write, and Delete checkboxes to grant or revoke permissions for the taxonomy or hierarchy.
Open the Hierarchy/Taxonomy Security Window
Manage Security Window
Enable 10 PIM Administration Guide
Page 336 of 371 Revised 8/2/2019
6. To save your changes and exit, click the Apply button. To exit without saving, click the Cancel button.
Workflow
Enable 10 PIM uses the EPX component, a standalone workflow application to drive automation, custom workflow processes and scheduling activities. The EPX component is comprised of a JAVA thick client application used to build and manage workflows, and browser web-based portal for users to interact with the work flow. EPX is fully integrated with the Enable PIM.
16.4.1 Workflow Properties
Workflow Properties give Enable PIM administrators the ability to configure workflow properties for a repository, based on workflow requirements. The following shows the Workflow Properties window and more information on each input field of the Workflow Properties screen.
To access the Workflow Properties window:
1. Log into the Enable Classic UI.
2. Open the Content tab, the repository’s folder, select the repository’s name, select Edit, and select Workflow Properties.
Enable 10 PIM Administration Guide
Page 337 of 371 Revised 8/2/2019
3. The Workflow Properties window will appear.
Open Workflow Properties
Enable 10 PIM Administration Guide
Page 338 of 371 Revised 8/2/2019
The configuration options on the Workflow Properties window are:
• Workflow Enabled – When checked, the repository has the ability to link to an EPX Process Flow.
• Synchronous Submission – Synchronous Submission will be checked by default. When checked, the user interface will wait for the submission to process before rendering. Normally, when a submission is large or requires time to interface with other systems, this option will not be checked so that the submission is asynchronous, meaning the user interface will not have to wait for a submission to complete in order to render.
• Process Name, Starting Point, and Work Item Name are the default work item configurations when a work item is automated.
o Process Name – Enable PIM uses the Process Name value to locate the EPX Process Name so that it knows where to send a work item.
o Starting Point – Enable PIM uses the Starting Point value to locate the starting point for an EPX process flow.
o Work Item Name – Enable PIM uses the Work Item Name to give a default name to an automated work item.
Enable 10 PIM Administration Guide
Page 339 of 371 Revised 8/2/2019
• Default Submitting EPX User – Enable PIM will login to EPX as the specified user when an automated work item is submitted.
• Submit Multiple Selected Records as a Single Work Item – When this option is checked, multiple records can be submitted as a single work item/multi-record work item to an EPX process flow. When this option is unchecked, multiple records will be submitted as individual work items.
• Lock Record from Edit – When this option is checked, any record that is part of a work item is locked for all users, except for certain user roles when the work item is at an activity for that role.
• Custom Condition Class – Allows Enable PIM Workflow to callout to customized JAVA class(es) that define customer specific processes.
• Validate After Any Update – Works in conjunction with Attributes to Update and only executes for a new submission. Upon a work item submission, all attributes within Attributes to Update will be updated with the specified value.
• Attributes to Update – Provides a list of attributes within a repository’s profile and provides the ability to specify a value that an attribute will utilize upon an update.
o Workflow Properties to Submit – This option only applies to a single record work item. Allows an admin to associate properties with a work item and gives an admin the ability to specify whether literal values or dynamic values are retrieved from a repository’s profile.
16.4.2 Enable PIM Options
The Enable PIM Options provide the ability to link an EPX activity to an Enable PIM repository. Values either reference work item properties or are literal words. Typically, an administrator will keep Repository Name, Repository Friendly Name, and Repository Id dynamic. However, in rare scenarios, they can have literal values. For instance, the activity of processing a specific image of the DAMMaster repository.
1. Log into EPX as an administrator.
2. From the Navigator, go to Process Modeling → Process Flows → <select a flow>.
Enable 10 PIM Administration Guide
Page 340 of 371 Revised 8/2/2019
3. Right click on the flow.
4. Click Open.
5. Click on the Process Flow Modeler tab.
Enable 10 PIM Administration Guide
Page 341 of 371 Revised 8/2/2019
6. Right click on a manual activity and click Properties.
7. Click on the Details tab.
Enable 10 PIM Administration Guide
Page 342 of 371 Revised 8/2/2019
Enable PIM Options
Enable 10 PIM Administration Guide
Page 343 of 371 Revised 8/2/2019
Any time you submit to a workflow, you have properties that are attached to a work item. For instance, the following properties are always attached.
• Repository Name
• Repository Friendly Name
• Repository Id
• If you submitted a preference: (Deprecated)
o Preference Name (Deprecated) o Preference Id (Deprecated)
• If you submitted a saved set:
o Saved Set Id o Saved Set Name
• If you submitted a search: (Deprecated)
o Search Name (Deprecated) o Search Id (Deprecated) o Additional Search Attribute (Deprecated)
Enable PIM Options Details
Enable 10 PIM Administration Guide
Page 344 of 371 Revised 8/2/2019
• Item Id(s): If more than one item is selected, values will be in a comma separated list format.
The following options allow you to add additional information to submit to the workflow. Anything between two percent signs is a dynamic reference to an attribute inside an associated repository’s profile.
• Task Name – Details the process flow activity.
• Task Instructions – Informs the user what actions need to be done.
• Task Role – Informs the user the role assigned to a task.
• Task Status – Allows the user to manage the status of a task. The value specified will be the default value.
• Task Icon – Requires a URL of a 16x16 icon.
• Task Notification – option to specify notifications to the user when viewing the work item in the Enable UI. This is typically set to the %workflowCommentHistory% property reference.
• Task Object – References the object the activity will act upon. If you know it will be a saved set, then specify the saved set name. If you know it will be a record, then specify the name of the record. If you leave Task Object blank, it will not appear.
• Allow Reassign – Future feature that allows users to reassign their own tasks to someone else.
• Allow Listing Send – this option controls whether or not the work item can be sent directly from the Active Work Items list on the Workflow Task Manager widget.
• Listing Viewer Type – When a user is in the Workflow Task Manager viewer, the user will be able to be redirected to:
o Editor – the Detail Editor Tab. o Listing – a record listing of repository records associated with the work item
(e.g., in the referenced saved set). o Listing Preference
• Work Item Type – References an EPX Work Item Type and allows Enable PIM to render the workflow submission screen based on the work item type selected during the initial workflow submission or upon completion of an activity. If a Work Item Type is specified (recommended), the Task Attribute JSON field is disabled.
• Task Attribute JSON – Specifies the content of the submission form when creating or advancing a work item for a repository record. This is only required if a Work Item Type is not selected. The data inside the square bracket is a JSON array object. Everything inside each curly bracket is one attribute. For each attribute, there is:
o name – name of attribute.
Enable 10 PIM Administration Guide
Page 345 of 371 Revised 8/2/2019
o default – default value. o type – determines an HTML control type.
• Type 0 – Text Box
• Type 1 – Dropdown Select Box
• Type 2 – Select Area Box
• Type 3 – Check Box
• Type 4 – Radio Selection
• Type 5 – Hidden
o list – values for the control type. o In the second attribute there is “name” : “workflowComment”.
workflowComment is a special feature that causes a viewer of an activity to append whatever the user enters into a comment history, so when the next user comes up then they can look at the comment history.
16.4.3 Work Item Types
When a record, multiple records, or a saved set are sent to a workflow, the Enable 2020 UI will display a Workflow Submission screen with multiple input fields, such as the following screen.
Enable 10 PIM Administration Guide
Page 346 of 371 Revised 8/2/2019
The Workflow Submission screen is rendered based on the specified EPX Work Item Type. A Work Item type allows admins to specify how input should be specified by a user and what input should be gathered from the user.
Creating a Work Item Type
Work Item Types are created in EPX.
1. Log into EPX as an admin.
2. From the Navigator, go to Process Modeling → Work Item Types.
Workflow Submission Screen
Enable 10 PIM Administration Guide
Page 347 of 371 Revised 8/2/2019
3. Right click on the directory Work Item Types.
4. Click New...
5. From the General tab, find the Name input field and enter “defaultSubmission.”
6. Click on the MetaData tab.
7. Right click inside the table.
8. Select Add.
Enable 10 PIM Administration Guide
Page 348 of 371 Revised 8/2/2019
9. At this point there are many different combinations of html input fields you can create. For this example, we are going to create a dropdown list.
10. Enter “workflowApproval” in the Name field.
11. Select String for the Data Type.
12. Enter “Submission Type” in the Label field. This will be the label for Enable PIM’s Workflow Submission screen.
13. Select List for the HTML Input Type.
14. Enter “approval” in the Value field. This will be the default value for the dropdown list.
15. Right click in the Possible Values table.
Enable 10 PIM Administration Guide
Page 349 of 371 Revised 8/2/2019
16. Select Add…
17. Enter “submissionList” in the Name field.
18. Right click in the table below the Name field.
Enable 10 PIM Administration Guide
Page 350 of 371 Revised 8/2/2019
19. Select Add.
20. Enter “approval” in the Code field.
21. Enter “Approval” in the Meaning field.
22. Click OK.
23. Right click in the Possible Values table again.
24. Select Add.
Enable 10 PIM Administration Guide
Page 351 of 371 Revised 8/2/2019
25. Enter “review” in the Code field.
26. Enter “Review” in the Meaning field.
27. Click OK to save the new submission value.
28. Click OK again to return to the Define the Work Item Type’s metadata window.
29. Within the Possible Values table under the Use column, click on the checkbox for the newly created possible value.
Enable 10 PIM Administration Guide
Page 352 of 371 Revised 8/2/2019
14. Click OK to return to the WorkItemType window.
15. Click Apply.
16. Click OK.
16.4.4 Open Workflow Task Manager
To open the Workflow Task Manager in a tab:
1. Open the Features Sidebar, select the Administration tab, and select Workflow Task Manager.
2. The Workflow Task Manager will open.
Open Workflow Task Manager
Enable 10 PIM Administration Guide
Page 353 of 371 Revised 8/2/2019
16.4.5 Monitor Workflow Process
Enable administrator can monitor and manually initiate workflow process from the Enable PIM application. For information on monitoring Workflow, see the Enable 10 PIM User Guide.
16.4.6 Managing Workflow Process
To manage workflow you must install and use the JAVA thick client “EPX Design Console”. From the Design console, you can monitor workflow activities, add or modify work flow activities.
1. Log onto APP server or a client box that has EPX Design Console installed.
2. Open EPX Design Console.
3. Expand the tree and log on using an administrative account.
4. Open the Process Flow Monitor by opening the Process Modeling folder, opening the Process Flows folder, right-clicking on a workflow, and selecting Monitor.
Workflow Task Manager Detail
Enable 10 PIM Administration Guide
Page 354 of 371 Revised 8/2/2019
5. Click the Play icon to view a count of all work items at each activity.
6. Click the Monitor One Work Item icon to select an individual work item to monitor.
After selecting, click the Play icon to track the flow of the work item.
Open the Process Flow Monitor
Select a Work Item for Monitoring
Enable 10 PIM Administration Guide
Page 355 of 371 Revised 8/2/2019
7. The work item flow will highlight the path the work item has taken. A green icon indicates the current location of the work item. A red icon indicates an error at that activity.
8. If an activity has error, expand the navigation menu to find the activity under the corresponding flow or sub-flow.
9. Right-click on the activity and select Work Items.
10. Double-click the work item from the list.
The Path and Status of a Work Item
View Work Items at an Activity
Enable 10 PIM Administration Guide
Page 356 of 371 Revised 8/2/2019
11. Click on the Error tab. Review the error. Once resolved, click on the Clear Error button.
16.4.7 Purge a Workflow – DO NOT USE
WARNING: Purging a workflow will delete all work items (active and completed) from the workflow, even those not visible to the user. DO NOT USE THIS FUNCTION.
Purging a workflow also clears the Locked in Workflow state for all records associated with the work items.
To purge a workflow, first open the Workflow Task Manager. This can be done either by opening a Workflow Task Manager Widget (see Enable 10 PIM User Guide) or by opening the Workflow Task Manager in a new tab.
To open it in a tab, open the Features Sidebar by selecting the Features Sidebar icon on the Tab Bar, select the Administration tab, then select Workflow Tasks. The Workflow Task Manager tab will appear.
To purge all work items (active and completed) from a workflow:
1. Select one item in the workflow and click the Purge button on the Workflow Task Manager’s Activity Bar. A confirmation window will appear:
Workflow Task Manager Detail
Enable 10 PIM Administration Guide
Page 357 of 371 Revised 8/2/2019
2. Click Yes to purge all work items.
To purge all completed work items in a workflow:
1. Select one item in the workflow and click the Purge All Completed Work Items button on the Workflow Task Manager’s Activity Bar. A confirmation window will appear.
2. To purge the workflows, click the Yes button.
16.4.8 Add a Task to PIM Worklist
To add an additional task that can be initiated from the Enable PIM work list, the workflow process first must be defined. The sharedConfig.properties file must be updated to
add the task to the configuration. Refer to the Enable 10 Installation Guide or the Enable 10 Linux Installation Guide for location of the sharedconfig.properties files. All locations must be updated.
1. Add the new task’s name to key epx.tasklist.tasks.
2. Using the new task name, add the following keys, replacing <task> with the new task name and the appropriate value for the key.
Purge Workflow: Confirm the Purge of All Work Items from a Workflow
Purge Workflow: Confirm the Purge of All Completed Work Items from a Workflow
Enable 10 PIM Administration Guide
Page 358 of 371 Revised 8/2/2019
Key Value examples Description
epx.tasklist.<task>.
name
Start PMFImport Name of task as it will appear in UI
epx.tasklist.<task>.
flowname
PMFImport Name of workflow in EPX
epx.tasklist.<task>.
startingpoint
Manual Start Starting activity for workflow
epx.tasklist.<task>.
workitemname
Manual Initiated PMFImport
Name for work item
epx.tasklist.<task>.
workitemdescription
Manual Initiated PMFImport
Description for work item.
epx.tasklist.<task>.
proplist
prop1, prop2 Optional list of property values to pass to work flow.
epx.tasklist.<task>.
props.prop1.name
test1 Name of property, substitute ”prop1” for value in prop list, repeat for each value.
epx.tasklist.<task>.
props.prop1.value
test1val Value of property, substitute ”prop1” for value in prop list, repeat for each value.
epx.tasklist.<task>.
groupList
Administrator Optional comma separated list of groups that have access to execute this task.
Enable 10 PIM Administration Guide
Page 359 of 371 Revised 8/2/2019
Key Value examples Description
epx.tasklist.<task>.
userList
admin Optional comma separated list of users that have access to execute this task.
3. All sharedConfig.properties files must be updated with the same settings.
4. Enable services must be restarted for the changes to take effect.
Configuration Files
The following configuration files have settings that are unique to an organization or an organization’s environment (i.e., DEV, QA, and Production). They include custom property files and settings within standard property files.
The folder/directory tree structure is the same for all installations; however, the location of the folder/directory tree varies depending on system configuration and operating system. In the file paths listed in this section, replace <...> with the appropriate location and use the appropriate operating system-specific path syntax.
16.5.1 Custom Property Files
Enterworks.properties
Contains customized configuration settings. This file is located in the EPX component. Anytime a change is made to this file, all the services should be restarted.
APP Server – EPX component in:
<...>\Enterworks\EPX4\DesignConsole\conf\
The settings in this file control workflow settings, email notification settings, and Promotion workflow settings.
16.5.2 EPX Property Files
config.properties
Contains the configuration settings for the EPX component. Anytime a change is made to this file the EPX services should be restarted.
Web Server – EPX component in:
Enable 10 PIM Administration Guide
Page 360 of 371 Revised 8/2/2019
<...>\Enterworks\EPX4\DesignConsole\
Generally, changes should only be made to this property file based on direction from a patch. The settings in this file setup for location of EPX folders and server host name and ports.
esjdbc.properties
Contains the configuration settings for the EPX component. Anytime a change is made to this file the EPX services should be restarted.
Web Server – EPX component in:
<...>\Enterworks\EPX4\DesignConsole\
Generally, changes should only be made to this property file based on direction from a patch. This file contains connection information to the SQL Server database. The password to database is encrypted. Use the script in:
Contains the EPX product Tomcat service settings. Anytime a change is made to this file the EPX services should be restarted.
Web Server – EPX component in:
<...>\Enterworks\EPX4\tomcat\bin\
Generally, changes should only be made to this property file based on direction from a patch. This file contains class paths to custom library files and memory setting information for the Tomcat JVM.
service.bat
Contains the EPX product JBoss service settings. Anytime a change is made to this file the EPX services should be restarted.
Generally, changes should only be made to this property file based on direction from a patch. The settings in these files are for location of EPIM folders, server host name, ports and database connection information. The password to the database is encrypted. Use the script in:
to generate the encrypted password. Additionally, these files have customizable settings for controlling triggers, promotion configuration, UI, and publication options.
WorkFlowHandlerConfig.properties
Contains configuration settings for invoking custom workflows on repository actions. Anytime a change is made to this file the EPIM services should be restarted.
Generally, changes should only be made to this property file based on direction from a patch. The settings in this file contain connection information to the database.
This file contains the EPIM product Master Tomcat service settings. Anytime a change is made to this file the EPIM services should be restarted.
Generally, changes should only be made to these property files based on direction from a patch. The files contain class paths to custom library files and log level and log file settings. The files also contain memory setting information for the JBoss JVM. Contains the EPIM product Master JBoss service settings. Anytime a change is made to these files the EPIM services should be restarted.
Contains configuration settings for the Enable DAM and PUB component. Anytime a change is made to this file the Enable IIS services should be restarted.
• Web Server – Enable web component in:
<...>\Enterworks\ EnableWeb
Generally, changes should only be made to this property file based on direction from a patch. The settings in this file setup for location of Enable folders, EPIM connection information, server timeout and database connection information. The password to database is not encrypted.
Configure Validation Levels
The initial set-up of the number of active validation levels in the shared configuration properties file is performed as follows:
Changing the number of validations and validation values in the sharedConfiguration.properties file:
Enable 10 PIM Administration Guide
Page 365 of 371 Revised 8/2/2019
Configure Google translate API
In order to activate the Google translate API for the Multi-Language Editor make sure the settings for the Google Translate API section in sharedConfig.properties for Tomcat all Jboss instances match the lines of code shown below. If the following section is not in the sharedConfig.properties files stop the services using the STOP ENTERWORKS shortcut script, then add them to the bottom of the sharedConfig.properties file and start the services again using the START ENTERWORKS shortcut script.
For users to be able to access Regional Language functionality at the login window, the following line of code allowRegionalLogin must be set to true in sharedConfig.properties for Tomcat and Jboss services.
If the lines of code shown below are not present stop the services using the STOP ENTERWORKS shortcut script, then add them to the bottom of
sharedConfig.properties files and start the services again using the START ENTERWORKS shortcut script.
There are several sets of files on Enable server that require periodic maintenance, otherwise, all disk space will eventually be used which will result in system failure.
16.6.1 Archive Files
Every time the Enable services are stopped and restarted using the Services Toolbar scripts, the log files are moved to an archive directory which has the log name, year, day, and time as the directory name. The archive directories for the three EnterWorks applications are all in:
<...>\Enterworks\logs\archive
Periodically, the older archive directories should be removed.
16.6.2 Log files
It is recommended that the log files be archived by stopping and starting the EnterWorks services every week to keep the log files short. This will prevent difficulties experienced when opening larges files and file corruption. This will also assist in troubleshooting when the files are shorter.
Enable 10 PIM Administration Guide
Page 367 of 371 Revised 8/2/2019
For Enable 10 PIM and EPX, log files reside in <...>\Enterworks\logs\ under these folders and subfolders:
• archive: This folder includes copies of logs before the last restart, (see the previous section for more information on archive logs).
• enableServer:
o cleanup o codeSet o export
• enableutilities:
o DAMReportUtility
o MonitorDAMDrop
o RegenerateDAMVariant
• enableWeb
• EPX
• pimql: This folder includes PimqlBIC logs.
Detailed Debugging
To track errors in the system it is useful to turn on detailed debugging logs, however they can produce copious log information. It is therefore recommended to perform this step only after requested to do so by EnterWorks support staff.
Anytime configuration files are modified, services that use those files must be restarted for those changes to go into effect.
Don’t turn on any config.properties debugging unless instructed by EW rep. entwerworks.properties is okay to turn on.
16.7.1 PIM System Debug Logs
To enable the Debug Logs feature,
1. Log into the Enable Classic UI as a user in the Administrator group.
2. In the Feature bar, open the System tab, and click Log Level Setting.
Enable 10 PIM Administration Guide
Page 368 of 371 Revised 8/2/2019
3. Set all the components to the level ALL and click Save.
Select Log Level Settings
Enable 10 PIM Administration Guide
Page 369 of 371 Revised 8/2/2019
4. Perform the action(s) that caused the errors.
5. Repeat steps 2 through 4, this time setting the log levels to Severe.
6. When you are finished generating the logs, it is recommended that you disable the Debug Logs feature, as the debugging logs create a large number of entries. To disable the debug logs, repeat steps 2 through 4, this time setting the log levels to Off.
16.7.2 EPX Workflow Debug Logs
There are configuration options in two files that control debug logging for workflow processes: config.properties and enterworks.properties.
The debugging logs configured in the config.properties file provide a large amount of
detailed debugging log messages. It is recommended that you disable this debug log function for daily use. To configure this function:
1. In the configuration file <...>\Enterworks\EPX\bin\config.properties:
o To enable logging: debug.out=true o To disable logging: debug.out=false
2. Restart the EPX services for the configuration change to take effect.
The debugging logs configured in the Enterworks.properties file provide detailed debugging log messages but have a smaller footprint. It is not necessary to disable this debug log function for daily use; however, you may wish to do so once the Enable system has been
Select Level of Logging
Enable 10 PIM Administration Guide
Page 370 of 371 Revised 8/2/2019
installed and live for a few months, and this debug log is not necessary. To configure this function:
1. In the configuration file <...>\Enterworks\EPX\bin\conf\Enterworks.properties:
o To enable logging: debug.enable=true o To disable logging: debug.enable=false
2. Restart the EPX services for the configuration change to take effect.
Server Maintenance
The administrator must set the server properties for system maintenance. When configured, the Enable will automatically clean up history, log files, system files, and temporary database objects. The system will cache objects for improved performance. Any changes to the underlying structure will require the administrator to clear the data cache.
To configure the automatic system clean-up jobs:
1. Log into the Enable Classic UI as a user with Administrative privileges.
2. Expand the Feature bar, open the System tab, and click on Server Properties.
3. The Server Properties window appears.
Open Server Properties
Enable 10 PIM Administration Guide
Page 371 of 371 Revised 8/2/2019
4. Check the boxes to enable the Schedule Cleanup Job feature, then set the schedule as desired.
5. The Configure Retail Product Generation configuration options are not part of Scheduled Cleanup.
6. To save the cleanup schedule, click the Save button.
