Start EnterWorks Services on One Server - Precisely_EnterWorks - Sales_and_Services_Portal - EnterWorks - Match_and_Merge - 11.0
EnterWorks Guide
Product type
Software
Portfolio
Verify
Product family
EnterWorks
Product
Precisely EnterWorks
Precisely EnterWorks > EnterWorks
Version
11.0
Language
English
Product name
Precisely EnterWorks
Title
EnterWorks Guide
Copyright
2024
First publish date
2007
Last updated
2025-01-07
Published on
2025-01-07T07:44:20.997352
EnterWorks Guide
How EnterWorks Works
Users and Groups
Data Model
Repositories and Records
Preferences
Profiles
Attributes
Attribute Data Types
Category and Dynamic Attributes
Specialized Attributes
Editor Control Settings
Data Model Object Properties
How Snapshot Table Views Work
Types of Snapshot Table Views
Main Snapshot Table
Category Attribute Snapshot Table
Multi-language Snapshot Table
Rebuilding and Automatic Rebuilding of Snapshot Tables
Limitations of Snapshot Table Views
Attributes that are Good Candidates for the Snapshot Tables
Using SQL to Access Snapshot Tables
Permitting Access to Snapshot Tables
Taxonomies and Hierarchies
Types of Taxonomies and Hierarchies
Taxonomy and Hierarchies Paths
Digital Asset Management
Governing Image Variant Creation with Regex Rules
Multi-language Support
Saved Sets
Link Relationships
Search and Filters
Basic Text Search
Saved Search and Advanced Search
Filters
Staging and Production
Promotion and Package Promotion
Staging and Production
Package Promotion in Detail
Syndication
Record Validation
Channel Readiness
Transmission Options
Templates
Events
Jobs
Security
User and Group Security
Data Object Security Filters
Security Context
Migrate Data Model and Configuration Components
System Components
Workflow
Using EnterWorks
Logging into the New UI
Session Language
User Dashboard
Customize a New UI User Dashboard
The New UI Screen Controls
The New UI Table Controls
Logging into the Classic UI
Users and Groups
Widgets
Using Widgets
Channel Readiness Widget
Custom Widget
Filter Report Widget
Generate Import Export Template Widget
Import Widget
Item Editor Widget
Job Monitor Widget
Linked Content Report Widget
Logged in User Listing Widget
Repository Status Report Widget
Repository View Widget
Shortcuts Widget
System Health Widget
Upload Digital Assets Widget
Workflow Task Manager (Work List Task Manager) Widget
Multi-language Support
Editing Multi-language Fields
Data Management
Viewing a Repository
Repository View List View Types
Preferences
Add or Edit a Preference
Monitoring Repositories
Repository Audit History
Filter Report Widget
Linked Content Report Widget
Repository Status Report Widget
Repository View Widget
Record Management
Add, Copy, Delete, or Undelete a Record
Rollback Record Changes
Editing Records
Detail Editor
Use Address Validation
Inline Editor
Attribute Value Editor
Item Editor Widget
Edit a Multi-language Attribute Value
Compare Records
Multi-Record Access within a Repository
Manage a Record's State
Record Change History
Repository Audit History
Manage Linked Records
Manage a Record's Taxonomy Assignment
Record Validation
Record Date and Time Synchronization
Saved Sets
Create, Edit, or Delete a Saved Set
Add or Remove Records from a Saved Set
Use a Saved Set
Searches and Filters
Basic Text Search
Saved Search
Advanced Saved Search
Filters
Preview
Taxonomy and Hierarchies
Hierarchy/Taxonomy Sidebar
Hierarchy Management
Hierarchy Manager
Create a Hierarchy
Delete a Hierarchy
Manage Hierarchy Nodes
Manage Hierarchy Record Assignments
Taxonomy Management
Taxonomy Node Management
Manage a Record's Taxonomy Assignment
Manage Category Attribute Assignment
Taxonomy Manager
Digital Asset Management
Import or Upload Digital Asset Files
Upload Digital Assets through Widget or DamMaster
Upload Digital Asset Files to DamMaster in a Repository View
Bulk Import of Digital Assets
Upload Digital Assets Widget
Image Report
Download Digital Assets
Regenerate Variants
Regenerate Variants Using the Classic UI
File Upload Restriction
Factors that Affect Image Processing
Data Quality
Record Validation
Syndication and Channel Readiness
Channel Readiness View Channels Tab
Channel Readiness View Attributes Tab
Channel Readiness View History Graph
Update Channel Statistics
Syndicating a Channel
Channel Readiness Widget
Imports, Exports and Syndication
Imports
Import Records Using the Current View
Import Records Using a Defined Template
Create a Saved Set Import
Create a Pending Content Change File
Import or Upload Digital Asset Files
Multi-language Behavior for Imports
Exports
Export Records using the Current View
Multi-language Behavior for Exports using Current View
Export Records using a CSV, XLS, XLSX, or Syndication Template
Multi-language Behavior for CSV, XLS, and XLSX Export Templates
Export Records using an Exchange Template
Export Records using a JSON or XML Template
Multi-language Behavior for JSON and XML Export Templates
Export Records using a Mapped CSV or InDesign Template
Multi-language Behavior for Mapped CSV and InDesign Export Templates
Generate Import Export Template
Generate Import Export Template Function
Generate Import Export Template Widget
Events
Create, Edit, or Delete an Event
Add or Remove Records for an Event
Define an Event's Record Changes
View Pending Events
Reviewing or Changing a Pending Event's States
Batch Processing of Pending Event Transactions
Promotion
Manual Promotion
Manually Promote Selected Records using the New UI
Manually Promote Selected Records using the Classic UI
Manually Promote a Repository using the New UI
Manually Promote a Repository using the Classic UI
Promote a Saved Set's Definition using the New UI
Promote a Saved Set's Definition using the Classic UI
Package Promotions
Package Promotion Report
Review Difference from Production
Reports
Image Report
Package Promotion Report
System Monitoring for Users
Image Report
Job Monitor
Job Monitor Widget
Logged in User Listing Widget
Package Promotion Report
System Health Widget
Workflow
Using Workflow Task Manager
Workflow Task Manager in Detail
Workflow Task Manager (Work List Task Manager) Widget
Workflow in the Detail Editor
Clear the Cache
Business Administration
Logging into the Classic UI
View a Different Group's Dashboard
Find the EnterWorks Version using the Classic UI
Common Tasks for Business Administrators
Clear the Cache
Rebuild, Drop, or Repopulate a Snapshot Table
Restart EnterWorks Services
Start EnterWorks Services on All Servers
Start EnterWorks Services on One Server
Stop EnterWorks Services on All Servers
Stop EnterWorks Services on One Server
Pause or Resume EPX Processing
Stop EPX Services
Users and Group Management
User Management
Create, Edit. or Delete Local Users Using the New UI
Create, Edit, or Delete Local Users using the Classic UI
Change a Local User's Password
Configure User Impersonation
Group Management
Create or Edit Groups using the Classic UI
Configure a Group's Dashboard and Home Page
Widget Administration
Configure a Group's Dashboard and Home Page
Channel Readiness Widget
Generate Import Export Template Widget Administration
Shortcuts Widget Administration
Edit a Shortcut Link in a Shortcuts Widget
Shortcut Widget Administration in the Classic UI
System Health Widget
Add a System Health Widget to the Administrator's Classic UI Home Page
Job Monitor
Data Model Management
Manage Data Model Folders
Manage Profiles
Create or Edit a Profile
Profile Types
Configure an Attribute
Attribute Control Types
Manage Attribute Groups
Manage Attribute Tabs
Manage Repositories
Create a Repository
Delete a Repository
Edit a Repository's Attribute Properties
Manage Repository Link Relationships
Variant Record Generation
Generate and Update Variants
Link Relationship Join Pairs
Configure a Unified Parent Child View
Using Literal Values to Sort Child Records
Troubleshoot Repository Link Relationships
Manage a Repository's Properties
Manage a Repository's Trigger Properties
Manage a Repository's Promotion Properties
Create or Edit a Record Security Filter
Manage a Repository's Promotion Properties
Configure Automatic Validation of Linked Records
Manage Attributes
Manage Attribute Groups
Manage Attribute Tabs
Configure an Attribute to appear as a Search Filter
Configure an Attribute with a Custom Action
Configure an Attribute to be Multi-language
Add or Remove a Search Index for an Attribute
Add or Remove Attributes from the Snapshot Table
Create or Edit an Attribute Security Filter
Snapshot Table Views
How Snapshot Table Views Work
Types of Snapshot Table Views
Main Snapshot Table
Category Attribute Snapshot Table
Multi-language Snapshot Table
Rebuilding and Automatic Rebuilding of Snapshot Tables
Limitations of Snapshot Table Views
Attributes that are Good Candidates for the Snapshot Tables
Using SQL to Access Snapshot Tables
Permitting Access to Snapshot Tables
Manage Snapshot Table Views
Rebuild, Drop, or Repopulate a Snapshot Table
Add or Remove Attributes from the Snapshot Table
Add or Remove a Search Index for an Attribute
Enable or Disable a Category Attribute Snapshot Table
Enable or Disable Multi-language Snapshot Tables
Manage Code Sets
Create or Edit a Code Set
Edit a Code Set's Codes
Set the Sequence of Code Set Codes
Copy Codes from One Code Set to Another
Export a Code Set's Codes to a File
Import Codes from a File
Delete a Code Set
Manage Taxonomies and Hierarchies in the Classic UI
Manage Taxonomies
View a Repository's Taxonomy and Hierarchies in the Classic UI
Create a Taxonomy
Create a Properties Repository for Code Sets, Taxonomies, and Hierarchies
Create or Edit a Hierarchical Code Set
Create or Edit Hierarchical Code Set Codes with the Detail Editor
Create a Taxonomy or Hierarchy Control Attribute
Create or Edit a Category or Dynamic Attribute Association Object
Manage Category or Dynamic Attributes from a Repository View
Delete a Taxonomy or Hierarchy
Export a Taxonomy's or Hierarchy's Codes
Import a Taxonomy's or Hierarchy's Codes
Manage Hierarchies
View a Repository's Taxonomy and Hierarchies in the Classic UI
Create a Hierarchy
Create a Properties Repository for Code Sets, Taxonomies, and Hierarchies
Create or Edit a Hierarchical Code Set
Create or Edit Hierarchical Code Set Codes with the Detail Editor
Create a Hierarchy Catalog Repository
Create or Edit a Category or Dynamic Attribute Association Object
Register a Hierarchy
Create a Taxonomy or Hierarchy Control Attribute
Manage Category or Dynamic Attributes from a Repository View
Copy a Hierarchy
Add a Hierarchy Node or Change its Metadata
Delete a Taxonomy or Hierarchy
Export a Taxonomy's or Hierarchy's Codes
Import a Taxonomy's or Hierarchy's Codes
Manage Auto-generated Sequences
Create or Edit a Sequence Definition
Configure a Repository to Auto-generate Unique Sequence Numbers
Set an Auto-generated Sequence's Starting Number
Define Access to Securable Objects
Migrate Data Model and Configuration Components
Migrate Out Data Model and Configuration Components
Migrate In Data Model and Configuration Components
Data Management
Address Validation
Use Address Validation
Configure Address Validation
Package Promotions
Define a Data Package
Package Promotion Repository
Validation
Create or Edit a Validation Rule
Validation Rule Types
Display Validation Status of Linked Records
Configure Automatic Validation of Linked Records
Validation Level Configuration
Digital Asset Management
Configure Variant Generation
Governing Image Variant Creation with Regex Rules
DAMVariants Repository
DAMVariantSizes Repository
Batch Import of Digital Asset Metadata
Change the Content Type assigned to Digital Assets when they are Uploaded
Restrict Digital Asset Upload by File Extenstion
Factors that Affect Image Processing
Templates
Import Templates
View Existing Import Templates
Import Template Management Functions
Create or Edit an Import Template
Create or Edit an Import Template: Attribute Mapping
Start an Import Job from the Import Template Tab
Export Templates
View Existing Export Templates
Export Template Folder Management
Export Template Management
Create or Edit an Export Template
Create or Edit a CSV, XLS, XLSX, JSON or XML Export Template
Multi-language Behavior for CSV, XLS, and XLSX Export Templates
Create or Edit a Mapped CSV or InDesign Export Template
Attribute Formula Builder
Multi-language Behavior for Mapped CSV and InDesign Export Templates
Start an Export Job from the Export Template Tab
Exchange Templates
View Exchange Templates
Create or Edit an Exchange Template
Syndication Templates
View Syndication Templates
Create or Edit a Syndication Template
Edit a Syndication Template's Attribute Mappings
Publication Templates
Job Scheduling
Scheduled Imports
Scheduled Imports Repository
Scheduled Import Jobs Repository
Scheduled Import Configuration Properties
Scheduled Exports
Scheduled Exports Configuration Details
Scheduled Exports Repository
Scheduled Export Jobs Repository
Scheduled Export Configuration Properties
Create a Scheduled Repository Export
Create a Scheduled Template Export
Create a Scheduled View or DataMart Export
Scheduled Promotions
Promotions Repository
Promotion Jobs Repository
Implementing Pre- or Post-Processing of Scheduled Imports and Exports
Predefined Pre-processing and Post-processing Blocks
Custom Pre-Processing and Post-Processing Blocks
Channel Readiness
Language Management
Add a Language to EnterWorks
Export Data Model Objects or Messages for Translation
Translate Exported Data Model Objects or Classic UI Messages
Import Translated Messages
Import Translated Data Model Objects
Manage Languages in the Language List
View the Language List
Add or Edit a Language in the Language List
Enable or Disable a Language
Reorder the Languages in the Language List
Delete a Language from the Language List
Workflow Management
Open Workflow Task Manager in the New UI
Open Work List Task Manager in the Classic UI
Manage Workflow Processes
Edit Workflow Properties
Edit EnterWorks PIM Options
Create a Work Item Type
Add a Task to the Work List
Purge a Workflow using the New UI
Purge a Workflow using the Classic UI
Upload Attachement to the Work Item
Predefined Workflows
Functionality Extension Points
Connectors
Functional Guides for Business Administrators
Advanced VTL Mapping Guide
Comments
References
Variables
Properties
Methods
Strict References Setting
Case Substitution
Directives
Conditionals
Loops
Include
Parse
Stop
Evaluate
Define
Getting Literal
VTL: Formatting Issues
Other Features and Miscellany
Summarized VTL Guide
EDI Preprocessing
EDI Preprocessing Specification
EDI SpecName
Qualified Data Element
EDI Target File
EDI Section (Loop)
EDI Field
Generating Multiple Files
Importing the EDI Specification from a Spreadsheet
Preprocessing Steps
Troubleshooting EnterWorks
Data Management Troubleshooting
Digital Asset Management (DAM) Troubleshooting
Logs Troubleshooting
System Troubleshooting
SSO SAML Behaviors and Troubleshooting
SSO LDAP/LDAPS Behaviors and Troubleshooting
Workflow Troubleshooting
Installation and Upgrade Troubleshooting
Operational Verification Procedures
DAM Operational Verification
System Administration
Logging into the Classic UI
Quick Start Guide
View a Different Group's Dashboard
Widgets
System Health Widget
Creating a System Health Widget
User Interface
Customize the UI Title Bar
Rebranding the EnterWorks UIs
Regional Language Login Configuration
Common Tasks
Clear the Cache
Restart EnterWorks Services
Start EnterWorks Services on All Servers
Start EnterWorks Services on One Server
Stop EnterWorks Services on All Servers
Stop EnterWorks Services on One Server
Pause or Resume EPX Processing
Stop EPX Services
Manage create-service Scripts
Edit Shared Configuration Properties
Edit Enterworks.properties Files
Back Up EnterWorks Folders by Script
Deploy JAR Files
DAM Configuration
Configure DAM to Use Amazon S3
Encrypt a String using the EnterWorks Encryption Method
Configure DAM to Use Azure Blob
Encrypt a String using the EPX Encryption Method
Configure Parallel Processing of Digital Assets
Configure DAM Support for an Adobe ICC Profile
DAM Operational Verification
Change Notification
Architecture
Configure a Repository for Change Notification
Register the Change Notification Trigger with a Repository
Integrate a Change Notification Trigger with an Existing Trigger
Managing Multi-Language Attributes in Existing Trigger
Register Change Notification as a PreSave Validation Rule
Enable or Disable Debug Logging
CN_Registry Repository
Summary Tab
Conditions Tab
Attributes Tab
Update Tab
Transformation Tab
Log Tab
Translation Tab
Email Tab
Workflow Tab
CN_Log Repository
Reporting Using Scheduled Exports
Transformation Extension
CN_Transformation_Repository
Summary Tab
Target Tab
Condition Tab
Future Tab
SQL Expressions
Example Transformations
Rollup Attribute
Cascade Attribute
Language Translation Extension
Change Notification Translation Registry
Summary Tab
Attributes Tab
Change Notification Translation Queue
Change Notification Translation Log Repository
Translation Request File
Translation Request Scheduled Export
Translation Request Log Update Scheduled Import
Translation Queue Update Scheduled Import
Translation Queue Update Response Template
Translation Language Update Import Templates
SQL-Based Reports
Reports Using the CN_Reports Repository and Scheduled Export
CN_Reports Repository
Summary Tab
Attributes Tab
Report Scheduled Export
Launch Report Scheduled Export
Report Scheduled Export Details
Change Report Processing
Channel Readiness
Schedule Channel Readiness Automatic Statistics Updates
Search and Filters
Manage Typeahead Search
Add a Search Index for when Records were Created
Imports and Exports
Configure JSON Exports to Include or Exclude the Root Node
EDI Preprocessing
EDI Preprocessing Specification
EDI SpecName
Qualified Data Element
EDI Target File
EDI Section (Loop)
EDI Field
Generating Multiple Files
Importing the EDI Specification from a Spreadsheet
Preprocessing Steps
Security
Change the EnterWorks System Account Password
Change the EPX System Password
Change the EPIM and EPX Database Password
Encrypt or Unencrypt a Microservice
Encrypt or Unencrypt a Utility
Configure Single Sign-on (SSO)
Supported Security Specifications
Configure EnterWorks for SSL (Secure Socket Layer)
Configure RabbitMQ for SSL/TLS
Obtain SSL/TLS Certificate Files for RabbitMQ
Configure Single Sign-on for SAML
Create the SSO Mapping File
Settings for Manual Configuration of Specific IDPs
Settings for Manual Configuration of Azure AD
SSO SAML Behaviors and Troubleshooting
(Optional) Configure Publication Manager and EnterWorks Classic UI for SSO
Configure Single Sign-on for LDAP or LDAPS
SSO LDAP/LDAPS Behaviors and Troubleshooting
EnterWorks REST API Access and Single Sign-on (SSO)
Create Web Server without Single Sign-On
Configure EnterWorks for SSL (Secure Socket Layer)
Configure EPX for SSL
Configure RabbitMQ for SSL/TLS
Obtain SSL/TLS Certificate Files for RabbitMQ
Using Windows Authentication to Connect to the EPIM and EPX Databases
Encryption Methods Used by EnterWorks
Encrypt a String using the EnterWorks Encryption Method
Encrypt a String using the EPIM Encryption Method
Encrypt a String using the EPX Encryption Method
Services and Configuration
Manage create-service Scripts
Edit Shared Configuration Properties
Encrypt or Unencrypt a Microservice
Encrypt or Unencrypt a Utility
Encryption Methods Used by EnterWorks
Encrypt a String using the EnterWorks Encryption Method
Encrypt a String using the EPIM Encryption Method
Encrypt a String using the EPX Encryption Method
System Logs
How to Use the Logs for Debugging
Configure the Format of Log Messages
Specify the Severity of Messages to Log
Configure Debugging Logs for EPX Workflows
Configure User Permission Error Logging
Deployment and Migration Best Practices
Overview
Deployment Definition
Deployment Process
Preparation
Development
Deployment Package Creation
Back Up the Target Environment
Deployment Execution
EnterWorks Migration
EPX Migration
Migrating EPX Process Flows and Subflows – No Active Work Items
Migrating EPX Process Flows and Subflows – Active Work Items
EPX Migration Pitfalls, Limitations, and Workarounds
Deployment Tools
Compare Extract Scripts
Procedure - Generate Full Report
Procedure - Generate Partial EPX Report
Procedure – Comparing Extraction Reports Using WinMerge
Deployment Script Examples
Environment Configuration
High Availability with System Monitoring Services
Freeze an Environment's Data Model and Configuration
Freeze an Environment's Data Model and Configuration
Configure Additional Functionality
Configure Address Validation
Configure Google Translate API
Configure EPXTomcat to be a 64-bit Service
Determine if EPXTomcat is Configured as 32-bit or 64-bit
Functionality Extension Points
Connectors
Message Queue Integration for Microservices
Maintenance, Monitoring, and Preparing for Disaster
Prepare for Disaster
System Monitoring
System Maintenance
New UI System Maintenance Page
Obtain Product and Third-party Files
Log File Maintenance
Archived Log Files Maintenance
System File and Record Maintenance
Scheduled Cleanup
Rebuild EPIM Database Indexes
indexfragmentation Script
Troubleshooting EnterWorks
Data Management Troubleshooting
Digital Asset Management (DAM) Troubleshooting
Logs Troubleshooting
System Troubleshooting
SSO SAML Behaviors and Troubleshooting
SSO LDAP/LDAPS Behaviors and Troubleshooting
Workflow Troubleshooting
Installation and Upgrade Troubleshooting
Operational Verification Procedures
DAM Operational Verification
System Architecture
EnterWorks Environments
Tomcat's Port Usage
EnterWorks Services
Configuration Files
System Configuration Files
Edit Shared Configuration Properties
Determine if EPXTomcat is Configured as 32-bit or 64-bit
DAM
DAMVariants Repository
DAMVariantSizes Repository
Job Codes
Service and Folder Name Changes
System Development
Functionality Extension Points
Connectors
Custom Actions
Create a Custom Action
Writing the HTML/JSP
itemDataMap
EnterWorks APIs
Getting Started
Authentication and Authorization
Authorize Using a Token
Authorize Using JavaScript
REST APIs Interactive Swagger Page
Calling the REST APIs
API Programming Examples
Example Node.js: Setting the Request Headers After Logging In
Example Python: Checking the Response Body for New Token
Example: REST Service Code
REST APIs Overview
Codeset API: Code Set Controller
EnterWorks Monitor API: EnterWorks Monitor
Determine which Port enable-monitor-service Uses
Job Codes
Group and User API: Admin Controller
Item API: Item Controller
Media API: Media Controller
Profile API: Profile Controller
Repository API: Repository Controller
Security API: Security Controller
System API: System Controller
Template API : Template Controller
Appendix: Web Service SOAP APIs
How to Use the Web Service SOAP APIs
SOAP API Example
System Development Functional Guides
Message Queue Integration for Microservices
EnterWorks Add-on Products
Notices
Open File Explorer and go to:
<drive> :\Enterworks\bin
Right-click Start Enterworks and select Run as Administrator .
A command prompt will appear indicating that the services are starting. This
prompt will close once all services have been started.
Verify that the services have been started by opening the Services
control panel and confirming that all Enable* and
enable* services (that have not been disabled) have a
status of Running .