Enable Product Information Management (PIM) · Enable PIM Administration Manual Page 11 of 300...

Enable

Product Information Management (PIM)

Administrator’s Manual

Version 9

Enable9 1.0.38 Build 09282018_1909

EnableServer 9.0 Build 09262018_1228

Revised 10/2/2018

EnterWorks®, Inc.

46040 Center Oak Plaza Suite 115

Sterling, VA 20166

Enable PIM Administration Manual

Page 2 of 300 Revised 10/2/2018

©EnterWorks Acquisition, Inc. Loudoun Tech Center 46040 Center Oak Plaza Suite 115 Sterling, VA 20166 1.888.242.8356 (Sales and General Information) 1.888.225.2705 (U.S. Support) http://www.enterworks.com EnterWorks ® Enable PIM™ Administrator’s Manual Version 9 Copyright © 2007-2018 EnterWorks Acquisition, Inc. 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. Oracle is a registered trademark and Oracle 10g is a trademark of Oracle Corporation. Pentium is a registered trademark of Intel Corporation in the United States and other countries. JBoss is a registered trademark of Red Hat, Inc. All other trademarks and registered trademarks are the property of their respective holders. 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 ...................................................................................................... 9

2. Customer Support ............................................................................................................. 10

3. Overview ........................................................................................................................... 11

4. Logging into Enable ........................................................................................................... 12

5. Quick Start Guide .............................................................................................................. 14

6. Home Page Report Widgets .............................................................................................. 15

6.1 Administrative Report Widgets ...................................................................................... 15

6.1.1 Creating a Shortcut Widget ................................................................................. 15

6.1.2 Creating a System Health Widget ....................................................................... 19

6.2 Defining User Group Home Page ................................................................................... 23

6.3 Switching to Other Group Views .................................................................................... 26

7. Managing Attributes ......................................................................................................... 27

7.1 Adding an Attribute to a Repository .............................................................................. 27

7.1.1 Attribute Details .................................................................................................. 29

7.2 Making an Attribute a Search Filter ............................................................................... 33

8. Managing Taxonomies and Hierarchies ............................................................................ 36

8.1 Registering a Hierarchy .................................................................................................. 36

8.2 Exporting a Hierarchy ..................................................................................................... 38

8.3 Importing a Hierarchy .................................................................................................... 41

8.4 Copying a Hierarchy ....................................................................................................... 44

8.5 Creating a Restricted Hierarchy ..................................................................................... 44

8.6 Adding and Changing a Node’s Metadata ...................................................................... 47

9. Creating Code Sets ............................................................................................................ 49

10. Export Templates .............................................................................................................. 53

11. Syndication Templates ...................................................................................................... 53

12. Import Templates.............................................................................................................. 54

13. Multiple Language Support ............................................................................................... 54

13.1 Access the Language List Function ............................................................................. 54

13.2 Maintaining Supported Languages ............................................................................. 56



13.3 Defining an Attribute with Multiple Languages ......................................................... 58

13.4 Entering Multiple Languages ...................................................................................... 61

13.5 Browser Specific Language Settings ........................................................................... 63

14. Translating Data Model Entities........................................................................................ 63

14.1 Exporting Data Model Entities for Translation ........................................................... 64

14.2 Import Data Model Translations into EPIM ................................................................ 68

15. Translating Enable Labels and Messages .......................................................................... 69

16. Validation Levels and Rules .............................................................................................. 73

16.1 Understanding Validation Levels and Rules ............................................................... 73

16.2 Design the Validation Rules for each level ................................................................. 74

16.3 Create a New Validation Rule ..................................................................................... 76

16.4 Assign/Unassign Existing Validation Rule to an Existing Attribute............................. 85

16.5 Defining Attribute Validation Rules for Validation Levels .......................................... 90

16.6 Assigning multiple attributes to a Validation Rule. .................................................... 96

16.7 Setting a Syndication/Export’s Validation Level ......................................................... 99

16.8 Setting a Record’s Validation Level ............................................................................ 99

17. Managing Digital Assets .................................................................................................... 99

17.1 Bulk Importing Digital Assets .................................................................................... 100

17.2 Batch Importing Digital Asset Metadata .................................................................. 101

18. Using Category Attributes ............................................................................................... 104

18.1 Managing Category Attributes from the Taxonomy List .......................................... 104

18.2 Managing Category Attributes from Repository List View ....................................... 112

19. Using Staging and Production Repositories .................................................................... 115

19.1 Staging vs. Production Repositories ......................................................................... 115

19.2 Manually Promoting Records ................................................................................... 116

19.3 Manually Promoting a Repository ............................................................................ 117

19.4 Review difference from Production ......................................................................... 118

20. Using Package Promotions ............................................................................................. 119

20.1 Package Promotion ................................................................................................... 119

20.2 Package Promotion Repository ................................................................................ 120

20.3 Defining a Data Package ........................................................................................... 121



21. Job Scheduling ................................................................................................................ 124

21.1 Scheduling Imports ................................................................................................... 124

21.1.1 Scheduled Imports Repository ...................................................................... 124

21.1.2 Scheduled Import Jobs Repository ................................................................ 132

21.1.3 Scheduled Import Configuration Properties ................................................. 133

21.2 Scheduling Exports ................................................................................................... 134

21.2.1 Scheduled Export Repository ........................................................................ 134

21.2.2 Scheduled Export Jobs Repository ................................................................ 142

21.2.3 Creating a Scheduled Repository export ....................................................... 144

21.2.4 Creating a Scheduled View/DataMart Export ............................................... 147

21.2.5 Creating a Scheduled Template Export ......................................................... 150

21.2.6 Scheduled Export Configuration Properties .................................................. 156

21.3 Implementing Pre- or Post-Processing ..................................................................... 156

21.3.1 Pre/Post-Processing Block ............................................................................. 160

21.4 Scheduling Promotions ............................................................................................. 164

21.4.1 Scheduled Promotions Repository ................................................................ 164

21.4.2 Promotion Jobs Repository ........................................................................... 168

21.4.3 Scheduled Promotion Configuration Properties ........................................... 169

22. Data Model Management ............................................................................................... 169

22.1 Managing Profiles ..................................................................................................... 170

22.1.1 Profiles ........................................................................................................... 170

22.1.2 Profile Types .................................................................................................. 173

22.1.3 Profile Properties ........................................................................................... 174

22.1.4 Profile Property Rules .................................................................................... 175

22.1.5 Profile Attributes ........................................................................................... 177

22.2 Managing Snapshot Tables ....................................................................................... 178

22.3 Creating/Updating Enable Snapshot Tables ............................................................. 178

22.4 Auto-Generated Sequence Maintenance ................................................................. 181

22.4.1 Defining the Sequence Attribute ................................................................... 181

22.5 Adding a Sequence Definition .................................................................................. 182

22.5.1 Adjusting the Starting Sequence Number ..................................................... 186



22.6 Repository Link Management .................................................................................. 189

22.6.1 Managing the attributes displayed in link tables .......................................... 190

22.7 Managing the Custom Controls to select linked data .............................................. 195

22.8 Migrating Enable Data Model ................................................................................... 197

22.8.1 Common Attribute Migration ........................................................................ 198

22.8.2 Enable Data Model Migration ....................................................................... 199

22.8.3 Repository Property Migration ...................................................................... 201

22.8.4 Migrating Objects .......................................................................................... 201

23. System Administration .................................................................................................... 202

23.1 Enable Environments ................................................................................................ 202

23.1.1 Enable PIM ..................................................................................................... 203

23.1.2 Enable DAM & PUB ........................................................................................ 204

23.1.3 Stopping and Starting Services ...................................................................... 204

23.1.4 Configuration Files ......................................................................................... 205

23.1.5 Custom Property Files.................................................................................... 205

23.1.6 EPX Property Files .......................................................................................... 206

23.1.7 EPIM Property Files........................................................................................ 206

23.1.8 Configuring Google translate API .................................................................. 209

23.1.9 Regional Language Login Access.................................................................... 209

23.1.10 Changing the Enable Database Password ..................................................... 210

23.2 Users Groups & Security Management .................................................................... 212

23.2.1 Enable Groups................................................................................................ 212

23.2.2 Enable Users .................................................................................................. 222

23.2.3 Managing Users with Active Directory .......................................................... 222

23.2.4 Configuring the Active Directory ................................................................... 222

23.2.5 Adding Active Directory Users ....................................................................... 224

23.2.6 Automatically adding user from Active Directory ......................................... 224

23.2.7 Changing Local User to Active Directory user ............................................... 224

23.2.8 Adding or Removing a Local User .................................................................. 225

23.2.9 Attribute Security Filter Management .......................................................... 231

23.2.10 Record Security Filter Management .............................................................. 237



23.3 Configuring a Group’s Home Page Desktop ............................................................. 242

23.4 Configuring a Repository’s Edit Screens ................................................................... 243

23.4.1 Tabs ................................................................................................................ 244

23.4.2 Groups ........................................................................................................... 246

23.4.3 Group Assignment ......................................................................................... 249

23.4.4 Attribute Order .............................................................................................. 253

23.5 Workflow .................................................................................................................. 255

23.5.1 Workflow Properties ..................................................................................... 255

23.5.2 Enable PIM Options ....................................................................................... 257

23.5.3 Work Item Types ............................................................................................ 262

23.5.4 Monitor Workflow Process ............................................................................ 268

23.5.5 Managing Workflow Process ......................................................................... 270

23.5.6 Purging Completed Work Items .................................................................... 272

23.5.7 Adding Task to Enable PIM Worklist ............................................................. 275

23.6 File Maintenance ...................................................................................................... 276

23.6.1 Archive Files ................................................................................................... 276

23.6.2 Log files .......................................................................................................... 277

23.7 Detailed Debugging .................................................................................................. 277

23.7.1 Debugging EPX Work FLOWs ......................................................................... 278

23.8 Server Maintenance ................................................................................................. 279

23.8.1 Configure System Properties ......................................................................... 279

23.8.2 Clear Data Cache ............................................................................................ 279

23.8.3 Adding access to Jasper Report server .......................................................... 280

23.9 Services ..................................................................................................................... 281

23.10 Enable Utilities .......................................................................................................... 282

23.10.1 DAM Report Utility ........................................................................................ 282

23.10.2 Monitor DAM Drop Utility ............................................................................. 283

23.10.3 Regenerate DAM Variant Utility .................................................................... 284

24. Channel Readiness .......................................................................................................... 285

24.1 Creating a Channel Manager User Group ................................................................ 285

24.2 Creating a Channel Readiness Widget ...................................................................... 286



24.3 Creating a Channel Readiness Shortcut ................................................................... 287

24.4 Configuring Scheduled Statistic Update ................................................................... 287

24.5 Creating a Channel.................................................................................................... 288

24.6 Editing a Channel ...................................................................................................... 297

24.7 Deleting a Channel .................................................................................................... 299



1. Document Conventions

This EnterWorks document uses the following typographic conventions:

Convention Usage

pathnames Pathnames are shown with backslashes, as for Windows systems.

Courier New

font

Denotes sample code, for example, Java, IDL, and command line information. May be used to denote filenames and pathnames, calculations, code samples, registry keys, path and file names, URLs, messages displayed on the screen.

If italicized and in angle brackets (< >), it denotes a variable.

Calibri Font (bold) When used in body text, it denotes an object, area, list item, button, or menu option within the graphical user interface; or a database name or database-related object. (Examples: the Save button; the Product tab; the Name field; the SKU repository)

Can also be used to denote text that is typed in a text box. (Example: Type “trackingNo” in the Name field)

Blue underlined text Words, phrases or numbers in blue are active links that can be clicked. Clicking these active links will bring the user to the required information, steps, pages chapters, or URL.

http://www.enterworks.com/



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.

How to reach us Comments

On the Web:

http://support.enterworks.com

Via email:

[email protected]

For detailed discussions of hardware, software, configuration issues, or Helpdesk credentials, contact your EnterWorks representative.

Phone:

U. S. Support

1. 888. 225. 2705

Support hours are from 9:00 a.m. to 8:00 p.m., United States Eastern Time (-0500 UTC), Monday through Friday.

Postal mail:

EnterWorks Acquisition Inc.

Customer Support Team

Loudoun Tech Center

46040 Center Oak Plaza

Suite 115

Sterling, VA 20166

USA

Please include your telephone number and customer identification number or project name in your letter.

http://support.enterworks.com/

mailto:[email protected]



3. Overview

This document covers 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, but it’s recommended that data maintenance activities be given to 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 (users assigned to the Administration security group) will have access to all Enable system features and functions, but not all functionality is covered in this document so refer to the following documents for additional information.

For installation steps, see the “Enable Product Information Management (PIM) Installation Manual”.

For user functionality, see the “Enable Product Information Management (PIM) User Manual”.

For publication functionality, see the “Enable Product Information Management (PIM) Publication Manual”.



4. Logging into Enable

To log into Enable, perform the following steps:

1. Open the web browser (Firefox is recommended)

2. Enter the Enable URL :

http://<servername>/webcm/

3. Select a Language. Enter your Login ID and Password and click the Logon button.

1.

2.

4. The Enable startup screen appears.

3. Depending upon the user’s permissions, the startup screen could have different features

available. The screen shown above contains all features and functions. The Home Page

tab is shown on system entry and since the reports are user specific, the screen above

shows an example of three possible report widgets, or internal web applications.



Enable 9 PIM Administration Manual


5. Quick Start Guide

The following Quick Start Guide for Enable is not meant to describe all functionality, but to identify the most used and useful features to help users get up to speed quickly for maintaining your repository information. The following sections go into more detail and step-by-step instructions.



6. Home Page Report Widgets

This section describes report widgets designed for administrative use and home page default set up for each user group. When the user first signs on, the default home page associated with the user group assigned will be shown. The user can then modify their home page, as desired, without changing the default home page for the user group. See the Enable PIM User Manual for details on setting up the user-oriented widgets.

6.1 Administrative Report Widgets

6.1.1 Creating a Shortcut Widget

The Shortcuts report widget can be used to set up quick links to certain functions for users to access via the Home Page instead of navigating from the left Feature Bar. These shortcuts are customized by using the Scheduled Activities / Shortcuts repository as shown below.

1. Open the Shortcuts repository.

2. Click the Create a new record button .



3. The Add New record window appears.

4. Click the lookup button to select the Shortcut Type.

5. Click the OK button.



6. Enter a Name for the Shortcut which will appear in the widget as a link.

7. Enter a Description for the Shortcut (optional).

8. Select a Group Name (optional) which will limit the shortcut to a Shortcut Widget to any

user within the group.

9. The Id will be generated by the system when the record is saved.

10. The default Display Order is last; this can be changed in this field by entering a number.



11. Click on the Details tab to enter the details for the Shortcut Type. The required fields

will change based on the Shortcut Type. The example below shows the Repository

Listing details.

12. Select the Repository Name to identify the repository that will open up when the

widget link is clicked.

13. Select the Preference Listing to indicate the Preference View that will be shown when

the listing is opened (optional). If no Preference Listing is selected, the default

preference will be shown.

14. Select a Saved Set and/or Saved Search to apply to the repository before displaying the

records (optional).

15. Select a Search Attribute, Search Operator, and Search Value to execute on the

repository before displaying the records (optional).

16. Click the Save button.

4.

17. When finished creating the Shortcut records, add the Shortcut Widget to the home page

(and/or group home page) as shown below.



a. Click the plus button on the top-right of the Home Page to add a new

widget.

b. Enter a Title for your report widget.

c. Select the Type = “Shortcuts” from the dropdown list.

d. Select a different color for the report widget (optional).

e. Change the Height, if required to show all the shortcut links (optional).

f. There is no configuration window for this widget.

5.

g. Click the check button on the top right and the Shortcut widget will be shown.

h. Click the Save button on the top-right of the home page to save the new widget.

6.1.2 Creating a System Health Widget

This widget is designed to help a Systems Administrator monitor the components of the Enable system. Therefore, it is recommended this widget be added to the Administrator home page.

1. Open the Users & Groups Feature on the left Feature bar.



2. Open the Groups Function.

3. Select the Administrator group record.

4. Click on the Action dropdown list and select the Edit Home Page option.

5. Click the plus button on the top-right of the Home Page to add a new widget.

6. The new widget will be added to the bottom of the home page.



7. Click the wrench button to open the definition window.

8. Enter a Title for your report widget.

9. Select a different color for the report widget (optional).

10. Select the Type = “System Health” from the dropdown list.

11. Change the Height, if required (optional).

12. Click the Configure button (the first time it will show automatically).



13. Change default settings (optional).


15. Click the check button on the top right and the System Health Report widget will be

shown:



16. Click the Save button on the top-right of the home page to save the new widget

on the Administrator’s home page.

6.2 Defining User Group Home Page

1. Navigate to the Users and Groups Feature in the left Feature bar and click on the

Groups Function option.



2. Select the User Group that needs a default home page defined.

3. Select the Edit Home page option under the Action dropdown list.



4. The Edit Group Home Configuration page is shown for that User Group. See the Enable

PIM User Manual for details on setting up report widgets.

5. Set up (or edit) the report widgets for the user group.



6. Click the Save icon.

6.3 Switching to Other Group Views

It is possible to switch to another home page view. This is based on the groups the user belongs to. All the groups a user belongs to are shown in a dropdown list on the top of the home page.

6.

Click the dropdown menu to reveal the other group views that the user has access to. See the Test Group view in the example below.



7. Managing Attributes

7.1 Adding an Attribute to a Repository

1. Right-click on the repository you want to add a new attribute to.

2. Click the Manage Model submenu.

3. Select the Profile option.

4. Click the Next button.



5. Select the New option under the Action menu.

6. Enter the required fields and click the OK button. See the following subsections for

more details pertaining to required fields and commonly used elements.



7.1.1 Attribute Details

Multi-Language Name and description fields The name and description fields for attributes are translatable. To add translations, click the

multi-language icon corresponding to either name or description to open the multi-language editor (shown below). After the user is done adding translations simply click the save button on the multi-language editor page and click “OK” on the Define Attribute Details page to save your translations.



Data Types Data types are one of the required fields for an attribute. By defining the Data Type you are defining what values the field can store and what functionality can be performed.

Group Groups are another required field for an attribute. A group will organize a repository’s attributes in a meaningful manner via tabs within a repository’s record editor.

Code Set Code sets are comprised of predefined values. The predefined values are used to give a selection to the user so that an attribute can be defined. See Section 9 on Code Sets.

Control Type Control types specify behavioral rules in which data can be entered. The graphical interface for an attribute is conditionally dependent upon the specified control type; which at times can be paired with the Is Repeatable option to help further determine the graphical interface. For instance, the use of a check box or radio button is dependent upon the Is Repeatable option.

The following table describes each control type within the Enable system.

Control Types Description

HTML Editor Allows the user to format data via a WYSIWYG

editor.

Numeric Attribute field that only permits numerical characters.

Check Box or Radio

Check Boxes are a series of small boxes which a user

can select one or many particular values relative to an

attribute. Radio buttons also offer a set of values

relative to an attribute however, only one of which can

be selected at a time.

Repository List

Repositories are the central point within the Enable

system in which data is retained and managed. The

Repository List control type allows the user to choose a

single value via a dropdown or multiple values via a

multi-select box of all Repository names within the

Enable system.




Code Set List

Code sets are a list of predefined values. The Code Set

List control type allows the user to choose a single

value via a dropdown or multiple values via a multi-

select box of all Code Set names within the Enable

system.

Taxonomy List

Taxonomy is a scheme of classification. The

Taxonomy List control type allows the user to choose a


multi-select box of all Taxonomy names within the

Enable system.

Hierarchy List Hierarchy defines the arrangement of things in terms of

importance. The Hierarchy List control type allows the

user to choose a single value via a dropdown or

multiple values via a multi-select box of all Hierarchy

names within the Enable system.

Code Set – Taxonomy and

Hierarchy List

Allows the user to choose a single value via a

dropdown or multiple values via a multi-select box of a

combined list of all Taxonomy and Hierarchy names

within the Enable system.

Profile List Profiles are used to manage the structure and collection

of attributes for a given repository. The Profile list

control type allows the user to choose a single value

via a dropdown or multiple values via a multi-select

box of all Profile names within the Enable system.

User List The Enable system has many users within the system.

The User List control type allows the user to choose a


multi-select box of all User names within the Enable

system.

Group List Groups consist of multiple users. Group List control

types allows the user to choose a single value via a

dropdown or multiple values via a multi-select box of

