Professional Documents
Culture Documents
Revised 7/17/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®, Inc.
46040 Center Oak Plaza Suite 115
Sterling, VA 20166
Enable 10 PIM Administration Guide
Copyright © 2007-2019 EnterWorks Acquisition, Inc., a Winshuttle company. All rights reserved.
Law prohibits unauthorized copying of all or any part of this document. Use, duplication, or disclosure by
the U.S. Government is subject to the restrictions set forth in FAR 52.227-14.
“EnterWorks” and the “EnterWorks” logo are registered trademarks and “Enable PIM”, “EnterWorks
Process Exchange” and “EnterWorks Product Information Management” are trademarks of EnterWorks
Acquisition, Inc.
Windows, .Net, IIS, SQL Server, Word, and Excel are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries.
Java and all Sun and Java based trademarks are trademarks or registered trademarks of the Oracle
Corporation in the United States and other countries.
All icons and graphics, with the exception of the "e." logo, were obtained from West Coast Icons and
Design at http://www.bywestcoast.com. EnterWorks Acquisition, Inc. retains copyrights for all graphics
unless otherwise stated. All other trademarks and registered trademarks are the property of their
respective holders.
This document is furnished for informational purposes only. The material presented in this document is
believed to be accurate at the time of printing. However, EnterWorks Acquisition, Inc. assumes no
liability in connection with this document except as set forth in the License Agreement under which this
document is furnished.
Table of Contents
1 Document Conventions .................................................................................................... 10
2 Customer Support ............................................................................................................. 11
3 Overview ........................................................................................................................... 12
4 User Interfaces .................................................................................................................. 13
Supported Browsers ....................................................................................................... 13
5 Logging into Enable ........................................................................................................... 13
Logging into Enable 2020 UI ........................................................................................... 13
Logging into Enable Classic UI ........................................................................................ 14
User Dashboard/Home Page .......................................................................................... 15
6 User Dashboard ................................................................................................................ 16
Select a Dashboard ......................................................................................................... 18
Customize Dashboard Layout ........................................................................................ 18
7 Widgets ............................................................................................................................. 19
Generate Import Export Template Widget .................................................................... 19
7.1.1 Configuring Generate Import Export Template Widget ..................................... 20
Shortcuts Widget ............................................................................................................ 23
7.2.1 Open the Shortcuts Repository ........................................................................... 24
7.2.2 Delete a Shortcuts Link........................................................................................ 26
7.2.3 Add a Shortcuts Link ............................................................................................ 26
7.2.4 Edit a Shortcuts Link ............................................................................................ 27
Summary Tab Attributes.................................................................................. 28
Shortcut Types ................................................................................................. 29
System Health Widget .................................................................................................... 34
7.3.1 Configuring System Health Widget ..................................................................... 35
Workflow Task Manager Widget ................................................................................... 38
8 Templates.......................................................................................................................... 38
Import Templates ........................................................................................................... 38
8.1.1 View Import Templates ....................................................................................... 39
8.1.2 Create an Import Template ................................................................................. 39
1 Document Conventions
Convention Usage
Courier New Denotes sample code, for example, Java, IDL, and command line
font information. May be used to denote filenames and pathnames,
calculations, code samples, registry keys, path and file names, URLs,
messages displayed on the screen.
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.
2 Customer Support
EnterWorks provides a full spectrum of customer support. Check your maintenance contract for
details about the level of support purchased. A customer identification number will be issued
the first time customer support is contacted. Keep this number for future reference when using
the EnterWorks customer support service.
3 Overview
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.
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.
4. Select a Language, enter the Login ID and Password, and click the Sign In button.
5. The user’s Dashboard will appear.
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.
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.
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.
Dashboard Selector
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.
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.
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.
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.
Shortcut Widget
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.
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.
Summary Tab
(required values are marked with a *)
Shortcut Type* Defines the type of shortcut. See Shortcut Types for descriptions
of the available shortcut types.
Summary Tab
(required values are marked with a *)
Display Order Where the shortcut will If not specified, the default Display
appear in the list of shortcuts. Order (last) is used.
Shortcut Types
Additional URL Any additional parameters This value will be appended to the
Parameters necessary for the URL. URL specified.
Width The width of the dialog box or Does not appear if shortcut type is
window. Custom Tab.
Height The height of the dialog box or Does not appear if shortcut type is
window. Custom Tab.
Attribute Purpose
Width The width of the dialog box or Does not appear if shortcut
window. type is Custom Tab.
Height The height of the dialog box or Does not appear if shortcut
window. type is Custom Tab.
• 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 *.
Search Operator The relationship between the In order for this attribute to be
Search Attribute and the Search used, all the following attributes
Value. must be specified:
• Search Attribute
• Search Operator
• Search Value
Search Operator The relationship between the In order for this attribute to be
Search Attribute and the Search used, all the following attributes
Value. must be specified:
• Search Attribute
• Search Operator
• Search Value
In order for this attribute to be
Search Value The attribute value to search for.
used, all the following attributes
must be specified:
• Search Attribute
• Search Operator
• Search Value
The configuration options for the System Health Widget allow you to select the status to be
included in the widget’s display.
EPIM Job Monitor Monitor the Job Monitor, reporting the number of
queued, active, and recently failed jobs.
EPIM Application File System Verify the file system is accessible and is not out of
Access 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 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 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 The name of the starting point activity in the
Name 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.
EPX File System Verify that the EPX process can update the file
system and has not run out of disk space.
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.
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.
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.
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
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.
Standard (All Able to use VTL scripts or Default system configuration limits
versions of triggers to alter records that an import file to 1000 columns or
Enable.) have been imported. 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 Able to import files with a Not able to use VTL scripts or
9 and later only.) virtually unlimited number triggers to alter records that have
of columns. (Typically, in been imported.
files with a large number of
columns, most columns are
mapped to category
attributes.)
• 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.
Edit the Details page’s configuration options as desired. Click Next to continue to the Related
Repositories page.
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.
To add, delete or change the order of the target attributes, click the Manage Attributes button
on the Attribute Mapping page’s Activity Bar.
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.
• 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.
• 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.
3. In the Action drop-down menu, click New to set up a new import template.
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.
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.
13. Click the Browse button to create the import template based on a previously created
export file.
Reload the Import Templates Tab to See the New Import 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.
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.
NOTE: The template list displayed above can be filtered by using the Name, Root
Repository, and/or Type fields with the Apply button.
To edit an existing Export Template, select the template, open the Action drop-down
menu and click Edit.
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.
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.
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.
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.
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.
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.
NOTE: The Syndication Template list displayed above can be filtered by using the Name,
Root Repository, and/or Type fields with the Apply button.
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.
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.
12. Click the Save button (above) to go back to the Syndication Template Editor links:
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.
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.
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:
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.
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.
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.
33. Drag and drop the fields to set the order of the fields in the export file.
34. Click the Ok button.
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.
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.
Language Selection
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.
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.
4. Then click on the Languages link under the Data Model Management tab and Model
section.
NOTE: Only Active Languages can be sequenced; deactivated languages are displayed first.
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.
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:
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.
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.
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.
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.
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.
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.
19. Paste the copied files into every tomcat and Jboss instance. An example is shown below
for a multiple Jboss instances.
<Drive>:\Enterworks\EnableServer\tomcat\webapps\webcm\
WEB-INF\classes
<Drive>:\Enterworks\EnableServer\JbossMaster\standalon
e\configuration\conf
<Drive>:\Enterworks\EnableServer\JbossSlave1\standalon
e\configuration\conf
<Drive>:\Enterworks\EnableServer\JbossSlave2\standalon
e\configuration\conf
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.
• 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).
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.
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.
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.
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.
1. Open the More dropdown list from the Repository View’s Activity Bar.
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.
Package Promotions
For an overview of the Package Promotion process, see Enable 10 Basics.
Attribute Description
Attribute Description
Parent Link Relationship Name Name of link relationship associating this repository with its
parent (blank if the top level).
Promotion Raise Validation Raise the validation level for records in this repository if Yes.
Level
Attribute Description
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.
Open Promotions
Promotions Repository
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.
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”.
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.
Attribute Description
Code Set Full If set to “Yes”, the code set import file fully replaces the existing
Replacement 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”.
Attribute Description
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”
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).
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).
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 Execute dependent operation immediately if Yes when this job
Operation Immediate fails with an error.
Error Dependent List of operation types for each Dependent Operation when this
Operation Type job fails with an error.
Export – launch an export job
Import – launch an import job
Promotion – launch a promotion job
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.
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.
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 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 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.
Attribute Description
Import Priority Priority of import controls order which jobs are checked. The
lower the number, the higher the priority.
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).
Attribute Description
Last Scheduled Import Date and time of when scheduled import was last processed
Datetime
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.
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 File Import file must be preprocessed using the designated class and
arguments if “Yes”.
Attribute Description
Repository View Name of mapping view for Repository Import. Mappings are
Mapping 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).
Schedule Days Identifies the days of the week if Schedule Type is “Days of Week”
Schedule Exclude Dates If set to a code set listing dates as code values, the scheduling
Code Set 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
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 Used to control the order of scheduled jobs in the Scheduled
Sequence 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.
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 Delete File Delete file from FTP server if Yes (default)
From Server
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 User FTP Server user name if Source Type is FTP
Source FTP User FTP Server user password if Source Type is FTP
Password
Source Type Type of Source for Import (File or FTP). Default is File
Attribute Description
Template Timeout Number of minutes before the processing for a Template import
(Minutes) 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.
Attribute Description
Attribute Description
Import Errors Lists the details for the cause of the import to fail (when the
Import Status is “Error”).
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.
Property Description
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.
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 This allows the user to select if all or any one of the conditions
(AND/OR) (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 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.
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 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”
Attribute Description
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).
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)
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 Execute dependent operation immediately if Yes when this job
Operation Immediate fails with an error.
Error Dependent List of operation types for each Dependent Operation when this
Operation Type 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 Execution Date and time at which this export was last executed.
Datetime
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.
Attribute Description
Export Include Null Values Include Null Values in XML Export 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.
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.
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 Date and time of when last DELTA export was executed
Datetime
Last Scheduled Export Date and time the export was last scheduled
Datetime
Linked Repository Name Optional list of repositories included in the Export Template
Linked Repository Saved Saved set to be used for each corresponding linked repository to
Set identify which linked records are to be included.
Linked Search Repository For more information on Linked Search Repository Name,
Name contact your Enable account representative.
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”.
Attribute Description
Output Null Extended [DEPRECATED] Include extended attributes that are empty or
Value 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 File Export file must be postprocessed after being generated using
the designated class and arguments if “Yes”.
Publication As Of Date Effective date for Export Template type if not the current date
and time.
Attribute Description
Repository Format Format for Repository type export (e.g., CSV, XLS, XML, or DB)
Repository Timeout Number of minutes before a Repository type export has timed
(Minutes) out.
Root Repository Saved Saved set for root repository in Template export.
Sets
Root Repository Search List of predefined searches on the root repository to be applied
Configs to limit the records in the export.
Schedule Days Identifies the days of the week if Schedule Type is Days of Week
Schedule Exclude Dates If set to a code set listing dates as code values, the scheduling
Code Set logic will skip to the next scheduled date if the calculated date is
one of the dates in the code set.
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 Used to control the order of scheduled jobs in the Scheduled
Sequence 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.
Attribute Description
Target Path Directory location for export file if Export Type is File
Updated Attribute Name [DEPRECATED] Name of attribute represented date and time the
data in a record was last updated.
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]’
Attribute Description
# 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
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).
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 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
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.
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.
3. Click the Add button on the Repository View’s Activity Bar. A new Scheduled Export
record appears in the Detail Editor Tab.
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.
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.
3. In the Feature Sidebar, open the Repository tab, open the Scheduled Activities group,
and open the Scheduled Exports repository.
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:
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.
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.
Property Description
Property Description
Classpath Description
com.enterworks.services. Copies the DAM assets for the records in the export
exports.MoveDamAssets file to the Portal PIM. The export file must include the
FilePath attribute which is removed from the final file
after processing.
Classpath Description
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.
7. The argument values can be changed and saved by clicking Update Attributes.
Arguments:
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:
The BaseCustomProcessFile class has a set of methods that help minimize the amount
of coding required in a processing block class:
• boolean doesFileExist(String directoryName, String
fileName)
o Returns true if the specified file in the specified directory exists.
• void logDebug(String message)
o Generates a message in the log file if debug logging is enabled
(debugEnabled=true) in the Enterworks.properties file
• void logReport(String message)
o Adds a line to the import or export report file.
• void logError(String message)
o Adds a line to the EPX BIC log file.
• void logError(StringBuffer msgs, String message)
o Adds a line to the EPX BIC log file and to the Errors attribute for the Scheduled
Import Job or Scheduled Export Job record.
• void updateImportStatus(String recordsProcessed, String
recordsUpdated, String recordsCreated, String
recordsDeleted, String recordsWithErrors, String status,
String importErrors)
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.
• void updateExportStatus(String recordsProcessed, String
recordsWithErrors, String status, String exportErrors)
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.
• void updateExportStatus(String recordsProcessed, String
recordsWithErrors, String status, String downloadLink,
String exportErrors)
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.
• BufferedReader newInput(String directoryName, String
fileName, String charSet)
o Opens a CSV or TXT file for reading.
• void closeInput(BufferedReader br)
o Closes the opened CSV or TXT file.
• PrintWriter newOutput(String directoryName, String
fileName, String encoding)
o Opens a CSV or TXT file for writing.
• void closeOutput(PrintWriter output)
o Closes the opened CSV or TXT file.
• String[] simpleParseHeader(String headerLine, String
delimiter)
o Parses the header line using the designated delimiter. Delimiter is passed to the
String.split() method.
• String[] parseHeader(String headerLine, String delimiter)
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.
• HashMap parseLine(String line, String[] header, String
delimiter)
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.
• void removeCharacter(HashMap parsedLine, String character)
o Removes the designated character from each parsed value.
• void convertToBoolean(HashMap parsedLine, String column)
o Convers the values “Y” or “Yes” to 1 and everything else to 0 for the designated
column.
• void insertDecimal(HashMap parsedLine, String column, int
decimalPosition)
o Inserts a decimal point character in a value at the designated number of digits
from the right.
• void clearBadDate(HashMap parsedLine, String column)
o Clears the date value if it is not 10 characters (in mm/dd/yyyy format) or is an
invalid date (e.g., 00/00/0000).
• void reactivateRecord(HashMap parsedLine, HashMap
inactiveRecords, TreeMap primaryKey, String
reactivateColumnName)
o Reactivates a record that was previously inactivated but is now in the import file.
• void outputHeaderLine(PrintWriter output, String[] columns,
String delimiter)
o Outputs the header line with each column separated using the specified
delimiter.
• void outputParsedLine(PrintWriter output, HashMap
parsedLine, String[] columns, String delimiter)
o Outputs a line using the parsed values and the designated delimiter.
• ArrayList extractFiles(String directoryName, String
fileName, String fileEncoding, StringBuffer msgs)
o Extracts the contents of a zip file and returns a list of unzipped files.
Scheduling Promotions
Staging records can be promoted manually via the UI, by the Package Promotion workflow, or
automatically using the following Scheduled Promotions functionality.
Attribute Description
Attribute Description
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”
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.
Attribute Description
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.
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.
Promotion Configuration Configuration name for the promotion. Must match a named
Name configuration in the EPIM sharedConfig.properties file.
Promotion Priority Relative priority for each promotion (the lower the number, the
higher the priority).
Promotion Skip Validation Skips the validation step and relies on current validation status
if Yes.
Attribute Description
Promotion Timeout Number of minutes the Promotion job will wait for the Enable
(Minutes) 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 If set to a code set listing dates as code values, the scheduling
Code Set 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
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 Used to control the order of scheduled jobs in the Scheduled
Sequence 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.
Attribute Description
Promotion Execution Date and time of when this promotion was executed.
Datetime
Property Description
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.
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.
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.
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.
Add a Channel
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).
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.
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.
Delete a Channel
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
Type of Edit to Profile Effects on Repository Attributes and the Snapshot Table
Add a default value to The repository attribute values in existing repositories will
a profile attribute. 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 Attribute values in existing records will not be changed.
code set. 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 Affected records in repositories and snapshot tables that use
code set. 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.
Manage Folders
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.
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.
Add a Folder
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.
2. The Profiles tab will open, displaying the profiles defined in Enable.
Profiles Tab
3. To open a profile for editing in a Manage Profile tab, click the Edit button on the
Profiles 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.
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.
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.
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.
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.
• 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.
Profile Types
Type Description
EPIM Used for generic repositories. Most profiles are of this type.
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.
ENABLE_READY Deprecated.
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.
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.
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.
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 table describes each control type within the Enable system.
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.
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.
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.
• 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
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.
• 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.
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.
Select the tab and click the Delete button on the Tabs pane/tab’s Activity Bar.
• 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.
Groups Pane
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.
Groups Pane
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
To delete an attribute group, select it and click the Delete button on the Groups pane’s Activity
Bar.
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.
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.
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
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 (
) as T1 WHERE 1=1
Example queries:
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])
select InternalRecordId,
'Marketing Ad: ' + [Marketing Ad ID] + ' has no Main image'
as ErrorMessage
from PIM_MarketingAd_Staging
where InternalRecordId not in
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
• 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.
The configuration options on the Manage Rule editor’s Details page are:
Call Out Required The JAVA class process that will Call Out
alter the assigned attribute. Pre-save Call Out
(See Callout and Pre-Save
Callout.)
Class Path Required Specifies the class path for the Call Out
JAVA class process that will alter Pre-save Call Out
the assigned attribute. (See
Callout and Pre-Save Callout.)
Bulk Rule Required The text of the SQL query Bulk Callout
Text performed on the set of records
being validated.
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.
Any Optional Indicates that all the conditions listed must be met for
Conditions the rule to be applied.
Valid
All Conditions Optional Indicates that if any of the conditions listed are met,
Valid the rule will be applied.
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.
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.
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.
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.
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.
Repositories Tab
3. On the Repositories tab Activity Bar, open the Action drop-down and select New. A
New Repository window will appear.
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.
6. When you are finished editing the repository’s attribute properties, select Next. The
final configuration options appear.
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.
Repositories Tab
Repository Dashboard
3. Click the open icon to the right of the repository’s name. The repository’s
Repository Dashboard will be opened.
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.
Repository Dashboard
• Groups
• Attributes
• Link Relations
• Import Templates
• Export Templates
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.
Multilingual Icon
Below is a summary of the panes appearing in the Repository Dashboard. The following
sections of this document detail the functioning of each pane.
Tabs • Add
• Edit
• Delete
• Reorder
Groups • Add
• Edit
• Delete
Groups Pane
Tabs Pane
Validation Model
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.
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).
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.
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.
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.
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.
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
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.
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.
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.
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.
Taxonomy Manager/Editor
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.
Taxonomy Manager
Taxonomy Manager
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.
Taxonomy Editor
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).
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.
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.
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).
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
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).
Edit Attribute
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.
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.
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.
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:
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.
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.
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.)
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.)
Import a Taxonomy
3. Select the hierarchy record that you want to import data into and select the Import
option under the Utilities dropdown menu.
4. Check the Import options to make sure the import will function as you desire. Click the
Next button.
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.)
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.
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.
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.
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.
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.
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.
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.
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.
2. The Model – Code Set tab will open, displaying a list of all the existing code sets.
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.
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.
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.
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 .
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.
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).
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.
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.
2. Select the code set to import into and click the Import button on the Model – Code Set
tab’s Activity Bar.
• 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.
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.
3. From the Repository list, single-click to select the repository that contains the
attribute(s) to add to the snapshot table.
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.
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.
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.
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.
Clear Cache
3. Any users currently on system will get the latest data upon reloading a tab window.
3. The Users tab will open. It displays a list of all the Enable users.
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.
Attribute Required
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.
LDAP Configuration
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.
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.
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.
Add Group
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.
2. The Groups tab will appear which lists all the defined user groups. Click the Delete
button on the Groups tab’s Activity Bar.
Delete a Group
3. A confirmation window will appear, asking if you wish to delete the group. Click Yes to
delete the group.
3. Select the desired user and click the Assign Group button on the Users tab’s Activity
Bar. The User – Groups dialog will open.
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.
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.
5. Click the Apply button to save your changes and exit, or click the Cancel button to exit
without saving your changes.
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.
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.
Define Visibility
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.
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.
Configure Impersonator
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.
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.
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:
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.
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.
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.
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.)
3. To delete a record security filter, select it and click the Delete button on the Record
Security Filter pane’s Activity Bar.
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.
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.
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.
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.
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.
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.
3. The hierarchy or taxonomy will open in an editor. Click the Security button in the
editor’s Activity Bar.
5. For each user group, check and uncheck the Read, Write, and Delete checkboxes to
grant or revoke permissions for the taxonomy or hierarchy.
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.
• 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.
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)
• 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.
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.
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.
12. Enter “Submission Type” in the Label field. This will be the label for Enable PIM’s
Workflow Submission screen.
14. Enter “approval” in the Value field. This will be the default value for the dropdown list.
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.
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.
11. Click on the Error tab. Review the error. Once resolved, click on the Clear Error button.
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.
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
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.
<...>\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:
<...>\Enterworks\EPX4\DesignConsole\getEncryptedString.bat
to get the encrypted password.
service.bat
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.
Web Server – EPX component in:
<...>\Enterworks\EPX4\Jboss\modules\system\layers\base\nati
ve\sbin\
Generally, changes should only be made to this property file based on direction from a patch.
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.
• WEB Server – EPIM Master JBoss component in:
<...>\Enterworks\EnableServer\jbossMaster\standalone\c
onfiguration\conf
• APP Server – EPIM Slave 1 JBoss component in:
<...>\Enterworks\EnableServer\jbossSlave1\standalone\c
onfiguration\conf
• APP Server – EPIM Slave 2 JBoss component in:
<...>\Enterworks\EnableServer\jbossSlave2\standalone\c
onfiguration\conf
• APP Server – EPIM Slave 3 JBoss component in:
<...>\Enterworks\EnableServer\jbossSlave3\standalone\c
onfiguration\conf
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.
• <...>\Enterworks\EnableServer\tomcat\bin\service.bat
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.
• <...>\Enterworks\EnableServer\jbossMaster\bin\service\servi
ce.bat
• <...>\Enterworks\EnableServer\jbossSlave1\bin\service\servi
ce.bat
• <...>\Enterworks\EnableServer\jbossSlave2\bin\service\servi
ce.bat
• <...>\Enterworks\EnableServer\jbossSlave3\bin\service\servi
ce.bat
• <...>\Enterworks\EnableServer\jbossMaster\bin\standalone\st
andalone.conf.bat
• <...>\Enterworks\EnableServer\jbossSlave1\bin\standalone\st
andalone.conf.bat
• <...>\Enterworks\EnableServer\jbossSlave2\bin\standalone\st
andalone.conf.bat
• <...>\Enterworks\EnableServer\jbossSlave3\bin\standalone\st
andalone.conf.bat
• <...>\Enterworks\EnableServer\jbossMaster\bin\standalone\st
andalone.bat
• <...>\Enterworks\EnableServer\jbossSlave1\bin\standalone\st
andalone.bat
• <...>\Enterworks\EnableServer\jbossSlave2\bin\standalone\st
andalone.bat
• <...>\Enterworks\EnableServer\jbossSlave3\bin\standalone\st
andalone.bat
web.config
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.
#######################################################################
#Google Translate API
#######################################################################
google.translate.enabled=1
google.translate.refer.site=52.0.11.117
google.translate.key=AIzaSyAFTHWpMaso5FbWQMil-gh9J0wWvT1MzO0
#######################################################################
#Specify if ‘Regional Login’ link is available on the Login Page
#######################################################################
allowRegionalLogin=true
• <...>\Enterworks\EnableServer\tomcat\webapps\webcm\WEB-
INF\classes\sharedConfig.properties
This change must also be added to the Jboss Server(s) depending on:
• If the setup is a single Jboss Server:
<...>\Enterworks\EnableServer\jboss\standalone\configu
ration\conf\sharedConfig.properties
• If the setup is a Master Jboss Server with Slaves:
<...>\Enterworks\EnableServer\jbossMaster\standalone\config
uration\conf\sharedConfig.properties
<...>\Enterworks\EnableServer\jbossSlave1\standalone\config
uration\conf\sharedConfig.properties
<...>\Enterworks\EnableServer\jbossSlave2\standalone\config
uration\conf\sharedConfig.properties
<...>\Enterworks\EnableServer\jbossSlave3\standalone\config
uration\conf\sharedConfig.properties
File Maintenance
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.
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.
3. Set all the components to the level ALL and click Save.
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.
Server Properties
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.