all Group names within the Enable system.




Import Template List Import Templates are used to develop a template that

can be used once or multiple times to import data into

one or more repositories. The Import Template list



box of all Import Template names within the Enable

system.

Export Template List Export Templates are used to develop a template that

can be used once or multiple times to export data from

one or more repositories. The Export Template List



box of all Export Template Names within the Enable

system.

Export Style Map List Export Style Maps are used to develop particular

templates for specific cross-system interactions. The

Export Style Map List control type allows the user to

choose a single value via a dropdown or multiple

values via a multi-select box of all Export Style Map


Publication Template List Publication Templates are used to develop a template

that can be used once or multiple times to publish data

of one or more repositories. The publication template

list control type allows the user to choose a single

value via a dropdown or multiple values via a multi-

select box of all Publication Template names within the

Enable system.

Publication Style Map List Publication Style Maps are used to develop particular

templates for specific cross-system interactions. The

Publication Style Map control type allows the user to

choose a single value via a dropdown or multiple

values via a multi-select box of all Publication Style

Map names within the Enable system.




Syndication Template List Syndication Templates are used to develop a template

that can be used once or multiple times to export data

from one or more repositories for syndication.

Syndication Template List allows the user to choose a


multi-select box of all Syndication Template List


Export, Publication and

Syndication Template List

Allows the user to choose a single value via a

dropdown or multiple values via a multi-select box of

all Export, Publication, and Syndication Template List


Custom Dropdown List The Custom Dropdown List allows a user to specify

values via a specified SQL query. The values are

displayed via a dropdown list or multi-select list.

Attribute Options

The various attribute options within the Define Attribute Details editor allow the user to manage functionality relative to an attribute’s environment.

Attribute Options Description

Is Multi Language Allows the attribute to be defined in multiple

languages.

Is Category Attribute Helps differentiate an attribute between

global scope and a category scope.

Is Required

Allows the attribute to be defined as a

required element for each record within a

repository.

Is Repeatable Helps define the attribute as either an

attribute of one value or multiple values.

7.2 Making an Attribute a Search Filter

1. Right-click the repository that contains the attribute you want to filter.



2. Click on the Edit menu option.

3. Select the Attribute Properties menu option.



4. The attributes are organized by the editor tab, so find the attribute under the tab

section and click the Drill down Index checkbox.

5. Click the Save button on the bottom of the list.

NOTE: To define the attribute as a Filter search field, the attribute Relational field must be checked also.

6. Open the repository or click the refresh icon on the repository tab if it’s already

open.

7. The attribute will now appear as an option under the Filter area in the Search tab of the

repository.



8. Managing Taxonomies and Hierarchies

This section describes how to register a Taxonomy or Hierarchy for use. Importing and exporting hierarchies to, from and within environments (e.g., from a Dev server to a QA server, copying a hierarchy) is covered in this section. Managing a Taxonomy is achieved in the same manner. See the Enable User Manual for defining and modifying taxonomies or hierarchies.

8.1 Registering a Hierarchy

1. Navigate to the Model Feature in the Feature bar and click on the Hierarchy (or

Taxonomy) function option.



2. Select the new hierarchy record that you defined from the Hierarchy List.

3. Under the Utilities dropdown menu, select the Register option.

4. Select the repository that you want to use the new Hierarchy with and move it over to

the Registered Views box, using the buttons in between.




8.2 Exporting a Hierarchy

1. Navigate to the Model Feature in the Feature bar and click on the Hierarchy function

option.

2. Select the hierarchy record that you want to export.

3. Select the Export option under the Utilities dropdown menu.



4. The generated *.csv file is shown in a pop-up window.

5. The file name and the window’s open file box will be shown.



6. Click the file name link to open the generated export file.



8.3 Importing a Hierarchy

The easiest way to determine the format of an import *.csv file is to export the hierarchy as shown above. The exported *.csv file can then be modified and reimported to update the hierarchy. This is useful if there’s a large number of changes that need to be made. Also, instead of modifying the *.csv file directly, the file can be opened with Excel, modified, and saved as a *.csv file. The steps to import the file are shown below.

1. Navigate to the Model Feature in the Feature bar and click on the Hierarchy function

option.

2. Select the hierarchy record that you want to import data into and select the Import

option under the Utilities dropdown menu.



3. Check the Import options to make sure the import will function as you desire. Click the

Next button.

4. Add or remove levels, if required.




6. Click the Browse button and navigate to the input file.

7. Click the Open button.



8.4 Copying a Hierarchy

In the event a Hierarchy needs to be copied, a user with administrator permissions can create a copy. This copy function will copy an existing hierarchy and all repository items attached to nodes to a new hierarchy.

NOTE: After the copy is complete, each hierarchy is separate and changes to one hierarchy do not affect the other hierarchy.

1. Click on Hierarchy tab located between Search and Saved Sets Tabs.

2. Select a hierarchy from choose hierarchy dropdown.

3. Click Copy button. (The Copy icon to the right of the plus sign icon).

4. Enter a name for the new Hierarchy.

5. Click Copy.

8.5 Creating a Restricted Hierarchy

A Hierarchy can be set up by any user that has been given permission, but to make the Hierarchy restricted (which means that it is similar to a Taxonomy, in that a record can only be associated with one node) must be done by an Administrator. After the user (or the Administrator) defines the Hierarchy structure, the following steps are done to make it restricted.

1. Create an attribute on the repository to capture the hierarchy node:

a. Left-click on the repository you want to add a new attribute into.



b. Click on the Manage Model submenu.

c. Select the Profile option.

d. Click the Next button.

e. Click the New option under the Action menu.



f. Enter the required fields and click the OK button.

▪ Enter a Name for the field that will contain the hierarchy node.

• An attribute name is a translatable field, to add translations

simply select the multi-language icon to open the multi-

language editor to add translations

▪ Enter a Description (optional) to better describe the attribute.



• An attribute description is a translatable field, to add translations

simply select the multi-language icon to open the multi-

language editor to add translations

▪ Change the Data Type to VARCHAR.

▪ Enter a numeric value in the Data Size to fit the largest node name.

▪ Select the Group (the tab on the edit window) that the field will show up

on.

▪ Select the Associated Group (the section on the tab on the edit window)

that the field will show up under.

▪ Select the restricted hierarchy name under the Code Set dropdown list.

▪ Select the Category Node Link option under the Special Function Ind

down list.

▪ Click the OK button.

▪ Click the Save button.

8.6 Adding and Changing a Node’s Metadata

Metadata properties can be added or changed from the Hierarchy tab. It is necessary that the "codeSet_metadata" type repository is already set up and attached to the hierarchy with these settings:

Set profile: [name]HierarchyProperties

Profile type is CODE_SET_METADATA

Metadata repository: [name]HierarchyProperties

To add to or change the metadata, follow these steps:

1. Open the repository node and select the Hierarchy tab, then select the desired

hierarchy.

2. Select one of the nodes (such as "ttttt" in the example below) and click the pencil

button just above the hierarchy dropdown selection list in order to "edit" this node.



3. 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 Metadata.

4. A new record editor pops up with the contents of the [name]HierarchyProperties record

(if it already exists) or a blank record (if new).

5. Change or enter data and click Save.

6. Open up the [name]HierarchyProperties repository to verify.



9. Creating Code Sets

Code sets are created by System Administrators and the data in them are usually maintained by one or more users. See the Enable PIM User Manual for details on maintaining Code Set data. Perform the following steps to create a code set using Enable.

1. Click on the Model feature in the left feature bar.

2. Click on the Code Set function under the Model feature to show all the defined code

sets.

3. Click on the New option under the Action dropdown list.



4. The New Setup window will be shown.

5. Enter a Name for the new Code Set.

6. Select a Code Set Group (folder) to place the new Code Set.

7. Enter an optional Code Set Description.

8. Select an optional default Owner for the Code Set maintenance.

9. Identify the Source of the initial data.




11. Click the Add button to enter a code for the new Code Set.

12. Enter the Code and the Description.

13. If Include Owner was selected, an owner should be can be optionally be defined for

each specific code.


15. To modify a code, select the code and click the Edit button.

16. To remove a code, select the code and click the Remove button.

17. To re-sequence a code, select the code and click the Up or Down button to move it in

the list.



18. Click the Save button to save changes or Cancel button to cancel changes.

19. Add an attribute that uses the new Code Set that was set up.



10. 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 setting up advanced export templates, especially ones that export data from multiple repositories. See the Enable PIM User Manual for details on setting up Export Templates.

11. Syndication Templates

The Syndication Template function is used to develop a template that can be used once or multiple times to export data from one or more Enable repositories for syndication. Use the Syndication Template instead of the Export Template if you need to do any data transformations before exporting or if you need to validate the data before exporting (using validation levels or field required filters). It is recommended that the System Administrator assists users in setting up syndication templates. See the Enable PIM User Manual for details on setting up Syndication Templates. Material regarding the creation of Syndication Templates is TBD.



12. Import Templates

The Import Template function is used to develop a template that can be used once or multiple times to import data into one or more Enable repositories. The easiest way to set up an import template is to create an export file (see the Export Templates Function section) and then use that to create the import template. It is recommended that the System Administrator verifies and tests a user’s import template to make sure it is set up and works correctly. It should be tested with one or two records on your development environment before using on your production system. See the Enable PIM User Manual for details on setting up Syndication Templates.

13. Multiple Language Support

13.1 Access the Language List Function

1. Select the Languages function under the System Feature in the left feature bar.



2. 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.

3. Then click on the Languages link under the Data Model Management tab and Model

section.



4. The Language List screen is displayed, as shown below.

13.2 Maintaining Supported Languages

1. From the Language List screen, click on the New option under the Action dropdown list

to add a new language option.

a. Current Languages can be edited using the Edit option.

b. Current Languages can be deleted using the Delete option.

c. The Language list can be sequenced using the Sequence option.

d. Multiple Languages can be enabled or disabled using the Enable/Disable

Languages option.

NOTE: Only Active Languages can be sequenced; deactived languages are shown first.



2. The Language Editor window is displayed.

3. Enter the Language Name.

4. Enter the Language Extension. Use a standard language code like ISO 639-1 or ISO 639-

2/T in order to sufficiently differentiate the language for maintenance.

5. Click the Enable checkbox, if applicable.

6. Select the user Group that will have the ability to update fields in this language. Move

the group(s) from the left to the right using the arrows in the middle.




13.3 Defining an Attribute with Multiple Languages

1. Select Profiles under Model from the left feature bar.

2. Select the Profile record that needs (or contains) an attribute that will have multiple

languages entered.



3. Select the Edit option under the Action dropdown list.




5. Find and select the Attribute that will have multiple languages.

6. Select the Edit option under the Action dropdown list.

7. Click the Is Multi Language checkbox.



8. Click the Ok button on the bottom of the screen.

9. On the Define Attribute list screen, click the Save button.

10. Click the Ok button.

13.4 Entering Multiple Languages

1. If a field has been set up for multiple languages, it will have a multi-language icon

to the right of the field as shown below.



2. Click the multi-language icon to open the Multi-Language Editor. If the use is a

Systems Administrator, all languages will be modifiable, but a non-administrator will

only be able to edit/modify the languages with appropriate permissions.

The languages shown in the Multi-Language Editor are set to enable in the language listing page as described in “Maintaining Supported Languages” section of this admin guide. Inside the Multi-Language Editor next to every language, except for the default language, are the translate default language buttons that allow you to automatically translate the default language into the corresponding language text field.

For instructions on enabling or maintain this functionality reference the “Configuring Google Translate API” section of this manual.

3. Add translations and click the Save button.




13.5 Browser Specific Language Settings

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.

14. Translating Data Model Entities

Enable data model objects have translatable multi language fields, such as name and description. For adding translating entire data model objects and its attributes use the Export and Import multi-languages functions described in this section.



14.1 Exporting Data Model Entities for Translation

To access the Multi-Language function, select the feature “System” in the feature bar then select “Export Multi-Languages” from the list of functions.

The “Export Multi-Languages” function has four sections

1. Select Languages:

• This section allows you select which language(s) are available for translation. Only

active languages are available for translation.

2. Profile:



• Selecting profiles exports a profile’s name, description fields as well as every

profile’s attribute name and description fields.

3. Code Set:

• Selecting code set exports a Code set’s name and description field along with each

code sets codes description field

4. Selecting Other Sub-Systems:

• Other Sub-systems cover the rest of the data models that can be translated, which

include:

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 the EPIM interface” section of the admin

manual.

Once 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.

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.

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 hold crtl and select 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.



14.2 Import Data Model Translations into EPIM

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 are outlined in

the Browser Specific Language Settings 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

15. Translating Enable Labels and Messages

EPIM allows all labels and messages to be translated into the active languages. Labels are the field names, headers, page names, and button labels. Messages include confirmation and error messages displayed as a consequence of user actions.

To translate all the labels that make up the EPIM interface use the “Export Mutli-Languages” function and export “Messages” from the “Other Sub-systems” section.

1. Navigate to “Export Multi-Languages” function.

2. Select desired languages for translation then select Messages from the Other

Subsystems section.

3. Click Export and click on the generated link.

4. Extract file(s) to your computer.

5. Open a new Excel file.

6. Select the data tab.

7. In the Get External Data section of the data tab, select From Text.

8. In the file explorer that appears navigate to the extracted data model file(s



9. In the Text Import Wizard that appears, select the Delimited radio button. In the file

origin dropdown list, select Unicode (UTF-8). An example is shown below:

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.



13. Save the file as Unicode (UTF-8) text.

a. If the file name is changed, the new file name must include “Messages” in the file

name.



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 hold Crtl and select 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\standalone\con

figuration\conf

<Drive>:\Enterworks\EnableServer\JbossSlave1\standalone\con

figuration\conf

<Drive>:\Enterworks\EnableServer\JbossSlave2\standalone\con

figuration\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 Settings 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

16. Validation Levels and Rules

Enable conducts basic data validation such as data type, data size, or whether a field’s value is required or not. If more complex data validation rules are needed, Enable provides functionality to set specific criteria for validation rules based on data in other attributes of the same record by using conditional validation rules.

16.1 Understanding Validation Levels and Rules

Validation Levels allow the data within Enable to be validated based on expected data quality. There are five possible levels that Validation Rules can be defined for Levels “A” thru “E”. These levels should be viewed as “A” being the highest quality through “E” being the lowest quality.



The minimum Validation Rules for each record should be assigned to the E level. The highest quality Validation Rules for each record should be assigned to the A level.

The following diagram illustrates how Validation Rules assigned to validation levels affect the validation status of records for those levels:

Long Item Description required for Level B

SKU Group required for Level A

Taxonomy required for Level C

Master Item Id = 1234Long Item Description = SKU Group = Taxonomy =

Level A

Level B

Level C

Level D

Level E

Level A

Level B

Level C

Level D

Level E

Master Item Id = 1235Long Item Description = My ItemSKU Group = Taxonomy = Wheel Brushes

Level A

Level B

Level C

Level D

Level E

Master Item Id = 1236Long Item Description = My ItemSKU Group = Steel BrushesTaxonomy = Wheel Brushes

Validation Rules (By Levell) Example Item Records Level Status

In the above example, if the first record (with Master Item Id = 1234) is assigned to levels D or E, the record will be deemed valid. But if it is assigned to Levels A, B, or C, it will have at least one severe error. The second record is valid if set to any level but Level A. The third record is deemed valid regardless of what Level the record is set to since all Validation Rules have been satisfied.

Using validation levels within Enable allows the customer to control the following:

• The level/quality of data required for each record to be promoted to production.

• The level/quality of data required for each export or syndication.

16.2 Design the Validation Rules for each level

The first step when using validation levels is to design the Validation Rules for each level. When a record is entered or imported into a repository that is using validation levels, the new record is assigned (as a default) the validation level of “A”, if the default value was not changed. This means that all Validation Rules in all levels (A thru E) will be enforced on that record. The Product Manager can change the validation level of the record depending upon its data validation requirements.

The validation level assigned to a record effectively sets the data quality bar for the record’s availability to external systems. For example, if a record is initially set to the lowest level (E), it will be promoted to Production once the minimum data quality requirements are met. If the



Staging record is subsequently changed to Level C, it will not be promoted to Production unless the Validation Rules for Levels C through E are met. Until then, the Level E version of the record will continue to be available to external systems. Once the data quality requirements are met, the Level C version of the record will be promoted to Production.

Validation levels will determine which records are included in generated exports / syndications. In order for a candidate record to be included, its level must be equal to or greater (in terms of quality) then the level assigned to the export or syndication. If a record is at a lower level, it will not be included.

Level Assignment Impact

The following diagram illustrates the impact level assignments have on determining whether items are included:

Catalog Publication

Level A

Hanson Syndication

Level B

Data Warehouse

Level E

Master Item Id = 1234

Level E

Catalog Publication

Hanson Syndication

Data Warehouse


Level B


Level A

Exports Production Item Records Included In Export

Catalog Publication

Hanson Syndication

Data Warehouse

Catalog Publication

Hanson Syndication

Data Warehouse

In the example diagram above, all three records will be included in the Data Warehouse export since all records meet the Level E requirement of the export. The second and third records will be included in the Hanson Syndication since they are the two records that meet the Level B requirement of the syndication. The Catalog Publication will only include the third record since it is the only record meeting the Level A requirement. In order for the first two records to be included in the Catalog Publication, they need to be assigned to Level A. Once the records pass validation for Level A, they will be promoted to Production as Level A and be available for the Catalog Publication.

Assigning a Validation Level

When assigning a validation level to an export/syndication, the Product Manager needs to understand what the item will eventually be used for to determine what level of data validation is required. Initial set up of the number of active validation levels in the shared configuration properties file.

Example Filepath: \\salesdemo1\c\Enterworks\EnableServer\tomcat\webapps\ webcm\WEB-INF\classes\sharedConfig.properties



Changing the number of validations and validation values in the sharedConfiguration.properties

file:

16.3 Create a New Validation Rule

1. Log in to Enable and navigate to the SKU profile.



2. Click Next.



3. Click the Rule List tab. This will take you to a list of existing validation rules:



4. Create a new rule by selecting Action > New.

5. The “Define Rule Details (New)” window opens. Populate the appropriate values for the

following fields:



a. Name – This is the text that will appear on the record if it fails the validation rule.

For example, a rule with name = “Required – Severe (If PartType = M and Range

Code Not 92200)” would show up on the UI as follows:



b. Type – Always choose “Simple”. Other options are available but typically only

utilized when custom code is required.

c. Severity

i. Warning – Record will be flagged with an orange validation error icon but

will be allowed to promote to production if the validation rule fails.

ii. Severe – Record will be flagged with a red validation icon. This setting

will prevent a record from promoting to production if the validation rule

fails.

d. Level –If validation levels are used, this will define the level that this rule applies

to.

e. Rule

i. Operator – choose the appropriate operator based on the validation

you’re trying to implement. For example, if trying to validate an attribute

to ensure it is not blank, the operator would be: “Not Empty (IS NOT

NULL)”.

ii. Value – Applicable based on selection for Operator. For example, if you

want to check to make sure an attribute has a specific value, you would

specify Operator as “=” and Value as “SomeValue”.

f. Condition(s) – Adding conditions provides you the ability to make the rule

‘applicable’ to the SKU/Attribute based on values of another attribute. In the

example below, we are setting up a rule that applies only to SKUs where Legacy

SKU = No.

6. Click the Add button:



7. Select the attribute from the dropdown list, choose appropriate operator and value, and

then click the OK button.

8. If you have multiple criteria, specify whether ALL conditions must be true in order for

this rule to be applicable or whether only one condition is necessary to be true:







11. Now that the validation rule exists, we need to assign it to the SKU repository (staging

only).

12. Navigate to the Rule Properties page for SKU.

13. Select your new rule and use the “Down” button to assign the rule to the SKU staging

repository.



14. You have successfully created a new validation rule. However, based on instructions

above, no attributes have been assigned to this new validation rule. To assign attributes

to the new rule, see the following procedure.

16.4 Assign/Unassign Existing Validation Rule to an Existing Attribute

1. Log in to Enable and navigate to the SKU profile.



2. Click Next.

3. Find the attribute you wish to assign to a validation rule and double-click to open it in

edit mode.



4. Under the “Define Attribute Rules” section, choose Action > Assign.

5. Click on the name of the rule you wish to assign to the attribute.



6. You are taken back to the attribute editor window where you will see the newly

assigned validation rule. Click OK.

7. Click Save.



8. Clear the server data cache.



16.5 Defining Attribute Validation Rules for Validation Levels

1. Select the repository using validation levels in the Feature bar.

2. Select the Manage Model / Profiles function.

3. Click Next.

4. Select the Attribute that needs a Validation Rule.



5. Select Action / New under the Attribute Rules tab.



6. Define the rule for the attribute and select the Validation Level that the rule applies to.





9. Click Save and a confirmation message will be shown.



IMPORTANT: For a new rule the following steps must be taken to activate it.

10. Activate the new rule.

a. Right-click the repository and select Edit and then Rule Properties.

b. Select the new rule in the top Rule Available list box.

c. Click the Down arrow to move the rule to the bottom list box.



d. Click the Save button.



16.6 Assigning multiple attributes to a Validation Rule.

1. Click the Rule List tab.

2. Select the Validation Rule (or create a new one with Action / New).

3. Double-click the record or select Action / Edit.



4. Click the checkbox next to the attributes to apply the same Validation Rule (with the

same validation level).

5. Click the Ok button.

6. Click the Ok button. The new attributes for the Validation Rule will appear in the list.



7. Click Save to save the changes to the Rule List.



8. A confirmation window will be shown.

16.7 Setting a Syndication/Export’s Validation Level

When defining a Syndication Template to use for an export or syndication, the default validation level is set to “A”. This validation level can be changed for the template during setup or modification. See the Enable PIM User Manual for detailed steps on how to accomplish this.

16.8 Setting a Record’s Validation Level

The default validation level can be overridden for a specific record, if required. See the Enable PIM User Manual for steps on how to accomplish this. Even though a System Administrator would not set a record’s validation level, the steps are included here for complete understanding of the validation functionality.

17. Managing Digital Assets

Digital assets, such as an organization’s digital images, audio files, video files, PDF documents, Microsoft Office documents, and other file types, as well as, the metadata associated with these digital assets are stored in the DAM repositories. After the digital asset objects are stored, they can be associated with any repository that has been set up as Digital Asset enabled by the Systems Administrator. See the Enable PIM User Manual for steps for managing digital assets through the Enable User Interface. This section will only cover activities normally handled by a System Administrator.


Page 100 of 300 Revised 6/28/2018

17.1 Bulk Importing Digital Assets

When dealing with a large number of Digital Assets to import, the basic import process could be lengthy. Another option called Bulk Uploading is available within Enable and utilizes an automatic upload folder located on the Enable Web Server.

The upload directory is defined in the SourceFolder property in the DamConfig repository. To access this value, open the DamConfig repository as shown below:

The first record shows the Source Folder’s path on the server.

To import multiple digital assets:

1. Stage the files to be uploaded in a local directory.


Page 101 of 300 Revised 6/28/2018

2. To automatically assign the files to nodes in a DamHierarchy, define a directory

structure that mirrors the DamHierarchy structure and place the files in the appropriate

folder. Files placed in the upload directory will be uploaded without setting or changing

the DamHierarchy assignments. New nodes will be created in the DamHierarchy

structure if the directory structure does not match it exactly. For example, if a file is

uploaded into a directory <drop folder>\Furniture\Office\Desks, the DamHierarchy

setting for the assets being loaded will be set to the Furniture.Office.Desks node.

3. Log into the server and follow the source path to the Mass Upload folder (or access the

upload folder if it has been configured as a shared directory on the network).

4. Copy the local files (including the directories) into the upload folder. The folder is

checked every 15 seconds (which is configurable by the System Administrator) for new

items, and when they are found they are automatically uploaded. Results of the upload

processing can be viewed in the log file for the Asset Monitor process.

17.2 Batch Importing Digital Asset Metadata

The Import function in the DamMaster also allows importing CSV or Excel files containing metadata for existing digital assets including links to other repositories. This is useful when you want to update information for many assets. This functionality is recommended only for System Administrators and should be tested on a development or QA box before running on the production server.

1. Under the Content feature in the left feature bar, open the DAM Repository Group and

the DamMaster repository under this group.


Page 102 of 300 Revised 6/28/2018

2. Click the Import Record(s) from data source button on the toolbar third button from

the right.

3. Select the Import Type and click the Next button.


Page 103 of 300 Revised 6/28/2018

4. Map the fields from your file to appropriate target fields.

NOTE: The fields will be automatically mapped if the column names in the file match the attribute names in the repository.

5. Click Finish.

6. Monitor the import job on the Job Monitor page.


Page 104 of 300 Revised 6/28/2018

18. Using Category Attributes

Enable PIM allows managing attributes based on the Taxonomy categorization. All attributes must first be defined in the profile for the repository. The user must be granted security to the underlying taxonomy and profile to be able to edit the attributes.

Each Category Attribute must then be assigned to the nodes of the Taxonomy. This can be done from the list view for the repository containing the Category Attributes, from the Taxonomy editor under the Model feature, or from the Hierarchy Tab in the repository associated with the Taxonomy.

18.1 Managing Category Attributes from the Taxonomy List

1. Log into Enable.

2. Expand the left-side feature bar and expand the Model Feature. Click on the Taxonomy

function.

3. Select the sub-tab containing the Taxonomy that is tied to the Category Attributes, if

applicable.

4. Select the Taxonomy record and select menu Category Attribute Association option

under the Manage dropdown list.


Page 105 of 300 Revised 6/28/2018

5. The Manage Category Attributes editor appears.

6. Double-click on the desired Category Attribute Association object or select it and select

the Edit option under the Action dropdown menu.

7. Click the Edit button next to Category Attribute Association Mapping.


Page 106 of 300 Revised 6/28/2018

8. Repeat the following steps for each Taxonomy node to be updated.

a. Drill down into the taxonomy and select the node to be updated.


Page 107 of 300 Revised 6/28/2018

b. The Category Attribute Association Mapping Editor appears, showing the

selected node attribute assignments along with any inherited assignments from

parent nodes.

c. To remove an attribute assignment, check the checkbox next to the attribute and

click Delete.

d. To change the codes of an attribute’s code set (if a code set is assigned to the

attribute) that are allowed for this node, check the checkbox next to the

attribute and click the Possible Values button.


Page 108 of 300 Revised 6/28/2018

e. Select the Subset radio button.

f. Select the desired codes from the Available Detail Code List and click the right-

arrow button.


Page 109 of 300 Revised 6/28/2018

g. Click the OK button.

h. To add an attribute assignment, click the Manage button. The Select Category

Attribute window appears:

i. Select the desired attributes to be assigned and click the Add Selected button.

The selected attributes are added to the list.


Page 110 of 300 Revised 6/28/2018

j. To set the order of the assigned and inherited attributes, click the Set Order

button.

k. Drag and drop the attributes in the desired order.

l. Click the Save button.


Page 111 of 300 Revised 6/28/2018

9. Click the Close button.

10. Click the Return button.



Page 112 of 300 Revised 6/28/2018

NOTE: If the Save button is not clicked on the Manage Category Attributes Editor window, then any changes made to the assignments will be lost.

18.2 Managing Category Attributes from Repository List View

Perform the following steps to update the defined Category Attributes to the taxonomy node in the Enable:

1. Log into Enable.

2. Expand the feature bar, expand to show the desired repository, and open it.

3. Select the Hierarchy sub tab.

4. Select the Taxonomy type hierarchy from list. The taxonomy tree will load below the

dropdown list.

5. Select a taxonomy node and click the Manage Category Button.


Page 113 of 300 Revised 6/28/2018

9.

6. The window below is shown with the current list of attributes for the selected node.

7. Select the attribute checkbox and click Delete button to delete an attribute from the

node. (This will not delete the attribute, just remove its assignment from this node).

8. To add new Category Attributes to this taxonomy node, click the Manage button and

the following screen will be shown.


Page 114 of 300 Revised 6/28/2018

9. Select the checkbox next to the attribute(s) you want to assign to the node.

10. Use Action dropdown menu to add new attributes that are not already defined.

11. Click Add Selected.

12. To change the order of the attributes, click Set Order.

13. Drag and drop the attributes in the desired order.

14. Click Save on the Order Attribute Mapping form.

15. Click Save.


Page 115 of 300 Revised 6/28/2018

NOTE: If Save is not clicked, the changes to the Category Attribute assignments for the selected node will be lost.

19. Using Staging and Production Repositories

19.1 Staging vs. Production Repositories

In order to insulate “production-ready” data from updates that may be incomplete or invalid, Enable supports the creation of separate Staging and Production versions of the data. When this functionality is used, each repository has a staging and a production version.

• Staging – A staging repository is the work area where records are updated by users. A

record’s updates will stay in the staging area until there are no severe validation errors

on the record. The record(s) can then be promoted to production which takes the

changes that were done to staging and applies them to the production record(s). If the

record is new, it will be added to production. Promotion of data to production can be

done either automatically or manually.

• Production – approved data for generating publications or creating/scheduling exports

for syndications.

The following diagram shows the data flow between the Enable Staging and Production repositories as well as to external entities:


Page 116 of 300 Revised 6/28/2018

Staging ProductionApproval

Pub

licat

ions

Imports

InDesign ECDB

Exports

Excel

Syndic

ations

UI Updates

Promotion can be controlled by requiring records to be approved in staging before being promoted to Production. Some repositories may be configured to not require an approval and some users may have the authority to bypass an approval. In most cases, records will be automatically promoted to Production if they don’t contain severe validation errors.

Data that is added or updated in repositories not configured for Staging-Production will be “production-ready” when the records are saved.

19.2 Manually Promoting Records

Users can manually promote individual records from a Staging repository to Production by performing the following steps.

1. Log into Enable.

2. Search for and select the record(s) to be promoted.

3. From menu, select Utilities→ Promote Records.


Page 117 of 300 Revised 6/28/2018

4. Select first option to promote the record and all configured children. This will submit as

background job.

5. Select the second option to just promote the selected records only and not any linked

children. This will immediately copy valid records to production.

6. Click the Promote button to submit promotion request.

NOTE: Only the valid selected records will be promoted to Production.

19.3 Manually Promoting a Repository

An entire staging repository can be promoted in a single operation by performing the following steps:

1. Expand the Feature bar and select Promotion Configuration under Model

Configuration.

2. Select the Promotion Configuration to be used to promote.

3. To promote all new or changed records, select the All New or Changed Records radio

button.

4. To promote only those records in a saved set, select the All Records from Saved Set

radio button and select the desired saved set from the list.

5. Select the desired promotion type.

6. Select the desired validation option.


Page 118 of 300 Revised 6/28/2018

7. Click OK. A background job will be launched that will validate and promote the

designated records from the designated repository.

19.4 Review difference from Production

To view differences between the staging record and the production record.

1. Select a single record from listing. From the Utilities menu, select Utilities→ Diff

Production Record.

2. The Differences viewer will open. It defaults to only showing the attributes that are

different. Use the dropdown selection to control what attributes to show.


Page 119 of 300 Revised 6/28/2018

20. Using Package Promotions

Records are modified in the staging environment and then moved to production using the promotion process. Promotion can be handled automatically or manually (depending upon the configuration), but records cannot be promoted if there are any validation errors. If records are in a repository that is identified as part of a package (and the repository is defined as Package Dependent), the records will not be promoted until all records in that package have passed validation. See the section below for more details.

20.1 Package Promotion

This procedure describes the steps that a user would go through to manually promote a group of linked records (a package) from staging to production. The repositories that make up the package are defined by the Enable System Administrator. The example below shows use of a package defined from the root of SKU Group. It is comprised of the Item records linked to the SKU Group record, the Brand, Manufacturer and Item Business Unit records linked to each Item record. The SKU Group, Item, and Item Business Unit records are designated as “Package-Dependent”. This means that if any records within the package have a severe validation error, the Package-Dependent records will NOT be promoted to Production. The Brand and Manufacturer records are not designated as Package-Dependent so they will be promoted to Production even if the Package, in which they are linked, is deemed invalid.


Page 120 of 300 Revised 6/28/2018

SKU Group - XYZ

Item - A Item - B Item - C

Brand Manufacturer

Item

Business

Unit - ORS

Item -

Lagasse

Brand Manufacturer

Item

Business

Unit - ORS

Item -

Lagasse

Brand Manufacturer

Item

Business

Unit - ORS

Item -

Lagasse

20.2 Package Promotion Repository

The Package Promotion repository defines the promotion packages for Enable and has the following attributes:

Attribute Description

Display Attributes List of attributes to display when referencing a record in this repository

(instead of primary key).

Package Dependent Indicates a record in this repository can only be promoted if the entire

package containing this record is valid if Yes.

Package Level Level for package with top level being 1.

Package Name Name of promotion package.

Parent Link Relationship Name Name of link relationship associating this repository with its parent

(blank if the top level).

Promote Warnings Records having only Warning validation errors will be promoted for this

repository if Yes.


Page 121 of 300 Revised 6/28/2018


Promotion Attribute Comma-delimited list of attributes to be updated in each package record

from the values of the corresponding work item properties (defined in

Promotion Property).

Promotion Configuration Name Name of promotion configuration if repository is to be promoted as part

of the package promotion processing. This name must match a

promotion configuration in the sharedConfig.properties configuration

file.

Promotion Property Comma-delimited list of work item properties to be used to update the

corresponding attributes (defined in Promotion Attribute) for each record

in the package.

Repository Name Name of repository.

Status Only process if Active. Inactive records will prevent children

repositories from being processed.

Update Package Errors Update the Package Errors attribute in the root repository if Yes. The

Package Errors attribute must be defined and have a Validation Rule

specifying the attribute must be empty.

20.3 Defining a Data Package

The following steps are used to set up a data package to control the promotion of related records. This functionality is only available to System Administrators.

1. Open the Promotions repository under the Scheduled Activities group in the Content

feature.


Page 122 of 300 Revised 6/28/2018

2. Click the Add new record (+) button. The detail editor for the Package Promotions

repository appears.

3. Enter the name of the package to which this record applies in the Package Name field.


Page 123 of 300 Revised 6/28/2018

NOTE: All package level records for the same package must have the exact same Package Name value.

Enter the name of the repository to which this level applies in the Repository Name field. Each repository can only be listed once for a package.

4. Enter the package level for this repository in the Package Level field. 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).

5. If this is not the top level, enter the name of the Link Relationship that connects this

repository to its parent in the Parent Link Relationship Name field. 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).

6. 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”.

7. Enter the name of the promotion configuration for this repository in the Promotion

Configuration Name field. This name should be copied from the

sharedConfig.properties file.

8. If warning validation errors are to be ignored, set the Promote Warnings attribute to

Yes.

9. 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).

10. 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.

11. 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.

12. Click Save.

13. Repeat the above steps to define all levels for a package.


Page 124 of 300 Revised 6/28/2018

21. Job Scheduling

21.1 Scheduling Imports

The 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 provide 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.

21.1.1 Scheduled Imports Repository

All scheduled imports are defined in the Scheduled Imports repository. Each record in this repository represents one scheduled import. Each attribute from this repository is described in the following table:


Category Attribute Association

Name

The name of the Category Attribute Association object to be updated when the

Import Type is Cat Attr Assoc.

Code Set Full Replacement

Indicates the Code Set import file fully replaces the existing code set if set to

Yes. 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 The specified saved set should be deleted before adding records for the current

import to the saved set if “Yes”.

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”.


Page 125 of 300 Revised 6/28/2018


Dependent Operation Name of dependent Import, Export, or Promotion to be initiated upon

successful completion of this job.

Dependent Operation

Immediate

Initiate the dependent operation immediately if “Yes”. Otherwise the

operation will be queued and processed by the scheduler, which may take

several minutes to start.

Dependent Operation Type Type of dependent operation: Promotion, Import, or Export

Dependent Values Values corresponding to the Dependent Keys that are passed to the dependent

operations. Values may reference attributes by surround the attribute name

with double-pipe characters. For example, to reference the Import Job

number, the Dependent Values might contain: “Job||Export Job||”. If Export

Job in the current record is set to 1234, the resulting value will be “Job1234”

Description Description of scheduled import. It is strongly recommended that the

Description be populated with all the details for the import, including any job

that launches this job, any pre-processing performed, and what jobs this job

launches. If ParameterX attributes are used, each should be detailed as to their

content and purpose.

Display Attributes [DEPRECATED] Comma-delimited list of attributes to include in e-mails

Effective Primary Key [DEPRECATED] Comma-delimited list of attributes to serve as the primary

key for this import.

Email Body Override e-mail body for successful jobs. Attributes in the job record can be

referenced by surrounding them with double-pipe characters (e.g., ||Manager

Login|| is replaced with the value of the Manager Login attribute).

Email Notify Failure Send an Import Failed e-mail to the owner if Yes and the import fails to

process successfully.

Email Notify Success Send an Import Successful e-mail to the owner if Yes and the import processes

successfully.

Email Subject Subject for success e-mail. May contain references to any other job attribute

by surrounding it with double-pipe characters (e.g., ||Manager Login|| is

replaced with the value of the attribute Manager Login).

Email To Email address(es) to which success/failure notifications will be sent. If not

defined, the e-mail address(es) associated with the Manager Login user/group

will be used.


Page 126 of 300 Revised 6/28/2018


Error Dependent Keys Optional keys for arguments to be passed to any Dependent jobs (as

properties) when this job fails with an error.

Error Dependent Operation List of Promotions, Imports, and/or Exports (based on Dependent Operation

Type) that should be triggered on successful completion of this one.

Error Dependent Operation

Immediate

Execute dependent operation immediately if Yes when this job fails with an

error.


Type

List of operation types for each Dependent Operation when this job fails with

an error.

• Export – launch an export job

• Import – launch an import job

• Promotion – launch a promotion job

Error Dependent Values Optional values for dependent keys when this job fails with an error.

Group Lock Action Group locks allow for multiple concurrent jobs to all attach to the same lock.

The lock is not freed until all processes have detached from it.

Action to be taken with the lock identified in Group Lock Name:

• Attach – the import will attach to the specified lock. Processing for

the import will begin immediately.

• Free – the import will detach from the named lock (presumably set

by a previous job that invoked this import) once the import

processing has completed. The lock is not completely freed until all

attached processes have detached.

• Attach And Free – the import will attach to the named lock and begin

processing and detach from the named lock once processing has

completed.

• No Lock – the import will not attach to a group lock.

Group Locks will always acquire the designated lock, even if another process

has acquired or attached to the same lock. If multiple jobs attach to the same

lock via Group Lock, the lock is not free until all of the processes have freed

the lock.

Group Lock Name Name of the group lock.

Ignore Missing File When an Import is executed and the specified file cannot be found, the Failure

e-mail will be suppressed if this flag is set to “Yes”.


Page 127 of 300 Revised 6/28/2018


Import Directory Name Fully qualified path to directory where import file can be found.

Import File Name Name of file to be imported.

Import File Sort Specifies whether the matching files (if Import File Name includes a wildcard

character) should be sorted before selecting a file.

• File Ascending – sort file names in ascending order

• File Descending – sort file names in descending order

Import Format [DEPRECATED] Format of the import file.

Import Language Specifies the language to be used for the import. If blank, the default

language is used. If set to a non-default language, the multi-language fields

for this language are updated.

Import Name Logical name for the Import.

Import Now The import file is to be processed immediately if set to “Yes”.

This flag is immediately set to No once a record for this import has been

created in the Scheduled Import Jobs repository. This flag will be set to Yes

any time the import is to be processed outside of the scheduled time. The

immediate processing of the import file will not alter the next scheduled date

and time. For example, if the import is scheduled to be processed nightly at

1:30 a.m. and a user requests an immediate import at 11:00 p.m. by setting this

flag to “Yes”, the file will be processed at 11 p.m. and then again at 1:30 a.m.

Import Option Name Name of import option to be applied to this import. The code set Import

Options contains a complete list of available options. The description for each

code identifies what the option does and what values can be specified.

Import Option Value Value for the corresponding import option to be applied to this import.

Import Priority Priority of import controls order which jobs are checked. The lower the

number, the higher the priority.


Page 128 of 300 Revised 6/28/2018


Import Type Identifies the type of import:

• Template – the import uses an Import Template

• Repository – the import uses a View Mapping for a specific

repository

• Code Set – the import is for a Code Set

• Custom – the import only performs the assigned pre-processing

module

Inactive Records Identifies action to be taken with Inactive records when the import type is

Template and is configured as a full replacement import (which will flag

records not present in the file as being inactive):

• No Action – don’t do anything

• Delete – delete inactive records from Staging and Production after

the import has completed

• Reactivate – reactivate inactive records if they are present in the

import file

Inactive View Name of snapshot table view for the target repository. This view is used when

processing inactive records in a full replacement template import.

Include Timestamp Include date and time in Import_<job>.log file if Yes. This can be helpful in

troubleshooting pre-processing for an import as it shows how long processing

steps took (providing the appropriate messages are being reported).

Last Import Datetime Date and time of when this import was last initiated (scheduled or manual).

Last Scheduled Import

Datetime

Date and time of when scheduled import was last processed


Page 129 of 300 Revised 6/28/2018


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.

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||).


Page 130 of 300 Revised 6/28/2018


Preprocess Class Fully-qualified path, identifying the Preprocess class to be invoked for this

import. It must be a subclass of

com.enterworks.services.BaseCustomProcessFile

Preprocess File Import file must be preprocessed using the designated class and arguments if

“Yes”.

Preprocess Keys Argument keys identifying the Preprocess Argument Values to be passed to

the designated preprocess module.

Preprocess Values Values for corresponding Preprocess Argument Keys to be passed to the

designated preprocess module. Values can contain references to properties

from this job by surrounding the property name with double-pipe characters.

For example, to pass the Import Job, the value would be set to “||Import Job||”

Repository Name Name of target repository.

Repository Timeout (Minutes) Maximum number of minutes allowed for processing a Repository Import.

This timeout specifies how long the Scheduled Import processing will wait for

the import to complete processing. If a timeout is reached, the job is flagged

with an error and the designated user or group is notified. The actual job may

still complete successfully, but any dependent jobs will not be triggered.

Repository View Mapping Name of mapping view for Repository Import. Mappings are either manually

defined in the Enable PIM UI or by manually performing an import using the

Enable PIM Repository interface and selecting the option to Save Mapping.

Run As Manager Login Run the import using the login designated in Manager Login if Yes. When

enabled, the Manager Login must be set to a user and not a group. This option

ensures the import is subject to the security of the designated login and also

identifies the records being created/updated by that login (vs. system).

Saved Set Name of Saved Set to be created if specified.

Schedule Days Identifies the days of the week if Schedule Type is “Days of Week”

Schedule Exclude Dates Code

Set

If set to a code set listing dates as code values, the scheduling logic will skip

to the next scheduled date if the calculated date is one of the dates in the code

set.

Schedule Period Number of time units (based on Schedule Type) after Last Scheduled Date

before the next scheduled import is initiated. For example, an import that is to

be processed daily could be set to type DAYS and have a period of 1 or be set

to type MINUTES and have a period of 1440. The scheduled imports are not

affected by any manually initiated imports


Page 131 of 300 Revised 6/28/2018


Schedule Type Type of schedule:

• MINUTES – the Schedule Period identifies the number of minutes

before re-invoking the import.

• DAYS – the Schedule Period identifies the number of days before re-

invoking the import.

• DAYS OF WEEK – specific days of the week on which the import is

to be executed (which is specified by the attribute Schedule Days).

• WEEKS – the Schedule Period identifies the number of weeks before

re-invoking the import.

• MONTHS – the Schedule Period identifies the number of months

before re-invoking the import.

Scheduled Folder Logical folder in which the scheduled job is assigned for organization

purposes. If set, and the Scheduled Folder hierarchy is selected in the

repository list view, this import job can be found by clicking a node in the

Scheduled Folder hierarchy.

Scheduled Folder Sequence Used to control the order of scheduled jobs in the Scheduled Folders

Scheduled Import Set to “Yes” if the import is to be scheduled. Each time the scheduled import

is processed, the Next Import Datetime is updated based on the Schedule Type

and Scheduled Period along with the previous value for Next Import Datetime.

For example, if the Schedule Type is set to DAYS OF WEEK and Scheduled

Days is set to Monday, Wednesday, and Friday and the Next Import Datetime

is set to 10/3/2014 02:00:00 (2:00 am on Friday, October 3rd), the Next Import

Datetime attribute will be updated to 10/6/2014 02:00:00 (2:00 am on

Monday, October 6th).

Skip File Check Skip checking for and moving a file if Yes. Requires Preprocess File = Yes

and Preprocess Class is defined. The assigned class is responsible for

ensuring a file is created.

Skip If Busy Skip this Import if Scheduled and there is already an active job for the same

import. This ensures only one scheduled import job is running at any given

time.

Source FTP FTP Server name if Source Type is FTP

Source FTP Delete File From

Server

Delete file from FTP server if Yes (default)


Page 132 of 300 Revised 6/28/2018


Source FTP File Name Name of source file if Source Type is FTP. The file name may contain

wildcards (‘*’) which may result in multiple files being retrieved. If multiple

files are expected, the Import File Name should also have wild cards and the

Scheduled Import should be configured to call itself as a dependent operation

to ensure each file is processed.

Source FTP List Gaps Number of gaps in the data returned by the LIST command for the FTP server

between the start of each line and the name of the file. This is used by Enable

to know how to extract the name of the file.

Source FTP Path Fully qualified directory path on the FTP server if Source Type is FTP.

Source FTP Port FTP Server port (21 default, 22 SFTP)

Source FTP User FTP Server user name if Source Type is FTP

Source FTP User Password FTP Server user password if Source Type is FTP

Source Type Type of Source for Import (File or FTP). Default is File

Status Status of import record:

Active – record is active

Retired/Inactive – record is not active

Template Name Name of Import Template name if Import Type is “Template”

Template Timeout (Minutes) Number of minutes before the processing for a Template import is flagged as

timing out, at which point an e-mail will be sent to the designated user or

group. The import template processing may still finish successfully, but any

dependent jobs will not be initiated.

21.1.2 Scheduled Import Jobs Repository

The Scheduled Import Jobs repository contains records representing the currently active or recently completed import jobs. Whenever an import is initiated, the details for that import are copied from the Imports repository. This record is subsequently updated to reflect the current status of the import. In addition to the attributes define in the Scheduled Imports repository, the Scheduled Import Jobs repository also has the following attributes:


Page 133 of 300 Revised 6/28/2018


# Created The total number of records created

# Deleted The total number of records deleted

# Errors The total number of errors encountered during the import processing.

# Processed The total number of records processed

# Updated The total number of existing records that were updated

Import Errors Lists the details for the cause of the import to fail (when the Import Status is

“Error”).

Import Job Unique number for the import job.

Import Status Status of current or last import. Possible values include:

Aborted – the import has been aborted by a user

New – the import is new

Processing – the import file is being processed. While in this state, no

additional import can be initiated for this import record.

Completed – import processing has completed successfully

Error – the import failed. The Import Status must be changed to New or

Completed for it to be processed again (if scheduled)

Job Log File Name of the Scheduled Import job log file (e.g., Import_<job>.log)

Last Submitted By Login ID of last user who submitted a file for this target.

System Log Directory Contains the directory for where the Enable import logs are created.

System Log File Name of the Enable import log file.

21.1.3 Scheduled Import Configuration Properties

The Scheduled Import behavior is controlled by several configuration properties:


Page 134 of 300 Revised 6/28/2018

Property Description

import.baseDirectory Full path to the directory where the Scheduled Import files will be placed (e.g., D:/Enterworks/shared/Imports). If the Enable is configured in a distributed environment, a network directory path should be specified.

import.expireActiveDays Number of days before import jobs that still show “Processing” are deleted from the Scheduled Import Jobs repository.

import.expireCompletedDays Number of days before import jobs that have completed or failed are deleted from the Scheduled Import Jobs repository.

import.logDirectory Full path to the directory where the Enable import logs are placed (e.g., D:/Enterworks/logs/EnableServer/import)

21.2 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.

21.2.1 Scheduled Export Repository

All scheduled exports are defined in the Scheduled Exports repository. Each attribute from this repository is described in the following table:


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')


Page 135 of 300 Revised 6/28/2018


Additional Conditions

(AND/OR)

This allows the user to select if all or any one of the conditions (if multiple)

should be used to filter records

Compress File Compress the export file into a zip file if “Yes”.

Created Attribute Name Name of attribute representing the creation date for the record.

Custom Source File Name Sets the file name for a Custom export for the registered post-processing class

(since no file was generated by Enable). It is the responsibility of the post-

process class to actually generate the file.

Delta Export <blank> - No Filtering of records

Add – Include only new records since last export

Change - Include only changed records since last export

Add or Change - Include only new or changed records since last export

Full – Include all records subject to Additional Conditions






example, if an export is dependent on an import and that export should specify

the same user, the Dependent Key would be set to “Manager Login” and the

value would be “||Manager Login||”. Conversely, if the same dependent

Export needs to be set to the admin user regardless of its initial definition, the

Dependent Key would be set to “Manager Login” and the Dependent Values

set to “admin”.



Dependent Operation

Immediate

Initiate the dependent operation immediately if “Yes”. Otherwise the

operation will be queued and processed by the scheduler.








Page 136 of 300 Revised 6/28/2018


Description Optional description for export. It is strongly recommended that the

Description be populated with all the details for the export, including any job

that launches this job, any pre-processing performed, and what jobs this job

launches. If ParameterX attributes are used, each should be detailed as to their

content and purpose.

Email Body Override e-mail body for successful jobs. Attributes in the job record can be

referenced by surrounding them with double-pipe characters (e.g., ||Manager

Login|| is replaced with the value of the Manager Login attribute).

Email Notify Failure Send an Export Failed e-mail to the owner if Yes and the export fails to

process successfully.

Email Notify Success Send an Export Successful e-mail to the owner if Yes and the export processes

successfully.

Email Subject Subject for success e-mail. May contain references to any other job attribute

by surrounding it with double-pipe characters (e.g., ||Manager Login|| is

replaced with the value of the attribute Manager Login).

Email To Email address(es) to which success/failure notifications will be sent. If not

defined, the e-mail address(es) associated with the Manager Login user/group

will be used.

Empty File Action Identifies the action to be taken if the export file is empty.

• Continue - continue processing;

• Error - treat empty file as failed export;

• Stop - stop processing (no dependent operations)

Error Dependent Keys Optional keys for arguments to be passed to any Dependent jobs (as

properties) when this job fails with an error.

Error Dependent Operation List of Promotions, Imports, and/or Exports (based on Dependent Operation

Type) that should be triggered on successful completion of this one.


Immediate

Execute dependent operation immediately if Yes when this job fails with an

error.


Page 137 of 300 Revised 6/28/2018



Type

List of operation types for each Dependent Operation when this job fails with

an error.

• Export – launch an export job

• Import – launch an import job

Promotion – launch a promotion job

Error Dependent Values Optional values for dependent keys when this job fails with an error.

Export Encoding File Encoding for Export (UTF-8, Windows-1251, etc.)

Export Execution Datetime Date and time at which this export was last executed.

Export File Name Name of file to be generated by the export. This attribute can include

references to other attributes by surrounding the attribute name with double-

pipe characters. For example, to include the job number in the export file

name, the file name could be “MyFile_||Export Job||.csv”

Export Include Images [DEPRECATED] Include images with the export if Yes.

Export Name Name of the export.

Export Now Process the export immediately if Yes.

Export Priority Relative priority for the export determines the order of exports ready to be

processed. The lower the number, the higher the priority.

Export Template Name of Export Template (if Export Type is Template)

Export Type Type of export:

• Repository – export of a single repository using the designated User

Preference

• View – SQL export against the Enable PIM database.

• DataMart – SQL export against the Data Mart database

• Export Template – export using the designated Export Template

• Custom – relies on the PostProcessing module to generate a file.

• Validate – performs a validation on the designated repository and

saved set.


Page 138 of 300 Revised 6/28/2018





• 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



• 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.




the lock.


Image Context [DEPRECATED] List of Image Contexts to be included if Export Include

Images is Yes.

ImageType [DEPRECATED] List of image types to be included if Export Include Images

is Yes (e.g., Original, Thumbnail, Detail, Low, or Web)

Include Status [DEPRECATED] Identifies export records to be included matching the

designated list of Status values (e.g., Active, Inactive, Retired, or Reactivated)

Include Timestamp Include date and time in Export_<job>.log file if Yes. This can be helpful in

troubleshooting post-processing for an export as it shows how long processing

steps took (providing the appropriate messages are being reported).

Last Export Datetime Date and time of when the export was last executed.

Last Export Update Datetime Date and time of when last DELTA export was executed

Last Scheduled Export

Datetime

Date and time the export was last scheduled

Linked Repository Name Optional list of repositories included in the Export Template


Page 139 of 300 Revised 6/28/2018


Linked Repository Saved Set Saved set to be used for each corresponding linked repository to identify

which linked records are to be included.

Linked Repository Search

Config

List of predefined searches on the linked repositories to be applied to limit the

records in the export.


• 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


completed.

• No Lock – the import will not wait for any lock before processing.





than one import shares the same lock, then they will be processed serially.


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”.

Output Null Extended Value [DEPRECATED] Include extended attributes that are empty or null if “Yes”.

Output to File Generate an export file if Yes for Export Template type

Output to Table Saved the publication table if Yes for Export Template type


the Dependent Operation attributes. They are not used directly by the export

processing but can be referenced in other attributes.


Page 140 of 300 Revised 6/28/2018


Postprocess Class Fully-qualified path, identifying the Postprocess class to be invoked for this

import. It must be a subclass of

com.enterworks.services.BaseCustomProcessFile

Postprocess File Export file must be postprocessed after being generated using the designated

class and arguments if “Yes”.

Postprocess Keys Argument keys identifying the Postprocess Argument Values to be passed to

the designated postprocess module.

Postprocess Values Values for corresponding Postprocess Argument Keys to be passed to the

designated postprocess module. Values can contain references to properties

from this job by surrounding the property name with double-pipe characters.

For example, to pass the Export Job, the value would be set to “||Export Job||”

Publication As Of Date Effective date for Export Template type if not the current date and time.

Publication Hierarchy Hierarchy used by the Export Template

Repository Format Format for Repository type export (e.g., CSV, XLS, XML, or DB)

Repository Name Name of repository for Repository or Template exports

Repository Preference User Preference to be used for Repository export.

Repository Timeout (Minutes) Number of minutes before a Repository type export has timed out.

Root Repository Saved Sets Saved set for root repository in Template export.

Root Repository Search

Configs

List of predefined searches on the root repository to be applied to limit the

records in the export.

Saved Set Saved set for Repository type export.

Schedule Days Identifies the days of the week if Schedule Type is Days of Week


Set



set.

Schedule Period Number of minutes between exports if Scheduled Export is “Yes”.


Page 141 of 300 Revised 6/28/2018




before re-invoking the export.


invoking the export.

• DAYS OF WEEK – specific days of the week on which the export is

to be executed.

• WEEKS – the Schedule Period identifies the number of weeks




Scheduled Export Export is scheduled if “Yes”.






Skip if Busy Skip the scheduled export if the same named export is already busy processing

if Yes. This can be used to prevent a backlog of exports if an export has been

delayed or takes longer than the schedule period to complete.

Status Status of export (Active, Inactive, Retired)

Target Email Email address if Target Type is Email

Target FTP FTP server name or IP address if Target Type is FTP

Target FTP User FTP user name

Target FTP User Password FTP user password

Target Overwrite File Overwrite output file (vs. append) if Yes

Target Path Directory location for export file if Export Type is File

Target Type Type of target (Email, FTP, File)


Page 142 of 300 Revised 6/28/2018


Transmission Option Identifies the transmission option to be invoked upon completion of the export

file generation.

Updated Attribute Name [DEPRECATED] Name of attribute represented date and time the data in a

record was last updated.

View Format Format for View or Data Mart Export Type:

• TAB – values separated by tab characters

• COMMA – values separated by commas. If a value contains a

comma or double-quote, the entire value is surrounded by double

quotes and any double-quotes in the value are escaped by another

double quote. For example, the value: Monsters, Inc. Size=3” x 4”

is converted to: “Monsters, Inc. Size=3”” x 4”””

• ~ - values separated by the tilde character

• * - values separated by the asterisk character

• | - values separated by the pipe character

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]’

21.2.2 Scheduled Export Jobs Repository

The Scheduled Export Jobs repository contains records representing the currently active or recently completed export jobs. Whenever an export is initiated, the details for that export are copied from the Scheduled Exports repository. This record is subsequently updated to reflect


Page 143 of 300 Revised 6/28/2018

the current status of the export. In addition to the attributes define in the Scheduled Exports repository, the Scheduled Export Jobs repository also has the following attributes:


# Errors Total number of records with errors.

# Exported Total number of records exported.

# Processed Total number of records for the export file that were processed.

Download Link URL to download the export file. Requires setting up a virtual directory in

IIS

Export Errors Error messages encountered during export if there is a failure.

Export Job Unique number for the Export job.

Export Status Status of the Export job

• New – the job has been created but a work item has not been

assigned (this is either due to this job being launched as a Dependent

job with the Dependent Operation Immediate set to No, or a

configuration error preventing a work item from being created for

this job).

• Queued – the job has been queued and is waiting for a lock to be

freed

• Processing – the job is processing

• Completed – the job completed successfully

• Error – the job failed with an error. This could be a timeout, abort

by user, or some unexpected processing error.

Submitted By Login ID of the user who submitted the Export Job.

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).


Page 144 of 300 Revised 6/28/2018

21.2.3 Creating a Scheduled Repository export

A user with authority creates a scheduled Repository export by performing the following steps:

1. Log into Enable.

2. Open the repository for which a Repository Export is to be generated.

3. Select or create the User Preference view that defines the attributes to be included in

the export as columns.

4. Open the Scheduled Exports repository in the Scheduled Activities group under the

Content function in the left feature bar.

5. Click the icon to create a new record. The detail editor for a new Scheduled Export

record appears.

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.


Page 145 of 300 Revised 6/28/2018

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. Select the output format in the Repository Format dropdown selection list.

13. Enter the target details (file/e-mail/FTP) in the appropriate fields:

14. Enter the name of the export file to be created.

15. To overwrite an existing file, set Target Overwrite File to “Yes”.


Page 146 of 300 Revised 6/28/2018

16. Click the Schedule sub-tab.

17. Set the Schedule Export field to “Yes”.

18. Set the Schedule Type to the desired type and the Schedule Period to the desired

interval (based on the selected type). For example, to produce an export nightly, set the

Schedule Type to Days and the Period to 1. 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 and instead the days listed in Schedule

Days determine which days of the week the export will be triggered:

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. Click Save. 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.


Page 147 of 300 Revised 6/28/2018

21.2.4 Creating a Scheduled View/DataMart Export

A user with authority creates a scheduled View or DataMart export by performing the following steps:

1. Log into Enable.


Content function in the left feature bar.


record appears.

4. Enter a Name for the scheduled export.


Login field.


Page 148 of 300 Revised 6/28/2018

6. Select View for a SQL View or DataMart for Data Mart in the Export Type dropdown

selection list. A View export will be against the Enable PIM snapshot table views. A

DataMart export will be against the Data Mart database.

7. Click the Export sub-tab.

8. Enter the SELECT SQL query into the View SQL field.

9. Select TAB, COMMA or ~ in the View Format field to specify the character to be used as

a delimiter.

10. Enter the target details (file/e-mail/FTP) in the appropriate fields.


Page 149 of 300 Revised 6/28/2018



13. Click the Schedule sub-tab.

14. Set the Schedule Export field to “Yes”.





Page 150 of 300 Revised 6/28/2018



Days determine which days of the week the export will be triggered.










21.2.5 Creating a Scheduled Template Export

A user with authority creates a Scheduled Export Template by performing the following steps:

1. Log into Enable.

2. If the Export Template does not already exist, click on the Export Templates under the

Import & Export feature bar and create a new Export Template, noting its name.


Page 151 of 300 Revised 6/28/2018


Content feature bar.


record appears.


Page 152 of 300 Revised 6/28/2018

5. Enter a name for the export.


Login field.

7. Select Template in the Export Type dropdown selection list.

8. Click the Export Details sub-tab.

9. Select the root repository in the Repository dropdown selection list.

10. Enter the name of the defined Export Template.


Page 153 of 300 Revised 6/28/2018

11. Set Output to File to Yes.

12. Click on the Export Target sub-tab.



15. To overwrite an existing file, set Target Overwrite File to Yes.


Page 154 of 300 Revised 6/28/2018

16. Click on the Schedule sub-tab


10.




Page 155 of 300 Revised 6/28/2018

20. Click the Export Schedule sub-tab.

21. Set the Schedule Export field to Yes.






Days determine which days of the week the export will be triggered.











Page 156 of 300 Revised 6/28/2018

21.2.6 Scheduled Export Configuration Properties

The Scheduled Export behavior is controlled by several configuration properties:


export.directoryName Full path to the directory where the Scheduled Export files will be placed (e.g., D:/Enterworks/shared/Exports)

export.epimDirectoryName Enable directory for export files (e.g., D:/Enterworks/shared/export)

export.expireActiveDays Number of days before export jobs that still show “Processing” are deleted from the Scheduled Export Jobs repository.

export.expireCompletedDays Number of days before export jobs that have completed or failed are deleted from the Scheduled Export Jobs repository.

export.logDirectoryName Full path to the directory containing the Enable export log files (e.g., D:/Enterworks/logs/EnableServer/export)

export.publicationDirectoryName Full path to the directory containing the Enable publication files (e.g., D:/Enterworks/shared/publication

export.publicationLogDirectoryName Full path to the directory containing the Enable publication log files (e.g., D:/Enterworks/logs/EnableServer/publish

21.3 Implementing Pre- or Post-Processing

The Scheduled Imports provides the option to pre-process files before the files are actually imported and the Scheduled Exports provides the option to post-process files after they have been exported. In both cases, the actual processing is handled by a Java class that is an extension of the BaseCustomProcessFile class found in the Services.jar file (or in an application-specific JAR file). The following pre-defined pre/post-processing blocks are available:


Page 157 of 300 Revised 6/28/2018

Classpath Description

com.enterworks.services.exports. MoveDamAssets Copies the DAM assets for the records in the

export file to the Portal PIM. The export file

must include the FilePath attribute which is

removed from the final file after processing.

com.enterworks.services.exports.

MoveDamAssetsAndUpdateAttributesForItemsInFile

Moves the DAM assets to the Internal PIM

and produces an import file to update the

designated attributes to the specified values

for each record in the file. The export file

must include the FilePath attribute which is

removed from the final file after processing.

com.enterworks.services.exports.

ProcessPublicationMergeAutomatedSortTemplate

Converts a Publication Merge and Automated

Sort template export in CSV format to XLS

with the category attributes reduced to only

those in the taxonomy node (assumes all

records are for the same taxonomy node) and

inserts placeholders for the Publication Merge

and Automated Sort entries.

com.enterworks.services.imports. DAMLinksFullReplace Treats the import file as a full replacement for

the designated target repository (DAMLink

repository may link assets to more than one

repository). Any record found in the

DAMLink repository but not in the file (for

the designated repository) will be flagged as

Inactive. If the import is configured to delete

inactive records, those records will be

physically removed from the DAMLink

repository.

com.enterworks.services.imports.EncodeFile Converts the import file from one encoding to

another.

com.enterworks.services.imports. PreProcessAddFields Adds attributes and values to the import file

before loading.

com.enterworks.services.imports. PreProcessImageLinksFile Preprocesses a generic DAM Link file that

contains one or more business keys, the file

name, and the image context, priority, and

caption. The business keys are replaced with

a single ID value.


Page 158 of 300 Revised 6/28/2018

Classpath Description

com.enterworks.services.imports. ProcessImagePackage Processes a single file or a zip file containing

one or more image files. If the submitted file

has the csv extension, it is passed on for

import processing by ePIM. If the submitted

file has the zip extension, the contents of the

zip file are processed. Any valid image files

are copied to the designated image directory.

If the submitted file is a valid image file, it is

copied to the designated image directory.

com.enterworks.services.imports. PromoteSavedSet Promotes the valid records in the designated

saved set to Production.

com.enterworks.services.imports. SplitDynamicAttributesFile Preprocess import file containing category

attributes, splitting the file into multiple parts

to avoid exceeding database maximums. The

file is split based on the part lists in the Enterworks.properties

configuration file. Each part must include the

primary key plus some attributes with a total

column count of less than 1000.

com.enterworks.services.imports.

SplitDynamicAttributesFromKeyValuePairFile

Reprocess import file containing category

attributes in key/value pairs, combines

multiple lines (if for the same target record),

then splitting the file into multiple parts to

avoid exceeding database maximums. The

file is split based on the part lists in the

configuration file. Each part must include the

primary key plus some attributes with a total

column count of less than 1000.

com.enterworks.services.imports. UncompressZipFile Decompresses zip file before processing.

1. When configuring a Scheduled Import or Export with a pre/post-processing block, enter

the full class path for the processing block class and click the calculate button on the

Pre-process Class or Post-process Class field.


Page 159 of 300 Revised 6/28/2018

2. 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.


Page 160 of 300 Revised 6/28/2018

3. The argument values can be changed and saved by clicking Update Attributes.

21.3.1 Pre/Post-Processing Block

Each processing block class must implement the processFile method. This method is called when there is an import or export file to be processed:

String processFile (String directoryName, String fileName, HashMap

args, HashMap inactiveRecords, TreeMap primaryKey, and StringBuffer

msgs)

Arguments:

Data Type Argument Description

String directoryName Fully-qualified path to the directory

containing the file to be processed.

The file to be returned must also be

placed in this same directory.

String fileName Name of the file to be processed.


Page 161 of 300 Revised 6/28/2018


HashMap args Map of any pre/post processing

arguments defined in the Scheduled

Import/Export.

HashMap inactiveRecords Map containing the primary keys of

any records in the repository having

a Status of Inactive. This is only

set for imports and only if the

Inactive Records flag is set to

Reactivate.

TreeMap primaryKey The primary key for the repository.

StringBuffer msgs Medium for returning error

messages to be displayed with the

job.

The method must return either the name of the processed file or null if the processing block failed.

If the processing block class has configurable arguments, there are two 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:


String Arg Name of argument. This name will

be used to retrieve the actual value

for the argument. Each defined

argument must be uniquely named


Page 162 of 300 Revised 6/28/2018


String description Detailed description for the

argument. It should include

possible values (if finite set) or

range of values, default if left

blank, etc.

The BaseCustomProcessFile class has a set of methods that help minimize the amount of coding required in a processing block class:

• 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)


Page 163 of 300 Revised 6/28/2018

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.


Page 164 of 300 Revised 6/28/2018

• 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.

21.4 Scheduling Promotions

Staging records can be promoted manually via the UI, by the Package Promotion workflow, or automatically using the following Scheduled Promotions functionality.

21.4.1 Scheduled Promotions Repository

All scheduled promotions are defined in the Promotions repository. Each attribute from this repository is described in the following table.

When a scheduled promotion is activated (either manually or by schedule), the records in the designated repository are validated and promoted to Production, providing the validation requirements are met.







example, if an export is dependent on a promotion and that export should

specify the same user, the Dependent Key would be set to “Manager Login”

and the value would be “||Manager Login||”. Conversely, if the same

dependent Export needs to be set to the admin user regardless of its initial

definition, the Dependent Key would be set to “Manager Login” and the

Dependent Values set to “admin”.




Page 165 of 300 Revised 6/28/2018


Dependent Operation

Immediate

Initiate the dependent operation immediately if Yes. Otherwise the operation

will be queued and processed by the scheduler.










• 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



• 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.




the lock.


Last Promotion Datetime Date and time of when this promotion was last initiated (scheduled or

manual).


Page 166 of 300 Revised 6/28/2018



• 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


completed.

• No Lock – the promotion will not wait for any lock before

processing.





than one promotion shares the same lock, then they will be processed serially.


property name with double-pipe characters.

If the referenced lock is associated with the Group Lock in other jobs, the

lock will not be considered free until all the Group Lock jobs have detached

from the lock.

Manager Login [DEPRECATED]

Next Promotion Datetime Date and time when the promotion (if scheduled) will be launched.


the Dependent Operation attributes. They are not used directly by the export

processing but can be referenced in other attributes.

Promote Now Perform the promotion now if set to Yes. Processing of the promotion will

reset this flag to No.

Promote Warnings Promote records that have only validation warnings to Production if Yes.

Promotion Configuration Name Configuration name for the promotion. Must match a named configuration in

the EPIM sharedConfig.properties file.

Promotion Errors Detailed error messages if promotion processing failed.


Page 167 of 300 Revised 6/28/2018


Promotion Priority Relative priority for each promotion (the lower the number, the higher the

priority).

Promotion Production

Repository

Name of Production repository into which records are to be promoted.

Promotion Skip Validation Skips the validation step and relies on current validation status if Yes.

Promotion Staging Repository Name of Staging repository from which records are to be promoted.

Promotion Timeout (Minutes) Number of minutes the Promotion job will wait for the Enable promotion to

complete. The default is 600 (10 hrs)

Saved Set Name of saved set containing items to be promoted. All items are promoted

if empty.

Schedule Days Identifies the days of the week if Schedule Type is Days of Week


Set



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



before re-invoking the promotion.


invoking the promotion.

• DAYS OF WEEK – specific days of the week on which the

promotion is to be executed.

• WEEKS – the Schedule Period identifies the number of weeks





Page 168 of 300 Revised 6/28/2018







Scheduled Promotion Set to Yes if the promotion is to be scheduled. Each time the scheduled

promotion is processed, the Next Promotion Datetime is updated based on the

Schedule Period.

Status Status of the Promotion

• Active – the promotion is active and will be processed when

conditions are met

• Inactive – the promotion is inactive and will not be processed.

21.4.2 Promotion Jobs Repository

The Promotion Jobs repository contains records representing the currently active or recently completed promotion jobs. Whenever a promotion is initiated, the details for that promotion are copied from the Promotions repository. This record is subsequently updated to reflect the current status of the promotion. In addition to the attributes define in the Promotions repository, the Promotion Jobs repository also has the following attributes:


# Errors Total number of records with errors.

# Processed Total number of records processed

# Updated Total number of records updated in Production

Promotion Execution Datetime Date and time of when this promotion was executed.

Promotion Job Unique number for this job.


Page 169 of 300 Revised 6/28/2018


Promotion Status Status of promotion job

• New – a new job that hasn’t started yet due either to it being

launched as a Dependent job with the Dependent Operation

Immediate set to No, or encountering an error when launching the

work item.

• Processing – the Promotion is currently processing

• Completed – the Promotion has completed successfully

• Aborted – the Promotion was Aborted by a user.

• Error – the Promotion failed with an error.

21.4.3 Scheduled Promotion Configuration Properties

The Scheduled Import behavior is controlled by several configuration properties:


promote.expireActiveDays Number of days before import jobs that still show “Processing” are deleted from the Scheduled Import Jobs repository.

promote.expireCompletedDays Number of days before import jobs that have completed or failed are deleted from the Scheduled Import Jobs repository.

22. Data Model Management

The Enable data model comprises of the following objects:

• Profiles – defines the structure (schema) of one or more repositories.

• Attributes – defines an element of a profile including numerous characteristics, such as

attribute name, data type, length (if character), whether the field is required, whether

there are any explicit Validation Rules to be applied, etc.


Page 170 of 300 Revised 6/28/2018

• Repositories – defines a storage container for a collection of data using the structure

defined in the assigned Profile.

• Links – defines the relationship between two repositories, such as one product record is

related to many item records.

• Snapshot Tables – each repository has a snapshot table that contains a column for each

attribute that has been identified as being relational in the Attribute Properties editor

for that repository. If an attribute is to be included in an ODBC view or if the relational

search operators (e.g., <, >, like, etc.) are to be applied in searches, then the attribute

must be included in the snapshot table.

• Sequences - Defines an auto generated sequence used by repositories to auto generate

sequence value for an attribute.

Some aspects of the data model can be modified at any time without performing any additional steps. For example, an attribute in a profile can be changed from being required to not being required, or an explicit Validation Rule can be applied to or removed from an attribute.

The following Data Model activities can be periodically performed by an Administrator.

22.1 Managing Profiles

The Profiles function is used to manage the structure applicable to a given repository and the collection of attributes contained within. A repository can only have one active profile.

22.1.1 Profiles

1. Select Model feature on the left feature bar.

2. Select the Profiles option under the Model feature.


Page 171 of 300 Revised 6/28/2018

3. Select the New option under the Action dropdown menu. The Profile (New) screen is shown (or select the profile record and then select the Edit option to modify).

4. Enter a profile Name.


Page 172 of 300 Revised 6/28/2018

11.

5. Enter a short Description (optional).

6. Select the profile Type.


Page 173 of 300 Revised 6/28/2018

22.1.2 Profile Types

Type Description

EPIM Used for generic repositories, most will use this type of profile

ICON Used to define an Icon repository for use in the publication process where it holds definitions and rules for translating specific attribute values into icon filenames.

DAM_LINK Used to define the repository for DAM links which holds the link relationship attributes for relating digital assets to the related data records (for example, digital assets to items).

DAM_MASTER Used to define the repository to hold the DAM Master attributes for the Digital Asset metadata.

DAM_CONFIG Used to define the repository to hold the configuration attributes for the DAM process.

DAM_VARIANTS Used to hold the configuration definitions for the variants created in the DAM.

DAM_VARIANTS_SIZE Used to hold the configuration definitions for the variants created in the DAM.

ENABLE_READY Deprecated

EXTENDED_DEFINITION Deprecated

EXTENDED_ATTR Deprecated

EXTENDED_DATA Deprecated

HIERARCHY_CATALOG Used to define the repository for use in linking data to the hierarchy.


Page 174 of 300 Revised 6/28/2018

Type Description

PUBLISH_PLAN Deprecated

CODE SET METADATA Used to define the repository that extends code sets with custom attributes.

22.1.3 Profile Properties

Create any needed Profile Properties to store attribute metadata, for example, a profile property called Portal_Use_Flag could be used to identify any attribute that needs to be sent to an external portal.

7. Select the New option under the Action Dropdown list.

8. Select a Property Template, if one exists that satisfies the requirement (optional).


Page 175 of 300 Revised 6/28/2018

9. Enter a Property Name and select the Data Type.

10. Fill in the additional fields, which are different depending upon the Data Type.


22.1.4 Profile Property Rules

Create any needed Profile Property Rules (also called Validation Rules) to define checks made against one or more fields when a record is modified. These Profile Property Rules can be assigned to one or more attributes.

12. Click on the Profile Property Rules tab.


Page 176 of 300 Revised 6/28/2018

13. Click the New option under the Action dropdown menu.

14. The Property Rule Editor window is shown.


Page 177 of 300 Revised 6/28/2018

15. Enter the Property Rule conditions.


17. Click the Next button after returning to the add Profile window.

22.1.5 Profile Attributes

18. The Define Attributes window will be shown.

19. Select the New option under the Action dropdown menu.


Page 178 of 300 Revised 6/28/2018

22.2 Managing Snapshot Tables

External applications have the option to access Enable data via ODBC accessible database views (snapshot tables) for each repository. The contents of these views are dictated by which attributes are identified as being relational (on the Repository Attribute Properties page). Any time the list of relational attributes changes, the corresponding views will be automatically updated.

22.3 Creating/Updating Enable Snapshot Tables

The following steps show how to add (or remove) one or more attributes in a repository’s snapshot table.

1. Log into Enable as a user assigned to the Administrator group.

2. Select Repositories from the Quick Links dropdown list on the top right of the screen or

Model/Repositories from the left Feature bar.


Page 179 of 300 Revised 6/28/2018

3. From the Repository list, single-click to select the repository record that contains the

attribute(s) to add to the snapshot table.

4. Select the Edit/Attribute Properties from the Action dropdown menu.


Page 180 of 300 Revised 6/28/2018

5. Check or uncheck the Relational checkbox for each attribute to be added to or removed

from the Snapshot table.

6. Click the Save button at the bottom of the screen.


Page 181 of 300 Revised 6/28/2018

22.4 Auto-Generated Sequence Maintenance

The following sections describe defining and/or maintaining an auto-generated sequence attribute for a repository.

22.4.1 Defining the Sequence Attribute

To define the attribute that will use a generated sequence number definition:

1. From the repository, select the Manage Model / Profile option.


Page 182 of 300 Revised 6/28/2018


3. Select New from the Action dropdown list (or select an existing field and select Edit).

4. Select the Common Attribute of “Sequence” and that field will use the repository’s

sequence definition to get the next sequential value if the field is blank when the record

is saved.

22.5 Adding a Sequence Definition

An auto-generated sequence value for a repository is controlled by the corresponding sequence definition associated to the repository. When a new record is created in the repository and no value for the auto generated id field is provided, the next sequence number is selected from the sequence definition. Even though a sequence definition can be shared by multiple repositories, it is recommended as best practice to create a separate sequence definition for each repository. A repository sequence definition is defined as follows:


2. Select Repositories from the Quick Links dropdown list on the top right of the screen

or Model/Repositories from the left Feature bar.


Page 183 of 300 Revised 6/28/2018


auto-generated sequence attribute.

4. Select the Edit/Properties option from the Action dropdown menu.


Page 184 of 300 Revised 6/28/2018


Page 185 of 300 Revised 6/28/2018

5. Select the Auto Generate Sequence checkbox.

6. Click the Manage button next to the Sequence dropdown list (above the Auto Generate

Sequence checkbox) to create a new sequence definition.

NOTE: Sequence definitions can also be accessed via the Model Configurations / Sequences option on the left Feature Pane.

7. Enter a Name and Starting Sequence Number for the sequence number definition.



Page 186 of 300 Revised 6/28/2018

22.5.1 Adjusting the Starting Sequence Number

If the auto-generated sequence attribute is the primary key, a validation error will be shown if the value is not unique. This could indicate a need to reset the starting sequence value for the repository. Perform the following steps to adjust the next sequence for a repository.


2. Find the highest currently used sequence value:

a. Open the repository.

b. If the sequence attribute is not listed in default preference view, select a user

preference that contains the auto-generated attribute (or the No Preference

option that contains all fields).

c. Single-click on the table header column for the sequence attribute. First time will

sort ascending, second time will sort descending. Note the highest value for this

attribute will appear as the first or last item.


Page 187 of 300 Revised 6/28/2018

3. Select Repositories from the Quick Links dropdown list on the top right of the screen

or Model/Repositories from the left Feature bar.


auto-generated sequence attribute.


Page 188 of 300 Revised 6/28/2018

5. Select the Edit/Properties option from the Action dropdown menu.

6. If the repository has an auto-generated sequence attribute the Auto Generate

Sequence checkbox will be selected.


Page 189 of 300 Revised 6/28/2018

7. Click the Manage button next to Sequence dropdown list to change the next sequence

number to use, which is the field above the checkbox.

8. Change the Starting Sequence Number to the next number you want the system to use

for the auto-generated field. (Set the Starting Sequence Number to number greater

than the value retrieved in step 2.)

9. Click the Save button and a confirmation widow will be shown.

22.6 Repository Link Management

The repository links are used to link two repositories that have a relationship with each other. The path of these multiple link relationship between repositories is used to control publication, customized import, customized exports, and enable search views.


Page 190 of 300 Revised 6/28/2018

Care must be taken in 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.

In a link relationship, one repository will be the parent and other repository will be the child. The linkage between repositories is created by joining one or more attributes from both repositories. The join attributes must be defined as part of the snapshot views in order to participate in the join. Once a link has been established, the link is available to be displayed as a link table in both parent and child repository record editor details.

22.6.1 Managing the attributes displayed in link tables

Perform the following steps to adjust what attributes are displayed in the corresponding editors of the linked repository.

1. Log into Enable as a user with Administrative privileges.

2. From Quick Links dropdown, Select Repositories and navigate and select the repository.

3. Select the menu Manage Model→ Manage Link relationship menu. The list of all link

relationships for the repository is displayed.

NOTE: This screen can also be found from the left feature bar by right-clicking on the repository and going to the Manage Model/Manage Links option as shown below.


Page 191 of 300 Revised 6/28/2018

4. Click on the name of the link relationship to edit. Details of Link relationship are

displayed.

NOTE: Do not change existing link names, otherwise the Enable views may break, as well as, other features that reference the link, such as export templates.


Page 192 of 300 Revised 6/28/2018

5. Click Next, the join condition list is displayed. The join is from parent repository to child

repository.

6. Click Next.

7. The Display Options screen is shown.


Page 193 of 300 Revised 6/28/2018

8. Click the Show Link in Detail Editor Checkbox to indicate if link table is shown when

editing the parent repository record.

9. Select an existing Placement Group (also called Attribute Tabs) to define which record

editor tab to show the link table or click the Manage button to modify the Attribute tab

or Attribute Group.

10. Click the Show Buttons checkboxes to control what action buttons will be available to

users.

NOTE: The Edit Link in Grid option will allow the link record attributes to be modified from the link relationship table in an Excel-like format.

11. Click the Edit Button Label Description button to modify the default labels for the

selected buttons as shown below.


Page 194 of 300 Revised 6/28/2018

12. Choose which attributes from child repository to display in parent repositories link table.

Use the arrow buttons to add or remove attributes.

13. The Source dropdown allows you to select attributes from the repositories other link

relationships.

14. Click Display Width button to set widths of columns in the link table.


Page 195 of 300 Revised 6/28/2018

15. To save the display options, click Save.

22.7 Managing the Custom Controls to select linked data

Perform the following steps to adjust what custom JSP UI control displayed next to repository attribute using Enable.

1. Log into the Enable as a user with the Administrator group.


3. From Action Menu select Action→Edit → Properties.

4. The Repository Properties screen for the selected repository appears.

5. Click the Edit button next to the Attribute Properties.


Page 196 of 300 Revised 6/28/2018

6. Select the Calculation Indicator for each attribute (optional).

a. Calculated Attribute with Popup - set on attribute to show the button to invoke

custom UI as in the example below.


Page 197 of 300 Revised 6/28/2018

b. Calculated Attribute - set on attribute whose value may be updated by the

custom control.

7. Click OK to save. Default mapping messages will indicate updates or snapshot update.

22.8 Migrating Enable Data Model

In order to migrate the enable Data Model from one Enable server to another for example, from Development to QA or QA to Production, the following procedure must be performed. The high-level steps and when they need to be performed are described in the table below:

Step When Performed

Common Attribute Migration A name or data type of any Common

Attribute has been changed

Enable Data Model Migration Code set definition changes

Addition, modification (e.g., character

length, data type, etc.) or removal of

attributes to any profiles

Hierarchy or Taxonomy changes (e.g.,

addition of new nodes)

Change to attribute order, group or tab

assignments.


Page 198 of 300 Revised 6/28/2018

Step When Performed

Extended Attribute Migration Change of extended attribute data type,

or character length or required status.

Addition of extended attributes for

nodes.

Repository Property Migration Addition of attributes that have been

added to the snapshot table.

Change of default values.

Change of assignment of Pop-Up controls

and pages.

Update Snapshot Table Views After EPIM Data Model Migration or

Repository Property Migration has been

performed

Restart of EnterWorks Services After any of the above steps are

performed.

The following subsections provide the detailed steps for performing each of these high-level steps described in the table above.

22.8.1 Common Attribute Migration

If existing Common Attributes are modified, these changes must be manually applied to the other environment.

To modify a Common Attribute:

1. Log in to Enable as a system administrator.

2. Click the Model option on the feature bar and select the Profiles function.


Page 199 of 300 Revised 6/28/2018

3. Select Manage Model→ Common Attributes. The Common Attribute – Listing page

appears.

4. Double-click the attribute to be modified. The Common Attribute – Details dialog

prompt appears.

5. Make the desired changes and click OK.

6. Repeat steps 4 and 5 for any additional Common Attributes.

22.8.2 Enable Data Model Migration

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) 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 Attribute tabs (including order) have been changed, click the Check link at the top

of the Attribute Tabs section. All attribute tabs are checked.

8. If any Attribute groups (including order) have been changed, click the Check link at the

top of the Attribute Groups section. All attribute groups are checked.

9. 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).

10. If any changes have been made to the hierarchies or taxonomies, check its checkbox in

the Hierarchies section.

11. If any changes have been made to a Publication Context, check its checkbox in the Pub

Contexts section.

12. If any changes have been made to a Publication Context Group, check its checkbox in

the BpubContextGroup section.


Page 200 of 300 Revised 6/28/2018

13. If any changes have been made to a Style Map, check its checkbox in the Style Maps

section.

14. If any changes have been made to a Style Map Group, check its checkbox in the

BstyleMapGroup section.

15. Click Migrate. The Migration History page appears with the new migration job

appearing at the top of the list.

16. Repeatedly click Refresh to monitor the progress of the migration, until the Status

shows “Completed”.

17. Copy the .zip and .msf files from the <drive>:\Enterworks\shared\migration

folder on the source system (e.g., QA) to the same location on the target system (e.g.,

PROD).

18. Log into the target Enable (e.g., PROD) as user system.

19. Click on the Migration option on the feature bar and select Migrate In function. The

Migrate Objects In page appears.

20. Select the zip and msf files that were just copied to the migration folder and click Next.

The Select Objects to Migrate page appears.

21. Click the Overwrite All Check link. The checkboxes for all objects in the migration are

checked.

22. Click Migrate. The Migration History page appears with the new migration job

appearing at the top of the list.

23. Repeatedly click Refresh to monitor the progress of the migration, until the Status

shows “Completed”.

24. Select the Users and Groups Feature and select the Groups function. The list of groups

appears.

25. For each group, perform the following:

a. Click the checkbox next to the group record and select Security from the Action

menu. The security page for the group appears.

b. Click the Hide All link on the top right and open the Code Sets table.

c. Click the Check link under the Read column to ensure all code sets are readable

by the group.

d. Click Save. The changes to security are saved.

26. If there are any migration errors reported, click the Log File icon for the Migration in

the History Page. A window containing the migration log file contents appears. If the

errors are substantial and cannot be quickly remedied, abort the migration attempt by

restoring the target Enable database from the backup.


Page 201 of 300 Revised 6/28/2018

22.8.3 Repository Property Migration

Changes made to the properties of a Repository (e.g., adding/removing an attribute to/from the snapshot table, changing its default value, adding/removing the index to/from an attribute, adding/removing a Calculate pop-up for the attribute) must be manually replicated in the target repository by performing the following steps:

1. Log in to the target Enable (e.g., PROD) as user system.

2. Click the Content Feature and expand the list of repositories by clicking the triangle to

the left of the desired group under the Repositories list. The list of repositories appears.

3. Click the link of the repository to be updated and select the Edit →Attribute Properties

from the pop-up menu. The Attribute Properties page appears.

4. Make the desired changes to the attributes to match the changes made to the source

system.

5. Click Save.

22.8.4 Migrating Objects

1. Expand Content on Feature bar.

2. Open the Repository to have migration activity.

3. Expand Migration Feature.

4. Select Migration In or Migration Out.

5. Click on Hide All.

6. Open Bimport Config (last item on the list).


Page 202 of 300 Revised 6/28/2018

12.

7. Enter Migration Zip File Name.

8. Enter Migration Specification File Name.

9. Select Migration Specification File Name on Server from dropdown list.

10. Click on Migrate.

23. System Administration

23.1 Enable Environments

EnterWorks recommends at least two separate environments for the Enable implementation: DEV, and PROD. The PROD environment has the Enable PIM, DAM and PUB components running on the web server, the Enable PIM App server and EPX components running on the application server and a separate SQL Server 2008 database server.


Page 203 of 300 Revised 6/28/2018

The DEV environment only requires two slave servers and all components from WEB and APP servers are on a single server box. The DEV server should be used to test system upgrades, import templates, and system changes before applying to production.

If possible, a QA test environment should also be set up the same way as production in order to test on a configuration that matches production. This is especially useful for system upgrade testing.

23.1.1 Enable PIM

Some user tasks such as Importing, Exporting, Validation, and Mass updates are submitted as background jobs. These background jobs are distributed to an available free PIM Slave server to execute. The Master PIM server controls will monitor for new jobs, determine if the job can be run simultaneously with other jobs or must be run sequentially, and then send the job to the next free server. When the job is run on a separate server the log files will be located with that server. In general, the greater the number of PIM Slaves configured, the greater the number of jobs that can run concurrently. However, some jobs will be serialized due to resource constraints. For example, import jobs to the same target repository will be processed serially, regardless of the number of configured slaves.

Web Server

PIM PIM DAM

App Server

PIM PIM

EPX

Database Server

SQ


Page 204 of 300 Revised 6/28/2018

NOTE: In distributed environment, for the Enable system to access files, the services must be run using a network account that has permission to access shared resources for all locations where the Enable application is installed.

23.1.2 Enable DAM & PUB

The Enable DAM settings are controlled through the Enable DAMConfig repository and variant settings are set in the DAMVariant repository and web.config property file in the <drive>:\Enterworks\EnableWeb folder. Any changes to image location and file paths must be updated in these repositories and the system must be restarted for changes to take effect.

The Enable DAM will load images from the defined DAMRoot folder path. The DAM will automatically create all defined variants in separate folders under DAMRoot. The DAMFilesPerNumberedFolder property in the DAMConfig repository dictates how many images are to be placed into each physical file folder. When the number of images reaches the configured maximum the system will automatically create a separate subfolder for next set of images.

For uploading large image files or multiple image files a bulk upload utility service will run in background. This service monitors the DAMDrop folder for new images. The drop folder must be shared and have the correct security setting so that users can drop new images into the folder. The background bulk upload service will periodically monitor the DAMDrop folder and upload the new images.

23.1.3 Stopping and Starting Services

When stopping and starting services for DEV, QA, or PROD, use the “Stop Enterworks” and “Start Enterworks” toolbar shortcuts or the individual start and stop scripts for each component. If these are not defined for your login, right click on task bar and add new toolbar, then browse to Service folder in <drive>:\Enterworks\bin.

Any time any one of the components is restarted all EPIM, EPX and IIS services must be restarted. The startup script will ensure all services are started in the proper order. You must run the scripts defined on each server or utilized the common script to stop all services across the boxes. Run the scripts as administrator as shown below:


Page 205 of 300 Revised 6/28/2018

23.1.4 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.

23.1.5 Custom Property Files

Enterworks.properties – Contains customized configuration settings. This file is located in the EPX component. Anytime a change is made to this file, all the services should be restarted.

• APP Server – EPX component in <drive>:\Enterworks\EPX4\DesignConsole\conf\

The settings in this file control workflow settings, email notification settings, and Promotion workflow settings.


Page 206 of 300 Revised 6/28/2018

23.1.6 EPX Property Files

config.properties – Contains the configuration settings for the EPX component. Anytime a change is made to this file the EPX services should be restarted.

• Web Server – EPX component in <drive>:\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 <drive>:\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 <drive>:\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 <drive>:\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 <drive>:\Enterworks\EPX4\Jboss\modules\system\layers\base\native\

sbin\

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 JBoss JVM.

23.1.7 EPIM Property Files

sharedconfig.properties – Contains the configuration settings for the EPIM component. Anytime a change is made to this file the EPIM services should be restarted.


Page 207 of 300 Revised 6/28/2018

• WEB Server – EPIM Tomcat component in <drive>:\Enterworks\EnableServer\tomcat\webapps\webcm\WEB-

INF\classes

• WEB Server – EPIM MASTER JBoss component in <drive>:\Enterworks\ EnableServer\jbossMaster\standalone\configuration\conf

• APP Server – EPIM Slave 1 JBoss component in <drive>:\Enterworks\ EnableServer \jbossSlave1\standalone\configuration\conf



Generally, changes should only be made to this property file based on direction from a patch. The settings in these files are for location of EPIM folders, server host name, ports and database connection information. The password to the database is encrypted. Use the script in <drive>:\Enterworks\EnableServer\bin\getEncryptedString.bat to generate the encrypted password. Additionally, these files have customizable settings for controlling triggers, promotion configuration, UI, and publication options.

WorkFlowHandlerConfig.properties – Contains configuration settings for invoking custom workflows on repository actions. Anytime a change is made to this file the EPIM services should be restarted.

• WEB Server – EPIM Master JBoss component in <drive>:\Enterworks\EnableServer\jbossMaster\standalone\configura

tion\conf

• APP Server – EPIM Slave 1 JBoss component in <drive>:\Enterworks\EnableServer\jbossSlave1\standalone\configura

tion\conf


tion\conf


tion\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.

• <drive>:\Enterworks\EnableServer\tomcat\bin\service.bat


Page 208 of 300 Revised 6/28/2018

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.

• <drive>:\Enterworks\EnableServer\jbossMaster\bin\service\service.

bat

• <drive>:\Enterworks\EnableServer\jbossSlave1\bin\service\service.

bat


bat


bat

• <drive>:\Enterworks\EnableServer\jbossMaster\bin\standalone\stand

alone.conf.bat

• <drive>:\Enterworks\EnableServer\jbossSlave1\bin\standalone\stand

alone.conf.bat


alone.conf.bat


alone.conf.bat

• <drive>:\Enterworks\EnableServer\jbossMaster\bin\standalone\stand

alone.bat


alone.bat


alone.bat


alone.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 <drive>:\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.


Page 209 of 300 Revised 6/28/2018

23.1.8 Configuring Google translate API

In order to activate the Google translate API for the Multi-Language Editor make sure the settings for the Google Translate API section in sharedConfig.properties for Tomcat all Jboss instances match the lines of code shown below. If the following section is not in the sharedConfig.properties files stop the services using the STOP ENTERWORKS shortcut script, then add them to the bottom of the sharedConfig.properties file and start the services again using the START ENTERWORKS shortcut script.

#######################################################################

#Google Translate API

#######################################################################

google.translate.enabled=1

google.translate.refer.site=52.0.11.117

google.translate.key=AIzaSyAFTHWpMaso5FbWQMil-gh9J0wWvT1MzO0

23.1.9 Regional Language Login Access

For Users to be able to access Regional Language functionality at the login window the following line of code allowRegionalLogin must be set to true in sharedConfig.properties for Tomcat and Jboss services. If the lines of code shown below are not present stop the services using the STOP ENTERWORKS shortcut script, then add them to the bottom of sharedConfig.properties files and start the services again using the START ENTERWORKS shortcut script.

#######################################################################

#Specify if ‘Regional Login’ link is available on the Login Page

#######################################################################

allowRegionalLogin=true

sharedConfig.properties file are located in:

• D:\Enterworks\EnableServer\tomcat\webapps\webcm\WEB-

INF\classes\sharedConfig.properties

This change must also be added to the Jboss Server(s) depending on:


Page 210 of 300 Revised 6/28/2018

• If the setup is a single Jboss Server:

<drive>:\Enterworks\EnableServer\jboss\standalone\configuration\c

onf\sharedConfig.properties

• If the setup is a Master Jboss Server with Slaves:

<drive>:\Enterworks\EnableServer\jbossMaster\standalone\configura

tion\conf\sharedConfig.properties

<drive>:\Enterworks\EnableServer\jbossSlave1\standalone\configura






23.1.10 Changing the Enable Database Password

The EPIM database user and password is established within the SQL Server database and then used within configuration files in the Enable installation. The password is encrypted in these files. The initial Enable installation takes care of encrypting the correct value into the configuration files.

The user and/or password that EPIM is installed with may be changed at any time by following these steps.

1. Shutdown the Enable services:

13. Use the start and stop scripts provided in the <drive>:\Enterworks\bin\Service

folder to stop all enable services on each server. Otherwise use Windows

Administrative Tools→Services window and locate all enable services and set the

status to “Stop”.

2. Change User and/or Password within SQL Server:

3. Follow normal database administrator standards. Within SQL Server the steps are:

a. Log into the Microsoft SQL Server Management Studio with the administrator

login.

b. Click Security→Logins to display all users.

c. Right-click on user login, select Properties.

d. Fill in new Password and Confirm Password.

e. Click the OK button.

4. Encrypt the EPIM Password:


Page 211 of 300 Revised 6/28/2018

14. EPIM has an encryption utility that will encrypt the password. The following steps use

<new_password> to indicate where the new password value is entered. Substitute the

actual password in the following steps:

a. Open a DOS prompt and change to the following directory (substitute <drive> for

the installed drive):

15. <drive>:\Enterworks\EnableServer\bin\

b. Type: getEncryptedString <new_password>

c. A result similar to this will appear:

16. EncryptedString=k9PN44Zn0bw=

d. Copy the encrypted value e.g. k9PN44Zn0bw= and edit the value for the

property “EPIM.connection.password” in all locations within the

sharedConfig.property files:

▪ <drive>:\Enterworks\EnableServer\tomcat\webapps\webcm\

WEB-INF\classes

▪ <drive>:\Enterworks\EnableServer\jbossMaster\standalon

e\configuration\conf

▪ <drive>:\Enterworks\EnableServer\jbossSlave1\standalon






e. Copy the encrypted value e.g. k9PN44Zn0bw= and replace the unencrypted

password located in the following files:

▪ <drive>:\Enterworks\EnableWeb\web.config

▪ <drive>:\Enterworks\EPX4\DesignConsole\conf\Enterworks

.properties

5. Restart the Enable services:

17. Use the start and stop scripts provided in the <drive>:\Enterworks\bin\Service

folder to start all enable services on each server. Otherwise use Windows

Administrative Tools→Services window and locate all enable services and set the

status to “Start”.

6. Verify EPIM login functionality:

18. Using your Internet browser, connect to Enable PIM login and log on using the login

“system” (the password to the “system” login is initially “system”, but may be changed

by the administrator after installation).

19. Verify that you can successfully login and view your content.


Page 212 of 300 Revised 6/28/2018

23.2 Users Groups & Security Management

Users are entered into Enable and then assigned to Groups. The groups are defined based on types of system responsibilities, such as Administrator, Product Manager, Publications Manager, or Syndication Manager. These groups are designed around each organization’s specific business processes. To efficiently manage the Enable users’ security, EnterWorks recommends that system security is managed at the group level.

23.2.1 Enable Groups

Enable Groups control both functional areas of the application a user is allowed to view or perform, and what level of access a user in a group has access to objects within Enable PIM (e.g. code sets, users, groups, repositories etc.). Each type of object can be set to assign user within group permission to create object, read, edit or delete permission on existing Enable PIM objects.

Repositories have additional permission to allow adding, editing, sync-in (importing), and deleting records inside of repository. Care must be given to assign correct permission to repository and underlying objects that build that repository. Anyone given access to repository must have read privilege on the underlying profile and code sets used by repository. If allowing the user to import data into a repository, the create permission must be given to File Definition and Data Source objects.

Repositories security assignment must also select an attribute security filter and optionally record security filter. The filter attribute controls which attributes in a repository the user is allowed to read and edit. If no specific filter is defined for profile, the default filter must be specified. If no filter is defined, the user will not see any data. The Record filter applies a search condition on records returned from a repository to limited access for only those records that match the Record filter criteria.

Adding or Removing a User to or from an EPIM Group

1. Log into the Enable as an Administrator.

2. Click on the Users and Groups feature bar.


Page 213 of 300 Revised 6/28/2018

3. Click the Groups feature within the Users and Groups feature bar. The list of defined

groups appears.

4. To create a new Group, select the New option under the Action dropdown menu.

5. Click on the group record and select the Edit option from the Action dropdown menu.


Page 214 of 300 Revised 6/28/2018

6. Alternatively, double-clicking on the Group record will open the editor.

7. A groups name and description field are translatable. In order to add translations simply

click the multi-language icon corresponding to name or description and add

translation through the multi-language editor.

8. Click Next. The Users page appears.


Page 215 of 300 Revised 6/28/2018

9. Select the users to be added from the Available Users list.

10. Click the Add > button. The users are added to the Selected Users list.

11. Select the users to be removed from the Selected Users list and click the < Remove

button. The users removed from the Selected Users list.

12. Click Next to continue with additional Group properties; the Group Capability page

appears. These capabilities represent aspects of the user interface that members of the

Group will have access to.


Page 216 of 300 Revised 6/28/2018

13. By expanding each Node in the list, individual aspects of each section can be “granted”

to the Group. A checkmark in the checkbox indicates that users in the Group will have

access to the capability.

20.

14. Click Next button to advance to the Set Display Attribute Tabs page. Here all of the

Attribute Tabs (i.e. collections of attributes within a repository) within each defined

Profile are displayed. A checkmark should be placed next to each Attribute Tab that

members of this Group should be able to view with ENABLE’s Item Editor. This feature

allows certain collections of Attributes to be hidden from group members.


Page 217 of 300 Revised 6/28/2018

15. Click Save if no more changes are desired. The changes to the Group are saved and an

Operation Successful dialog prompt appears.

Assigning Object Security to an Enable Group



3. Click on the Groups feature within the Users and Groups feature bar. The Groups list

appears.

4. Select the Group to which privilege(s) will be added or removed.

5. Then select the Security option from the Action menu.


Page 218 of 300 Revised 6/28/2018

6. A Security page will be shown for the selected group.

7. Click the Hide All link on the upper right of the page to view all categories of security.


Page 219 of 300 Revised 6/28/2018

8. Each category of permissions pertains to a specific Enable security-enabled object type

a. Click the Create check box in each sub group to allow user in group to create

that object.

b. Click the Read, Edit or Delete checkbox for each object to set permission to that

object.

9. For Repositories, additional permissions are available. The Attribute filter and optionally

the item filter need to be defined.

a. Sync-in allows importing of data into repository.

b. Sync-out not used in this implementation.

c. Add items allows adding new records to repository.

d. Delete items allows deleting records from repository.

e. Attribute filter, must select a filter, the default filter allows access to all

attributes.

f. Item Filter, select a defined available item filter. If none specified, will give access

to all rows of data in repository.

10. The security categories available and permissions for each are described in this table:


Page 220 of 300 Revised 6/28/2018

Security Category

Permissions Available Description

Users Read/Edit/Delete User has Read/Edit/Delete permission by default to themselves; must be granted access to others.

Groups Read/Edit/Delete User has Read permission by default to Groups they belong to; must be granted access to others.

Style Maps Read/Edit/Delete User has Read/Edit/Delete permission by default to any Style Maps (used in publication) created themselves; must be granted access to others.

Templates Read/Edit/Delete User has Read/Edit/Delete permission by default to any Templates (used in publication) created themselves; must be granted access to others.

Data Sources Read/Edit/Delete User has Read/Edit/Delete permission by default to any Data Sources (used for import) created themselves; must be granted access to others.

Sequences Read/Edit/Delete User has Read/Edit/Delete permission by default to any Sequences (used in repositories with auto-generated sequence attributes) created themselves; must be granted access to others.

Profiles Read/Edit/Delete User has Read/Edit/Delete permission by default to any Profiles (attributes defined for a repository) created themselves; must be granted access to others.

Code Sets Read/Edit/Delete User has Read/Edit/Delete permission by default to any Code Sets created themselves; must be granted access to others.

Taxonomies Read/Edit/Delete User has Read/Edit/Delete permission by default to any Taxonomies created themselves; must be granted access to others.

Hierarchies Read/Edit/Delete User has Read/Edit/Delete permission by default to any Hierarchies created themselves; must be granted access to others.

Transmission Options

Read/Edit/Delete User has Read/Edit/Delete permission by default to any Transmission Options (used in definition of a repository) created themselves; must be granted access to others.


Page 221 of 300 Revised 6/28/2018

Security Category

Permissions Available Description

Attribute Security Filters

Read/Edit/Delete User has Read/Edit/Delete permission by default to any Attribute Security Filters (used to grant access to repository attributes) created themselves; must be granted access to others.

Record Security Filters

Read/Edit/Delete User has Read/Edit/Delete permission by default to any Record Security Filters (used to grant select privilege to certain rows in repositories) created themselves; must be granted access to others.

File Definitions Read/Edit/Delete User has Read/Edit/Delete permission by default to any File Definitions created themselves; must be granted access to others.

Repository Groups

Read/Edit/Delete User has Read/Edit/Delete permission by default to any Repository Groups created themselves; must be granted access to others.

Media Groups Read/Edit/Delete User has Read/Edit/Delete permission by default to any Media Groups created themselves; must be granted access to others.

Repositories Read/Edit/Delete/View/SyncIn/Add Records/Delete Records/Edit Meta Data/Edit Record Attribute Filter/Record Filter

Read: permission to read repository definition

Edit: permission to Edit items within repository; combine with Edit Record Attribute Filter to determine which attributes have Read/Edit

Delete: permission to delete repository and contents

View: permission to view the repository in context of Enable Content feature listing

SyncIn: permission to use Import to add data to repository

Add Records: permission to add new rows to repository

Delete Records: permission to delete rows from repository

Edit Metadata: permission to change repository properties


Page 222 of 300 Revised 6/28/2018

11. Click Save. The changes to the Group Security are saved and an Operation Successful

dialog prompt appears.

23.2.2 Enable Users

Users must be defined locally and assigned to a single Group for maintaining security and access. User’s authentication can be from Active Directory or from Local Enable Database.

23.2.3 Managing Users with Active Directory

When the active directory is configured and the user is identified as an “Is LDAP” user, the Enable system will validate the user password using active directory authentication.

The use of LDAP versus secure LDAP (LDAPS) depends on system configuration.

The LDAP protocol and port choices may also differ between development, test, QA, staging, and production based on environmental and operational requirements.

23.2.4 Configuring the Active Directory


2. Click on the Users and Group feature bar.

3. Open the Users, click on menu Utilities→ LDAP Configuration.


Page 223 of 300 Revised 6/28/2018

4. Check the LDAP Enabled checkbox to enable Active Directory.

5. Select “Microsoft Active Directory” as Provider.

6. Do not change the Context, it will update automatically.

7. Select “SUBTREE_SCOPE” option in the Search Scope dropdown list.

8. Enter the LDAP Server Host according to the protocol used:

• LDAP: <hostname>

• LDAPS: ldaps://<hostname>

9. Enter the LDAP Server Port. This can be the server’s port or the default value for the

protocol used.

• LDAP: the default port is 389.

• LDAPS: the default port is 636.

10. Optionally, enter Search Base using standard LDAP terms.

11. Enter the full domain name for the User Context Search Base.

12. Enter the short domain name for User Default Domain.

13. Click Save.


Page 224 of 300 Revised 6/28/2018

23.2.5 Adding Active Directory Users

23.2.6 Automatically adding user from Active Directory

1. To automatically add users from active directory, there must exist in Enable a group that

has an exact match with the Active Directory Group name. Ensure that user is a member

of that active directory group. When the user first logs on to Enable, the enable system

will automatically add the user to the local database if the user is authenticated and is a

member of the corresponding active directory group.

2. After user has been added to the local system, any changes to the Active directory

group membership will not be reflected in Enable. You must manually move the user to

appropriate group in Enable.

23.2.7 Changing Local User to Active Directory user


2. Click on the Users and Group feature bar.

3. Open the Users, select a user and click on menu Action→ Edit or double-click on a user

row in listing.

4. Change the LDAP User dropdown to Yes.


Page 225 of 300 Revised 6/28/2018

23.2.8 Adding or Removing a Local User




Page 226 of 300 Revised 6/28/2018

3. Click on the Users feature within the Users and Groups feature bar. The Users list

appears.


Page 227 of 300 Revised 6/28/2018

4. Select the New menu option from the Action menu. The New User editor appears.


Page 228 of 300 Revised 6/28/2018

5. Fill in all fields prefaced with a green flag (required fields) and click Next to continue.

The Detailed user editor appears. These fields are all optional; click Next to continue.

6. The Manage User Groups editor appears.

7. Move entries from the Available Groups panel to the Selected Groups panel. The

entries in the Selected Groups panel will be the groups to which your user will belong.

8. Click Save to save the user.


Page 229 of 300 Revised 6/28/2018

9. To remove (delete) a user simply highlight the desired user and select the Delete option

from the Action dropdown menu.


Page 230 of 300 Revised 6/28/2018

10. Respond to the confirmation request.


Page 231 of 300 Revised 6/28/2018

23.2.9 Attribute Security Filter Management

An Attribute Security filter controls access to column data (i.e., attributes) in a repository. The filters are created based on the profile definition and assigned to repository security to users and groups.


2. Click on the Security Filters feature bar option.

3. Click on the Attribute Security Filters function. The list of defined attribute security

filters appears.


Page 232 of 300 Revised 6/28/2018

4. Click on the attribute security filter record.

5. Select Edit from the Action menu. The Attribute Security Filter page appears.


Page 233 of 300 Revised 6/28/2018

6. The attribute security filter is defined for a profile. For new filter, a profile must be

chosen. Click Next.


Page 234 of 300 Revised 6/28/2018

7. The Attributes for the profile are listed in a collapsible sub grouping list. Set read and

edit permission for each attribute in all sub groups. If you have selected a profile where

a Taxonomy with Owner configuration is defined for one of the attributes, then an

additional column titled Owner Edit will appear for each attribute section. A check in

this column means that only the user defined as the owner of the taxonomy code value

will have edit permission to item data containing that value.

8. Click Save.


Page 235 of 300 Revised 6/28/2018

9. To assign the Attribute Security Filter to a Group:

a. Open the Users and Group feature.

b. Open the Group function.

c. Select the Group record the Attribute Security Filter applies to.

d. Select the Security option under the Action dropdown menu.


Page 236 of 300 Revised 6/28/2018

e. Click the Hide All link on the top right of the screen to close all the category

details.

f. Navigate to the Repositories section and open it by clicking the + plus sign.

g. Navigate to the repository needing the attribute security filter applied for the

group.

h. Select the Attribute Security Filter in the Record Attribute Filter column.

i. Navigate to the bottom of the list and click the Save button.


Page 237 of 300 Revised 6/28/2018

10. The same method can be used to assign an Attribute Security Filter to a User (starting

with a User instead of a Group), but it is recommended as best practice to use a group

(even if there is only one person in the group).

23.2.10 Record Security Filter Management

Record Security filter controls access to row data in a repository. The filters are created based on the profile definition and assigned to repository security to users and groups.


2. Click on the Security Filters feature bar.


Page 238 of 300 Revised 6/28/2018

3. Click on the Record Security Filters function within the Security Filters feature bar. The

list of defined record security filters appears.

4. Select the item security filter record to edit and double-click the record or select Edit

under the Action dropdown menu.

5. The Record Security Filter page appears.


Page 239 of 300 Revised 6/28/2018

6. Add filter conditions by pressing the add button. A list of available attributes will be

displayed.

7. Click OK, and the Record Security Feature Details screen is shown again.


Page 240 of 300 Revised 6/28/2018

8. Select a Search Type (Contains or Exact Match) and enter the Search Value.

9. If more than one search condition is defined, select the "OR" or "AND" operation radio

button.


To assign the Record Filter to a Group:

1. Open the Users and Group feature.

2. Open the Group function.

3. Select the Group record the Attribute Security Filter applies to.

4. Select the Security option under the Action dropdown menu.


Page 241 of 300 Revised 6/28/2018

5. Click the Hide All link on the top right of the screen to close all the category details.

6. Navigate to the Repositories section and open it by clicking the + plus sign.

7. Navigate to the repository needing the attribute security filter applied for the group.

8. Select the Record Security Filter in the Record Attribute Filter column.

9. Navigate to the bottom of the list and click the Save button.

The same method can be used to assign a Record Security Filter to a User (starting with a User instead of a Group), but it is recommended as best practice to use a group (even if there is only one person in the group).


Page 242 of 300 Revised 6/28/2018

23.3 Configuring a Group’s Home Page Desktop

When users first log on to the Enable application a customizable desktop is presented. The desktop allows multiple tabbed windows to be opened for each content feature and the tabbed window can be re-ordered and closed. The Home tab allows users to define and configure custom panels that will show most relevant content for the user. The Home tab cannot be closed.

Initially the Home tab will show the default configuration for a Group. Users can customize this configuration, and once customized the home page will be saved specific to the user.

CAUTION: If you define more than ten (10) panels, browser performance may be impacted. Some browsers do not support too many internal AJAX connections. This may limit the total number of panels that can be defined. If all panels do not load, remove panels until they load correctly.


2. Select the Users and Group feature bar option.

3. Open the Groups function.

4. Select the Group you want to define a default home page for.

5. Select the Edit Home Page option under the Action dropdown menu.


Page 243 of 300 Revised 6/28/2018

6. When first creating home page, blank screen will show. If modifying an existing group’s

home page the configured widgets will be shown.

7. Create or modify report widgets for the Enable group and click the save button on

the top right. See the Enable PIM User Manual for more information on setting up

report widgets.

23.4 Configuring a Repository’s Edit Screens

A repository’s edit screens can be customized in the following ways by a Systems Administrator:

• Tabs – attributes can be arranged on one or more tabs and the order of the tabs can be

specified.

• Groups – attributes can be grouped in one or more sections and the order of the groups

can be specified.

• Group Assignment – attributes can be moved from one group to another.

• Attribute order – order of attributes within each group can be specified.


Page 244 of 300 Revised 6/28/2018

• Preference Views – views can be defined for each repository, controlling which

attributes are visible. See the “Using Repository Preference Views” section in the User

Manual for more information.

• Security – security can be utilized for each repository to control which attributes can be

seen and accessed (e.g., read-only vs. read & edit). See the “Managing Profiles” section

in the Administration Manual for more information.

23.4.1 Tabs

The following procedure describes how to configure/manage the Editor tabs. Use tabs to organize attributes into logical groupings.



3. Select the Attribute Tabs from the Manage Model dropdown menu.

4. The Attribute Tab listing appears showing the currently defined tabs and the desired

display order:


Page 245 of 300 Revised 6/28/2018

5. Select menu option Action→New or select a tab and select menu option Action→Edit.

The Attribute Tab – Details window appears.

6. Enter the name of the new tab and a description (optional) and click OK. The new tab is

added to the end of the list.

7. To order tabs, use the Menu action Set Display Order and reorder tab list.


Page 246 of 300 Revised 6/28/2018

8. To delete a tab, select a tab and select menu option Action→Delete.

23.4.2 Groups

The following procedure describes how to configure/manage the Groups editor. Use Groups to organize attributes into logical groupings shown as sections in a tab.



3. Select the option Attribute Groups from the Manage Model menu.


Page 247 of 300 Revised 6/28/2018

4. The Attribute Group listing appears showing the currently defined groups and the

desired display order.


Page 248 of 300 Revised 6/28/2018

5. Select menu option Action→New or select a group and select menu option

Action→Edit. The Attribute Group – Details window appears.

6. Enter the name of the new group and optionally its description and set which tab that

group will be shown in. Then click OK. The new group is added to the end of the list.

7. To order groups, use the Menu Action Set Group Display Order and reorder groups for

each tab.


Page 249 of 300 Revised 6/28/2018

8. To delete a group, select a group and select menu option Action→Delete.

23.4.3 Group Assignment

Attributes can be moved from one tab/group to another within the Repository’s Profile, as follows.

1. Select the menu Manage Model→ Profile menu options from the repository.


Page 250 of 300 Revised 6/28/2018

2. The Profile editor appears:

3. Click Next. The attribute list appears:

4. Check the checkbox next to the desired attribute and select the menu option

Action→Edit (or double-click the attribute name) to open the attribute editor.


Page 251 of 300 Revised 6/28/2018

5. The Define Attribute Details editor screen appears:

6. Select the desired group in the Group dropdown selection list and click OK. The

attribute is tentatively assigned to the new group (the changes must be saved in order

to make them permanent).


Page 252 of 300 Revised 6/28/2018

NOTE: The first name is the Tab and the second name after the dash is the Group (or section) on that tab that the attribute will be shown under. For example, the Marketing tab shown below shows 4 groups that contain different attributes. Click the left arrow to open the tab and show the attributes under the group.

7. Repeat for all attributes to be re-assigned, when finished click Save.


Page 253 of 300 Revised 6/28/2018

23.4.4 Attribute Order

Attributes can be d within a tab/group within the Repository’s Profile, as follows.

1. Select the menu Manage Model→ Profile menu options from the repository.

2. The Profile editor appears:


Page 254 of 300 Revised 6/28/2018

3. Click Next. The attribute list appears:

4. Click Next. The attribute order list appears:


Page 255 of 300 Revised 6/28/2018

5. Select one or more attributes in one of the attribute groups and click the Up or Down

buttons to change the display order in the group. The selected attributes are moved up

or down in the list.

NOTE: To move an attribute up or down many positions, select all attributes above or below the attribute to be moved and move them in the opposite direction.

6. Click Save at the bottom of the screen.

23.5 Workflow

Enable 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.

23.5.1 Workflow Properties

Workflow Properties gives Enable PIM administrators the ability to configure workflow properties based on workflow requirements. The following screen shows the Workflow Properties screen which is accessed via the Repository → Edit menu. Following this screen is more information on each input field of the Workflow Properties screen.


Page 256 of 300 Revised 6/28/2018

• Workflow Enabled – Repository has the ability to link to an EPX Process Flow when

checked.

• Synchronous Submission – By default Synchronous Submission will be checked. When

checked the user interface will wait for the submission to process before rendering.

Normally, when a submission is large or requires time to interface with other systems

then this option will not be checked so that the submission is asynchronous.

Asynchronous meaning the user interface will not have to wait for a submission to

process in order to render.

• Process Name, Starting Point, and Work Item Name are the default work item

configurations when a work item is automated.

o Process Name – Enable PIM uses the Process Name value to locate the EPX

Process Name so that it knows where to send a work item.

o Starting Point – Enable PIM uses the Starting Point value to locate the starting

point for an EPX process flow.


Page 257 of 300 Revised 6/28/2018

o Work Item Name – Enable PIM uses the Work Item Name to give a default name

to an automated work item.

• 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

then multiple records can be submitted as a single work item, multi-record work item,

to an EPX process flow. When this option is unchecked then multiple records will be

submitted as individual work items.

• Lock Record from Edit – When this option is checked then any record that is part of a

work item is locked for all users except for users of certain roles when the work item is

at an activity for that certain 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 be utilize upon an update.

• 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 either literal values or dynamic values retrieved from a repository’s profile.

23.5.2 Enable PIM Options

The Enable PIM Options provides the ability to link an EPX activity to an Enable PIM repository. Values either reference work item properties or are literal words. Typically, an administrator will keep Repository Name, Repository Friendly Name, and Repository Id dynamic. However, rare scenarios can have literal values. For instance, the activity of processing a specific image of the DAMMaster repository.

1. Log into EPX as an admin.

2. From the Navigator, go to Process Modeling → Process Flows → ProcessReview.


Page 258 of 300 Revised 6/28/2018

3. Right click ProcessReview.

4. Click Open.

5. Click on the Process Flow Modeler tab.


Page 259 of 300 Revised 6/28/2018

6. Right click on a manual activity.

7. Click on the Details tab.


Page 260 of 300 Revised 6/28/2018

Anytime you submit to a workflow you have properties that always 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 saved set

o Saved Set Id

o Saved Set Name


Page 261 of 300 Revised 6/28/2018

• If you selected one item

o Item Id

• If you selected more than one item

o Item Id – values are in comma separated list format

The following properties allow you to add additional information you want to submit to the workflow. Anything inside a 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 Object – Is a way to reference to know what it is the activity is being against. If you

know it is a saved set, then specify the saved set name or if you know it will be a record,

then specify the name of the record. If you leave it blank, then it will not show up.

• Allow Reassign – Future feature that allows users to reassign their own tasks to

someone else.

• Listing Viewer Type – Future feature when a user is in the Worklist Task Manager

viewer the user will be able to be redirected to a record editor or a record listing of work

item records.

• 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 completion of an activity.

• Task Attribute JSON – The data you see inside the square bracket is a JSON array object.

Everything inside each curly bracket is one attribute. For each attribute, we will have

o name – name of attribute.

o default – default value.

o type – determines an html control type.

▪ Type 0 – Text Box

▪ Type 1 – Dropdown Select Box

▪ Type 2 – Select Area Box


Page 262 of 300 Revised 6/28/2018

▪ Type 3 – Check Box

▪ Type 4 – Radio Selection

▪ Type 5 – Hidden

o list – values for the control type.

o In the second attribute you have “name” : “workflowComment”.

workflowComment is a special feature that a viewer of an activity will append

whatever the user enters into a comment history so when the next user comes

up then they can look at the comment history.

23.5.3 Work Item Types

When a record, multiple records, or a saved set are sent to a workflow, Enable PIM will display a Workflow Submission screen with multiple input fields like the following screen.

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. Work Item types can be created from EPX. The following screen is the Work Item Type for the above Workflow Submission screen.


Page 263 of 300 Revised 6/28/2018

Creating a Work Item Type

1. Log into EPX as an admin.

2. From the Navigator, go to Process Modeling → Work Item Types.

3. Right click on the directory Work Item Types.

4. Click New...

5. From the General tab, find the Name input field and enter “defaultSubmission.”


Page 264 of 300 Revised 6/28/2018

6. Click on the MetaData tab.

7. Right click inside the table.

8. Select Add.

9. At this point there are many different combinations of html input fields you can create.

For this admin manual, we are going to create a dropdown list.

10. Enter “workflowApproval” in the Name field.

11. Select String for the Data Type.

12. Enter “Submission Type” in the Label field. This will be the label for Enable PIM’s

Workflow Submission screen.


Page 265 of 300 Revised 6/28/2018

13. Select List for the HTML Input Type.

14. Enter “approval” in the Value field. This will be the default value for the dropdown list.

15. Right click in the Possible Values table.

16. Select Add…

17. Enter “submissionList” in the Name field.


Page 266 of 300 Revised 6/28/2018

18. Right click in the table below the Name field.

19. Select Add.

20. Enter “approval” in the Code field.

21. Enter “Approval” in the Meaning field.


Page 267 of 300 Revised 6/28/2018

22. Click OK.

23. Select Add.

24. Enter “review” in the Code field.

25. Enter “Review” in the Meaning field.


Page 268 of 300 Revised 6/28/2018

26. Click OK.

27. Within the Possible Values table under the Use column, click on the checkbox for the

newly created possible value.

28. Click OK.

29. Click Apply.

30. Click OK.

23.5.4 Monitor Workflow Process

Enable administrator can monitor and manually initiate workflow process from the Enable PIM application.


2. From Quick Links dropdown, select WorkList Task Manager.

3. The My Active Work Items displays a list of current tasks assigned to the logged in

user.

4. To initiate a task that is granted to user, select the Tasks menu and select the task, a

new work item process will start.

5. The All Active Work Items tab displays list of all running tasks for all users and

background tasks.


Page 269 of 300 Revised 6/28/2018

6. Use the action button to view details, clear errors, reassign task or purge task.

7. The All completed Work Items tab show list of all completed tasks.


Page 270 of 300 Revised 6/28/2018

23.5.5 Managing Workflow Process

To manage workflow you must install and use the JAVA thick client “EPX Design Console”. From the Design console, you can monitor workflow activities, add or modify work flow activities.

1. Log onto APP server or a client box that has EPX Design Console installed.

2. Open EPX Design Console.

3. Expand tree and log on using an administrative account.

4. Expand Process Modeling. Expand Process Flow.

5. Right click on workflow to open menu and select Monitor.

6. Click the play icon to view count of all work items at each activity.

7. Click the last blue icon to select an individual work item to monitor. After selecting, click

play icon to track the flow of the work item.


Page 271 of 300 Revised 6/28/2018

8. The work item flow will highlight the path the work item has taken. The green icon is

current location of work item. A red icon indicates an error at that activity.

9. If activity has error, expand the navigation menu to find activity under the

corresponding flow or subflow.

10. Right click on activity and select Work item.


Page 272 of 300 Revised 6/28/2018

11. Double click on the work item from the list.

12. Click on Error tab. Review the error. Once resolved, click on the Clear Error button.

23.5.6 Purging Completed Work Items

Over time work items will grow and it will be necessary to purge all older work that has been completed.


2. From Quick Links dropdown, select WorkList Task Manager.

3. Go to the Completed Work Items tab.

4. From the list select individual work items and use menu Action → Purge to remove

work item.

5. Use menu Action→ Purge All Completed to purge all.

21.

To purge all and/or older uncompleted work items you must use the design console application

1. Log on to APP server or a client box that has EPX Design Console installed.

2. Open EPX Design Console.

3. Expand tree and log on using an administrative account.

4. Expand Process Modeling. Expand Process Flow.

5. From menu select Tools→ Purge Work Items.


Page 273 of 300 Revised 6/28/2018

6. To purge all select all radio option and click OK.

7. To purge for specific work flow, first select workflow in before opening Purge Work

Item window. Then select Selected radio option and click OK.


Page 274 of 300 Revised 6/28/2018

8. To purge based on date range, select the date tab and enter date range and then press

OK.


Page 275 of 300 Revised 6/28/2018

23.5.7 Adding Task to Enable PIM Worklist

To add additional tasks that can be initiated from the Enable PIM work list, the workflow process first must be defined. The sharedConfig.properties must be updated to add task to the configuration. Refer to Configuration Files section for location of the sharedconfig.properties files, all locations must be updated.

1. Add new task name to key epx.tasklist.tasks separated by a comma

2. Using the new task name add following keys updating with new task name for “task1”

and appropriate value for key.

Key Value examples Description

epx.tasklist.task1.name Start PMFImport Name of task as it will appear in UI

epx.tasklist.task1.flowname PMFImport Name of workflow in EPX


Page 276 of 300 Revised 6/28/2018

Key Value examples Description

epx.tasklist.task1.startingpoint Manual Start Starting activity for workflow

epx.tasklist.task1.workitemname Manual Initiated PMFImport Name for work item

epx.tasklist.task1.workitemdescr

iption

Manual Initiated PMFImport Description for work item

epx.tasklist.task1.proplist prop1,prop2 Optional list of property values to pass to

work flow

epx.tasklist.task1.props.prop1.na

me

test1 Name of property, substitute ”prop1” for

value in prop list, repeat for each value

epx.tasklist.task1.props.prop1.va

lue

test1val Value of property, substitute ”prop1” for

value in prop list, repeat for each value

epx.tasklist.task1.groupList Administrator Optional comma separated list of groups that

have access to execute this task

epx.tasklist.task1.userList admin Optional comma separated list of users that

have access to execute this task

3. All sharedConfig.properties files must be updated with same settings.

4. Enable services must be restarted for changes to take effect.

23.6 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 a failure in Enable application.

23.6.1 Archive Files

Every time the Enable services are stopped and restarted using the Services Toolbar scripts, the log files are moved to an archive directory which has the log name, year, day, and time as the directory name. The archive directories for the three EnterWorks applications are all in <drive>:\Enterworks\logs\archive.

Periodically, the older archive directories should be removed.


Page 277 of 300 Revised 6/28/2018

23.6.2 Log files

It is recommended that the log files be archived by stopping and starting the EnterWorks services every week to keep the log files short. This will prevent difficulties experienced when opening larges files and file corruption. This will also assist in troubleshooting when the files are shorter.

For Enable PIM and EPX, log files reside in <drive>:\Enterworks\logs\ under these subfolders:

• \archive

This folder includes copies of logs before the last restart (see previous section for more information on archive logs)

• \EnableServer

This folder includes subfolders: cleanup, codeSet, export

• \enableutilities

This folder includes subfolders: DAMReportUtility, MonitorDAMDrop, RegenerateDAMVariant

• \enableWeb

This folder includes enable logs

• \EPX

This folder includes EPX logs

• \pimql

This folder includes PimqlBIC logs

23.7 Detailed Debugging

In tracking errors in the system it is useful to turn on detailed debugging logs. It is recommended to perform this step before requesting additional support from EnterWorks. Providing the detailed debug logs at time of support call will expedite resolving of issue by EnterWorks support staff.

1. Log into the Enable as a user with the Administrator group.

2. Click on the System feature bar.

3. Click on Log Level Setting.


Page 278 of 300 Revised 6/28/2018

4. Set all the Components to ALL level and click Save.

5. Perform action that causes errors.

6. Repeat steps b and d, this time setting log level back to Severe.

It is recommended to turn off detailed debugging for daily use due to the high volume of entry in log files.

23.7.1 Debugging EPX Work FLOWs

To turn on debugging logs for the workflow processes:

1. In the configuration file

<drive>:\Enterworks\EPX4\DesignConsole\config.properties, change

the debug.out property to “true” .

2. Restart the EPX services.

It is recommended to reset this option back to info for daily use (execute steps 1 and 2 again but set the property to false.).


Page 279 of 300 Revised 6/28/2018

23.8 Server Maintenance

The administrator must set the server properties for system maintenance. When configured, the system will automatically clean up history, log files, system files, and temporary database objects. The system will cache objects for improved performance. Any changes to underlying structure will require administrator to clear the data cache.

23.8.1 Configure System Properties


2. Expand the Feature bar and click on the System feature bar.

3. Click on Server Properties.

4. Check the boxes to schedule clean up job and set job schedule

5. Select which objects to clean and each objects configuration

6. When saved a cleanup-job will be scheduled.

23.8.2 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.


Page 280 of 300 Revised 6/28/2018


2. Expand the Feature bar and click on the System feature bar.

3. Click on Data Cache.

4. Click the clear all button to clear all caches

5. Any users currently on system will get latest data when a feature tab window is

reloaded.

23.8.3 Adding access to Jasper Report server

Once a Jasper Report server is installed, report lists and reports will be available under the Enable Reports feature. Each sharedconfig.properties needs to be edited to complete this configuration.

1. Open each Sharedconfig.properties files in these directories (if applicable):

• <drive>:Enterworks\EnableServer\jbossSlave1\standalong\configurat

ion\conf


ion\conf


ion\conf

• <drive>:Enterworks\EnableServer\jbossMaster\standalong\configurat

ion\conf


Page 281 of 300 Revised 6/28/2018

• <drive>:Enterworks\EnableServer\tomcat\webapps\webcm\WEB-

INF\classes

2. Search for the “Report Manager Settings” section

3. Locate lines starting with the following, and remove the # at the beginning of each line :

Report_Manager.url

Report_listing.url

######################################################################### Report Manager Settings

#######################################################################

#report.manager.url=http://@JASPER_SERVER_HOST@:@JASPER_PORT@/jasperserver-pro/flow.html?_flowId=homeFlow&j_username=jasperadmin&j_password=jasperadmin

#report.listing.url=http://@JASPER_SERVER_HOST@:@JASPER_PORT@/jasperserver-pro/flow.html?_flowId=searchFlow&mode=search&j_username=jasperadmin&j_password=jasperadmin

#######################################################################

# for Preview Jasper Report Base Url

#######################################################################

#jasper.preview.report.server.baseUrl=http://@JASPER_SERVER_HOST@:@JASPER_PORT@/jasperserver-pro/flow.html?

8. Complete these changes for all the sharedconfig.properties files.

9. Save all the files in their respective locations.

10. After completing these steps, restart the EPIM, JBoss, and Tomcat services.

23.9 Services

It is recommended that the EnterWorks services be restarted at least once a week (outside of the normal system reboot cycle). This clears the log files, memory and optimizes system functioning.


Page 282 of 300 Revised 6/28/2018

23.10 Enable Utilities

Enable Utilities component may be installed in folder <drive>:\Enterworks\Utilities or separate folder for each utility.

23.10.1 DAM Report Utility

Enable DAM Report Utility component may be installed in folder <drive>:\Enterworks\Utilities\DAMReportUtility or in <drive>:\Enterworks\DAMReportUtility.

1. Modify the file DAMReportUtility.exe.config in the folder

<drive>:\Enterworks\Utilities\DAMReportUtility.

Item Value

WEB_SERVER_NAME Line 6: <add key="BaseEpimUrl"

value="http://@WEB_SERVER_NAME@:8090/webcm"/>

AWSAccessKey Line 10: <add key="AWSAccessKey" value="@AWSAccessKey@"

/>

AWSSecretKey Line 11: <add key="AWSSecretKey" value="@AWSSecretKey@"

/>

AWSRegion Line 12: <add key="AWSRegion" value="@AWSRegion@" />

AWSBucketName Line 13: <add key="AWSBucketName" value="@AWSBucketName@"

/>

AWSDAMRootFolder Line 14: <add key="AWSDAMRootFolder"

value="@AWSDAMRootFolder@ />


Page 283 of 300 Revised 6/28/2018

Item Value

DB_HOST_URL

DB_USER

DB_PSWD

DB_EPIM

Line 20: <add name="EPIMConnectionString"

connectionString="Data

Source=@DB_HOST_URL@;Initial

Catalog=@DB_EPIM@;Persist Security

Info=True;User

ID=@DB_USER@;Password=@DB_PASS@;MultipleActiveRe

sultSets=True"

providerName="System.Data.SqlClient" />

23.10.2 Monitor DAM Drop Utility

Enable DAM Report Utility component may be installed in folder <drive>:\Enterworks\Utilities\MonitorDAMDrop or in <drive>:\Enterworks\MonitorDAMDrop.

1. Modify the file MonitorDAMDrop.exe.config in the folder

<drive>:\Enterworks\Utilities\MonitorDAMDrop.

Item Value



AWSAccessKey Line 13: <add key="AWSAccessKey" value="@AWSAccessKey@" />

AWSSecretKey Line 14: <add key="AWSSecretKey" value="@AWSSecretKey@" />



/>


Page 284 of 300 Revised 6/28/2018

Item Value



DB_HOST_URL

DB_USER

DB_PSWD

DB_EPIM




Catalog=@DB_EPIM@;Persist Security Info=True;User

ID=@DB_USER@;Password=@DB_PASS@;MultipleActiveRes

ultSets=True"


23.10.3 Regenerate DAM Variant Utility

Enable DAM Report Utility component may be installed in folder <drive>:\Enterworks\Utilities\RegenerateDAMVariant or in <drive>:\Enterworks RegenerateDAMVariant.

1. Modify the file RegenerateDAMVariant.exe.config in the folder

<drive>:\Enterworks\Utilities\RegenerateDAMVariant.

Item Value



AWSAccessKey Line 13: <add key="AWSAccessKey" value="@AWSAccessKey@" />

AWSSecretKey Line 14: <add key="AWSSecretKey" value="@AWSSecretKey@" />



Page 285 of 300 Revised 6/28/2018

Item Value


/>



DB_HOST_URL

DB_USER

DB_PSWD

DB_EPIM




Catalog=@DB_EPIM@;Persist Security Info=True;User

ID=@DB_USER@;Password=@DB_PASS@;MultipleActiveRes

ultSets=True"


24. Channel Readiness

The Channel Readiness widget allows for defining, analyzing, and managing data content requirements for different channels. This new, cloud-ready, functionality will allow for advanced data profiling and channel readiness capabilities that enable end users to more quickly and easily to identify and correct channel-specific data issues, thus reducing time to market for delivering product data to a channel.

It is recommended that a User Group is created and Users be assigned to have access to the Channel Readiness widget. Channel Readiness also restricts what repositories, saved sets, and export templates a User or Group can use based on their security access. The default view of Channel Readiness hides the setup menu from the user. To view the setup menu, select yes for admin when configuring the widget. To create a Group and configure it for Channel Readiness follow these steps:

24.1 Creating a Channel Manager User Group

1. Select the Users and Groups feature.

2. Select the Groups function.

3. Select New from the Action dropdown menu.

4. Enter a name for the group.


Page 286 of 300 Revised 6/28/2018

5. Click Next.

6. Add the users that will be able to use the Channel Readiness widget.

7. Click Next.

8. Add the languages that the new group can use.

9. Click Next.

10. Click Next.

11. Click Save.

12. The new group should be visible from the Group dropdown menu on the user’s home

page.

24.2 Creating a Channel Readiness Widget

1. Select the Users and Groups feature.

2. Select the Groups function.

3. Select the group that is going to get the widget.

4. Select Edit Home Page from the . dropdown menu.

5. Click the + symbol in the top right of the Edit Group Home Config window to add a

new widget.

6. Click the wrench icon at the top right of the new widget to open the configuration menu

for the new widget.

7. Enter a name for the widget title.

8. Select Channel Readiness for the Type.

9. If the widget is for an admin select ‘yes’ for admin, otherwise select ‘no’.

10. If the widget is for inbound channels select ‘yes’ for inbound, otherwise select ‘no’.

11. Enter 600 or more for the height.


Page 287 of 300 Revised 6/28/2018

12. Click the Checkmark symbol at the top right of the widget to save the configuration.

13. Click the disk icon at the top right of the Edit Group Home Config window to save

the Home Page.

14. The widget should now be visible for the users in the Channel Manager group

24.3 Creating a Channel Readiness Shortcut

It is possible to create a Shortcut for Channel Readiness. This shortcut will create a new tab and display the Channel Readiness interface. To create a shortcut widget, follow the steps found in the User Manual. To add the shortcut to the widget, follow these steps:

1. Open the Content feature.

2. Expand the Scheduled Activities Repository folder by clicking the arrow next to its

name.

3. Click on the arrow next to Shortcuts.

4. Select Open.

5. Click the + icon to add a new shortcut.

6. Click the magnifying glass next to the Shortcut Type field.

7. Select Custom tab and click OK.

8. Enter “Channel Readiness” for the name.

9. Click on the Details tab.

10. Select the Channel Readiness type from the Type dropdown.

11. Select the configuration as desired. If it is configured as an admin then the widget will

allow users to edit channels. If it is configured as inbound then the widget will only

show inbound channels, otherwise it will show only outbound channels.

12. Click Save.

13. Click OK.

14. The “Channel Readiness” shortcut should be available in Shortcut widgets.

24.4 Configuring Scheduled Statistic Update

After each update to a Channel, be it modifying the Channel itself or updating records for the channel, the channels Statistics must be updated. This can be done by the user as specified in section 24.5 and beyond but is done automatically every 6 hours by default, but can be configured by following these steps:


Page 288 of 300 Revised 6/28/2018

1. Open the ewconfig file located at: <drive>:\Enterworks\enable-mean\express-micro-

services\conf\ewconfig

2. Navigate to line 106.

3. There are several options predefined. Delete the “//” from the option to be used

and add “//” to the option that already chosen.

24.5 Creating a Channel

1. To create a channel, click on Setup to the left of the slider.

2. Click on New Channel from the dropdown menu.

3. Enter a name for the Channel.

4. Start typing the name of the Repository you want.

5. Either select the Repository from the dropdown menu or continue typing the whole

name.

6. Click Save.


Page 289 of 300 Revised 6/28/2018

Selecting a Saved Set

1. To select a Saved Set, first click on the Channel that you want to select the Saved Set

for.

2. Click on Setup to the left of the slider.

3. Click on Edit from the dropdown menu.

4. Click on Saved Sets.

5. Start typing the name of the Saved Set you want.

6. Either select the Saved Set from the dropdown menu or continue typing the whole

name.


Page 290 of 300 Revised 6/28/2018

7. Click Save.

Selecting an Export Template

1. To select an Export Template, first click on the Channel that you want to select the

Export Template for.




Page 291 of 300 Revised 6/28/2018

4. Click on Export Templates.

5. Start typing the name of the Export Template you want.

6. Either select the Export Template from the dropdown menu or continue typing the

whole name.

7. Click Save.

8. Click Channels.

9. Click on the Channel’s Name.

10. Click Update Statistics.


Page 292 of 300 Revised 6/28/2018

11. Click Run.

12. Click Back.

Selecting Attributes

1. To select Attributes, first click on the Channel that you want to select the Attributes

for.




Page 293 of 300 Revised 6/28/2018

4. Click on Attributes.

5. Click the checkboxes next to the Attributes you want to select. These attributes

come from the Export Template. By default, the attributes that are Required by the

profile are check marked.

6. Click Save.

7. Click on Channels.




Page 294 of 300 Revised 6/28/2018

10. Click Run.

11. Click Back.

Selecting Validation Rules

1. To select Validation Rules, first click on the Channel that you want to select the

Validation Rules for.



4. Click on Validation Rules.


Page 295 of 300 Revised 6/28/2018

5. Click the checkboxes next to the Validation Rules you want to select. The Validation

rules that are displayed come from the Validation Rules for each attribute in the

Export Templates.

6. Click Save.

7. Click on Channels.




Page 296 of 300 Revised 6/28/2018

10. Click Run.

11. Click Back.

Selecting a Transmission Option

1. To select Transmission Option, first click on the Channel that you want to select the

Transmission Option for.




Page 297 of 300 Revised 6/28/2018

4. Click on Transmission Options.

5. Start typing the name of the Transmission Option you want.

6. Either select the Transmission Option from the dropdown menu or continue typing

the whole name.

7. Click Save.

24.6 Editing a Channel

It is possible to edit a Channel after it has been created. All aspects of a Channel, except for the Channel’s Repository, are editable. For Saved Set, Export Template, Required and Optional Attributes, and Validation Rules, they can be set as shown above. For the Channel’s name, instructions are provided below. Once the Channel has been edited, it is required to update the Channel’s statistics for the changes to take effect.

Changing a Channel’s Name

1. Select the Channels Tab.


Page 298 of 300 Revised 6/28/2018

2. Select the Channel that needs a name change.

3. Click on the Setup tab to the left of the slider.

4. Click on the Edit option from the dropdown menu.

5. Click on the Channel Name tab.

6. Change the Name of the Channel in the text box.



Page 299 of 300 Revised 6/28/2018


9. Click on the Channel’s Name

10. Click the Update Statistics button.

11. Click Run.

12. Click Back.

24.7 Deleting a Channel

1. To Delete a Channel, first click on the Channel that you want to delete.


Page 300 of 300 Revised 6/28/2018


3. Select Delete Channel from the dropdown menu.

4. Click Delete.

5. Click Back.

Date post:	15-May-2020
Category:	Documents
Upload:	others
View:	24 times
Download:	0 times

Enable Product Information Management (PIM) · Enable PIM Administration Manual Page 11 of 300...

Documents