epicor retail merchandising job management 4.3 management 4.3.21469.pdf · preface pipeline is a...
TRANSCRIPT
DISCLAIMER
This manual is provided for informational purposes only. Epicor Software Corporation and its affiliates and subsidiaries (hereinafter collectively referred to as “Epicor”) make no representations or warranties with respect to the contents of this manual and Epicor specifically disclaims any and all implied warranties including, but not limited to, merchantability and fitness for any particular purpose. Use of the software is governed by and subject to the terms of your agreement with Epicor. This manual is subject to change without notice. The contents of this manual are believed to be current and accurate as of its date of publication. Changes to this manual between re-printings and other important information about the software product are made or published in release notes and you are urged to obtain the current release notes for the software product. We welcome user comments and reserve the right to revise this publication and/or make improvements or changes to the products or programs described in this publication at any time, without notice.
© Copyright 2007-2013, Epicor Software Corporation and its subsidiaries and affiliates. Epicor is a registered trademark of Epicor Software Corporation. All other trademarks are the property of their respective owners and are acknowledged. No part of this publication may be reproduced in any form without the prior written consent of the Epicor copyright owner.
Epicor Retail2800 Trans-Canada HighwayPointe-Claire, Quebec, CanadaH9R 1B1Tel.: (514) 426-0822Fax: (514) 426-0824e-mail: [email protected]
Manual Release Date: January 12, 2015
Table of Contents
Preface ...............................................................................1Terminology .......................................................................................................................1About the User ...................................................................................................................2About this Manual .............................................................................................................3Before You Begin ...............................................................................................................3
1. Pipeline Administrator................................................... 4Servers ...............................................................................................................................6Segments and Jobs ...........................................................................................................8Segment Parameters ........................................................................................................8Segment Summary ...........................................................................................................8Job Summary .................................................................................................................. 17Advanced Job Operations .............................................................................................. 21Multiple Step Jobs .......................................................................................................... 28Troubleshooting .............................................................................................................. 31
2. Segment Reference ..................................................... 37Segment Requirements ................................................................................................. 37Segment 1000 - EDM & PROD to WM .......................................................................... 46Segment 1001 - EDM & PROD To MA – Style Retail Startup ..................................... 51Segment 1003 - EDM & PROD to Sales Audit ............................................................. 52Segment 1004 - EDM & PROD to Customer Info Mgmt .............................................. 60Segment 1005 - EDM & PROD to MA ........................................................................... 74Segment 1006 - EDM & PROD to Price Look-Up ......................................................... 83Segment 1008 - EDM & PROD Internal - Update Location Status ............................. 88Segment 1009 - EDM & PROD to Merch Planning - Send Loc Hierarchy .................. 89Segment 1010 - EDM & PROD to Merch Planning, Merch Entity ............................... 93Segment 1013 - EDM & PROD to Text File .................................................................. 98Segment 1015 - EDM & PROD To Sourcing ..............................................................102Segment 1023 - EDM & PROD Location Attributes to Planning ...............................104Segment 1030 - EDM & PROD to MA & SL ................................................................107Segment 1031 - EDM & PROD Internal - System Delete Styles ...............................110Segment 1032 - EDM & PROD To Offline IM File ......................................................112Segment 1033 - EDM & PROD To Offline IM File, Master Data ...............................115Segment 1034 - EDM & PROD To Offline IM File, Startup ........................................118Segment 1035 - EDM & PROD Internal – Make Jurisdiction Available ...................122Segment 1038 - EDM & PROD to Price Look-up File Generate (CRS) .....................123Segment 1536 - EDM & PROD to Price Look-Up - File Regenerate ........................125Segment 2000 - POM to Offline IM File ......................................................................128Segment 2005 - POM To EDI Text File .......................................................................131Segment 3000 - IM to WM ..........................................................................................134Segment 3002 - IM to WM, Store Shipment Confirmation .......................................136
iv Table of Contents
Segment 3003 - IM Internal - System Receive Documents ......................................137Segment 3004 - IM Internal - System Delete Documents ........................................138Segment 3006 - IM Internal - Post Physical Inventory Counts .................................141Segment 3008 - IM Internal - System Match PO Receipts .......................................142Segment 3009 - IM To Sourcing ................................................................................143Segment 3010 - IM Internal - System Match Unsolicited Receipts ..........................144Segment 3011 - IM Internal - System Match RTVs ...................................................145Segment 3012 - IM to Offline IM File ..........................................................................146Segment 3100 - IM to Infobase - Sales Posting ........................................................151Segment 4000 - PM Internal - Issue Documents .......................................................156Segment 4002 - PM Internal - Make Promotional PCs Effective ..............................158Segment 4003 - PM Internal - Make Permanent PCs Effective ................................160Segment 4004 - PM Internal - Complete Promotional PCs .......................................162Segment 4005 - PM Internal - System Cancel Unapproved Documents .................164Segment 4006 - PM Internal - System Delete Cancelled & Completed Docs .........166Segment 4007 - PM Internal - Remove Mix and Match Codes ................................168Segment 4008 - PM Internal - Issue Deal Document ................................................170Segment 4009 - PM Internal - Complete Deal Document ........................................172Segment 4010 - PM Internal - Delete Completed & Cancelled Deal Docs ..............174Segment 4011 - PM Internal - Update PC Totals .......................................................176Segment 4012 – PM Internal – PCM Update Locations ...........................................178Segment 4013 – PM Internal – System Cancel Unapproved Deal Documents ......179Segment 5005 - Infobase to MA - Post Beginning Inventory ....................................181Segment 5006 - Infobase to Stock Ledger - Post Transactions ...............................184Segment 5007 - Infobase to Stock Ledger - Stock Ledger Startup .........................188Segment 5010 - InfoBase To MA – Send Master Entities ........................................190Segment 5100 - Infobase to MA - Post Flash ............................................................192Segment 5101 - Infobase to MA - Post History ..........................................................194Segment 5102 - Infobase to MA - Post Component ..................................................196Segment 5103 - Infobase to MA - Post On Hand .......................................................198Segment 5104 - Infobase to MA - Post On Order Allocation .....................................200Segment 5105 - Infobase to MA - Initialize ................................................................202Segment 6001 - Stock Ledger to General Ledger Exp Tbls - Export Trans ..............204Segment 6002 - Stock Ledger to MA – Send RIM Costs .........................................207Segment 7000 - Invoice Matching to Text File ..........................................................209Segment 7001 - Invoice Matching Internal - Exec outstanding processes .............211Segment 7003 - Invoice Matching Internal - System Del Matched Invoice .............213Segment 8000 - WM to Merchandising .....................................................................216Segment 8002 - WM to Infobase ................................................................................220Segment 11009 - MA to Merch Planning - Send History ..........................................221Segment 11010 - MA Internal - Housekeeping .........................................................232Segment 11011 - MA Internal - Location Comp Startup ...........................................233Segment 11012 - MA Internal - Location Comp Update ...........................................234Segment 11013 - MA Internal - Purge History ...........................................................235Segment 11014 - MA Internal - Alternate Hierarchy Startup ...................................237Segment 11021 - MA Internal - History Import, Update Live SKU Hist ....................238Segment 11022 - MA Internal - History Import, Update Live SKU OH Hist ..............240Segment 11023 - MA Internal - History Import, Update Live Color Hist ..................242Segment 11024 - MA Internal - History Import, Upd Live Color Oh Hist ..................244Segment 11025 - MA Internal - History Import, Update Live Style Hist ...................246Segment 11026 - MA Internal - History Import, Upd Live Style Oh Hist ...................248
Table of Contents v
Segment 11027 - MA Internal - History Import, Update Live Group Hist .................250Segment 11028 - MA Internal - History Import, Upd Live Group Oh Hist ................252Segment 11029 - MA Internal - History Import, Update Live Group Rim Oh ...........254Segment 11031 - MA Internal - History Import, Summarize SKU Hist .....................256Segment 11032 - MA Internal - History Import, Summarize Sku OH Hist ...............260Segment 11033 - MA Internal - History Import, Summarize Color Hist ...................264Segment 11034 - MA Internal - History Import, Summarize Color OH Hist .............267Segment 11035 - MA Internal - History Import, Summarize Style Hist ....................271Segment 11036 - MA Internal - History Import, Summarize Style Oh Hist ..............274Segment 11037 - MA Internal - History Import, Summarize Group Hist ..................278Segment 11038 - MA Internal - History Import, Summarize Group OH Hist ...........282Segment 11039 - MA Internal - History Import, Summarize Group Rim Oh ............286Segment 11041 - MA Internal - History Import, Initialize ..........................................289Segment 11042 - MA Internal - History Import, Verify OH Posting ...........................292Segment 11051 - MA to Sales Audit - Send Plans to Flash Sales ............................294Segment 11060 - MA Internal - Summarize Hist Component at SKU Level ............296Segment 11061 - MA Internal - Summarize Hist Component Style Clr Lvl ..............297Segment 11062 - MA Internal - Summarize Hist Component at Style Level ...........298Segment 11063 - MA Internal - Summarize Hist Component at Group Level .........299Segment 12100 - Sales Audit Internal - Purge mew_sales_export ..........................300Segment 16001 - Text File To EDM, PROD & POM Import tables - Import ..............301Segment 16004 - Text File to IM Import - Import UDAs ............................................305Segment 16005 - Text File to Stock Ledger - Imp Initial CC Percentages ...............307Segment 16008 - Text File To Invoice Matching Imp Tbls - Imp Invoices ................310Segment 16020 - Text File To MA Hist Component Import ......................................312Segment 16021 - Text File To MA - History Import, Update Imp Sku Hist ...............315Segment 16022 - Text File To MA - History Import, Upd Imp Sku OH Hist ..............318Segment 16023 - Text File To MA - History Import, Upd Imp Color Hist ..................321Segment 16024 - Text File To MA - History Import, Upd Imp Color OH Hist ............324Segment 16025 - Text File To MA - History Import, Upd Imp Style Hist ...................328Segment 16026 - Text File To MA - History Import, Upd Imp Style OH Hist .............331Segment 16027 - Text File To MA - History Import, Upd Imp Group Hist .................334Segment 16028 - Text File To MA - History Import, Upd Imp Group OH Hist ..........337Segment 16029 - Text File to MA - History Import, Upd Imp Grp RIM Oh ................340Segment 16031 - Text File to IM Import tables - Import ASNs .................................343Segment 16032 - Text File to EDM, PROD & POM Import Tbls - Import Pack .........345Segment 16060 - Text File to PM Import - Import Price Changes ............................347Segment 17000 - EDM, PROD & POM Import tables to EDM, PROD & POM ..........350Segment 19000 - IM Import Tables to IM ..................................................................355Segment 19010 - IM Import Tables to IM - ASN Import ............................................358Segment 22000 - Invoice Matching Import Tables To Invoice Matching ................359Segment 26000 - Merch Planning Internal - Import History and Hierarchy ............361Segment 26001 - Merch Planning to MA - Import .....................................................363Segment 28000 - General Ledger Exp Tables to Text File - Export Trans ...............367Segment 32000 - RTP Internal - System Cancel and Delete RTP Documents ........379Segment 34000 - PM Import To PM ...........................................................................380Segment 53001 - Offline IM To IM .............................................................................381Segment 53002 - Offline IM To IM, Outbound Transfers ..........................................383Segment 53003 - Offline IM To IM, Store Shipment Receipts .................................385Segment 53004 - Offline IM To IM, PO Receipts .......................................................387Segment 53005 - Offline IM To IM, Inventory Counts ...............................................388
vi Table of Contents
Segment 58001 - 58008 Offline IM File Internal ......................................................389Segment 60001 - POM & AR to WM ...........................................................................399Segment Cross-reference Table ..................................................................................404
3. Scheduled Jobs.......................................................... 408Overview ........................................................................................................................409Scheduling Jobs ...........................................................................................................416Job Settings ..................................................................................................................420Purchase Order Management Scheduled Jobs .........................................................422PO Import ......................................................................................................................423PO Export ......................................................................................................................424PO Cancellation ............................................................................................................425PO Deletion ...................................................................................................................426Unconfirmed On-order Calculation .............................................................................426PO Mass Modify ............................................................................................................427Style Mass Modify ........................................................................................................428PO Cost & Style Cost Modify ........................................................................................429A&R Scheduled Jobs ....................................................................................................430Generate Size Scales ..................................................................................................430Generate Min/Max Profiles ........................................................................................432Vendor Review ............................................................................................................434Pick Review ..................................................................................................................436Auto Delete/Release Distribution Document .............................................................437Generate Seasonal Indices .........................................................................................439Calculate Lost and Extra Sales ...................................................................................441Adjust Lost and Extra Sales .........................................................................................442Generate Sales Forecast .............................................................................................443Ranking Group Import .................................................................................................448Generate Store Shipments ..........................................................................................450Physical Inventory Scheduled Jobs .............................................................................450Import Queued Counts .................................................................................................450IMRD Submit ................................................................................................................451Enterprise Selling Scheduled jobs ..............................................................................451Enterprise Selling Generate Refresh Files .................................................................451Enterprise Selling Send Inventory Movements ..........................................................452Enterprise Selling Remoting Host ...............................................................................454EDM Scheduled Jobs ...................................................................................................456Create Employee Import Files .....................................................................................456General Scheduled Jobs ..............................................................................................458Merch Extension Queue Process ................................................................................458Merchandising Export Financials to E9 ......................................................................460Troubleshooting Scheduled Jobs ................................................................................461Error Correction ............................................................................................................462
4. Planning Export Utility .............................................. 463Getting Started .............................................................................................................464Navigation .....................................................................................................................465
Appendix: MA SQL Startup Script ..................................472About the Script ............................................................................................................473
Preface
Pipeline is a Windows® application tool that integrates the applications and modules that make up Epicor Retail, executes scheduled processes required by the Epicor Retail applications and manages the import/export of data between Epicor Retail and third party applications. Pipeline provides a common user interface for end users.
It also manages integration errors and transactions, tracks statistics, schedules jobs and provides volume-reporting services for tracking performance.
TerminologySource and Destination A source is any node that provides data to other nodes; a destination is a
node that receives such information. A source publishes data, and a destination retrieves the data that it requires. A destination can be a source if it publishes data to another destination, and a source can be a destination if it retrieves data from another source. Each destination creates a set of mapping rules that define the data that it requires from the source and what affect it should have in the destination. The source publishes only changes in the data, and is not concerned with any of the destination's data requirements.
Process A process is the movement of a set of data from a source to a destination; only one process can run on a given segment at a time. A new process is created each time Pipeline starts and determines that it has data to post. A process ID is assigned to each process in order to simplify reporting.
Publish and Subscribe A mechanism where each source lists all data that is available and each destination is responsible for picking up the data it requires.
Entity The data type being acted upon for a transaction.
Action The activity being performed on an entity.
2 Preface
About the UserThis manual is intended for Epicor personnel who are involved in implementing and running scheduled jobs for the Epicor Retail Merchandising application.
Queue segment Pipeline moves data from a source to a destination. That is, it carries information from one application to another, or from one place to another within a specific application. The source publishes all information that may be of interest to a destination. Pipeline allows each destination to define what data it will process. A queue segment maps specific entities and actions between a source and a destination and processes the queue items identified by those entities and actions. A queue segment is unidirectional, from source to destination. If a destination node must return data to its original source, it does so along a separate segment. The original destination is the source for this segment, and the original source is the destination. Likewise, a single source can be linked to several destinations but each source/destination combination is a different segment. A queue segment is normally scheduled to run periodically throughout the day to keep data in the different Epicor Retail applications in synch. Segments can be started, stopped, scheduled and checked for errors and statistics.
Queue items A queue is a table in a source database. It contains any information in which a destination could have an interest. The queue table is updated whenever an entity that is to be logged is affected. A queue item is a row in the queue table. A sequence ID for each queue item defines the order in which the queue items are processed by the destination. Each queue item contains data (Style, PO Line, Color), which in turn defines what can be affected in the destination. When a queue segment is run, the segment verifies to see if there are any new queue items in the source queue that is mapped for the destination. If there are queue items, the segment sends them to the destination. Each queue item is processed only once. Either it is updated in the destination or, if the transaction fails, posted as an error. Error queues are posted to an error table in the Pipeline repository database. The next time Pipeline is run, the errors will be resubmitted to the destination unless otherwise specified by the administrator.
Non-queue segments Non-queue items are used for batch processing, importing text files and scheduled tasks. Unlike queue segments that process queue items and are normally scheduled to run regularly throughout the day, non-queue segments are often scheduled to run at specific times (for example, overnight, weekly, once per season etc.) or they may not be scheduled at all and may be run manually only when needed (for example, when there are files to import). They can exist outside of Pipeline.
About this Manual 3
About this ManualChapter 1 of this manual contains information on using Pipeline Administrator including procedures for viewing segments, starting and stopping segments and jobs and troubleshooting.
Chapter 2 includes information for every segment that is part of the release. Included is a segment description, list of segments parameters, scheduling requirements, database parameters and troubleshooting information, where available.
Chapter 3 covers information you need to set up, run and troubleshoot scheduled jobs.
Chapter 4 covers the use of the Planning Export Utility.
Before You BeginAfter your system has been installed and before you begin to use Pipeline on a day-to-day basis, you need to do the following:
Create the directories for all the log files required by the script called MA Startup and modify the scripts with client-specific values for parameters such as Company ID, Live Date and the paths to all log files. Script templates are contained in the Appendix to this document.
Run MA Startup BEFORE you run segment 1005 the first time, and again after it has been run. The primary purpose of the script is to set up the MA Calendar. You will get an error message the first time the script is run, but it should not occur when the script is run the second time - after segment 1005 has been run. Run segment 1034, EDM & PROD to Offline IM File, Startup, when performing the startup for clients with stores running Triversity cash registers. The segment should run before any of the following segments: 1032 - EDM & PROD to Offline IM File 1033 - EDM & PROD to Offline IM File, Master Data 3012 - IM To Offline IM File 2000 - POM To Offline IM FileThe following segments are generally run only once, to load history and set up tables, prior to beginning day-to-day operations:
11021-1103816021-16028
1 Pipeline Administrator
Pipeline Administrator is a visual interface that shows the flow of data. Here you can view a list of all of the data flows defined for your application installation. You can manually start and stop data flows, set them to run on a schedule, and monitor the progress of each job.You can: start a new process check the status of the process as it is in progress shut down a process that is in progress flag a process as not in progress to recover from a system crash perform volume reporting and error analysis
Pipeline Administrator provides a single place to check all Pipeline processes, whether each is running or not.
Starting Pipeline
Administrator
Click Start > Programs > Pipeline > Pipeline Administrator.
Viewing Pipeline
Administrator properties
1. Click Administrator > Options. The Pipeline Administrator Properties window opens and defaults to the General tab. The General tab displays the following information about Pipeline settings:
Viewing Pipeline Administrator properties 5
2. The Connection tab displays information about Pipeline data transfer.
Pipeline Administrator Properties – General tab
Poll server to find out state of services
Selected / Cleared Default: Cleared
Polling interval (seconds)
The number of seconds that must elapse after polling the server before it can be polled again.
Default Severity Level Errors with this severity level will be viewed in the error queue by default.
Pipeline Administrator Properties – Connection tab
Login timeout (seconds)
The number of seconds that must elapse before a login attempt ends due to a timeout.
6 Pipeline Administrator
ServersThe Enterprise server holds all the rules for data transfer, all statistics, errors and all connection information. The Enterprise server is a source. Generally, there is only one Enterprise server in a company.
An Application server executes the rules from the Enterprise server, and retrieves the data it requires. The Application server is a destination. Pipeline can manage data flow for many Application servers. Typically, the Enterprise and Application servers are one and the same.The Job server is an SQL Server Agent that executes scheduled jobs. It can be stopped and restarted if necessary.
Connecting to the Enterprise
server
1. In the Pipeline Administrator pane, right-click .2. Select Connect.
Disconnecting from the
Enterprise server
1. In the Pipeline Administrator pane, right-click .
2. Select Disconnect.
Viewing an Application
server’s details
In the Pipeline Administrator pane, expand the list of Application servers and click the name of the one to be viewed. This displays the Application Server Detail pane. Its default tab is General.
Click the + beside each item to expand the list inside the Pipeline Administrator pane.
Query timeout (seconds)
The number of seconds that must elapse before a query attempt ends due to a timeout.
Packet size (bytes) The number of bytes of data that can be transferred in each data packet.
Pipeline Administrator Properties – Connection tab
Disabling an Application server 7
The General tab is the default view of the Application Server Detail pane.
The General tab displays the following information for segments currently executing on the Application server:
Disabling an Application
server
This lets you stop an application server from functioning.1. In the Pipeline Administrator pane, expand the list of Application servers and right-
click the name of the one to be disabled.
2. Select Disable.
Enabling an Application
server
This lets you restart an application server that has been disabled.
1. In the Pipeline Administrator pane, expand the list of Application servers and right-click the name of the one to be enabled.
2. Select Enable.
Refreshing an Application
server
This updates the list of segments displayed for the Application server.1. In the Pipeline Administrator pane, expand the list of Application Servers and right-
click the name of the one to be refreshed.
2. Select Refresh.
Application Server Detail – General tab
ID A unique identification number for the segment.
Label A description of the segment, used to distinguish one from another.
Records Processed The number of records processed by the segment.
Errors Encountered The number of errors that occurred during the process.
Status Running, Stopped, Disabled
Application Server Message
If a message was generated by the process, it is displayed here.
8 Pipeline Administrator
Stopping the Job server
This lets you stop a job server from functioning.
1. In the Pipeline Administrator pane, right-click .2. Select Stop SQL Server Agent.
Starting the Job server
This lets you restart the Job server.
1. In the Pipeline Administrator pane, right-click .2. Select Start SQL Server Agent.
Refreshing the Job server
This updates the list of jobs displayed for the Job server.
1. In the Pipeline Administrator pane, right-click .
2. Select Refresh.
Segments and JobsA series of segments can be grouped together as a Pipeline job. Jobs are normally defined at set-up time by Epicor based on client requirements. These jobs can be maintained/modified by the client.
Segments and jobs can be viewed in Pipeline Administrator.
Segment ParametersSegment parameters can be viewed through Pipeline Administrator. Parameters fall into 2 categories: parameters that can be edited by end users (clients) parameters that can only be edited by Epicor
Parameters belonging to the first category can be edited in Pipeline Administrator. For information on editing segment parameters in Pipeline Administrator see “Editing segment parameters” on page 12. Parameters in the second category can only be modified by Epicor, using ParamEditor.
For a complete description of the parameters for each segment see Segment Reference on page 34.
Segment SummaryThe segment summary is a comprehensive listing in table format of all the segments defined for your application installation. You can review segment settings, modify them, and start or stop segments. You can also schedule segments to run as jobs.
Viewing segments 9
Viewing segments
In the Pipeline Administrator pane, double-click to display the Segment Summary.
Pipeline segments and segment information are shown on the right side of the above window.
Refreshing the segment summary
1. Right-click on any segment.
2. Select Refresh.
Viewing segment
details
In the Pipeline Administrator pane, expand the list of segments and click the one to be viewed. This opens the Segment Details pane. The Segment Details pane is made up of four tabs: General tab Configuration tab Parameters tab Statistics tab
Some of the information in the Configuration and Parameters tabs can be edited. For more information see Modifying process options and Editing segment parameters on page 12, and Changing statistics retention on page 13.
General tabThe General tab indicates: Segment name. Source: the node as defined in the Pipeline repository database. Destination: the node as defined in the Pipeline repository database. Segment status: Idle or Running. Segment group: provides context for groups posted, makes them easier to find. An
internal mechanism. DTS Package: shows which Data Transformation Services package is being used to
allow the definition of the source, destination and other complex transformations. DTS is an internal mechanism.
Segment category: an internal mechanism that determines how the segment should run. There are two categories, Free Form (a queue segment) and Non Queue (a non-queue segment).
10 Pipeline Administrator
Working thread: an internal mechanism. Write method: an internal mechanism.
Configuration tabThe Configuration tab shows you how the parameters for the segment are configured. Only the Process options can be modified. For more information see Modifying process options on page 12. Process mode: an internal processing mechanism. Cannot be modified. Shutdown: alternate method of segment shutdown. An internal mechanism. Cannot
be modified. Real Time sleep cycle (seconds): related to Process mode. An internal mechanism.
Cannot be modified. Number of retries: shows the number of times a segment will be retried. An internal
mechanism. Cannot be modified. Retry timeout (seconds): The wait period between tries. An internal mechanism.
Cannot be modified. Default application server: shows the application server used by default. An internal
mechanism. Cannot be modified. Run on default application server only (Yes / No). Cannot be modified. Process options (scheduled): Shows if new entries and error entries will be processed.
Cannot be modified. Posting parameters: an internal mechanism. Cannot be modified.
Parameters tab 11
Multi-thread processing: an internal mechanism. Cannot be modified.
Parameters tabThe Parameters tab enables you to view the individual parameters for the segment. If the parameter is set to Yes in the User Modifiable column, then the parameter value itself can be modified. For more information see Editing segment parameters on page 12.
12 Pipeline Administrator
Statistics tabThe Statistics tab displays a list of segment processes showing: Process ID Start Date/Time End Date/Time No. of Transactions No. of Errors Start Queue ID End Queue ID
To view statistics information for a segment, click a segment in the list in the left pane. Statistics for the selected segment display in the Segment Details pane. The Log Group and Transaction number for the selected process are identified in the Log Group Summary pane below the process list.
Note: The information in the Statistics tab is kept for the amount of time indicated in the Segment Statistics Retention field. For more information see Changing statistics retention on page 13.
Modifying process options
In the Pipeline Administrator pane, expand the list of segments and click the one to be viewed. The Segment Details pane displays.1. To modify process options for a parameter, right-click the segment from the segment
list and then click Configuration.
2. The Segment Configuration window displays. Make any required changes.3. Click OK.
Editing segment
parameters
1. In the Pipeline Administrator pane, expand the list of segments and click the one to be viewed. This opens the Segment Details pane.
Changing statistics retention 13
2. Click the Parameters tab.It enables you to view the individual parameters for the segment. If the parameter is set to Yes in the User Modifiable column, the parameter value can be modified in Pipeline Administrator by right-clicking the parameter and selecting Edit. The Edit Parameter window displays.
3. After modifying the parameter value, select OK to save the change.
Changing statistics retention
Statistics Retention is the period of time in days that the database keeps records of data flow activities before they are purged to make room for new tracking information. The retention period is the same for all segments.
1. In the Pipeline Administrator pane, right-click Segment .2. Select Statistics Retention.
3. Set the number of days to retain records and then click OK.
Starting a segment
1. Right-click a segment and then click Start to open the Start Segment input window.
2. Do one of the following:
Start Segment selection screen
Application server Enables you to select the application server on which you want to run the segment. Default: Default Server.
Poll servers Enables you to select whether you want to poll all servers or not. Selected / Cleared Default: Cleared.
Process options Enables you to select the criteria for the process. Errors and new entries Errors Only New Only Default: Errors and new entries.
Note: This field should only be modified for support purposes. Data integrity issues may result if transactions in error and new entries are processed out of sequence.
14 Pipeline Administrator
3. Click Start.
Stopping a segment
Only a queue segment can be stopped while it is running. The queue segment will stop once it has finished processing the current queue item. A non-queue segment cannot be stopped while it is running.
1. Right-click on a segment.
2. Select Stop.
Scheduling a segment or job
After you schedule a segment you can track it in the Job Summary. Jobs that contain more than one segment are scheduled through the Job server. For more information see Advanced Job Operations on page 21.1. Right-click on a segment and click Job to open the Select Schedule input window.
1. Select a Schedule name or type a New schedule name. The default is New Schedule.
2. Click OK.
To … Select …
Run only segment processes created since last time.
New Only
Reprocess existing errors. If errors were corrected, the process will run successfully; otherwise, it will fail again.
Errors Only
Reprocess existing errors and process new data. Errors and new entries
Scheduling for a single occurrence 15
3. The Edit Schedule dialog box opens. In the Occurs box, select how often the job should occur.
Scheduling for a single
occurrence
1. Select One time in the Occurs box.2. In the One time box, enter the start date in the On date field and the start time in the
At time field.
3. Select the Enabled box in the upper right corner of the window. If you clear the Enabled check box, the schedule will not run.
4. Click OK to save the schedule.
Scheduling on a daily basis
1. Select Daily from the Occurs box.
2. In the Daily box, select the interval you want the segment to run in the Every field.
3. In the Daily frequency box: If you want the schedule to run only once, select Occurs once at and enter the
time; or If you want the schedule to run more than once, enter the time requirements in
the Occurs every, Starting at and Ending at fields.4. In the Duration box, choose the Start date and the End date, or if you want the job to
run 'forever' select No end date.
5. Click Enabled > OK to save the schedule.
Scheduling on a weekly basis
1. Select Weekly from the Occurs box.
16 Pipeline Administrator
2. In the Weekly box, enter the weekly frequency in the Every field, and select the days of the week you want scheduled.
3. In the Daily frequency box: If you want the schedule to run only once, select Occurs once at and enter the
time; or If you want the schedule to run more than once, enter the time requirements in
the Occurs every, Starting at and Ending at fields.
4. In the Duration box, choose the Start date and the End date, or if you want the job to run 'forever' select No end date.
5. Click Enabled > OK to save the schedule.
Scheduling on a monthly
basis
1. Select Monthly from the Occurs box.
Job Summary 17
2. In the Monthly box: Select Day and enter the day of the month and the monthly frequency; or Select a specific day and enter the monthly frequency.
3. In the Daily frequency box: If you want the schedule to run only once a day, select Occurs once at and enter
the time; or If you want the schedule to run more than once a day, enter the time
requirements in the Occurs every, Starting at and Ending at fields.
4. In the Duration box, enter the Start date and the End date, or if you want the job to run 'forever' select No end date.
5. Click Enabled > OK to save the schedule.
Job Summary
Viewing the list of scheduled
jobs
1. In the Pipeline Administrator pane, expand the Job Server list.
Job Summary
Name The name of the job.
Description The description of the job.
Job Enabled Yes / No.
No. of Steps The number of steps in the job.
No. of Schedules (Enabled)
Two integers. The first is the number of schedules defined for the job. The second figure, enclosed in parentheses, is either 0 or 1; 0 indicates that no schedules have been enabled and 1, that at least one schedule has been enabled.
Status Idle or Running.
18 Pipeline Administrator
Note: In order to run a job, you must assign it a schedule and enable both the job and the schedule.
Viewing job details
1. In the Pipeline Administrator pane, expand the Job Server list.
2. In the Pipeline Administrator pane, click the name of the job to be viewed. The Job Details screen appears. The Job Details window consists of three tabs: General Run Status History
General tab
Next Run Date/Time The time the job is next scheduled to run. Date/Time not available indicates that no schedule has been defined or enabled for the job.
Job Summary
Job Details – General tab
Description A description of the segment given to the job.
Date created The date the job was created.
Date last modified The date the job was last modified.
Job enabled Shows if the job is enabled or not.
Contains step Shows if the job has a step or not.
Has schedule Shows if the job has a schedule or not.
Run Status tab 19
Run Status tab
History tab
Job Details – Run Status tab
Current run Shows if the run is idle or running, and which step it is on if it is running.
Last run Shows the date, time and if the outcome was successful or failed.
Next run Shows the date, the time, and the schedule ID. If no schedule exists, indicates Not Available.
20 Pipeline Administrator
The History tab shows a list of jobs that have been performed, and statistics for those jobs: Step ID Step Name Started at Date/Time Result Run DurationClick a job from the History tab list. A message will appear in the Message pane below the History tab list detailing that particular job step's history.
Modifying a job schedule
1. In the Pipeline Administrator pane, expand the Job Server list.
2. Right-click the name of the job to be rescheduled.
3. Select Schedule.4. Change the schedule settings as described in the instructions for Scheduling a
segment or job on page 14.
Disabling a job You can prevent a job from running as scheduled by disabling it. This allows you to suspend a job temporarily or to define jobs to be activated at a future date.
1. In the Pipeline Administrator pane, expand the Job Server list.2. Right-click the name of the job to be disabled.
3. Select Disable.
Enabling a job You can reinstate a disabled job by enabling it. This allows you to activate predefined jobs or return to running a job as scheduled once temporary conditions have changed.
1. In the Pipeline Administrator pane, expand the Job Server list.2. Right-click the name of the job to be enabled.
3. Select Enable.
Deleting a job If you are sure that a particular job should no longer be run you can delete it from the Job Summary. Deleting removes the job permanently.
1. In the Pipeline Administrator pane, expand the Job Server list.
2. Right-click the name of the job to be deleted.3. Select Delete.
Creating a new job
If a particular job doesn't exist in the Job Summary, you can create a new one.1. In the Pipeline Administrator pane, expand the Job Server list.
Advanced Job Operations 21
2. Right-click anywhere in the list and select New Job.
3. Enter the required information in the New Job dialog box and click Create.
4. Enter the required information in the Select Schedule dialog box and click OK.5. Set the schedule as described in the instructions for Scheduling a segment or job on
page 14.
Advanced Job OperationsThrough the Job Server, you access the advanced functions for managing Pipeline jobs.
Advanced functions include: Viewing and modifying job properties. Setting notification parameters. Adding multiple steps to a job. Creating and modifying job schedules. Adding system operators.
Viewing job properties
1. In the Pipeline Administrator pane, expand the Job Server list.2. Right-click the name of the job to be viewed and then click Advanced. The Job
Properties screen appears. The Job Properties screen consists of four tabs: General
22 Pipeline Administrator
Steps Schedules Notifications
General tabThe only field that should be modified by Epicor professional services is the Enabled flag.
Job Properties – General tab
Name A name (maximum 128 characters) used to identify the job to the system. If all jobs originate from a single server (as is normally the case) this name must be unique. Pipeline job names should combine 'PL' and the segment ID. For instance, a Pipeline job using segment 3007 would be named 'PL3007'.
Source The server from which the job originates. Default: Local.
Created A date and time stamp indicating when the job was created.
Enabled If this check box is selected, the job is enabled (active). If it is cleared, the job is disabled (inactive). A disabled job can run only if it is started manually.
Target local server Indicates if the job runs only on a single local server. If it is, the word Local appears in the window.
Target multiple servers Indicates if the job can run on multiple remote servers. If it is, the names of the servers appear in the window. This option is accessible only on a master server.
Category Type of job. Jobs can be assigned to different categories to aid in filtering and grouping.
Owner The user who is running this job. When the user is also the system administrator, 'ownership' of a particular job can be assigned to a different user.
Description A label (maximum 512 characters) describing the job. The description usually includes the Segment ID and the Segment Label of the job segment.
Last modified The date and time that this job was last modified.
Steps tab 23
Steps tabA step is an action that a job takes, either on the database or on the server. A job must have at least one step. To create a job with more than one step, see Adding multiple steps to a job on page 29.
Job Properties – Steps tab
ID A unique identification number for the step.
Step Name A descriptive name for the step.
Type Type of command. Operating System commandsActiveX script Replication commands Transact-SQL scriptPipeline uses Operating System commands to run segments.
On Success Outcome if step runs successfully.
On Failure Outcome if step runs unsuccessfully.
Move step To shift a particular step's place in the sequence, select it and click the up or down arrows until it is where you want it.
Start step To make a step the starting step in a process, select its name from this drop down list. A flag appears beside the starting step.
24 Pipeline Administrator
Schedule tabThis displays schedules that have been defined for the job.
Notifications tabThese settings determine what actions the system takes after a job ends. Automatic messages can be sent to system operators or recorded in log files. You specify whether the action occurs at failure, success, or job end regardless of outcome for each job.
Job Properties – Schedules tab
ID A unique identification number for the schedule.
Name A descriptive name for the schedule.
Enabled Indicates whether the schedule has been activated.
Description Describes the schedule.
Current date/time on target server
Allows you to verify the current date and time on each remote server targeted by the schedule. This aids job management on multiple servers in multiple time zones.
Job Properties – Notifications tab
E-mail operator Check this box and select a system operator to whom an automatic e-mail message should be sent.
Creating and modifying job schedules 25
Creating and modifying job
schedules
If a segment is to be run regularly throughout the day, it should be scheduled about every 10 minutes. Such jobs should have staggered start times. As a general rule, the maximum number of scheduled jobs that should start at any given minute should not exceed the number of CPU on the Pipeline server multiplied by 2.Regularly scheduled jobs should run no more frequently than every 5 minutes and this should only be implemented for very time-critical jobs.
1. In the Pipeline Administrator pane, expand the Job Server list.
2. Right-click the name of the job to be viewed and then click Advanced.3. Open the Schedules tab and do one of the following:
4. The New Job Schedule / Edit Job Schedule screen opens.
Page operator Check this box and select a system operator to whom an automatic pager message should be sent.
Net send operator Check this box and select a system operator to whom an automatic net message should be sent.
Write to Windows application event log
Check this box to have the job logged in an application log file.
Automatically delete job Check this box to have the job automatically and deleted from the job summary. This check box should only be selected if you want the job to be permanently deleted.
Job Properties – Notifications tab
To … Click …
Add a schedule. New Schedule
Modify a selected schedule. Edit
New Job Schedule fields / Edit Job Schedule fields
Name A user-defined name (maximum 128 characters) identifying the schedule. It must be unique within the job.
Enabled Select this box to activate the schedule. When the box is cleared, the schedule is not active, but it remains on the system.
26 Pipeline Administrator
Removing schedules from
a job
From the Schedules tab, select a schedule and then click Delete.
Creating a system
operator
1. In the Pipeline Administrator pane, expand the Job Server list.2. Right-click a job and then click Advanced. Click the Notifications tab.
3. Select one of the operator check boxes and then select New Operator from the drop-down list. The New Operator Properties window opens.
4. In the General tab, enter the operator's name and coordinates for receiving e-mail, pager or net send messages. You can also enter the operator's on-duty schedule.
Schedule Type The kind of schedule being defined. These settings determine what conditions trigger the job. This field is normally set to Recurring. Change schedule settings as described in the instructions for Scheduling a segment or job on page 14.
New Job Schedule fields / Edit Job Schedule fields
New Operator Properties / Operator Properties – General tab
Name The operator's name (to a maximum of 128 characters).
ID System-assigned identification number for the operator.
E-mail name The operator's e-mail address for receiving notifications.
Pager e-mail name The operator's pager coordinates for receiving notifications.
Net send address The operator's net send address for receiving notifications.
Creating a system operator 27
5. In the Notifications tab, for each job to be sent to the operator, choose when the message will be sent.
6. When your selections in both tabs are complete, click Apply.
Pager on duty schedule
Select one or more days of the week when the operator is on duty.
Workday begin The time that the operator's work hours begin.
Workday end The time that the operator's work hours end.
New Operator Properties / Operator Properties – Notifications tab
Notifications sent to this operator by
Select Alerts or Jobs to view the operator's notifications filtered by type.
Job Name Descriptive name of the job that the operator is responsible for.
E-mail, Pager, Net Send
For each type of message, indicates the job outcome that triggers the message to the operator. It can be sent upon completion of the job regardless of outcome, upon success, or upon failure.
Operator is available to receive notifications
Select this check box to activate the operator, and clear it to deactivate it.
Most recent notifications attempts
The system displays the time and date stamp for the last attempt to notify the operator.
By e-mail The last e-mail notification was sent at this time and date.
By pager The last pager notification was sent at this time and date.
By net send The last net send notification was sent at this time and date.
New Operator Properties / Operator Properties – General tab
28 Pipeline Administrator
E-mail, Pager, Net Send actions
Modifying a system
operator
1. Right-click a job and then click Advanced. Click the Notifications tab.
2. Beside the operator whose details you want to modify, click to open the Operator Properties window.
3. In the General tab, change the operator's name and coordinates for receiving e-mail, pager or net send messages. You can also edit the operator's on-duty schedule.
4. In the Notifications tab, for each alert or job to be sent to the operator, make the necessary modifications.
5. When you have completed all required changes in both tabs, click Apply.
Multiple Step JobsIt is possible to define a job with multiple steps. However, this calls for advanced programming knowledge. You must understand the structure of your database and the logical path that the data would follow throughout each process. The command types for multiple step jobs are listed below.
CmdExec (operating system commands)By default, Pipeline uses operating system commands.
These job steps are operating system commands or executable programs that typically end with .bat, .cmd, .com, or .exe file extensions.
A CmdExec job step must specify the command to be executed, the full path to all executable programs, and the process exit code that indicates success.
Note: The command types listed below are very rarely used. In order to use these command types for multiple step jobs you must be familiar with SQL, Microsoft® ActiveX® or one of the other methods of scripting a series of job steps.
Transact-SQL statementsWhen you create a Transact-SQL job step, you must write a Transact-SQL statement, stored procedure, or extended stored procedure and identify the database where the job will be executed.
A Transact-SQL job step can contain multiple batches and embedded GO commands.
ActiveX scriptsAn ActiveX scripting job step must identify the scripting language in which the job step is written.
Alternately, an ActiveX script command could be compiled externally and then run as a CmdExec executable.
Replication agents 29
Replication agentsPipeline automatically executes four agents to run particular database replication jobs. Distributor Transaction – Log Reader Merge Snapshot
Adding multiple steps to a job
1. In the Pipeline Administrator pane, expand the Job Server list.
2. Right-click the name of the job to be modified and then click Advanced.3. Open the Steps tab, select a job step and do one of the following:
4. The New Job Step / Edit Job Step screen opens. The default tab is General.Fields displayed in the General tab depend on the command Type that is selected.
To … Click …
Add a step to the end of the list. New
Add a step before the selected step. Insert
Modify the selected step. Edit
New Job Step / Edit Job Step – General tab
Step Name A user-defined name used to identify the step.
Type The kind of command used to define the step. ActiveX script Operating System Command (Cmd Exec) Transact-SQL Script (TSQL) Replication agents Pipeline uses operating system commands by default.
Database This field displays if you select Transact-SQL Script (TSQL) or Replication Queue Reader as your command type. Identify the database to be accessed by the command.
30 Pipeline Administrator
5. Click the Advanced tab.Fields in the Advanced tab depend on the command Type that is selected.
Process exit code of a successful command
This field displays only if you select Operating System Command (Cmd Exec) as your command type. Enter the output value that will indicate if the command succeeded.
Language These options display only if you select Active script as your command type. Select the scripting language you use to write the command script. Visual Basic Jscript Other (specify)
Command The command, procedure, or script used for this step.
New Job Step / Edit Job Step – Advanced tabOn success / failure flow
On success action If the command script runs successfully, this is the action the system will take next.
Retry attempts If the command script doesn't run successfully, this is the number of times the system tries again to run it before it is deemed to have failed. Default: 0.
Retry interval (minutes)
If the command script doesn't run successfully, this length of time in minutes must elapse between retry attempts. Not accessible if Retry attempts is 0.
On failure action Indicates whether the job should continue or abort if a segment within the job reports a failure.
Transact-SQL Script (TQSL) command options
Output file This identifies a path and filename where the system stores output resulting from running the command script.
New Job Step / Edit Job Step – General tab
Removing multiple steps from a job 31
No command options are available for the other command types.
Removing multiple steps
from a job
1. In the Pipeline Administrator pane, expand the Job Server list.2. Right-click the name of the job to be modified and then click Advanced.
3. Open the Steps tab, select a job step and then click Delete.
Troubleshooting
Segment errors Queue segment errors can be viewed in the error queue. The sections that follow discuss how to view a list of queue segment errors, create error queue reports and resubmit an error queue segment. The information in these section does not discuss specific errors that may be generated by individual queue segments. Information on specific errors generated by a segment can be found under the appropriate segment in the Segment Reference chapter starting on page 34.
Note: For information about viewing non-queue segment errors, see the troubleshooting section for the appropriate non-queue segment in the Segment Reference chapter on page 34.
Append output to step history
Check this box if output is to be added to the history entry for the step.
Run as user The database administrator can run a job as another user by selecting the alternative user name here.
Operating System Command (Cmd Exec) command options
Output file This identifies a path and filename where the system stores output resulting from running the command script.
Overwrite / Append If Overwrite is selected, the system will replace the existing file with the new information. If Append is selected, it will add the new information to the end of the existing file.
Replication Queue Reader command options
Server Identifies the server to be accessed by the command.
Database Identifies the database to be accessed by the command.
Transact-SQL Script (TQSL) command options
32 Pipeline Administrator
Manager log The manager log is a Pipeline engine file where all activity is logged, including non-queue segment errors. The manager log can be found at the following location: Drive: \NSB\Logs\Foundation\Pipeline\ (where Drive: is the location selected during the installation of the Pipeline Engine for generation of the manager log).
Sample Manager Log file
The Manager Log can be viewed as a text file (shown above) or through the Pipeline Log Reader.
Viewing a list of queue segment errors 33
Viewing a list of queue
segment errors
Click Error Queue.
The number of errors for each segment is indicated in brackets after the segment in the Pipeline Administrator list and in the Error Count field of the Error Queue Summary.
Viewing error details for a
segment
1. In the Pipeline Administrator pane, expand the Error Queue list and select the segment to be viewed.The Error Queue Details pane opens.
2. From the Error Queue Details pane, select the Sequence ID that you want to view. A message will appear in the Error Message text box describing the error that occurred for that particular sequence.
34 Pipeline Administrator
Creating error queue reports
1. In the Pipeline Administrator pane, expand the Error Queue list, right-click a segment and then select Report.
2. In the Error Report selection screen, select Show All Errors or enter the Sequence ID range to be included in the report.
3. Click Report.
4. Print your report or save it to file.
Error Queue Details
Sequence ID Displays the identification number for this error queue sequence.
Severity Level Identifies the severity level for the error.
Entity Displays the data type where the error occurred.
Entity Key Displays the entity key for the error.
Action Identifies the type of action being attempted when the error occurred.
Resubmit Displays whether this error has been enabled to resubmit.
Resubmit Count Displays the number of times this error has been resubmitted.
Current Severity Level Enables you to set the severity level for the segment; errors with a severity of zero or greater than the current severity level will be displayed. All others will be hidden. If you change the current severity level, it will change only for the selected error. To change the severity level for all errors in the segment, go to Administrator > Options.
Error Message A system-generated message describing the details of the error that occurred for the particular error queue sequence.
Error Report selection screen
Show All Errors Enables you to display all the sequence IDs for this error queue.
Sequence ID From/To Enables you to select a range of sequence ID numbers for display.
Resubmitting an error queue item 35
Print preview of an error report
All errors for queue segments are posted to the error queue table in the Pipeline Repository database. The way they are handled after that depends on the process options that were selected for the segment configuration.If a particular segment is configured to reprocess errors, then the next time Pipeline runs, its errors will be resubmitted. If a particular segment is configured to process new entries only, its errors will not be reprocessed.If you want to resubmit particular errors manually, you can do so.
You can also temporarily stop a particular queue item from being processed the next time Pipeline runs.To permanently prevent a queue item from being processed, you delete it from the error queue.
You can select errors from the queue one at a time, or use the <Shift> and <Control> keys to select groups or sequences of errors.
Resubmitting an error queue
item
Note: This action can result in data integrity problems. It should only be performed by a user that has a thorough understanding of the segment.
1. In the Pipeline Administrator pane, expand the Error Queue list and select a segment.
2. In the Error Queue Details pane, right-click the sequence ID you want to resubmit.
3. Select Resubmit.
Stopping resubmission
of an error item
Note: This action can result in data integrity problems. It should only be performed by a user that has a thorough understanding of the segment.
1. In the Pipeline Administrator pane, expand the Error Queue list and select a segment.2. In the Error Queue Details pane, right-click the sequence ID you do not want to
resubmit.
3. Select Do not resubmit.
36 Pipeline Administrator
Deleting an error queue
item
Note: This action can result in data integrity problems. It should only be performed by a user that has a thorough understanding of the segment.
1. In the Pipeline Administrator pane, expand the Error Queue list and select a segment.
2. In the Error Queue Details pane, right-click the sequence ID you want to delete.
3. Select Delete.
4. Click Yes.
Refreshing the error queue
1. In the Pipeline Administrator pane, right-click .2. Click Refresh.
\
2 Segment Reference
This section contains information on each Pipeline segment including segment description, segment parameters, database parameters and troubleshooting information (where available).
Note: Segment numbers listed in this manual are those that would be set up for Company 1 on the Pipeline Enterprise server. Clients with more than one company would have segments numbered as follows: Company 2 segments would be 1001000, 1001003, 10010004 etc., Company 3 segments would be 2001000, 2001003, 2001004, etc.
Segment RequirementsThe chart below: Lists the pipeline segments for the Merchandising release 4.3. Shows the current default for the ‘segment installed’ flag: 1=installed 0=not installed. Indicates whether the installation of the segment is:
Mandatory Conditional Mandatory; comment lists condition(s) when installation is mandatory Optional Required only at Startup Not Applicable
Segment Requirements 38
Segment ID Segment LabelSegment Installed / Current Default
MCMOSN/A
Comments
1 Pipeline Test 1 N/A Not Required – applicable only to test environment.
1000 EDM & PROD to WM 0 CM Required if Epicor WMS installed.
1001 EDM & PROD to MA - Style Retail Startup 0 S Required at startup when upgrading to Merchandising 4.1 or higher. This segment populates the style retail table in MA.
1003 EDM & PROD to Sales Audit 1 CM Required if Sales Audit installed.
1004 EDM & PROD to Customer Info Mgmt 1 CM Required if CRM installed.
1005 EDM & PROD to MA 1 M
1006 EDM & PROD to Price Look-Up 1 M Used for PLU. Also used if OIM installed and SIT is used at the register for non-sale. This segment is used to send PLU and to send the master data down to the registers for SIT.
1008 EDM & PROD Internal - Update Location Status 1 M
1009 EDM & PROD To Merch Planning - Send Loc Hierarchy 1 CM Required if Planning installed. Used to interface master data to planning.
1010 EDM & PROD To Merch Planning, Merch Entity 0 CM Required if Planning installed.Used to interface master data to planning.
1013 EDM & PROD to Text File 1 O Being used by type 2 development.
1015 EDM & PROD to Sourcing 0 CM Required if Sourcing installed.
1023 EDM & PROD Location Attributes To Planning 0 CM Required if Planning installed. Used to interface master data to planning.
1030 EDM & PROD to MA & SL 1 M Used for style reclassification.
1031 EDM & PROD Internal - System Delete Styles 1 M
1032 EDM & PROD To Offline IM File 0 CM Required if OIM installed and using NOI (NSB Open In-store) for non-sale.
Segment Requirements 39
1033 EDM & PROD To Offline IM File, Master Data 0 CM Required if OIM installed and using NOI (NSB Open In-store) for non-sale. Used only when a new store is created. It is used to send all the master data to the newly created store.
1034 EDM & PROD to Offline IM File, Startup 0 S Required if OIM installed and using NOI (NSB Open In-store) for non-sale. Only required at startup.
1035 EDM & PROD Internal - Make Jurisdiction Available 0 M
1038 EDM & PROD to Price Look-up File Generate (CRS) 1 CM Required if CRS POS is installed.
1536 ADM & PROD to Price Look-up - File Regenerate Client-specific
2000 POM To Offline IM File 0 CM Required only if OIM installed and using NOI or SIT for non-sale.
2005 POM to EDI Text File 0
3000 IM to WM 0 CM Required if Epicor’s WMS installed.
3002 IM to WM, Store Ship Confirmation 0 CM Required if Epicor’s WMS installed.
3003 IM Internal - System Receive Documents 1 M
3004 IM Internal - System Delete Documents 1 M
3006 IM Internal - Post Physical Inventory Counts 1 M
3007 IM to Infobase - Post Sales Obsolete as of 4.3
3008 IM Internal - System Match PO Receipts 1 CM Required only if Epicor IMAT is NOT installed.
3009 IM to Sourcing 0 CM Required if Sourcing installed.
3010 IM Internal - System Match Unsolicited Receipts 1 CM Required only if Epicor’s IMAT is NOT installed.
3011 IM Internal - System Match RTVs 1 CM Required only if Epicor’s IMAT is NOT installed.
3012 IM To Offline IM File 0 CM Required if OIM installed and using NOI or SIT for non-sale.
3050 IM to Text File, Franchise 1 N/A Not required – client specific
3100 IM to Infobase - Sales Posting 1 CM Required if AOM is installed
Segment ID Segment LabelSegment Installed / Current Default
MCMOSN/A
Comments
40 Segment Reference
4000 PM Internal - Issue Documents 1 M
4002 PM Internal - Make Promotional PCs Effective 1 M
4003 PM Internal - Make Permanent PCs Effective 1 M
4004 PM Internal - Complete Promotional PCs 1 M
4005 PM Internal - System Cancel Unapproved Documents 1 M
4006 PM Internal - System Delete Cancelled & Completed Docs
1 M
4007 PM Internal - Remove Mix and Match Codes 1 M
4008 PM Internal - Issue Deal Document 1 M
4009 PM Internal - Complete Deal Document 1 M
4010 PM Internal - Delete Completed & Cancelled Deal Docs 1 M
4011 PM Internal - Update PC Totals 0 M
4012 PM Internal - PCM Update Locations 1
4013 PM Internal - System Cancel Unapproved Deal Documents
5000 Infobase to MA - Post SKU Transactions Obsolete as of 4.3
5001 Infobase to MA - Post Style Transactions Obsolete as of 4.3
5002 Infobase to MA - Post Style Color Transactions Obsolete as of 4.3
5003 Infobase to MA - Post Group Transactions Obsolete as of 4.3
5004 Infobase to MA - Initialize Posting Obsolete as of 4.3
5005 InfoBase to MA - Post Beginning Inventory 1 S
5006 InfoBase to Stock Ledger - Post Transactions 1 M
5007 InfoBase to Stock Ledger - Stock Ledger Startup 1 N/A Not required – specific to Jacobson. Only required if startup S/L after already live with Merchandising.
5010 Infobase to MA - Send Master Entities 1 M
Segment ID Segment LabelSegment Installed / Current Default
MCMOSN/A
Comments
Segment Requirements 41
5100 InfoBase to MA - Post Flash 1 M
5101 InfoBase to MA - Post History 1 M
5102 InfoBase to MA - Post Component 1 M
5103 InfoBase to MA - Post On Hand 1 M
5104 InfoBase to MA - Post On Order Allocation 1 M
5105 InfoBase to MA - Initialize 1 S
6001 Stock Ledger to General Ledger Export Tbls - Export Trans
1 CM Required if sending SL data to GL.
6002 Stock Ledger to MA - Send RIM Costs 0 O
7000 Invoice Matching to Text File 1 CM Required if IMAT installed.
7001 Invoice Matching Internal - Exec outstanding processes 1 CM Required if IMAT installed.
7003 Invoice Matching Internal - System Del Matched Invoice
1 CM Required if IMAT installed.
8000 WM to Merchandising 0 CM Required if Epicor WMS installed.
8002 WM to InfoBase 0 CM Required if Epicor WMS installed.
11009 MA to Merch Planning - Send History 1 CM Required if Planning and MA installed.
11010 MA Internal - Housekeeping 1 M
11011 MA Internal - Location Comp Startup 1 S
11012 MA Internal - Location Comp Update 1 M
11013 MA Internal - Purge History 1 M
11014 MA Internal - Alternate Hierarchy Startup 1 S Required if upgrading to Release 2.1 from earlier versions of Merchandising. Alternate Hierarchies were introduced in Release 2.1.
11021 MA Internal - History Import, Update Live Sku Hist 1 S
11022 MA Internal - History Import, Update Live Sku Oh Hist 1 S
Segment ID Segment LabelSegment Installed / Current Default
MCMOSN/A
Comments
42 Segment Reference
11023 MA Internal - History Import, Update Live Color Hist 1 S
11024 MA Internal - History Import, Upd Live Color Oh Hist 1 S
11025 MA Internal - History Import, Update Live Style Hist 1 S
11026 MA Internal - History Import, Upd Live Style Oh Hist 1 S
11027 MA Internal - History Import, Update Live Group Hist 1 S
11028 MA Internal - History Import, Upd Live Group Oh Hist 1 S
11029 MA Internal - History Import, Update Live Group Rim Oh 1 S
11031 MA Internal - History Import, Summarize Sku Hist 1 S
11032 MA Internal - History Import, Summarize Sku Oh Hist 1 S
11033 MA Internal - History Import, Summarize Color Hist 1 S
11034 MA Internal - History Import, Summarize Color Oh Hist 1 S
11035 MA Internal - History Import, Summarize Style Hist 1 S
11036 MA Internal - History Import, Summarize Style Oh Hist 1 S
11037 MA Internal - History Import, Summarize Group Hist 1 S
11038 MA Internal - History Import, Summarize Group Oh Hist 1 S
11039 MA Internal - History Import, Summarize Group Rim Oh 1 S
11041 MA Internal - History Import, Initialize 1 S
11042 MA Internal - History Import, Verify Oh Posting 1 S
11051 MA to Sales Audit - Send Plans to Flash Sales
11060 MA Internal - Summarize History Component at SKU Level
1 S
11061 MA Internal - Summarize History Component at Style Color Level
1 S
11062 MA Internal - Summarize History Component at Style Level
1 S
Segment ID Segment LabelSegment Installed / Current Default
MCMOSN/A
Comments
Segment Requirements 43
11063 MA Internal - Summarize History Component at Merchandise Group Level
1 S
12000 Sales Audit to IM - Move Sales 1 Obsolete as of 4.3
12100 Sales Audit Internal - Purge mew_sales_export 1 CM If the source of the sale transactions is Sales Audit (and not an import using flat files).
16001 Text File to EDM, PROD & POM Import Tables – Import 1 M Used at startup and can also be used by clients importing data on a regular basis. Also used by Assortment Planning (even when running standalone Assortment Planning).
16004 Text File to IM Import Tables - Import UDAs 0 M
16005 Text File to Stock Ledger - Import Initial CC Percentages 1 S Required at startup only if using RIM - Retail Inventory Method.
16008 Text File to Invoice Matching Imp Tbls - Imp Invoices 1 CM Required if IMAT installed.
16020 Text File to MA Hist Component Import, All Prod Levels 1 S
16021 Text File to MA - History Import, Update Imp Sku Hist 1 S
16022 Text File to MA - History Import, Upd Imp Sku Oh Hist 1 S
16023 Text File to MA - History Import, Upd Imp Color Hist 1 S
16024 Text File to MA - History Import, Upd Imp Color Oh Hist 1 S
16025 Text File to MA - History Import, Upd Imp Style Hist 1 S
16026 Text File to MA - History Import, Upd Imp Style Oh Hist 1 S
16027 Text File to MA - History Import, Upd Imp Group Hist 1 S
16028 Text File to MA - History Import, Upd Imp Group Oh Hist 1 S
16029 Text File to MA - History Import, Upd Imp Grp RIM Oh 1 S
16031 Text File to IM Import Tables - Import ASNs 1 M
16032 Text File to EDM, PROD & POM Import Tbls - Import Pack
0
Segment ID Segment LabelSegment Installed / Current Default
MCMOSN/A
Comments
44 Segment Reference
16060 Text File to PM Import - Import Price Changes 1
17000 EDM, PROD & POM Import Tables to EDM, PROD & POM
1 M Used at startup and can also be used by clients importing data on a regular basis. Also used by Sourcing and Assortment Planning (even when running standalone Assortment Planning).
19000 IM Import Tables to IM 1 M
19010 IM Import Table to IM - ASN Import 1 CM Required if importing ASNs.
22000 Invoice Matching Import Tables to Invoice Matching 1 CM Required if IMAT installed.
26000 Merch Planning Internal - Import History and Hierarchy 1 CM Required if Planning installed.
26001 Merch Planning to MA – Import 1 CM Required if Planning data is needed in MA.
28000 General Ledger Exp Tables to Text File - Export Trans 1 CM Required only if sending SL data to GL.
32000 RTP Internal - System Cancel and Delete RTP Documents
1 M
34000 PM Import to PM 1 CM Required if importing price changes.
53001 Offline IM to IM 0 CM Required if OIM installed and using NOI or SIT for non-sale.
53002 Offline IM to IM, Outbound Transfers 0 CM Required if OIM installed and using NOI or SIT for non-sale.
53003 Offline IM to IM, Store Shipment Receipts 0 CM Required if OIM installed and using NOI or SIT for non-sale.
53004 Offline IM to IM, PO Receipts 0 CM Required if OIM installed and using NOI or SIT for non-sale.
53005 Offline IM to IM, Inventory Counts 0 CM Required if OIM installed and using NOI or SIT for non-sale.
58001 Offline IM File Internal - Prepare EDM & PROD Files 0 CM Required if OIM installed and using NOI or SIT for non-sale.
58002 Offline IM File Internal - Prepare POM Files 0 CM Required if OIM installed and using NOI or SIT for non-sale.
58003 Offline IM File Internal - Prepare IM Files 0 CM Required if OIM installed and using NOI or SIT for non-sale.
58004 Offline IM File Internal - Submit EDM & PROD Files 0 CM Required if OIM installed and using NOI or SIT for non-sale.
58005 Offline IM File Internal - Submit POM Files 0 CM Required if OIM installed and using NOI or SIT for non-sale.
58006 Offline IM File Internal - Submit IM Files 0 CM Required if OIM installed and using NOI or SIT for non-sale.
Segment ID Segment LabelSegment Installed / Current Default
MCMOSN/A
Comments
Segment Requirements 45
58007 Offline IM File Internal - Prepare Descriptor Files 0 CM Required if OIM installed and using NOI or SIT for non-sale.
58008 Offline IM File Internal - Submit Descriptor Files 0 CM Required if OIM installed and using NOI or SIT for non-sale.
60001 POM & AR to WM 0 CM Required if Epicor WMS installed.
Segment ID Segment LabelSegment Installed / Current Default
MCMOSN/A
Comments
46 Segment Reference
Segment 1000 - EDM & PROD to WMThe segment replicates enterprise and product data from EDM and PROD to WM.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
4Wall_Company WM Company The number of the WM company with which the segment integrates. The number specified must be the same as the number of the Merchandising company with which the segment integrates. The value specified must also match the company number for which the Pipeline segment has been configured in the Pipeline Repository database. WM requires that all data and transactions it is sent be accompanied by the value specified in this parameter. (This is to support the inherited WM feature that enables WM to support multiple companies in one database, however this feature is no longer recommended and not fully supported when integrating with Epicor Merchandising.)
No The company number for which the Pipeline segment has been configured in the Pipeline Repository database.
DivLevel Division Level The ID of the level in the main location hierarchy in EDM that is defined as division for WM. Can be set to 0 if no such level exists.Used by the segment to determine what main location hierarchy groups to send to WM and to link to locations sent to WM.
No 0
DisLevel District Level The ID of the level in the main location hierarchy in EDM that is defined as district for WM. Can be set to 0 if there is no such level in the main location hierarchy in EDM. Used by the segment to determine what main location hierarchy groups to send to WM and to link to locations sent to WM.
No 2
RegLevel Region Level The ID of the level in the main location hierarchy in EDM that is defined as region for WM. Can be set to 0 if there is no such level in the main location hierarchy in EDM. Used by the segment to determine what main location hierarchy groups to send to WM and to link to locations sent to WM.
No 5
Segment 1000 - EDM & PROD to WM 47
DeptLevel Department Level The ID of the level in the main merchandising hierarchy in PROD that is defined as department for WM. Must be set to a valid main merchandising hierarchy level ID in PROD. Used by the segment to determine what main merchandising hierarchy groups to send to WM and to link to styles sent to WM.
No 3
ClassLevel Class Level The ID of the level in the main merchandising hierarchy in PROD that is defined as class for WM. Must be set to a valid main merchandising hierarchy level ID in PROD. Used by the segment to determine what main merchandising hierarchy groups to send to WM and to link to styles sent to WM.
No 4
NoOfLevelsDeptHigherThanClass
Number Of Hierarchy Levels Dept is Higher Than Class
In the main merchandising hierarchy, the level mapped as WM department is this number of levels above the level mapped as WM class. For example, if the PROD hierarchy group code is 1-2-3-4-5-6, where WM class is represented by 5 and WM department is represented by 2, this parameter would be set to 3. Used by the segment to determine what main merchandising hierarchy group codes to send to WM and to link to styles sent to WM.
No 1
Mod22 Custom Modification 22 Installed
Indicates whether custom modification 22 is active. A value of 1 indicates that the custom modification is active, a value of 0 indicates that it is not. In package functionality, WM class codes are made up of the part of the main merchandising hierarchy group code representing department, concatenated with the part of the main merchandising hierarchy group code representing class. If custom modification 22 is active, WM class codes are made up of the entire main merchandising hierarchy group code for the level in the main merchandising hierarchy that is defined as class for WM, minus the hyphens.
No
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
48 Segment Reference
Scheduling Requirements Should be run regularly throughout the day as this is an online interface. This segment should be scheduled to run before segment 60001 - POM & AR to WM
and segment 3000, IM to WM. Replication queue entries processed by segments POM & AR to WM and IM to WM
may be rejected to the Pipeline error queue if they reference enterprise or product data not yet interfaced to WM via segment 1000 - EDM & PROD to WM. For example, a PO may be rejected with a message indicating that it references invalid SKUs. These rejections will eventually be reprocessed successfully once segment 1000 - EDM & PROD to WM runs. Scheduling segments 1000, 60001 and 3000 to run consecutively in a single job may reduce the number of such timing-related rejections but will not completely eliminate them as users in Merchandising may save POM, AR, and IM documents that reference new enterprise and product entities while segment 1000 - EDM & PROD to WM is finishing but before segments 60001 - POM & AR to WM and 3000 - IM to WM begin.
Database ParametersIn WM, the column release_no in table w4_parameter_cm must be set to set to the correct WM release number, i.e. 4.1.004.020, 4.1.005.020, 5.0.000.000 etc.
Queue Segment DescriptionThe segment requires the following Pipeline dll to be installed: NSBPLMapping.dll
Mod22 (cont.) For example, if the PROD hierarchy group code for the level in the main merchandising hierarchy that is defined as class for WM is 1-2-3-4-5, where 2 is the WM department and 5 is the WM class, the WM class code would be 12345 if custom modification 22 is active. If the custom modification is not active, the WM class code would be 25.
Dummy_vendor_code
Dummy Vendor Code
Vendor code used when a style is inserted as a pseudo-style.
No 99999
Dummy_vendor_style
Dummy Vendor Style
Vendor style used when a style is inserted as a pseudo-style.
No 99999
BuyerRole Employee Role For Buyer
Specifies the employee role of the positions which are sent to WMS as department buyers
No Buyer
Mod 209 Mod 209 Do not send location address Updates to WM
No 0
bMod180 LaSenza fixed hierarchy
User with LaSenza fixed hierarchy only No 0
Mod221 Mod221 Send style distribution multiple to WM No 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Segment 1000 - EDM & PROD to WM 49
Warehouse Management subscribes to the following entities and actions via this segment:
Entity Action Description
Calendar Week (43) Insert (I) Published when a calendar is initially created in EDM, and when the number of weeks in a given period is changed. (When the number of weeks in a period is changed, the weeks in the period are deleted and the new number of weeks are inserted.)
The calendar week is retrieved from EDM and placed in the WM calendar table.
Delete (D) Published when a calendar is deleted in EDM, and when the number of weeks in a given period is changed. (When the number of weeks in a period is changed, the weeks in the period are deleted and the new number of weeks are inserted.)
The calendar week is deleted from the WM calendar table.
Country (71) Insert (I) Update (U) Delete (D)
Main Location Hierarchy Group (153)
Insert (I) Update (U) Delete (D)
Location (101) Insert (I) Update (U) Delete (D)
Insert Main Location Hierarchy Group a
Insert (I)
Location Address (3) Insert (I) Update (U) Delete (D)
Location Contact (23) Insert (I) Update (U) Delete (D)
Location Custom Property (621)
Insert (I) Update (U) Delete (D)
Pricing Group (920) Insert (I) Update (U) Delete (D)
Pricing Group Location (921) Insert (I) Delete (D)
Merchandise Vendor (401) Insert (I) Update (U) Delete (D)
Vendor Address (1) Insert (I) Update (U) Delete (D)
Vendor Contact (21) Insert (I) Update (U) Delete (D)
Carrier (51) Insert (I) Update (U) Delete (D)
Carrier Service (52) Insert (I) Update (U)
Style Attribute (452) Insert (I) Update (U) Delete (D)
Attribute Set For Style (482) Insert (I) Update (U) Delete (D)
50 Segment Reference
TroubleshootingNo troubleshooting information is currently available for this segment.
Processing Code (801) Insert (I) Update (U) Delete (D)
Main Merchandise Hierarchy Group (203)
Insert (I) Update (U) Delete (D)
Retrieves a class or department from EDM & PROD and places it in WM. For WM 4, it only sends classes from Merchandising to WM; for WM 5, it sends both classes and departments from Merchandising to WM.
Size Master (331) Update (U)
Style (301) Insert (I) Update (U) Delete (D)
Style Links To Main Merchandise (221)
Insert (I) Update (U)
Style Vendor (421) Insert (I) Update (U) Delete (D)
Style Size (321) Update (U)
Assigned Style Attribute Set (512)
Insert (I) Update (U) Delete (D)
Style Retail (316) Insert (I) Update (U)
Style Color Retail (317) Insert (I) Update (U) Delete (D)
Style Pricing Group (314) Insert (I) Update (U) Delete (D)
Style Pricing Group Color (315)
Insert (I) Update (U) Delete (D)
Style Color Location (312) Insert (I) Update (U) Delete (D)
Style Pricing Group (314) Insert (I) Update (U) Delete (D)
Style Location (313) Insert (I) Update (U) Delete (D)
SKU (351) Insert (I) Update (U) Delete (D)
UPC (361) Insert (I) Update (U) Delete (D)
Pack (661) Insert (I) Delete (D)
Pack Detail (662) Update (U)
Advance Price Notice (914) Insert (I)
Entity Action Description
Segment 1001 - EDM & PROD To MA – Style Retail Startup 51
Segment 1001 - EDM & PROD To MA – Style Retail StartupThis segment is run only when clients upgrade from Merch 3.0. It runs once to retrieve style retails from EDM & PROD and place them in MA.
Segment Parameters
Scheduling RequirementsNone.
Database ParametersNone.
Non-Queue Segment Description The segment doesn’t require any Pipeline dlls to be installed: The segment requires the following Merchandising dlls to be installed:
STSFCClient.dll STSFCServer.dll
This segment retrieves style retails from EDM & PROD and places them in MA. However, it will not process the style retails that are already referenced in the Core replication queue but haven’t been processed by segment 1005. This is because these style retails will be sent to MA by segment 1005 later.
TroubleshootingNo troubleshooting information is available for this segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Batchsize Batch Size Specifies the number of style retails retrieved from PROD and inserted into MA in each batch.
No 1000
Truncatestyleretailtable
Truncate the style_retail table?
Indicates if the style retail table in MA should be truncated before this segment runs. If set to 1, the style retail table is truncated; if set to 0, it is not.
No 0
52 Segment Reference
Segment 1003 - EDM & PROD to Sales AuditThe segment replicates enterprise and product data from EDM and PROD to Sales Audit.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
DBPlatform Database Platform Indicates the database platform of the Sales Audit database. A value of 1 indicates that the Sales Audit database platform is Microsoft SQL Server, a value of 2 indicates that the platform is Oracle. Must match the configuration of the Pipeline segment in the Pipeline Repository database.
Yes 1
Mod32 Custom Modification 32 Installed
Indicates whether custom modification 32 is active. A value of 1 indicates that the custom modification is active, a value of 0 indicates that it is not. If the custom modification is active, the calendar in EDM is not replicated to Sales Audit. This custom modification would be installed if a different calendar is maintained in Sales Audit than in EDM.
No 0
DivLevel Division Level The ID of the level in the main location hierarchy in EDM that is defined as division for Sales Audit. Optional. Can be set to 0 if there is no such level in the main location hierarchy in EDM. Used by the segment to determine what main location hierarchy groups to send to Sales Audit and to link to locations sent to Sales Audit.
No 0
DisLevel District Level The ID of the level in the main location hierarchy in EDM that is defined as district for Sales Audit. Optional. Can be set to 0 if there is no such level in the main location hierarchy in EDM. Used by the segment to determine what main location hierarchy groups to send to Sales Audit and to link to locations sent to Sales Audit.
No 2
RegLevel Region Level The ID of the level in the main location hierarchy in EDM that is defined as region for Sales Audit. Optional. Can be set to 0 if there is no such level in the main location hierarchy in EDM. Used by the segment to determine what main location hierarchy groups to send to Sales Audit and to link to locations sent to Sales Audit.
No 5
Segment 1003 - EDM & PROD to Sales Audit 53
SalesAuditVersion3 Sales Audit Version 3.0
Indicates whether the Sales Audit system with which the Pipeline segment integrates is version 3.0 or higher. A value of 1 indicates that the Sales Audit version is release 3.0 or higher, a value of 0 indicates that the Sales Audit version is prior to release 3.0. Because Sales Audit releases prior to 3.0 do not track open and comparative dates for stores, the segment will only send Sales Audit this data if the parameter indicates that Sales Audit is release 3.0 or higher.
No 1
StoreManagerValue Store Manager Name
EDM users have the option to link a custom property to a location and provide a value that can be used to identify the manager of the store (e.g., the manager’s name or employee code). The code of the EDM custom property set up for this purpose must be specified as the value for this parameter. The segment will use the custom property code to obtain the value linked to the location for the custom property and populate the Manager field of the Sales Audit Store table accordingly.
No SM
DeptLevel Department Level The ID of the level in the main merchandising hierarchy in PROD that is defined as department for Sales Audit. Must be set to a valid main merchandising hierarchy level ID in PROD. Used by the segment to determine what main merchandising hierarchy groups to send to Sales Audit and to link to Sales Audit classes.
No
ClassLevel Class Level The ID of the level in the main merchandising hierarchy in PROD that is defined as class for Sales Audit. Must be set to a valid main merchandising hierarchy level ID in PROD. Used by the segment to determine what hierarchy groups to send to Sales Audit and to link to styles sent to Sales Audit.
No 4
SubClassLevel Sub Class Level The ID of the level in the main merchandising hierarchy in PROD that is defined as class for Sales Audit. Optional. Set to 0 if subclasses will not be sent to SA. Used by the segment to determine what hierarchy groups to send to Sales Audit and to link to styles sent to Sales Audit.
No 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
54 Segment Reference
Mod 22 Custom Modification 22 Installed
Indicates whether custom modification 22 is active. A value of 1 indicates that the custom modification is active, a value of 0 indicates that it is not. In package functionality, Sales Audit department and class codes are set to the part of the main merchandising hierarchy group code representing department and class. If custom modification 22 is active, however, Sales Audit department and class codes consist of the entire main merchandising hierarchy group code for the level in the main merchandising hierarchy that is defined as Sales Audit department or class, without the hyphens. For example, if the PROD hierarchy group code for the level in the main merchandising hierarchy that is defined as class for Sales Audit is 1-2-3-4-5, where 2 is the part of the code representing Sales Audit department and 5 is the part of the code representing Sales Audit class, and custom modification 22 is active, the Sales Audit class code would be 12345. If the custom modification is not active, the Sales class code would be 5.
No 0
UpcLookupDivision UPC Lookup Division Sales Audit supports a feature that enables several Merchandising systems to feed a single Sales Audit system. The value specified in this parameter is sent to Sales Audit (along with any departments, classes and UPCs) to differentiate the departments, classes and UPCs belonging to one Merchandising system from those that belong to another Merchandising system. At present, this feature is not fully supported when integrating with Epicor Retail Merchandising, since only a single instance of Merchandising is used to populate the destination Sales Audit system; in this case, the value specified by this parameter must match the value of Sales Audit parameter "UPC lookup division for MeW sales export", which is normally 2. If several instances of CR Merchandising were used to populate the destination Sale Audit system, each would be assigned a unique UPC Lookup Division in the Sales Audit parameters and this Pipeline parameter would need to be set based on the segment’s source Merchandising system.
No 2
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Segment 1003 - EDM & PROD to Sales Audit 55
Scheduling Requirements The segment should be scheduled to run periodically throughout the workday, as
auditors trying to correct rejected transactions may need to correct Merchandising data, and will need these corrections to be replicated to Sales Audit in a timely manner.
Mod27 Custom Modification 27 Installed
Indicates whether custom modification 27 is active. A value of 1 indicates that the custom modification is active, a value of 0 indicates that it is not. In package functionality, the UPC POS identifer in Sales Audit is set to Merchandising SKU ID, used by Sales Audit to facilitate the processing of Offline IM transactions. If custom modification 27 is active, however, the UPC POS identifer in Sales Audit is set to a subset of the UPC. The custom modification would be active at installations where some of the POS transactions are fed to Sales Audit referencing a subset of the UPC rather than the full UPC.
No
Mod28 Custom Modification 28 Installed
Indicates whether custom modification 28 is active. A value of 1 indicates that the custom modification is active, a value of 0 indicates that it is not. In package functionality, the UPC POS identifer in Sales Audit is set to Merchandising SKU ID, used by Sales Audit to facilitate the processing of Offline IM transactions. If custom modification 28 is active, however, the UPC POS identifer in Sales Audit is set to style code. The custom modification would be active at installations where some of the POS transactions are fed to Sales Audit referencing style code rather than UPC.
No 0
POSIdentifierType POS Identifier Type Only used if custom modification 27 or 28 is active. If either one is, the parameter value is used to set the UPC POS identifer type in Sales Audit and a value other than 0 must be specified.
No 1
bMod180 Mod 180 LASPSE05035 - Fixed Hierarchy groups for LSC
No 0
ConvertCodeToNumeric
Convert Code to Numeric
Convert alpha hierarchy group code to numeric
No 0
bMod222 bMod222 Send Average Cost to SA No 0
DoNotSendEmployees
Send Employees If selected, employees are sent from Merch to CRDM.
Yes 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
56 Segment Reference
This segment also ensures that when a style has been successfully reclassified in PROD, the corresponding changes are made in Sales Audit (SA). Segment 1030 - EDM & PROD to MA & SL is the segment that reclassifies a style in PROD when it any processes pending reclassifications. Segment 1003 - EDM & PROD to Sales Audit should therefore be scheduled to run after Segment 1030 - EDM & PROD to MA & SL if the corresponding changes due to style reclassification are to take affect in SA. See the scheduling requirements for Segment 1030 - EDM & PROD to MA & SL for more details.
Database Parameters parameter_price_lookup.tax_by_size_flag: if this flag is turned on, the tax groups that
are linked to style sizes and styles are retrieved in EDM & PROD and placed in SA; if this flag is turned off, the tax groups that are linked to style sizes are not sent to SA.
parameter_price_lookup.override_for_style_flag: if this flag is turned on, the tax groups that are linked to styles are retrieved in EDM & PROD and placed in SA; if this flag is turned off, the tax groups that are linked to styles are not sent to SA. If the tax_by_size_flag is on, this parameter is ignored.
Queue Segment Description The following Pipeline dll needs to be installed:
STSPLEDMPRODtoSA.dll
Sales Audit subscribes to the following entities and actions via this segment.
Entity Action Description
Calendar Period (42) Insert (I) If custom modification 32 is installed, this entity action is not processed.
All dates for the calendar period are retrieved from EDM and placed in the Sales Audit user calendar table. The calendar period code and year code for the calendar period ID are placed in the cross-reference table in the Pipeline Repository with entity name “calendar period” so they can be referenced on the calendar period delete.
Delete (D) If custom modification 32 is installed, this entity action is not processed.
The calendar period code and year code for the calendar period ID are retrieved from the cross-reference table in the Pipeline Repository and all dates in the Sales Audit user calendar table are deleted for the calendar period / year.
Calendar Week (43) Insert (I) Not used when interfacing to SA5.0 Published when a calendar is initially created in EDM, and when
the number of weeks in a given period is changed. (When the number of weeks in a period is changed, the weeks in the period are deleted and the new number of weeks are inserted.)
The dates for the calendar week are retrieved from EDM and placed in the Sales Audit user table. If the dates are already in the Sales Audit user table (because they were interfaced to Sales Audit with the Calendar Period Insert), no update takes place.
Segment 1003 - EDM & PROD to Sales Audit 57
Delete (D) Published when a calendar is deleted in EDM, and when the number of weeks in a given period is changed. (When the number of weeks in a period is changed, the weeks in the period are deleted and the new number of weeks are inserted.)
The dates for the calendar week are deleted from the Sales Audit user calendar table.
Main Location Hierarchy Group (153)
Insert (I) / Update (U)
Not used when interfacing with SA5. The data for the location hierarchy group is retrieved from EDM.
If the hierarchy level ID of the location hierarchy group retrieved matches the level specified in segment parameters “Division Level”, “District Level”, or “Region Level”, the data for the group is used to populate the Sales Audit user division, user district, or user region tables respectively. Regardless of whether the level of the group retrieved matches that specified in the segment parameters, the hierarchy group code and hierarchy level ID for the group are placed in the cross-reference table in the Pipeline Repository with entity name “main location hierarchy” so they can be referenced on the entity delete.
Delete (D) The hierarchy group code and hierarchy level ID for the location hierarchy group are retrieved from the cross-reference table in the Pipeline Repository and if the hierarchy level ID matches the level specified in segment parameters “Division Level”, “District Level”, or “Region Level”, the group is deleted from the Sales Audit user Division, user District, or user Region tables respectively.
Location (101) Insert (I) / Update (U)
The data for the location is retrieved from EDM and placed in the Sales Audit user Store table. The location hierarchy group to which the location is linked and the location hierarchy group’s parents (to which the location is linked by extension) are retrieved from EDM. Any location hierarchy groups that the location is linked to that correspond to the levels specified in segment parameters “Division Level”, “District Level”, or “Region Level” are used to populate the division code, district code, and region code respectively for the store in Sales Audit’s user Store table (see Mapping Document for this segment).
Insert Main Location Hierarchy Group (162)
Insert (I) Not used when interfacing with SA5. Published by EDM when the location is created (it is mandatory
to link a location to a location hierarchy group when the location is created).
The location hierarchy group to which the location is linked and the location hierarchy group’s parents (to which the location is linked by extension) are retrieved from EDM. Any location hierarchy groups that the location is linked to that correspond to the levels specified in segment parameters “Division Level”, “District Level”, or “Region Level” are used to populate the division code, district code, and region code respectively for the store in Sales Audit’s user store table.
Entity Action Description
58 Segment Reference
Update (U) Not used when interfacing with SA5. Published by EDM when the location hierarchy that a location is
linked to is modified. The location hierarchy group to which the location is linked and
the location hierarchy group’s parents (to which the location is linked by extension) are retrieved from EDM. Any location hierarchy groups that the location is linked to that correspond to the levels specified in segment parameters “Division Level”, “District Level”, or “Region Level” are used to populate the division code, district code, and region code respectively for the store in Sales Audit’s user store table.
Location Contact (23) Insert (I) / Update (U)
Not used when interfacing with SA5. The data for the location contact is retrieved from EDM. If the
contact type is “Phone” and the location is not a head office location, the phone number in Sales Audit’s user Store table is updated and the phone number and location code for the contact are placed in the cross-reference table of the Pipeline Repository with entity name “contact” so they can be referenced when the entity is deleted.
Delete (D) If the phone number and location code for the contact can be retrieved from the cross-reference table of the Pipeline Repository (i.e., if the contact data was previously sent to Sales Audit), the phone number for the store is removed from the Sales Audit user Store table (i.e., the field is set to NULL).
Location Cust Property (621) Insert (I) / Update (U)
Not used when interfacing with SA5. The data for the location custom property is retrieved from
EDM. If the custom property code matches the code specified in segment parameter “Store Manager Custom Property Code” and the location is not a head office location, the Manager field in Sales Audit’s user Store table is updated with the custom property’s value and the location code for the custom property is placed in the cross-reference table of the Pipeline Repository with entity name “location cust prop” so that it can be referenced when the custom property is deleted.
Delete (D) If the location code for the custom property can be retrieved from the cross-reference table of the Pipeline Repository (i.e., if the value for the custom property was previously sent to Sales Audit), the Manager field for the store is removed from the Sales Audit user Store table (i.e., the field is set to NULL).
Employee (601) Insert (I) / Update (U)
The data for the location is retrieved from EDM and placed in the Sales Audit Employee table. The employee code for the employee is also placed in the cross-reference table in the Pipeline Repository with entity name “employee” so that it can be referenced when the employee is deleted.
Delete (D) The employee code for the employee is retrieved from the cross-reference table in the Pipeline Repository, and the employee is deleted from the Sales Audit Employee table (i.e., the field is set to NULL).
Main Merchandise Hierarchy Group (203)
Insert (I) / Update (U) / Delete (D)
Entity Action Description
Segment 1003 - EDM & PROD to Sales Audit 59
TroubleshootingNo troubleshooting information is currently available.
Style (301) Insert (I)/ Update (U)/ Delete (D)
Style Links To Main Merchandise (221)
Insert (I)
Update (U) When a style is being reclassified in SA, the Tax Item Group ID of the style is set to null.
Style Detail (322) Update (U)
UPC (361) Insert (I) / Update (U)/ Delete (D)
Style Color (311) Update (U)
Size Master (331) Update (U)
Merch Assignment PLU (910) Insert (I) / Update (U)
This script retrieves a PLU Profile that has been linked to a Merch Group in Merchandising. If the Merch Group is not at the Merch Level that is linked to the tax group code in the PLU settings for collections, this script does nothing and terminates.
It retrieves the tax group code of the PLU Profile and all the classes (i.e. Merch Groups at POS Merch Group Key level) that are children of the Merch Group.
In SA, it applies the tax group code to all classes that are children of the Merch Group.
Style Assignment PLU (911) Insert (I)/ Update (U)/ Delete (D)
If the database parameters Tax By Size Flag and Override For Style Flag are set to false, the script does nothing and terminates.
This script retrieves a PLU Profile that has been linked to a Style or Style Size in Merchandising. It retrieves the tax group codes of the PLU Profiles that are linked to the style or to the sizes on that style.
If a tax group code is for the style, it will be applied on that style in SA; if a tax group code is for a style size, it will be applied on the UPCs that belong to the style size in SA.
Entity Action Description
60 Segment Reference
Segment 1004 - EDM & PROD to Customer Info MgmtThis segment loads EDM & PROD entities into Customer Information Management.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin
Default Value
ApplyCodeFiller Apply Code Filler Indicates if filler (specified by parameter UseCodeFiller) should be added to class code to adjust the class code length for legacy.
No 0
ClassFeature Class Feature The Merchandising attribute code assigned to class level main merchandise hierarchy groups. Attribute sets of this attribute are sent to Customer Information Management to link to classes as class features.
No
ClassGroupingAthroughClassGroupingD
Class Grouping A through Class Grouping D
Possible values: ATxxx, where xxx is the exclusive class
attribute code in EDM whose attribute set codes will be used for this class grouping.
HLxxx, where xxx is the ID of the level in the main merchandising hierarchy in PROD whose group codes will be used for this class grouping.
0 if the class grouping will not be used.
No 0
ClassLevel Class Level The ID of the level in the main merchandising hierarchy in PROD that is defined as class for Customer Info. Management. Must be set to a valid main merchandising hierarchy level ID in PROD.
No 0
CostFlag Cost Flag This parameter can only be set to 1 or 0. If the value is 1, when the last net PO cost of a style is modified in Merchandising the associated style cost in Customer Info. Management will be updated. If the value is 0, the style cost in
Customer Info. Management should never be modified.
No 1
CostType Cost Type Indicates the cost type to send. If set to 0, last net PO cost is sent; if set to1, last net final PO cost is sent.
No
DBPlatform Database Platform Indicates the database platform of the Merchandising and Customer Info Management database. 1 indicates that the database platform is
Microsoft SQL Server. 2 indicates that the platform is Oracle.
Must match the configuration of the Pipeline segment in the Pipeline Repository database.
No
Segment 1004 - EDM & PROD to Customer Info Mgmt 61
DeptLevel Department Level The ID of the level in the main merchandising hierarchy in PROD that is defined as department for Customer Info. Management. Must be set to a valid main merchandising hierarchy level ID in PROD.
No 0
DisLevel District Level The ID of the level in the main location hierarchy in EDM that is defined as district for Customer Info. Management. Optional. Can be set to 0 if there is no such level in the main location hierarchy in EDM.
No 0
DivLevel Division Level The ID of the level in the main location hierarchy in EDM that is defined as division for Customer Info. Management. Optional. Can be set to 0 if there is no such level in the main location hierarchy in EDM.
No 0
EmployeeFeature Employee Feature The Merchandising attribute code assigned to employees. The attribute sets of this attribute will be sent to Customer Info. Management to link to sales associates (employees) as sales associate features.
No
EmployeeGroupingAthroughEmployeeGroupingB
Employee Grouping A through Employee Grouping B
Possible values: Atxxx, where xxx is the exclusive employee
attribute code in EDM whose attribute set codes will be used for this sales associate (employee) grouping.
0 if the employee grouping will not be used.
No 0
EmployeeRoles Employee Roles Employee roles to be sent to Customer Info. Management. Different employee role values are separated by @. Only employees whose positions link to these roles are sent to Customer Info. Management.
No Sales Associate@Store Manager
Mod3 Custom Modification 3 activated
Custom Mod “6 digit vendor to MarketWorks”. If the parameter value is 0, the custom modification is not installed. If the parameter value is 1, the custom modification is installed.
No 0
Mod22 Custom Modification 22 installed
Custom Mod “Core out multiple level hierarchies concatenation”. If the parameter value is 0, the custom modification is not installed. If the parameter value is 1, the modification is installed.
No 0
Mod51 Custom Modification 51 installed
Custom Mod “Multi level hierarchy for styles”. If the parameter value is 0, the custom modification is not installed. If the parameter value is 1, the modification is installed.
No 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin
Default Value
62 Segment Reference
Mod58 Custom Modification 58 installed
Custom mod "Style color concatenation in style". If the parameter value is 0, the modification is not installed. If the parameter value is 1, style color is sent rather than style.
No 0
Mod70 Custom Modification 70 installed
Custom mod "Link attributes for style color to style groups". If the parameter value is 0, the modification is not installed. If the parameter value is 1, the modification is installed.
No 0
Mod142 Custom Modification 142 installed
Custom mod "Build customized style description". If the parameter value is 0, the modification is not installed; style description is built based on package definition. If the parameter value is 1, the modification is installed and the style description is built based on client's requirements not package.
No 0
Mod206 Mod206 Color code not to be sent from Merch to CIM. No 0
MultiChanneRedemption
Support Multi Channel Redemption
Determines whether Pipeline needs to pass a value for the reward redemption flag that CIM is expecting. This parameter is required for CIM version 5.1 and up and for these versions it must be set to Yes.
No
RegLevel Region Level The ID of the level in the main location hierarchy in EDM that is defined as region for Customer Info. Management. Optional. Can be set to 0 if there is no such level in the main location hierarchy in EDM.
No 0
RetailFlag Retail Flag This parameter can only be set to 1 or 0. 1 indicates that if the home jurisdiction
current retail of a style is created or modified in Merchandising the associated style retail in Customer Info. Management will also be updated.
0 indicates that the style retail in Customer Info. Management should always be 0 even when the corresponding style current retail of home jurisdiction is changed in Merchandising.
No
SendNonSellingStoreEmployee
Send Non Selling Store Employee
This parameter can only be set to 1 or 0. 1 indicates that all employees should be
sent to Customer Info. Management. 0 indicates that only employees whose
home location is a store should be sent to Customer Info. Management.
No 0
StoreFeature Store Feature The Merchandising attribute code assigned to locations. Attribute sets of this attribute will be sent to Customer Info. Management to link to stores as store features.
No
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin
Default Value
Segment 1004 - EDM & PROD to Customer Info Mgmt 63
StoreGroupingA through StoreGroupingC
Store Grouping A through Store Grouping C
Possible values: Atxxx, where xxx is the exclusive class
attribute code in EDM whose attribute set codes will be used for this store grouping.
HLxxx, where xxx is the ID of the level in the main location hierarchy in EDM whose group codes will be used for this store grouping. 0 if the store grouping will not be used.
No 0
StyleFeature Style Feature The Merchandising attribute code assigned to styles. The attribute sets of this attribute will be sent to Customer Info. Management to link to styles as style features.
No
StyleGroupingAthroughStyleGroupingF
Style Grouping A through Style Grouping F
Possible values: Atxxx, where xxx is the exclusive class
attribute code in EDM whose attribute set codes will be used for this style grouping.
HLxxx, where xxx is the ID of the level in the main merchandising hierarchy in PROD whose group codes will be used for this style grouping.
0, if the class grouping will not be used.
No 0
SubClassLevel Sub Class Level The ID of the level in the main merchandising hierarchy in PROD that is defined as sub class for Customer Info. Management. Must be a valid PROD main merchandising hierarchy level ID.
No 0
UseCodeFiller UseCodeFiller If the segment parameter ‘ApplyCodeFiller’ is set to 1, the value of this parameter should be added to the left of the class code to adjust the class code length for legacy.
No
VendorFeature Vendor Feature The Merchandising attribute code assigned to vendors. The attribute sets of this attribute will be sent to Customer Info. Management to link to vendors as vendor features.
No
VendorGroupingA through VendorGroupingB
Vendor Grouping A through Vendor Grouping B
Possible values: Atxxx, where xxx is the exclusive employee
attribute code in EDM whose attribute set codes will be used for this vendor grouping.
0, if the vendor grouping will not be used.
No 0
DefaultVendorCode Default Vendor Code
The dummy vendor code for a pseudo-style, required by Customer Info. Management but not by pseudo-styles, and set in Customer Info. Management.
No Must be set in Pipeline to the value of the dummy vendor code set in Customer Info. Mgmt.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin
Default Value
64 Segment Reference
Scheduling RequirementsThis segment ensures that when a style has been successfully reclassified in PROD, the corresponding changes are made in Customer Information Management (CIM). Segment 1030 - EDM & PROD to MA & SL is the segment that reclassifies a style in PROD when it processes any pending reclassifications. Segment 1004 - EDM & PROD to Customer Information Management should therefore be scheduled to run after Segment 1030 - EDM & PROD to MA & SL if the corresponding changes due to style reclassification are to take effect in CIM. See the scheduling requirements for Segment 1030 - EDM & PROD to MA & SL for more details.
Database ParametersNone.
Queue Segment Description The segment does not require any Pipeline dlls to be installed.
Customer Info. Management subscribes to the following entities and actions via this segment:
SubDeptLevel Sub Department Level
The hierarchy level ID of Sub Department (defaults to 0 if not used)
No 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin
Default Value
Entity Action Description
Location address (3) Insert (I) / Update (U)
If the location is of type store, the location address information is retrieved from EDM and stored in the Customer Info. Management Store table.
Color (62) Insert (I) / Update (U)
The data for the color is retrieved from EDM and placed in the Customer Info. Management color table. The color code for the color is also placed in the cross-reference table in the Pipeline Repository with entity name “color” so that it can be referenced when the color is deleted.
Delete (D) The color code for the color is retrieved from the cross-reference table in the Pipeline Repository and the color is deleted from the Customer Info. Management Color table.
Location (101) Insert (I) / Update (U)
If a location is of type store, the data for the location is retrieved from EDM and placed in the Customer Info. Management Store table.
Main location hierarchy group (153)
Insert (I) / Update (U)
The data for the main location hierarchy group is retrieved from EDM and placed in the Customer Info. Management region, district, division, store_grouping_a, store_grouping_b or store_grouping_c table depending on the group level. The hierarchy group code and the hierarchy level ID for the group are also placed in the cross-reference table in the Pipeline Repository with the entity name “main location hierarchy” so that it can be referenced when the group is deleted.
Segment 1004 - EDM & PROD to Customer Info Mgmt 65
Delete (D) The hierarchy group code and hierarchy level ID for the main location hierarchy group are retrieved from the cross-reference table in the Pipeline Repository and the group is deleted from the Customer Info. Management division, region, district, store_grouping_a, store_grouping_b or store_grouping_c table depending on the hierarchy level ID.
Insert main location hierarchy group (162 – i.e. location group)
Insert (I) If the location type of the location group is store, the data for the location group is retrieved from EDM and placed in the Customer Info. Management Store table.
Main merchandise hierarchy group (203)
Insert (I) / Update (U)
The data for the main merchandise hierarchy group is retrieved from PROD and placed in the Customer Info. Management department, class, class_grouping_a through class_grouping_d or style_grouping_a through style_grouping_f table depending on the group level. The hierarchy group code and the hierarchy level ID for the group are also placed in the cross-reference table in the Pipeline Repository with the entity name “mm hierarchy node” so that it can be referenced when the group is deleted.
Delete (D) The hierarchy group code and hierarchy level ID for the main merchandise hierarchy group are retrieved from the cross-reference table in the Pipeline Repository and the group is deleted from the Customer Info. Management dept, class, class_grouping_a through class_grouping_d or style_grouping_a through style_grouping_f table depending on the hierarchy level ID.
Style links to main merchandise (221 – i.e. style group)
Insert (I) / Update (U)
The data for the style group is retrieved from PROD and placed in the Customer Info. Management Style table.
Style (301) Insert (I) The data for the style is retrieved from PROD and placed in the Customer Info. Management Style table. The style is also placed in the cross-reference table in the Pipeline Repository with entity name “style” so that it can be referenced when the entity is deleted.
If the segment parameter ‘RetailFlag’ is set to 0, the style retail in Customer Info. Management will be set to 0.
The class code in the Customer Info. Management Style table is set as follows:
If segment parameter ‘Mod51’ is set to 1 and segment parameter ‘ApplyFiller’ is set to 1, the class code = filler (specified by segment parameter ‘UseCodeFiller’), concatenated with the multi-level class code (that is, the class level hierarchy group code without dashes) For example, if the class code is 101-002-93-04, the multi-level code would be 1010029304).
Entity Action Description
66 Segment Reference
Style (301) (cont’d) Insert (I) (cont’d) If ‘Mod51’ is set to 1 and ‘ApplyFiller’ is set to 0, the class code = the multi-level class code. If ‘Mod51’ is set to 0 and ‘ApplyFiller’ is set to 1, the class code = the lowest level group code of the department (for example, if the department code is 101-002-93, its lowest level group code is 93) concatenated with the filler, concatenated with the lowest level group code of the class (for example, if the department code is 101-002-93-04, its lowest level group code is 04).
If ‘Mod51’ is set to 0 and ‘ApplyFiller’ is set to 0, the class code = the lowest level group code of the department concatenated with the lowest level group code of the class.
Style grouping code A through style grouping code F in the Customer Info Management style table are set as follows: If segment parameter ‘StyleGroupingA’ through
‘StyleGroupingF’ contain ATxxx, xxx is the attribute exclusive style attribute code in EDM whose attribute set codes will be used for this style grouping.
If segment parameter ‘StyleGroupingA’ through ‘StyleGroupingF’ contain HLxxx, xxx is the main merchandising hierarchy level ID for this style grouping. If the level ID matches the class level (specified by
segment parameter ‘ClassLevel’), style grouping code = class code.
The style grouping code is set to the multiple-level code for the style grouping level if the multiple-level code is not longer than 8 characters.
If the multiple-level code for the style grouping level is longer than 8 characters and if ‘Mod51’ is set to 1, the style grouping code will be set to the right-most 8 characters of the multiple-level code.
If the multiple-level code for the style grouping level is longer than 8 characters and if ‘Mod51’ is set to 0, the style grouping code is set to the lowest level group code of the style grouping level (if the lowest level group code is less than 8 characters) or set to the right-most 8 characters of the lowest level group code (if the lowest level group is more than 8 characters).
Update (U) The style code and short description for the style are retrieved from PROD and placed in the Customer Info. Management Style table.
Delete (D) The style code for the style is retrieved from the cross-reference table in the Pipeline Repository and the style is deleted from the Customer Info. Management Style table.
Style retail (316) Update (U) If 'RetailFlag' is set to 1 and if the style retail is of home jurisdiction, the data for the style retail is retrieved from PROD and placed in the Customer Info. Management Style table.
Entity Action Description
Segment 1004 - EDM & PROD to Customer Info Mgmt 67
Style detail (322) Insert (I) / Update (U)
If 'CostFlag' is set to 1, the last set PO cost for the style detail is retrieved from PROD and placed in the Customer Info. Management Style table.
UPC (361) Insert (I) / Update (U)
The data for the UPC is retrieved from PROD and placed in the Customer Info. Management product_xref table. The UPC is also placed in the cross-reference table in the Pipeline Repository with entity name “upc” so that it can be referenced when the UPC is deleted.
Delete (D) The UPC is retrieved from the cross-reference table in the Pipeline Repository, and the UPC is deleted from the Customer Info. Management product_xref table.
Vendor (401) Insert (I) / Update (U)
The data for the vendor is retrieved from EDM and placed in the Customer Info. Management Vendor table. The vendor code is also placed in the cross-reference table in the Pipeline Repository with entity name “Vendor” so that it can be referenced when the vendor is deleted.
Delete (D) The vendor code for the vendor is retrieved from the cross-reference table in the Pipeline Repository, and the vendor is deleted from the Customer Info. Management Vendor table.
Style vendor (421) Insert (I) / Update (U)
The data for the style vendor is retrieved from PROD and placed in the Customer Info. Management Style table.
Attribute set for location (481)
Insert (I) / Update (U)
The data for the attribute set is retrieved from EDM. If segment parameters StoreGroupingA through
StoreGroupingC contain ATxxx, where xxx is a value that matches the attribute code of the attribute set, the attribute set data is placed into Customer Info. Management store_grouping_a through store_grouping_c tables.
If the segment parameter StoreFeature contains a value that matches the attribute code of the attribute set, the attribute set data is placed in the Customer Info. Management store_feature_def table. The attribute code and attribute set code of the attribute set are also placed in the cross-reference table in the Pipeline Repository with the entity name “Store Attributes”.
Delete (D) The attribute code and attribute set code for the attribute set are retrieved from the cross-reference table in the Pipeline Repository.
If segment parameter StoreFeature contains a value that matches the attribute code, the attribute set data is deleted from the Customer Info. Management store_feature_def table.
If segment parameters StoreGroupingA through StoreGroupingC contain ATxxx, where xxx is a value that matches the attribute code, the attribute set data is deleted from the Customer Info. Management store_grouping_a through store_grouping_c tables.
Entity Action Description
68 Segment Reference
Attribute set for style (482) Insert (I) / Update (U)
The data for the attribute set is retrieved from EDM. If segment parameters StyleGroupingA through StyleGroupingF
contain ATxxx, where xxx is a value that matches the attribute code of the attribute set, the attribute set data is placed into Customer Info. Management style_grouping_a through style_grouping_f tables.
If the segment parameter StyleFeature contains a value that matches the attribute code of the attribute set, the attribute set data is placed in the Customer Info. Management style_feature_def table.
The attribute code and attribute set code of the attribute set are also placed in the cross-reference table in the Pipeline Repository with the entity name “Style Attributes”.
Delete (D) The attribute code and attribute set code for the attribute set are retrieved from the cross-reference table in the Pipeline Repository.
If segment parameters StyleGroupingA through StyleGroupingF contain ATxxx, where xxx is a value that matches the attribute code, the attribute set data is deleted from the Customer Info. Management style_grouping_a through style_grouping_f tables.
If segment parameter StyleFeature contains a value that matches the attribute code, the attribute set data is deleted from the Customer Info. Management style_feature_def table.
Attribute set for employee (483)
Insert (I) / Update (U)
The data for the attribute set is retrieved from EDM. If segment parameters EmployeeGroupingA through EmployeeGroupingB contain ATxxx, where xxx is a value that matches the attribute code of the attribute set, the attribute set data is placed into Customer Info. Management sales_ass_grouping_a through sales_ass_grouping_b tables.
If segment parameter EmployeeFeature contains a value that matches the attribute code of the attribute set, the attribute set data is placed in the Customer Info. Management sales_associate_feature_def table.
The attribute code and attribute set code of the attribute set are also placed in the cross-reference table in the Pipeline Repository with the entity name “Employee Attributes”.
Delete (D) The attribute code and attribute set code for the attribute set are retrieved from the cross-reference table in the Pipeline Repository.
If segment parameters EmployeeGroupingA through EmployeeGroupingB contain ATxxx, where xxx is a value that matches the attribute code, the attribute set data is deleted from the Customer Info. Management sales_ass_grouping_a through sales_ass_grouping_b table.
If segment parameter EmployeeFeature contains a value that matches the attribute code, the attribute set data is deleted from the Customer Info. Management sales_associate_feature_def table.
Entity Action Description
Segment 1004 - EDM & PROD to Customer Info Mgmt 69
Attribute set for merchandising group (484)
Insert (I) / Update (U)
The data for the attribute set is retrieved from PROD. If segment parameters ClassGroupingA through
ClassGroupingD contain ATxxx, where xxx is a value that matches the attribute code of the attribute set, the attribute set data is placed into Customer Info. Management class_grouping_a through class_grouping_d table.
If segment parameter ClassFeature contains a value that matches the attribute code of the attribute set, the attribute set data is placed in the Customer Info. Management class_feature_def table.
The attribute code and attribute set code of the attribute set are also placed in the cross-reference table in the Pipeline Repository with the entity name “Node Attributes”.
Delete (D) The attribute code and attribute set code for the attribute set are retrieved from the cross-reference table in the Pipeline Repository.
If segment parameters ClassGroupingA through ClassGroupingD contain ATxxx, where xxx is a value that matches the attribute code, the attribute set data is deleted from the Customer Info. Management class_grouping_a through class_grouping_d tables.
If segment parameter ClassFeature contains a value that matches the attribute code, the attribute set data is deleted from the Customer Info. Management class_feature_def table.
Attribute set for vendor (486) Insert (I) / Update (U)
The data for the attribute set is retrieved from EDM. If segment parameters VendorGroupingA through
VendorGroupingB contain ATxxx, where xxx is a value that matches the attribute code of the attribute set, the attribute set data is placed into Customer Info. Management vendor_grouping_a through vendor_grouping_b tables.
If segment parameter VendorFeature contains a value that matches the attribute code of the attribute set, the attribute set data is placed in the Customer Info. Management vendor_feature_def table.
The attribute code and attribute set code of the attribute set are also placed in the cross-reference table in the Pipeline Repository with the entity name “Vendor Attributes”.
Delete (D) The attribute code and attribute set code for the attribute set are retrieved from the cross-reference table in the Pipeline Repository.
If segment parameters VendorGroupingA through VendorGroupingB contain ATxxx, where xxx is a value that matches the attribute code, the attribute set data is deleted from the Customer Info. Management vendor_grouping_a through vendor_grouping_b tables.
If segment parameter VendorFeature contains a value that matches the attribute code, then the attribute set data is deleted from the Customer Info. Management vendor_feature_def table.
Entity Action Description
70 Segment Reference
Assigned location attribute set (511)
Insert (I) / Update (U)
The data for the location attribute set is retrieved from EDM. If segment parameters StoreGroupingA through
StoreGroupingC contain ATxxx, where xxx is a value that matches the attribute code of the attribute set, the location attribute set data is placed into Customer Info. Management Store table.
If segment parameter StoreFeature contains a value that matches the attribute code of the attribute set, then the location attribute set data is placed in the Customer Info. Management store_feature table.
The attribute set code, attribute code and location code of the location attribute set are also placed in the cross-reference table in the Pipeline Repository with the entity name “location attribute set”.
Delete (D) The attribute code, attribute set code and location code for the location attribute set are retrieved from the cross-reference table in the Pipeline Repository.
The attribute code, attribute set code and location code for the location attribute set are retrieved from the cross-reference table in the Pipeline Repository.
If segment parameters StoreGroupingA through StoreGroupingC contain ATxxx, where xxx is a value that matches the attribute code, the location attribute set data is deleted from the Customer Info Management Store table.
If segment parameter StoreFeature contains a value that matches the attribute code, the location attribute set data is deleted from the Customer Info. Management store_feature table.
Assigned style attribute set (512)
Insert (I) / Update (U)
The data for the style attribute set is retrieved from PROD. If segment parameters StyleGroupingA through StyleGroupingF
contain ATxxx, where xxx is a value that matches the attribute code of the attribute set, the style attribute set data is put in Customer Info. Management Style table.
If segment parameter StyleFeature contains a value that matches the attribute code of the attribute set, the style attribute set data is placed in the Customer Info Management style_feature table.
The attribute set code, attribute code and style code of the style attribute set are also placed in the cross-reference table in the Pipeline Repository with the entity name “style attribute set”.
Delete (D) The attribute code, attribute set code and style code for the style attribute set are retrieved from the cross-reference table in the Pipeline Repository.
If segment parameters StyleGroupingA through StyleGroupingF contain ATxxx, where xxx is a value that matches the attribute code, the style attribute set data is deleted from the Customer Info. Management Style table.
If segment parameter StyleFeature contains a value that matches the attribute code, the style attribute set data is deleted from the Customer Info. Management style_feature table.
Entity Action Description
Segment 1004 - EDM & PROD to Customer Info Mgmt 71
Assigned employee attribute set (513)
Insert (I) / Update (U)
The data for the employee attribute set is retrieved from EDM based on the parameter Employee Roles.
If segment parameters EmployeeGroupingA through EmployeeGroupingB contain ATxxx, where xxx is a value that matches the attribute code of the attribute set, the employee attribute set data is placed into Customer Info. Management sales_associate table.
If segment parameter EmployeeFeature contains a value that matches the attribute code of the attribute set, the employee attribute set data is placed in the Customer Info. Management sales_associate_feature table.
The attribute set code, attribute code and employee code of the location attribute set are also placed in the cross-reference table in the Pipeline Repository with the entity name “employee attribute set”.
Delete (D) The attribute code, attribute set code and employee code for the employee attribute set are retrieved from the cross-reference table in the Pipeline Repository.
If segment parameter EmployeeFeature contains a value that matches the attribute code, the employee attribute set data is deleted from the Customer Info. Management sales_associate_feature table.
If segment parameters EmployeeGroupingA through EmployeeGroupingB contain ATxxx, where xxx is a value that matches the attribute code, the employee attribute set data is deleted from the Customer Info. Management employee table.
Assigned main merchandising group attribute set (514)
Insert (I) / Update (U)
If the Merchandise group level is at class level, the data for the merchandise group attribute set is retrieved from EDM & PROD.
If segment parameters ClassGroupingA through ClassGroupingD contain ATxxx, where xxx is a value that matches the attribute code of the attribute set, the class attribute set data is placed into Customer Info. Management Class table.
If segment parameter ClassFeature contains a value that matches the attribute code of the attribute set, the class attribute set data is placed in the Customer Info. Management class feature table.
The attribute set code, attribute code and class code of the class attribute set are also placed in the cross-reference table in the Pipeline Repository with the entity name “node attribute set”.
Delete (D) The attribute code, attribute set code and class code for the attribute set are retrieved from the cross-reference table in the Pipeline Repository.
If segment parameters ClassGroupingA through ClassGroupingD contain ATxxx where xxx is a value that matches the attribute code, the class attribute set data is deleted from the Customer Info. Management class table.
If segment parameter ClassFeature contains a value that matches the attribute code, the class attribute set data is deleted from the Customer Info. Management class_feature table.
Entity Action Description
72 Segment Reference
Assigned main merchandising vendor attribute set (518)
Insert (I) / Update (U)
The data for the vendor attribute set is retrieved from EDM. If segment parameters VendorGroupingA through
VendorGroupingB contain ATxxx where xxx is a value that matches the attribute code of the attribute set, the employee attribute set data is placed into Customer Info. Management Vendor table.
If segment parameter VendorFeature contains a value that matches the attribute code of the attribute set, the employee attribute set data is placed in the Customer Info. Management vendor_feature table.
The attribute set code, attribute code and vendor code of the location attribute set are also placed in the cross-reference table in the Pipeline Repository with the entity name “supplier attribute set”
Delete (D) The attribute code, attribute set code and vendor code for the vendor attribute set are retrieved from the cross-reference table in the Pipeline Repository.
If segment parameters VendorGroupingA through VendorGroupingB contain ATxxx, where xxx is a value that matches the attribute code, the vendor attribute set data is deleted from the Customer Info. Management vendor table.
If segment parameter VendorFeature contains a value that matches the attribute code, the employee attribute set data is deleted from the Customer Info. Management vendor_feature table.
Employee (601) Insert (I) / Update (U)
If segment parameter SendNonSellingStoreEmployee is on and the employee is linked to one of the roles specified in the segment parameter EmployeeRoles, the data for the employee is retrieved from EDM. If segment parameter SendNonSellingStoreEmployee is off and the employee’s home location is a selling store and the employee is linked to one of the roles specified in the segment parameter EmployeeRoles, the data for the employee is retrieved from EDM.
The retrieved employee data is placed in the Customer Info. Management sales_associate table.
The employee code of the employee is also placed in the cross-reference table in the Pipeline Repository with the entity name “employee”.
Delete (D) The employee code for the employee is retrieved from the cross-reference table in the Pipeline Repository and the employee is deleted from the Customer Info. Management sales_associate table.
Entity Action Description
Segment 1004 - EDM & PROD to Customer Info Mgmt 73
TroubleshootingNo troubleshooting information is currently available for this segment.
Employee position (605) Insert (I) / Update (U)
When a position is added/modified on an employee, if segment parameter SendNonSellingStoreEmployee is enabled and the employee position is linked to one of the roles specified in segment parameter EmployeeRoles, the data for the employee is retrieved from EDM.
When a position is added/modified on an employee, if segment parameter SendNonSellingStoreEmployee is not enabled and the employee’s home location is a selling store and the employee position is linked to one of the roles specified in segment parameter EmployeeRoles, the data for the employee is retrieved from EDM.
The retrieved employee data is placed in the Customer Info. Management sales_associate table.
Entity Action Description
74 Segment Reference
Segment 1005 - EDM & PROD to MAThe segment replicates enterprise and product master entities from EDM & PROD to Merchandise Analytics.
Segment Parameters
Scheduling RequirementsBefore this segment is run the first time, the MA Startup script (MV SQLServer startup script or MV Oracle startup script) must be run to set initial parameters. Once the segment is run, you must re-run the startup scripts to ensure that the Calendar tables are correctly populated.
Database ParametersNone.
Queue Segment Description The segment requires the following Pipeline dlls to be installed:
STSPLEDMPRODToMA.dll The segment requires the following Merchandising dlls to be installed.
STSFCClient.dll STSFCServer.dll
MA subscribes to the following entities and actions via this segment:
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
CalendarYN Update Calendar
Indicates if calendar period, calendar week should be sent to MA. 0 = No, 1 = Yes.
No 1
Mod64 Custom Mod 64 installed
Indicates if custom Mod 64 “Sony - Style Reclassification” is installed. If the parameter value is 0, the custom modification is not installed. If the parameter value is 1, the custom modification is installed.
No 0
Entity Action Description
Calendar Year (41) Insert (I) The calendar year is retrieved from the EDM & PROD Import table and placed in the MA calendar table.
Delete (D) The calendar year is deleted from the MA calendar table.
Calendar Period (42) Insert (I) If the segment parameter Calendar Year YN is set to 1, the calendar period is retrieved from EDM and placed in the MA calendar merchandising period table. The dates for the period are also retrieved from EDM and placed in the MA calendar date table.
Delete (D) If the segment parameter Calendar Year YN is set to 1, the calendar period is deleted from the MA calendar merchandising period table. The dates for the period are also deleted from the MA calendar date table.
Segment 1005 - EDM & PROD to MA 75
Calendar Week (43) Insert (I) Published when a calendar is initially created in EDM, and when the number of weeks in a given period is changed. (When the number of weeks in a period is changed, the weeks in the period are deleted and the new number of weeks is inserted.) If the segment parameter CalendarYN is set to 1, the calendar
week is retrieved from EDM and placed in the MA calendar merchandising week table.
Delete (D) Published when a calendar is deleted in EDM, and when the number of weeks in a given period is changed. (When the number of weeks in a period is changed, the weeks in the period are deleted and the new number of weeks is inserted.) If the segment parameter CalendarYN is set to 1, the calendar
week is deleted from the MA calendar merchandising week table.
Calendar Period Labels (44) Insert (I) / Update (U)
If the segment parameter CalendarYN is set to 1, all the calendar period labels are retrieved from EDM and placed in the MA period label table.
Color (61) Insert (I) / Update (U)
The color is retrieved from PROD and placed in the MA color table.
Delete (D) The color is deleted from the MA color table.
Country (71) Insert (I) / Update (U)
The country is retrieved from EDM and placed in the MA country table.
Delete (D) The country is deleted from the MA country table.
Currency (73) Insert (I) / Update (U)
The currency is retrieved from EDM and placed in the MA currency table.
Delete (D) The currency is deleted from the currency table .
Location (101) Insert (I) / Update (U)
The location is retrieved from EDM and placed in the MA location table.
The scripts also calculate the comparative weeks for the location based on close date, reopen date, remodel start date and remodel end date, and place them into the MA location comparative weeks.
Main location hierarchy (151)
Insert (I) / Update (U)
The main location hierarchy is retrieved from EDM and placed in the MA hierarchy table.
Delete (D) The main location hierarchy is deleted from the MA hierarchy table.
Main location hierarchy level (152)
Insert (I) / Update (U)
The main location hierarchy level is retrieved from EDM and placed in the MA hierarchy level table.
Delete (D) The main location hierarchy level is deleted from the MA hierarchy level table.
Main location hierarchy group (153)
Insert (I) / Update (U)
The main location hierarchy group is retrieved from EDM and placed in the MA hierarchy group table.
Delete (D) The main location hierarchy group is deleted from the MA hierarchy group table.
Insert main location hierarchy group (162)
Insert (I) / Update (U)
The location group for the main location hierarchy and all its parent groups are retrieved from EDM and placed in the MA location parent table.
Entity Action Description
76 Segment Reference
The location ID and one of the parent group level IDs of the location group is also placed in the Pipeline cross-reference table.
Delete (D) The location ID and parent group ID are retrieved from the Pipeline cross-reference table.
The location group and all its parent groups are deleted from the MA location parent table.
Alternate location hierarchy (171)
Insert (I) / Update (U)
The alternate location hierarchy is retrieved from EDM and placed in the MA hierarchy table.
Delete (D) The alternate location hierarchy is deleted from the MA hierarchy table.
Alternate location hierarchy level (172)
Insert (I) / Update (U)
The alternate location hierarchy level is retrieved from EDM and placed in the MA hierarchy level table.
Delete (D) The alternate location hierarchy level is deleted from the MA hierarchy level table.
Alternate location hierarchy node (173)
Insert (I) / Update (U)
The alternate location hierarchy group is retrieved from EDM and placed in the MA hierarchy group table.
Delete (D) The alternate location hierarchy group is deleted from the MA hierarchy group table.
Alternate hierarchy location node (182)
Insert (I) The location group for an alternate location hierarchy and all its parent groups are retrieved from EDM and placed in the MA location parent table.
The location ID and one of the parent group level IDs of the location group is also placed in the Pipeline cross-reference table.
Delete (D) The location ID and parent group ID are retrieved from the Pipeline cross-reference table.
All the parent groups of (and including) the location group are deleted from the MA location parent table.
Main merchandise hierarchy (201)
Insert (I) / Update (U)
The main merchandise hierarchy is retrieved from PROD and placed in the MA hierarchy table.
Delete (D) The main merchandise hierarchy is deleted from the MA hierarchy table.
Main merchandise hierarchy level (202)
Insert (I) / Update (U)
The main merchandise hierarchy level is retrieved from PROD and placed in the MA hierarchy level table.
Delete (D) The main merchandise hierarchy level is deleted from the MA hierarchy level table.
Main merchandise hierarchy group (203)
Insert (I) / Update (U)
The main merchandise hierarchy group is retrieved from PROD and placed in the MA hierarchy group table.
All the parent groups of the main merchandise hierarchy group are also retrieved from PROD and placed in the MA merchandise group parent table.
Delete (D) The main merchandise hierarchy group is deleted from the MA hierarchy group and merchandise group parent table.
Style links to main merchandise (221)
Insert (I) / Update (U)
The style group for the main merchandise hierarchy is retrieved from PROD and placed in the MA style group and style table.
All the parent groups of the style group are also retrieved from PROD and placed in the MA style parent table.
Entity Action Description
Segment 1005 - EDM & PROD to MA 77
Delete (D) The style group and all its parent groups are deleted from the MA style group and style parent table.
Alternate merchandise hierarchy (251)
Insert (I) / Update (U)
The alternate merchandise hierarchy is retrieved from PROD and placed in the MA hierarchy table.
Delete (D) The alternate merchandise hierarchy is deleted from the MA hierarchy table.
Alternate merchandise hierarchy level (252)
Insert (I) / Update (U)
The alternate merchandise hierarchy level is retrieved from PROD and placed in the MA hierarchy level table.
Delete (D) The alternate merchandise hierarchy level is deleted from the MA hierarchy level table.
Alternate merchandise hierarchy node (253)
Insert (I) / Update (U)
The alternate merchandise hierarchy group is retrieved from PROD and put in the MA hierarchy group table. All the parent groups of the alternate merchandise hierarchy
group are retrieved from PROD and put in the MA merchandise group parent table.
Delete (D) The alternate merchandise hierarchy group is deleted from the MA hierarchy group and merchandise group parent table.
Style links to alternate merchandise hierarchy nodes (271)
Insert (I) / Update (U)
The style group for the alternate merchandise hierarchy is retrieved from PROD and put in the MA style group table.
All the parent groups of the style group are also retrieved from PROD and placed in the MA style parent table.
Delete (D) The style group and all its parent groups are deleted from the MA style group and style parent table.
Style (301) Insert (I) / Update (U)
The style is retrieved from PROD and placed in the MA style table.
Delete (D) The style is deleted from the MA style table. An entry is also sent to the MA housekeeping queue to inform
MA that the history for this style should be cleaned up.
Style color (311) Insert (I) / Update (U)
The style color is retrieved from PROD and placed in the MA style color table.
Delete (D) The style color is deleted from the MA style color table.
Style retail (316) Insert (I) / Update (U)
The style retail is retrieved from PROD and put in the MA style retail table. If the style retail is of home jurisdiction, it is also placed in the MA style table.
Delete (D) The style retail is deleted from the MA style retail table.
Style color retail (317) Insert (I) / Update (U)
If the style color retail is of home jurisdiction, it is retrieved from PROD and placed in the MA style color table (see Mapping Document for this segment).
Delete (D) The style color retail is deleted from the MA style color table if it is of home jurisdiction.
Style size (321) Insert (I) / Update (U)
The style size is retrieved from PROD and placed in the MA style size table.
Delete (D) The style size is deleted from the MA style size table.
Style detail (322) Update (U) The style detail is retrieved from PROD and placed in the MA style table (see Mapping Document for this segment).
Entity Action Description
78 Segment Reference
Size master (331) Insert (I) / Update (U)
The size master is retrieved from PROD and placed in the MA size master table.
Delete (D) The size master is deleted from the MA size master table.
Size category (332) Insert (I) / Update (U)
The size category is retrieved from PROD and placed in the MA size category table.
Delete (D) The size category is deleted from the MA size category table.
SKU (351) Insert (I) / Update (U)
The SKU is retrieved from PROD and placed in the MA SKU table.
Delete (D) The SKU is deleted from the MA SKU table.
UPC (361) Insert (I) / Update (U)
The UPC is retrieved from PROD and placed in the MA UPC table.
Delete (D) The UPC is deleted from the MA UPC table.
Style list (370) Insert (I) / Update (U)
The style list is retrieved from PROD and placed in the MA style list table.
All style list items belonging to the style list are retrieved from PROD and placed in the MA style list item table.
Delete (D) The style list and its items are deleted from the MA style list and style list item table.
Style list item (371) Insert (I) / Update (U)
The style list item is retrieved from PROD and placed in the MA style list item table.
Delete (D) The style list item is deleted from the MA style list item table.
Merchandise vendor (401) Insert (I) / Update (U)
The vendor is retrieved from EDM and placed in the MA vendor table.
Delete (D) The vendor is deleted from the MA vendor table.
Style vendor (421) Insert (I) / Update (U)
The style vendor is retrieved from PROD and placed in the MA style vendor table.
If the vendor is the primary vendor of the style, the vendor information is also placed in the MA style table.
Delete (D) The style vendor is deleted from the MA style vendor table.
Location attribute (451) Insert (I) / Update (U)
The attribute is retrieved from EDM and placed in the MA attribute table.
Delete (D) The attribute is deleted from the MA attribute table.
Style attribute (452) Insert (I) / Update (U)
The attribute is retrieved from PROD and placed in the MA attribute table.
Delete (D) The attribute is deleted from the MA attribute table.
Employee attribute (453) Insert (I) / Update (U)
The attribute is retrieved from EDM and placed in the MA attribute table.
Delete (D) The attribute is deleted from the MA attribute table.
Merch group attribute (454) Insert (I) / Update (U)
The attribute is retrieved from PROD and placed in the MA attribute table.
Delete (D) The attribute is deleted from the MA attribute table.
Vendor attribute (456) Insert (I) / Update (U)
The attribute is retrieved from EDM and placed in the MA attribute table.
Entity Action Description
Segment 1005 - EDM & PROD to MA 79
Delete (D) The attribute is deleted from the MA attribute table.
Style color attribute (458) Insert (I) / Update (U)
The attribute is retrieved from PROD and placed in the MA attribute table.
Delete (D) The attribute is deleted from the MA attribute table.
Attribute set for location (481)
Insert (I) / Update (U)
The attribute set is retrieved from EDM and placed in the MA attribute set table.
Delete (D) The attribute set is deleted from the MA attribute set table.
Attribute set for style (482) Insert (I) / Update (U)
The attribute set is retrieved from EDM and placed in the MA attribute set table.
Delete (D) The attribute set is deleted from the MA attribute set table.
Attribute set for employee (483)
Insert (I) / Update (U)
The attribute set is retrieved from EDM and placed in the MA attribute set table.
Delete (D) The attribute set is deleted from the MA attribute set table.
Attribute set for merch group (484)
Insert (I) / Update (U)
The attribute set is retrieved from PROD and placed in the MA attribute set table.
Delete (D) The attribute set is deleted from the MA attribute set table.
Attribute set for vendor (486) Insert (I) / Update (U)
The attribute set is retrieved from EDM and placed in the MA attribute set table.
Delete (D) The attribute set is deleted from the MA attribute set table.
Attribute set for style color (490)
Insert (I) / Update (U)
The attribute set is retrieved from PROD and placed in the MA attribute set table.
Delete (D) The attribute set is deleted from the MA attribute set table.
Assigned location attribute set (511)
Insert (I) / Update (U)
The location attribute set is retrieved from EDM and placed in the MA entity attribute set table.
Delete (D) The location attribute set is deleted from the MA entity attribute set table.
Assigned style attribute set (512)
Insert (I) / Update (U)
The style attribute set is retrieved from PROD and placed in the MA entity attribute set table.
Delete (D) The style attribute set is deleted from the MA entity attribute set table.
Assigned employee attribute set (513)
Insert (I) / Update (U)
The employee attribute set is retrieved from EDM and placed in the MA entity attribute set table.
Delete (D) The employee attribute set is deleted from the MA entity attribute set table.
Assigned main merch hierarchy group attribute set (514)
Insert (I) / Update (U)
The main merchandise hierarchy group attribute set is retrieved from PROD and placed in the MA entity attribute set table.
Delete (D) The main merchandise hierarchy group attribute set is deleted from the MA entity attribute set table.
Assigned main location hierarchy group attribute set (516)
Insert (I) / Update (U)
The main location hierarchy group attribute set is retrieved from EDM and placed in the MA entity attribute set table.
Entity Action Description
80 Segment Reference
Delete (D) The main location hierarchy group attribute set is deleted from the MA entity attribute set table.
Assigned merch vendor attribute set (518)
Insert (I) / Update (U)
The vendor attribute set is retrieved from EDM and placed in the MA entity attribute set table.
Delete (D) The vendor attribute set is deleted from the MA entity attribute set table.
Assigned style color attribute set (520)
Insert (I) / Update (U)
The style color attribute set is retrieved from PROD and placed in the MA entity attribute set table.
Delete (D) The style color attribute set is deleted from the MA entity attribute set table.
Cost factor (551) Insert (I) / Update (U)
The cost factor is retrieved from PROD and placed in the MA cost factor and history component table.
Delete (D) The cost factor is deleted from the MA cost factor and history component table.
Discount type (552) Insert (I) / Update (U)
The discount is retrieved from EDM and placed in the MA discount and history component table.
Delete (D) The discount is deleted from the MA discount and history component table.
Discount (553) Insert (I) / Update (U)
The vendor discount is retrieved from EDM and placed in the MA vendor discount table.
Delete (D) The vendor discount is deleted from the MA vendor discount table.
Jurisdiction (555) Insert (I) / Update (U)
The jurisdiction is retrieved from EDM and placed in the MA jurisdiction table.
Delete (D) The jurisdiction is deleted from the MA jurisdiction table.
Employee (601) Insert (I) / Update (U)
The employee is retrieved from EDM and placed in the MA employee table.
Delete (D) The employee is deleted from the MA employee table.
Position (602) Insert (I) / Update (U)
The position is retrieved from EDM and placed in the MA position table .
Delete (D) The position is deleted from the MA position table.
Position location (603) Insert (I) / Update (U)
The location position is retrieved from EDM and placed in the MA entity position table.
Delete (D) The location position is deleted from the MA entity position table.
Position merch group (604) Insert (I) / Update (U)
The merchandise group position is retrieved from PROD and placed in the MA entity position table.
Delete (D) The merchandise group position is deleted from the MA entity position table.
Employee position (605) Insert (I) / Update (U)
The employee position is retrieved from EDM and placed in the MA entity position table.
Delete (D) The employee position is deleted from the MA entity position table.
Employee role (606) Insert (I) / Update (U)
The employee role is retrieved from EDM and placed in the MA employee role table.
Delete (D) The employee role is deleted from the MA employee role table.
Entity Action Description
Segment 1005 - EDM & PROD to MA 81
Custom property (620) Insert (I) / Update (U)
The custom property is retrieved from EDM and placed in the MA custom property table.
Delete (D) The custom property is deleted from the MA custom property table.
Location custom property (621)
Insert (I) / Update (U)
The location custom property is retrieved from EDM and placed in the MA entity custom property table.
Delete (D) The location custom property is deleted from the MA entity custom property table.
Style custom property (622) Insert (I) / Update (U)
The style custom property is retrieved from PROD and placed in the MA entity custom property table.
Delete (D) The style custom property is deleted from the MA entity custom property table.
Transaction reason (672) Insert (I) / Update (U)
The transaction reason is retrieved from EDM and placed in the MA history component table.
Delete (D) The transaction reason is deleted from the MA history component table.
Season (681) Insert (I) / Update (U)
The season is retrieved from EDM and placed in the MA season table.
Delete (D) The season is deleted from the MA season table.
Terms (683) Insert (I) / Update (U)
The terms are retrieved from EDM and placed in the MA terms table.
Delete (D) The terms are deleted from the MA terms table.
Price status (701) Insert (I) / Update (U)
The price status is retrieved from EDM and placed in the MA price status and history component table.
Delete (D) The price status is deleted from the MA price status and history component table.
Inventory status (703) Insert (I) / Update (U)
Inventory status is retrieved from EDM and placed in the MA inventory status table.
Delete (D) Inventory status is deleted from the MA inventory status table.
Merch hierarchy (810) Insert (I) / Update (U)
The hierarchy characteristics level is retrieved from PROD and placed in the MA hierarchy characteristics level table.
Delete (D) The hierarchy characteristics level is deleted from the MA hierarchy characteristics level table.
IB activity date (901) Insert (I) / Update (U)
The IB activity date is retrieved from EDM and placed in the MA IB activity table.
Delete (D) The IB activity is deleted from the MA IB activity table.
Pricing group (920) Insert (I) / Update (U)
The pricing group is retrieved from EDM and placed in the MA pricing group table.
Delete (D) The pricing group is deleted from the MA pricing group table.
Pricing group location (921) Insert (I) / Update (U)
The pricing group location is retrieved from EDM and placed in the MA pricing group location table.
Delete (D) The pricing group location is deleted from the MA pricing group location table.
Entity Action Description
82 Segment Reference
TroubleshootingNo troubleshooting information is currently available for this segment.
Color group (945) Insert (I) / Update (U)
The color group is retrieved from EDM & PROD and placed in the Sourcing interface database.
Color group item (946) Insert(I) / Update (U) The color group item is retrieved from EDM & PROD and placed in the Sourcing interface database.
Delete(D) Sending Delete results in color group column in the Sourcing tables being set to null for the color.
Entity Action Description
Segment 1006 - EDM & PROD to Price Look-Up 83
Segment 1006 - EDM & PROD to Price Look-UpThis segment generates files containing pricing information required by the Price Look-Up (PLU) applications running at point of sale (POS). The segment is capable of exporting PLU data in the format required by three different PLU applications: Store PLU, Triversity PLU, and PC Register PLU.
Segment Parameters
Scheduling Requirements
Note: Scheduling requirements for the segment differ if a store within the enterprise uses an Offline IM application at POS, i.e., if a store uses Store Inventory Tracking or Triversity NSB Open In-Store (aka NOI, Intelligent Non-Sale, Interactive Non-Sales, INS).
Because the segment generates files containing pricing information required by the PLU applications running at POS, the segment should be scheduled to run at least once after the following Price Management segments are run, as these segments have can have an effect on the effective retail of items the following day:
Parameter Name
DescriptionModifiable with Pipeline Admin.
Default Value
Disable File Regenerate
Controls the behaviour of entity 913 (PLU File Regenerate). If set to 0, the segment runs normally. If set to 1, the entity is disabled and PLU File Regenerate can be run separately if segment 1536 – EDM and PROD to Price Lookup – File Regenerate, is installed.
Yes 0
Enforce Style Code Limit
Indicates whether PLU will validate style code lengths > 10 when the Item and Style PLU files are generated.Set to 1 (True) to have PLU reject style code lengths > 10 and not send them to POS. Set to 0 (False) to have style code lengths > 10 added to the PLU files and sent to POS.Applicable only to the Store register type and if location has been flagged for either OIM, ES or Tax by Size. Requires Store POS version that has been upgraded to support style code lengths > 10.
Yes 1
Mutually Exclusive Segments
To ensure data integrity, prevents segment 1006 from running if segment 1038 is already running.
No 1038
Send Concatenated Item Description
Set to 0 (False) to send the item description based on the style's PLU description as defined in Style Maintenance. Set to 1 (True) to send the item description based on a concatenation of the style code + style color short description + size code. Applicable only to the Store register type and if the location has been flagged for Enterprise Selling.
Yes 0
84 Segment Reference
PM Internal - Issue Documents PM Internal - Make Promotional PCs Effective PM Internal - Make Permanent PCs Effective PM Internal - Complete Promotional PCs PM Internal - Issue Deal Document PM Internal - Complete Deal Document PM Internal - Delete Completed & Cancelled Deal Documents PM Internal - Update PC Totals
Normally, the Price Management segments are scheduled to run once in a single job, after hours. When there are no stores within the enterprise that run an Offline IM application at POS, segment EDM & PROD to PLU is normally scheduled to run as part of the Price Management job, after the Price Management segments. The job is scheduled to finish before the Polling session(s) that will download the generated PLU files to the stores. The Price Management segments and segment EDM & PROD to PLU can be scheduled to run more often, however, if the enterprise uses trickle polling to download PLU files to POS throughout the day.
If a store within the enterprise uses an Offline IM application, the segment should be scheduled in a single job with the following segments, in the order listed below: Segment 53002 – Offline IM to IM, Outbound Transfers Segment 3012 – IM To Offline IM File Segment 58003 – Offline IM File Internal - Prepare IM Files Segment 2000 – POM To Offline IM File Segment 58002 – Offline IM File Internal - Prepare POM Files Segment 1006 – EDM & PROD to PLU Segment 1032 – EDM & PROD to Offline IM File Segment 1033 – EDM & PROD to Offline IM File, Master Data Segment 58001 – Offline IM File Internal - Prepare EDM & PROD Files Segment 58007 – Offline IM File Internal - Prepare Descriptor Files Segment 58008 – Offline IM File Internal - Submit Descriptor Files Segment 58004 – Offline IM File Internal - Submit EDM & PROD Files Segment 58005 – Offline IM File Internal - Submit POM Files Segment 58006 – Offline IM File Internal - Submit IM Files
The job should be scheduled to run regularly throughout the day and after hours (and at least once after the Price Management segments and before the Polling session(s) that will download the generated PLU files to the stores).
Note: Segment 1006 - EDM & PROD to PLU does not need to be run as part of this job if there are no stores within the enterprise running Offline IM application - Coalition Store Inventory Tracking at POS, nor do segments 1032 – EDM & PROD to Offline IM File and 1033 – EDM & PROD to Offline IM File, Master Data need to be scheduled as part of this job if there are no stores within the enterprise running Offline IM application - Triversity NSB Open In-Store. Complete instructions for Offline IM scheduling can be found in: the NOI Configuration Guidethe Coalition SIT Configuration Guidethe release notes for Pipeline segment builds 3.00.002.000 and 3.00.004.000
Segment 1006 - EDM & PROD to Price Look-Up 85
Polling must be configured to deliver the files generated by this segment to the respective stores. The polling configuration requirements for a store differ greatly based on whether the store uses Coalition PLU, Triversity PLU, or PC Register PLU whether the enterprise uses BSC Polling to deliver Triversity PLU files to its stores,
and whether any stores within the enterprise use Offline IM application - Coalition
Store Inventory Tracking. For more details, see Queue Segment Description for this segment.
Database Parameters The parameters that need to be defined in order to run the segment are kept in the
Merchandising database. The main PLU parameter table is found in EDM/PROD, and is called parameter_price_lookup. The parameters stored in the table are explained in depth in the PLU User Guide under “Set the remaining PLU parameters”. main_directory transmission_log_directory error_log_directory plu_key use_mix_match_flag override_for_style_flag retrieve_group_code_flag send_price_change_flag shared_attribute_ID use_ftp_flag use_style_level_flag send_description_flag send_check_digit_flag upc_style_code_length unix_server_address unix_account unix_password backup_directory_pipeline backup_directory_application backup_retention_period
There are other tables in EDM/PROD that also need to be set up in order to use PLU, and this setup is customized based on how the client intends to use PLU. The PLU User Guide details how to perform this setup.
Queue Segment Description EDM, PROD, and PM publish events (rows) to the core replication queue, and segment
EDM & PROD to PLU processes the events relevant to the PLU applications running at POS. For each event in the core replication queue, the segment calls the same method on Merchandising object STSPLUDispatcher providing it different parameters. That component then retrieves the data related to the event and accumulates it in memory with that of the other events processed by the run of the segment. When a segment has processed all the new events in the core replication queue that are relevant to PLU, it takes the data that has been accumulated in memory and calls a
86 Segment Reference
component that persists it to files (this is done by a component called from the post batch script). Files are generated for each store that does not have a status of closed and that uses a PLU application at POS (i.e., a store whose Generate PLU flag is set to true).
The following entity actions are processed by this segment:
Entity Action Description
Assigned Location Attribute Set (511)
Update (U)
Assigned Style Attribute Set (512)
Update (U)
Color (61) Insert (I) / Update (U) / POS Update (PU)
Deal (930) Insert (I) / Update (U)
Item Group (941) Insert (I) / Update (U) / Delete (D)
Location (101) Insert (I) / Update (U) / Delete (D) / Master Data (MD) / POS Insert (PI) / POS Update (PU) / POS Delete (PD) / Regenerate PLU (RP)
Main Merchandise Hierarchy Group (203)
Insert (I) / Update (U) / Delete (D)
Merchandising Assignment Plu (910)
Update (U)
Merchandise Vendor (401) POS Insert (PI) / POS Update (PU) / POS Delete (PD)
Plu Price Change (915) Insert (I)
Plu File Regenerate (913) Insert (I)
Register Type (912) Insert (I)
Style Assignment Plu (911) Insert (I) / Update (U) / Delete (D)
Style Color Location (312) Insert (I) / Update (U) / Delete (D)
Style Location (313) Insert (I) / Update (U) / Delete (D)
Resend Style (925) Insert (I)
Size Master (331) Insert (I) / Update (U) / Delete (D)
Style (301) Update (U) / POS Update (PU) / Delete (D)
Style Color (311) Insert (I) / Update (U) / Delete (D)
Style Vendor (421) Insert (I) / Update (U)
Style Pricing Group (314) Insert (I) / Update (U) / Delete (D)
Style Pricing Group Color (315) Insert (I) / Update (U) / Delete (D)
UPC (361) Insert (I) / Update (U)
Hierarchy characteristic level (810)
Insert (I) / Update (U) / Delete (D) Any changes made in the hierarchy characteristic level trigger a full download of PLU department group information. The PLU dept files will also be downloaded as a result of changes to the PLU department group.
Segment 1006 - EDM & PROD to Price Look-Up 87
The PLU files for a store are generated in a subfolder of the PLU directory specified in the PLU parameters (i.e., specified in the parameter_price_lookup table). The PLU directory contains a subfolder for every store for which a file is generated. The subfolders are named using the following convention: location_ID, concatenated with an underscore, concatenated with the location_name. A subfolder named “Polling” also exists in the PLU directory. The following is an example of the directory structure in which the files are generated, where the PLU directory specified in the PLU parameters is “C:\sts_plu\files”:
TroubleshootingThe segment accumulates data in memory and waits until it has processed all the new events in the core replication queue that are relevant to PLU before persisting the data to file. In the event that the segment terminates abnormally (for example, a crash), it is necessary to roll back the last queue item for the segment in the Pipeline Repository database and run the segment again. This will regenerate most of the required data, however it may also be necessary to use the PLU functions in Merchandising to regenerate PLU data for a location for the entire enterprise or specific hierarchy groups.
Use this SQL command roll back the last queue item. The target DB is the PipelineRepository.
update last_queue_item
set last_sequence_id = < last queue item id >where segment_id = 1006
The last queue item ID is the CORE replication queue ID to which the user would like to roll back. Check the segment history in Pipeline Administrator to determine the ID. This operation can be repeated if necessary.
88 Segment Reference
Segment 1008 - EDM & PROD Internal - Update Location Status
This segment updates the status of locations in EDM based on the location dates.
Segment Parameters
Scheduling RequirementsThis is a housekeeping task and should generally be run once a week as part of a housekeeping run.
Database ParametersNone.
Non-queue Segment Description This segment calls the Save method on the EDM business object, which updates the
status of locations in EDM depending on the location dates.
Troubleshooting If any error occurs when the Merchandising business object updates the location
status, the error will be logged to the Windows Event Viewer (Control Panel/Administration Tools/Component Services/ Event Viewer/Application).
Segment failure without an error log indicates a setup problem or Pipeline defect.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Application ID Value used by the segment for security purposes. (This parameter is not currently used by the segment.)
No 100
CompanyID Company ID Value used by the segment for connectivity purposes. It is used to determine what company the segment should access. (This parameter is not currently used by the segment.)
No The company for which the segment has been installed
TaskProgID Task ProgID Indicates to the common process that runs scheduled tasks that location status update must be performed. (Not currently used by the segment.)
No STSMELocationScheduledTask.STSMELocationStatus
Segment 1009 - EDM & PROD to Merch Planning - Send Loc Hierarchy 89
Segment 1009 - EDM & PROD to Merch Planning - Send Loc Hierarchy
This segment produces one text file, store.dat, that will be used by Planning and one text file, strtrn that will be used by Allocations. These text files contain the Location Hierarchy Structure (called LTree) used by Planning. They have an output format predefined by Planning/Allocations. The data for these files is extracted from multiple tables in the Merchandising system.
Location Hierarchy Structure (LTree)This procedure provides a method of loading large volumes of location (store) information into the Planning system database. This information is contained in the Location Hierarchy in the Merchandising application. The location hierarchy cannot be customized for Planning. Either the complete location structure or only changes to it can be sent to Planning every time the segment is run. The following parameters are used by the LTree script: AllocationDataFolderRemoteServer drive/pathMappedRemoteServer DataFolderRemoteServer workingFolderRemoteServer BatchSize DB Platform sendChangesOnlyLocation lastQIDBTree
Segment Parameters
Note: Default values are intended as examples only. Values may change from client to client.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSize Batch Size This determines the size for batch processing. Used initially for batch processing. Depending on the performance of the system, the value of the parameter can be reduced or increased. This parameter speeds up the execution of the segment. This should be tested and set at installation time. This value is used to determine the number of location_ids from the location table that are to be processed at a time.
No 1000
90 Segment Reference
drive/pathMappedRemoteServer
Drive and path for the mapped Planning Server
Drive and path mapped to Planning server. In the following example, the 'I:' drive is mapped to the server and the path is 'I:\batch'. 'Batch' directory is the standard directory in every company for Planning exports. The “Planning Export for B-Tree and L-Tree” package writes text files to the Planning server using this parameter. The following format can also be used for this parameter: \\servername\path\folder/
No I:
DataFolderRemoteServer
DataFolderRemoteServer
Data folder on the Planning server. When the segment runs, the date-time stamped file will be copied to this folder and renamed to store.dat. This folder must be created in ...\batch directory in the path provided by the parameter drive/pathMappedRemoteServer, for example, i:\batch\Intrans
No Intrans
workingFolderRemoteServer
workingFolderRemoteServer
Working folder on the Planning server. The working folder contains the files that are generated by the segment. These files will have a date-time stamp and a two-character suffix indicating the file content. This folder must be created in ...\batch directory in the path provided by the parameter drive/pathMappedRemoteServer, for example i:\batch\MevWork
No MeVWork
AllocationDataFolderRemoteServer
AllocationDataFolderRemoteServer
Allocation folder on the Planning server. When the LTree is created, the <datetimestamp>LT.dat file is copied with a new name ‘strtrn’ to the path and the folder given in this parameter, for example, i:\Alloc
No
DB Platform Database Platform This parameter is used if the PlanningOnly parameter is set to true.
No
lastQIDLTree lastQIDLTree If 'sendChangesOnlyLocation' is set to True and changes were made to the location structure since the last time this segment ran, this parameter will contain the last queue ID that was exported. This parameter will be updated automatically when the segment runs. The next time the segment runs, the queue will continue, beginning with this ID. This parameter only needs to be set once.
No
SendChangesOnly Location
Send Changes Only Location
Determines whether all locations are sent or only those with changes. Can be set to 0 (All locations) or 1 (Only locations that are changed, created or deleted). Should be set to 0 at startup and 1 thereafter.
No 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Segment 1009 - EDM & PROD to Merch Planning - Send Loc Hierarchy 91
Scheduling RequirementsThe Text file to Planning Batch job must be scheduled after this segment is run. Segment 26000 – Merchandising Planning Internal – Import History and Hierarchy, if used, must be run after this segment.
Database ParametersThere are no Pipeline parameters stored in the source or destination database for this segment.
Non-queue Segment DescriptionThis segment produces a text file for Ltree, which can be found in MevWork folder with the timestamp and the suffix of LT.
TroubleshootingErrors may be related to parameter settings. For troubleshooting purposes there is a log file that is produced in the Working Folder (MevWork): BLLOG.dat.
If there is no output file produced, the easiest way to debug is to run the SQL statements from the BLLOG.dat file on the MA database and see which table is missing the required data.
PlanningOnly Planning Only Indicates if Planning only, or Planning and Allocation are used. Set to 0 (False), if data for both planning and allocation data are to be processed. Set to 1 (True) if only Planning data is to be processed.
No 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
92 Segment Reference
A sample log file is shown below. The parameters that are read from the segment parameters and the SQL statements that are used to extract date are shown in this file each time the segment is run, as are the start and end time of the segment.
[START TIME]
1/28/2004 2:58:56 PM
[PARAMETERS USED]
Batchsize: 1000
Last Queue ID for Location: 0Send Location Changes Only: False
Database Platform: 1
Planning Client Only: FalseExport path: \\servername\planning\batch\
Data Folder: intrans\
LT Working Folder: MeVWork\Send locations to Allocation: False
Location: SELECT location_code, location_short_name, location_name, active_flag FROM location WHERE location_ID between 1 AND 335 order by location_code
Text File copied to store.dat successfully.LLQID:0
[END TIME]
1/28/2004 2:59:26 PM
Segment 1010 - EDM & PROD to Merch Planning, Merch Entity 93
Segment 1010 - EDM & PROD to Merch Planning, Merch EntityThis segment retrieves merchandise hierarchy groups, styles, style colors, merch group attributes, style attributes and style color attributes from PROD, places them in Planning interface files and posts them to Planning.
Segment Parameters
Merchandising Hierarchy Structure (BTree)This procedure allows tree structures to be created or modified. It can also be used to create alternate or guest relationships of the tree structures. A ‘tree structure’ is the hierarchical relationship of the various merchandise classifications at a given company. The file produced by this procedure is bttrans.dat.
History Reorganization Structure (HReorg) This procedure sends information regarding deleted hierarchy groups to Planning. The
file produced by this procedure is reorg.dat.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
alignMLID Alignment for MLID Padding
If the MLID from Merch is shorter than the length expected from Planning, the MLID can be padded with a character defined in parameter charMLID. This parameter indicates if the padding of a MLID is right aligned, left aligned or if no padding is used.
No R
BatchSize Batch Size The number of records that can be retrieved from merch and written to file in one transaction.
No 2000
BtreeBaseName File Base Name for Btree
The file base name of the BTree file No bttrans
charMLID Character to pad MLID with
Character used to pad an MLID. No
DivCodeSeparator Division Code Separator
The character used to separate the merch entity code and division code in a MLID alias if Planning By Division is active.
No -
InProgPath In Progress Path Specifies the directory where the Planning interface files are built
No C:\NSB Interface\EDM & PROD To Merch Planning, Merch Entity\
Path File Path Specifies the directory where the output files are sent
No
ReorgBaseName File Base Name for Reorg
Specifies the file base name of the reorg file
No reorg
BtreeIntermediateName
Intermediate File Base Name for BTree
Specifies the file base name of the Intermediate BTree file
No BT
94 Segment Reference
IntermediatePath Intermediate File Path Specifies the directory where the intermediate files are sent
No
PathForMksrexec Path For mks_rexec.exe
Specifies the directory where the mks_rexec.exe is located on the Pipeline application server
No
PathForPlanExe Path For Planning Executable Unix Script
Specifies the directory where the REMRUN is located on the Planning application server
No
PathForPlanLog Path For Planning Log File
Specifies the directory where the return.dat is located on the Planning application server
No
PathForPlanningRoot
Path For Planning Root Specifies the Planning root directory on the Planning application server
No
PathForSh Path For sh.exe Specifies the directory where the sh.exe is located on the Planning application server
No
PlanningServerName
Planning Server Name Name of the remote Planning application server
No
PlanningServerPwd Planning Server Password
Password of the remote Planning application server
No
PlanningServerUser Planning Server Login User
Login user of the remote Planning application server
No
ReorgIntermediateName
Intermediate File Base Name for Reorg
Specifies the file base name of the Intermediate reorg file
No
SendInactiveStyles Send Inactive Styles Indicates whether history and modifications to inactive styles will be sent to Planning.If set to 0 (False), history is not sent for an inactive style even if there has been activity against it. This may result in balancing issues between Planning and SL, IB, BI and MA. If master entities (header flags, descriptions, colors, sizes) are modified for an inactive style, the Pipeline segment will check whether the style exists in Planning and if it does, the modifications will flow through to Planning even if the style is inactive. If set to 1 (True), the Active flag is ignored. All styles and history are sent at all times. This ensures that Planning and Merch (SL, IB, MA, BI) are in balance.
No 1
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Segment 1010 - EDM & PROD to Merch Planning, Merch Entity 95
Scheduling RequirementsSegment 1010 generates and posts the b-tree and reorg files in the correct sequence. No batch jobs need to be run after this segment is run. Segment 26000 – Merchandising Planning Internal – Import History and Hierarchy, if used, must be run after this segment.
Database ParametersIn merch table parameter_pipeline: The parameter value for parameter id 2 Segment 1010 Startup Flag must be set to 0 if
the segment is running as startup to initially load all merch entities to Planning; it is set to 1 automatically once the startup run of the segment loads any Merch level successfully to Planning. If the parameter is set to 1, the segment only loads the updated entities based on CORE replication queue.
The parameter value for parameter id 3 Last processed plan_mlid_xref_id in segment 1010 is automatically updated by the segment; it indicates the last record in the plan_mlid_xref table in Merchandising database that was sent to a Planning interface file.
In Merchandising GUI/EDM/Parameters/Planning, the mapping between Merch levels and Planning levels must be set up properly before the segment runs.
Queue Segment Description The following third party software must be installed on the Pipeline application server
for the segment to run: MKS Toolkit: the rexec.exe needs to be copied to the folder specified by segment
parameter PathforMksrexec and renamed mks_rexec.exe. The segment requires the following Pipeline dll to be installed:
STSPLEDMPRODToMerPlan.dll The segment requires the following Merchandising dlls to be installed:
STSFCClient.dll STSFCServer.dll
Merch Planning, Merch Entity (Interface File) subscribes to the following entities and actions via this segment.
Entity Action Description
main location hierarchy group (153)
Insert (I) / Planning Update (LU)
If a main location hierarchy group belongs to the division level (i.e. the level specified by “Breakdown plan by” in EDM/ Parameters/Planning/Planning By Division), Pipeline retrieves the location hierarchy group from EDM and places it in a Planning interface file.
main merchandise hierarchy group (203)
Insert (I) / Planning Update (LU) / Delete (D)
If a main merchandise hierarchy group belongs to a level that is mapped to Planning, Pipeline retrieves the merchandise hierarchy group from PROD and places it in a Planning interface file.
style link to main merchandise (221)
Update (U) If a style is reclassified in the Main Merchandise Hierarchy in PROD, Pipeline places the reclassified style in the Planning reorganization file, so that Planning can reclassify the style by processing the reorganization file.
96 Segment Reference
TroubleshootingIf one of the following errors is encountered when the segment is running:
alternate merchandise hierarchy group (253)
Insert (I) / Planning Update (LU) / Delete (D)
When an alternate merch group is created, modified or deleted in PROD, if its hierarchy level is mapped to Planning, Pipeline places the creation, modification or deletion of the alternate hierarchy group in the Planning Btree file, so that Planning can create, modify or delete the alternate merch group.
style link to alternate merchandise hierarchy nodes (271)
Update (U) If a style is reclassified in an Alternate Merchandise Hierarchy in PROD, Pipeline places the reclassified style in the Planning reorganization file, so that Planning can reclassify the style by processing the reorganization file.
Insert (I) If a style is linked to an alternate hierarchy group in PROD, and if the style level is a child level of that alternate hierarchy in Planning, Pipeline will send the style's link to Planning.
style (301) Insert (I) / Planning Update (LU)
If the style level is mapped to Planning, Pipeline retrieves a style from PROD and places it in a Planning interface file.
Delete (D) Sends a record to Planning indicating that a style was deleted in Merchandising.
style color (311) Insert (I) / Planning Update (LU)
If the style color level is mapped to Planning, Pipeline retrieves a style color from PROD and places it in a Planning interface file.
Delete (D) Sends a record to Planning indicating that a style color was deleted in Merchandising.
attribute set for style (482)
Update (U) If a style attribute set exists in Planning, and the attribute set label is updated in Merchandising, Pipeline retrieves the new attribute set label and places it in a Planning interface file.
attribute set for merch group (484)
Update (U) If a merch group attribute set exists in Planning, and the attribute set label is updated in Merchandising, Pipeline retrieves the new attribute set label and places it in a Planning interface file.
attribute set for style color (490)
Update (U) If a style color attribute set exists in Planning, and the attribute set label is updated in Merchandising, Pipeline retrieves the new attribute set label and places it in a Planning interface file.
assigned style attribute set (512)
Insert (I) / Update (U) If a style attribute set assignment belongs to a style attribute that is mapped to Planning, Pipeline retrieves the style attribute set and places it in a Planning interface file.
assigned main merch hierarchy group attribute set (514)
Insert (I) / Update (U) If a main merch group attribute set assignment belongs to a merch group attribute that is mapped to Planning, Pipeline retrieves the merch group attribute set and places it in a Planning interface file.
assigned alternate merch hierarchy group attribute set (515)
Insert (I) / Update (U) If an alternate merch group attribute set assignment belongs to a merch group attribute that is mapped to Planning, Pipeline retrieves the merch group attribute set and places it in a Planning interface file.
assigned style color attribute set (520)
Insert (I) / Update (U) If a style color attribute set assignment belongs to a style color attribute that is mapped to Planning, Pipeline retrieves the style color attribute set and places it in a Planning interface file.
Entity Action Description
Segment 1010 - EDM & PROD to Merch Planning, Merch Entity 97
ODBC error: -2147217833: String or binary data would be truncated. The statement has been terminated orORA-01401: inserted value too large for column
The alias of an MLID is probably longer than 22 characters. Go to Merchandising EDM/Parameters/Planning/Levels and modify the mappings so that none of the aliases for mapped levels exceed 22 characters.Before the startup run of the segment, the Sent To Planning Flags of all levels in the Merchandising To Planning Mapping are set to False. During the startup run, after a level is successfully loaded into the worktable plan_mild_xref in Merch, the Sent To Planning Flag of that level is automatically set to True by the segment; if a level wasn’t loaded successfully, the Sent To Planning Flag of that level remains False, so that the next run of the segment will pick up this level and try to load it again.When the segment successfully retrieves a mapped level or an MLID of a mapped level, the data is first placed in the worktable plan_mild_xref. After the segment successfully runs or if it errors out, the post batch script of the segment is executed and the content of plan_mild_xref will be written to the Planning interface file. The segment keeps track of the last processed plan mlid xref ID in the parameter Pipeline table, so that the next run of the segment will only place new MLIDs in plan_mild_xref. If the segment fails to dump data from plan_mild_xref to file, the last processed plan mlid xref ID won’t be updated in the parameter Pipeline table, so that the next run of the segment will automatically try to post those records again.
When segment 1010 creates both a btree file and a reorg file, normally the btree file should be processed before the reorg file in Planning; however, this may cause an error in the following situation: If a user reclassifies a style in PROD, then changes the long or short description of the style and runs segment 1010 to generate the btree file and reorg file, the error Alias already exists for a different MLID could occur when processing the btree file. A workaround is: process the reorg file (which should be successful), and then reprocess the btree file, which should now be successful.Similarly, if a user changes the attribute set code on a style, style color or Merch group, then modifies the long or short description of the style, style color or Merch group, and runs segment 1010, the same error could occur when processing the btree file in Planning. The workaround described above applies in this case as well.
98 Segment Reference
Segment 1013 - EDM & PROD to Text FileThis segment sends master entities from the EDM & PROD live table to a text file. (See Mapping Document for this segment for file layouts.)
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ListCurrencyConversionChanges
List Currency Conversion Changes
Indicates whether currency conversion changes should be sent to a text file. The parameter must be set to F (false) or T (true).
Yes F
ListEmployeeAttributeSetChanges
List Employee Attribute Set Changes
Indicates whether employee attribute set changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListEmployeeChanges
List Employee Changes
Indicates whether employee changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListJurisdictionEquivalencyChanges
List Jurisdiction Equivalency Changes
Indicates whether jurisdiction equivalency changes should be sent to a text file. The parameter must be set to F (false) or T (true).
Yes F
ListJurisdictionTaxExceptionChanges
List Jurisdiction Tax Exception Changes
Indicates whether jurisdiction tax exception changes should be sent to a text file. The parameter must be set to F (false) or T (true).
Yes F
ListLocationAttributeSetChanges
List Location Attribute Set Changes
Indicates whether location attribute set changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListLocationChanges
List Location Changes
Indicates whether location changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListLocationCustomPropertyChanges
List Location Custom Property Changes
Indicates whether location custom property changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListMerchGroupAttributeSetChanges
List Merchandising Group Attribute Set Changes
Indicates whether merchandise group attribute set changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListMerchandiseGroupChanges
List Merchandise Group Changes
Indicates whether merchandise group changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListStyleAttributeSetChanges
List Style Attribute Set Changes
Indicates whether style attribute set changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListStyleChanges List Style Changes Indicates whether style changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListStyleColorChanges
List Style Color Changes
Indicates whether style color changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
Segment 1013 - EDM & PROD to Text File 99
Scheduling RequirementsNo info is available.
Database ParametersNone.
Queue Segment Description This segment requires the following dll to be installed:
STSPLEDMPRODExp.dll This segment sends master entities from the EDM & PROD live table to a text file (see
Mapping Document for this segment for file layouts).
ListStyleCustomPropertyChanges
List Style Custom Property Changes
Indicates whether style custom property changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListStyleRetailChanges
List Style Retail Changes
Indicates whether style retail changes should be sent to a text file. The parameter must be set to F (false) or T (true).
Yes F
ListVendorAttributeSetChanges
List Vendor Attribute Set Changes
Indicates whether vendor attribute set changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListVendorChanges List Vendor Changes Indicates whether vendor changes should be sent to a text file. The parameter must be set to F (false) or T (true).
No T
ListStyleColorDescChanges
List Style Color Description Changes
Indicates if Style Color Description Changes should be exported to text files. The parameter must be set to T (true) or F (false).
Yes T
ListStyleSizeDescChanges
List Style Size Description Changes
Indicates if Style Size Description Changes should be exported to text files. The parameter must be set to T (true) or F (false).
Yes T
ListMerchGroupDescChanges
List Merch Group Description Changes
Indicates if Merch Group Description Changes should be exported to text files. The parameter must be set to T (true) or F (false).
Yes T
ListStyleDescChanges
List Style Description Changes
Indicates if Style Description Changes should be exported to text files. The parameter must be set to T (true) or F (false).
Yes T
Path Path The directory where the output files are found.
No C:\NSB Interface\EDM & PROD To Text File
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
100 Segment Reference
The following entity actions are sent to text files (i.e., when a certain action occurs on an entity, for example, when a style is created, updated or deleted, its information is sent to text file):
Entity Action Description
Location (101) Insert (I) / Location Status Change (S)/ Update (U)
Main merchandise hierarchy group (203)
Insert (I)/ Update (U)/ Delete (D)
Style (301) Insert (I)/ Update (U)/ Delete (D)
Style color (311) Insert (I)/ Update (U)/ Delete (D)
UPC (361) Insert (I)/ Update (U)/ Delete (D)
Merchandise vendor (401) Insert (I)/ Update (U)/ Delete (D)
Assigned location attribute set (511)
Insert (I)/ Delete (D)
Assigned style attribute set (512)
Insert (I)/ Delete (D)
Assigned employee attribute set (513)
Insert (I)/ Delete (D)
Assigned main merchandising hierarchy group attribute set (514)
Insert (I)/ Delete (D)
Assigned merchandising vendor attribute set (518)
Insert (I)/ Delete (D)
Employee (601) Insert (I)/ Update (U)/ Delete (D)
Location cust property (621)
Insert (I)/ Update (U)/ Delete (D)
Style cust prop (622) Insert (I)/ Update (U)/ Delete (D)
Jurisdiction equivalency (556)
Insert (I)/ Update (U)/ Delete (D)
Retrieves information about a Jurisdiction equivalency exception from EDM and puts it in a text file.
Jurisdiction tax exception (559)
Insert (I) / Update (U) / Delete (D)
Retrieves information about a Jurisdiction Tax Exception from EDM and puts it in a text file.
Currency Conversion (72) Insert (I) / Update (U) / Delete (D)
Retrieves information about a Currency Conversion Rate from EDM and puts it in a text file.
Style Retail (316) Insert (I) / Update (U) / Delete (D)
Retrieves information about a Style Retail from PROD and puts it in a text file
Style Color Description (325)
Insert (I) / Update (U) / Delete (D)
Retrieves information about a Style Color Description from PROD and puts it in a text file
Style Size Description (326)
Insert (I) / Update (U) / Delete (D)
Retrieves information about a Style Size Description from PROD and puts it in a text file
Segment 1013 - EDM & PROD to Text File 101
TroubleshootingNo troubleshooting information is currently available for this segment.
Merch Group Description (272)
Insert (I) / Update (U) / Delete (D)
Retrieves information about a Merch Group Description from PROD and puts it in a text file
Style Description (310) Insert (I) / Update (U) / Delete (D)
Retrieves information about a Style Description from PROD and puts it in a text file
Entity Action Description
102 Segment Reference
Segment 1015 - EDM & PROD To Sourcing This segment sends master entities from EDM & PROD to Sourcing.
Segment ParametersNone.
Scheduling RequirementsThis job must be run regularly throughout the day.
Database ParametersNone
Queue Segment DescriptionThe segment requires the following Pipeline dll to be installed. STSPLEDMPRODToSrc.dll STSPLBase.dll
Entity Action Description
Calendar Year - (41) Insert (I) Insert a calendar year
Delete(D) Delete a calendar year
Color - (61) Insert (I) Insert a Color
Update(U) Update a Color
Main Merch Hierarchy Level - (202)
Insert (I) Insert a merchandise hierarchy level
Update(U) Update a merchandise hierarchy level
Delete(D) Delete a merchandise hierarchy level
Main Merch Hierarchy Group - (203)
Insert (I) Insert a merchandise hierarchy group
Update(U) Update a merchandise hierarchy group
Delete(D) Delete a merchandise hierarchy group
Style Link To Main Merch Group Hierarchy – (221)
Update(U) Update a style link to Main merchandise group hierarchy (style reclassification)
Style – (301) Insert (I) Acknowledge that a Style has been created
Delete (D) Style deletes are sent to Sourcing via class object STSPLEDMPRODToSrc.STSPLStyle
Style Retail - (316) Update(U) Update a Style Retail
Style Color Retail – (317) Insert (I) Insert a Style/Color Retail
Update(U) Update a Style/Color Retail
Delete(D) Delete a Style/Color Retail
Size Grid Cell - (334) Insert (I) Insert a Size Grid Cell
Delete(D) Delete a Size Grid Cell
Style Attribute - (452) Insert (I) Insert a Style Attribute
Segment 1015 - EDM & PROD To Sourcing 103
TroubleshootingNone available at this time.
Update(U) Update a Style Attribute
Delete(D) Delete a Style Attribute
PO Attribute - (457) Insert (I) Insert a PO Attribute
Update(U) Update a PO Attribute
Delete(D) Delete a PO Attribute
Attribute Set for style – (482) Insert (I) Insert a Style Attribute Set
Update(U) Update a Style Attribute Set
Delete(D) Delete a Style Attribute Set
PO Attribute Set – (487) Insert (I) Insert a PO Attribute Set
Update(U) Update a PO Attribute Set
Delete(D) Delete a PO Attribute Set
Custom Property – (620) Insert (I) Insert a Custom Property
Update(U) Update a Custom Property
Delete(D) Delete a Custom Property
Season - (681) Insert (I) Insert a Season
Update(U) Update a Season
Delete(D) Delete a Season
Entity Action Description
104 Segment Reference
Segment 1023 - EDM & PROD Location Attributes to PlanningThis segment replicates location attributes whose Send to planning flag is set to true, to Planning.
Segment Parameters
Scheduling RequirementsThis segment must be run after segment 1009.
Database ParametersNone.
Queue Segment Description The segment require the following Pipeline dlls to be installed.
STSPLEDMPRODToPlanning.dll
Planning subscribes to the following entities and actions via this segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
AttBaseName Attribute File Base Name
Specifies the directory where the attribute file is sent
No Attrans
AttBatchSize Attribute Batch Size
Specifies the number of store attribute set assignments that can be written to file in one transaction
No 2000
AttPath Attribute File Path
Specifies the directory where the attribute file is sent
No C:\Planning311\Batch
InProgPath In Progress Path Specifies the directory where the Planning interface files are built
No C:\NSB Interface\EDM & PROD To Merch Planning, Loc Att\
Entity Action Description
Location Attribute (451)
Planning Activate (LA) Sends the attribute ID to Planning when a location attribute is created that is mandatory and whose Send to Planning flag is set to true, provided at least one location exists in the system and locations are auto-assigned to the attribute.
Planning Delete (LD) Sends the deletion of the Attribute Code and Attribute Label to Planning when the Send to Planning flag is changed from true to false.
Planning Insert (LI) Sends the attribute ID to Planning for the first store that is assigned to the new attribute (i.e. FABRIC).
Planning Update (LU) Sends the attribute ID to Planning when a location attribute is modified if the Send To Planning flag is set to true and if there's at least one store that is assigned to the attribute.
Segment 1023 - EDM & PROD Location Attributes to Planning 105
Attribute Set for Location (481)
Planning Delete (LD) Sends the deletion of the attribute set ID to Planning when the Send to Planning flag is changed from true to false on the attribute. Sends the deletion of attribute code, attribute set code, attribute set label and sequence numbers to Planning: when a location attribute is deleted if the Send to
Planning flag is set to true and at least one store is assigned to the attribute.
when a store is removed from an attribute/attribute set (in Merchandising this means the attribute and attribute set are removed from the location) if the Send to Planning flag is set to true, and there are no more stores assigned to the attribute set.
when a store is switched from one attribute (e.g. COORD) to another attribute (e.g. FABRIC), if the Send to Planning flag is set to true, and there are no more stores assigned to the old attribute set (COORD).
when a store is switched from one attribute set (e.g. A) to another attribute set (e.g. B) of the same attribute, and there are no more stores assigned to A.
Planning Insert (LI) ends the attribute set ID to Planning when: A location attribute is created that is mandatory and
whose Send to Planning flag set to true, provided that at least one location exists in the system and locations are auto-assigned to the attribute.
The Send to Planning flag of a location attribute set is changed from false to true, if there is at least one store attached to the attribute set.
A location attribute/attribute set is attached to a store in EDM where the Send to Planning flag of the attribute is set to true, and this is the first store assigned to the attribute set.
A store is switched from one attribute (e.g. COORD) to another attribute (e.g. FABRIC) in EDM, and the Send to Planning flag of the new attribute (FABRIC) is true.
Planning Insert (LI) (cont’d) When a store is switched from one attribute set (e.g. A) to another attribute set (e.g. B) within the same attribute in EDM, if the Send to Planning flag of the attribute set is set to true, and this is the first store assigned to the new attribute set (B), the attribute set ID for B is sent to planning.Sends old attribute, old attribute set code, old attribute set label, old sequence number when: A store is switched from one attribute (e.g. COORD) to
another attribute (e.g. FABRIC) in EDM, if no stores are still assigned to the old attribute set on COORD, and if the Send to Planning flag of the old attribute (COORD) is set to true.
Entity Action Description
106 Segment Reference
TroubleshootingNone available at this time.
Planning Update (LU) Sends attribute set ID to Planning when: a location attribute set is modified where the Send to
Planning flag of the attribute is set to true, if there's at least one store assigned to the attribute set.
Assigned Location Attribute Set (511)
Planning Delete (LD) Sends deletion of attribute code, attribute set code, location code when: the Send to Planning flag of a location attribute is
changed from true to false, if at least one store is assigned to the attribute.
a location attribute is deleted if the Send to Planning flag is set to true, and at least one store that is assigned to the attribute.
a store is removed from an attribute/attribute set (in Merchandising this means the attribute and attribute set are removed from the location) if the Send to Planning flag of the attribute is set to true.
Sends old attribute code, old attribute label when: a store is switched from one attribute (e.g. COORD) to
another attribute (e.g. FABRIC) in EDM, and the Send to Planning flag of the old attribute (COORD) is set to true.
Planning Insert (LI) Sends attribute set ID when: a location attribute/attribute set is attached to a store
in EDM if the Send to Planning flag of the attribute is set to true.
Planning Update (LU) Sends attribute set ID when: a store is switched from one attribute set (e.g. A) to
another attribute set (e.g. B) within the same attribute in EDM, if the Send to Planning flag of the attribute is set to true.
Entity Action Description
Segment 1030 - EDM & PROD to MA & SL 107
Segment 1030 - EDM & PROD to MA & SLStyle reclassification enables you to move a style from its present merchandising lowest level merchandise group to another lowest level merchandise group within the same merchandise hierarchy. When a style reclassification occurs in Merchandising, this segment reassigns styles to their new lowest level merchandise groups in Merchandising Analytics (MA) and Stock Ledger (SL) and moves the associated style history in MA. It also writes the associated style history to intermediate tables for posting to Stock Ledger.
When you initiate a style reclassification operation, the Merchandising application publishes a row into the core_replication_queue table with the entity_ID, style_ID, entity_code 302, replication_action Insert and replication_data with the old lowest level merchandise group that the style belonged to and the new lowest level merchandise group. A system parameter determines whether to move all history or just current history (beginning with the current day) to the new merchandise group of the style. Reclassification will not be performed for modules that are not installed (determined by system parameters). The system parameters are set in the Merchandising application at the time of installation and saved in the parameter_system table.
Segment Parameters
Scheduling Requirements This segment updates the style’s hierarchy group in Merch, MA and SL and it moves
the applicable history in MA. A style is only reclassified in PROD once this segment is run.
When styles are reclassified in PROD to new merchandise groups - that is, when merchandise groups are created as part of the reclassification - Segment 1005 (EDM/PROD to MA) updates MA with new merchandise hierarchy group. Therefore, Segment 1005 must be run before Segment 1030 - EDM/PROD to MA and SL.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
preSegmentsCheck Mutually Exclusive Segments
This segment parameter is used to prevent segment 1030 from running at the same time as IB to MA and IB to SL segments, in order to protect data integrity.
No 5005 + (1000000 * (@company - 1)), 5006 + (1000000 * (@company - 1)), 5007 + (1000000 * (@company - 1))
FoundConnectString
Foundation Database Connection String
The OLE DB Connection String used to connect to the Foundation database.
Note: The value of this parameter must match the string value of the registry key FoundationConnectStr at [HKEY_LOCAL_NACHBUE\SOFTWARE\STSSystems\STSSecurity\Databases] on the Pipeline Application server.
No
108 Segment Reference
When a style is reclassified in PROD, this segment is run to update the style’s hierarchy group in Merchandising, MA and SL, and to update MA history. Segment 1030 must be run before the following segments which ensure that the corresponding changes are made to their associated applications: Segment 5006 (Post IB to SL) - Gets the style’s history that is to be moved from
the intermediate tables to which it was written by Segment 1030 and updates SL with the moved history
Segment 1003 (EDM/PROD to SA)- updates SA style with new hierarchy group information
Segment 1004 (EDM/PROD to CIM) - updates Customer Information Management with new hierarchy group information
Segment 1000 (EDM/PROD to WM) - updates WM style with new hierarchy group information
Segment 1015 (EDM/PROD to Sourcing) - updates Sourcing styles with new hierarchy group information
Segment 1010 (EDM/PROD to Merch Planning) - updates Planning styles with new hierarchy group and rolls up history
Depending on the number of styles that are pending reclassification and the volume of history, on hand, and on order figures that will be affected by the reclassifications, this segment can be resource intensive and may run for an extended period of time. It should therefore be scheduled when there are as few users on the system as possible. Although there are no restrictions other than those mentioned above, we recommend that a separate job be scheduled on the weekend to handle the reclassifications. This job could include all of the segments listed above that update the other installed merchandising modules to ensure that changes are applied to them in a timely manner.
Database ParametersIn the Merchandising database: Table parameter_system
installed_envue_flag installed_sl_flag reclass_adj_trans_reason_ID ma_reclass_history_to_move
In the MA database: Table post_parameter
parameter_ID: 29-32, 35-36, 40-41, 69-70The parameter values of these IDs contain the ID (from ib_inventory) that was last processed with IB to MA segments.
In the Pipeline Repository: Table last_queue_item
This table contains the entry of the last core_replication_queue_ID that was processed during the last run of this segment. If it is the first time this segment is being run, the value of the last_squence_ID for this segment_ID must be set to 0.
Database RequirementsIn the MA database Table post_sql
Segment 1030 - EDM & PROD to MA & SL 109
Posting steps 1805-1809 have the commands to execute each of the stored procedures depending on the type of database.
Stored Procedures reclass_hist_$sp reclass_hist_cmp_$sp reclass_hist_flsh_$sp reclass_hist_oh_$sp reclass_oo_all_$sp
Queue Segment DescriptionA synchronization locking mechanism is applied on the segment, so that this segment only runs if the A&R service that posts Lost and Extra sales to MA is not in progress.MA and SL subscribe to the following entity and action via this segment.
Troubleshooting
Entity Action Description
Style Reclass (302) Insert (I)
Error Reason
-2147220504 - Last ID's do not match in post_parameter table in MA
-2147220503 - Segment Parameter is empty or invalid
-2147220502 - CRQ Table has invalid data
-2147220501 - Transaction Failed
The following errors may also occur while this segment is running:
ERROR: Process terminated due to data inconsistency. Parameter values in post_parameter table in MA, for parameter_ID <1> and <2> do not match
This error indicates that Last IDs do not match in the post_parameter table in MA.
ERROR: There are no rows in style_group table in MA/Merchandising for hierarchy_group_ID : <1> and style_ID :<2>
The old class (the hierarchy_group of the old class) must exist in the style_group table in both MA and Merchandising.
ERROR: System parameter reclass_adj_trans_reason_ID is invalid. The value must be a valid transaction reason ID. Cannot proceed.
The value from parameter_system table for reclass_adj_trans_reason_ID is either null or not numeric.
ERROR: System parameter ma_reclass_history_to_move is invalid. The value must be a valid either 1 or 2, Cannot proceed.
The value from parameter_system table for ma_reclass_history_to_move is either null or not numeric.
ERROR: There are no rows in gl_period table that is date_closed is null.
110 Segment Reference
Segment 1031 - EDM & PROD Internal - System Delete StylesThis segment deletes all styles in PROD whose 'to be deleted' date is earlier than the current system date.
Segment Parameters
Scheduling Requirements This segment allows styles flagged for deletion to be deleted as part of an unattended
task. Depending on the number of styles to be deleted, the segment may run for an extended period of time, and can be resource intensive. Although there are no restrictions on when the segment can be run, in case there are many styles to be deleted, we recommend that a separate job be scheduled on the weekend to handle style housekeeping.
Style deletions are replicated to Merchandising Analytics (MA) by segments “EDM & PROD to MA” and “MA Internal – Housekeeping”, to Sales Audit (SA) by segments “EDM & PROD to Sales Audit”, and to Customer Information Management (CIM) by segment “EDM & PROD to Customer Info Mgmt”. segment "EDM & PROD Internal - System Delete Styles" should thus be scheduled to run before these segments if the changes are to take effect in MA, SA, and CIM. These segments can be scheduled in the same job.
Database ParametersNone.
Non-queue Segment Description The segment calls the Execute method on the Merchandising scheduled task
controller. Merchandising scheduled task controller invokes the Merchandising component
specified by the segment parameter ‘TASKPROGID’ (i.e., “STSPRODScheduledTask.STSPRODStyleDelete”), which cleans up the to-be-deleted styles.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Application ID Value specified is used by the segment for security purposes.
No 100
CompanyID Company ID Value specified is used by the segment for connectivity purposes to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Task ProgID Indicates (to the process that runs scheduled tasks) that the system deletion of styles must be performed.
No STSPRODScheduledTask.STSPRODStyleDelete
Segment 1031 - EDM & PROD Internal - System Delete Styles 111
Troubleshooting If any errors occur when the Merchandising business object cleans up the styles, an
error log will be generated: The error logs of this segment are found in the path specified in
HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog of the registry
The error log name is PRODScheduledTaskErrors_yyyymmdd.log (where yyyymmdd is a timestamp)
Segment failure without an error log indicates a setup problem.
112 Segment Reference
Segment 1032 - EDM & PROD To Offline IM FileThis segment sends EDM & PROD entities (from EDM & PROD) and Price Change documents (from PCM) to interface files for INS stores (see Mapping Document for this segment for file layouts).
This segment supports multi-jurisdictions so that stores can belong to different sales jurisdictions. Therefore, EDM and PROD data sent from this segment to the Offline IM Triversity stores can be different for each jurisdiction, that is, stores in different jurisdictions can receive different interface files.
Segment Parameters
Scheduling RequirementsNo info. is available.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ClassLevelId Class Level ID Hierarchy level ID for class. Yes
DeptLevelId Department Level ID
Hierarchy level ID for department. Yes
FileAccessTimeOut File Access Time Out
The maximum amount of time in seconds that the segment will wait to have access to a store's interface file before rejecting the transaction.
No 1800
FileName Interface File Name
An identifier used to create the name of the file in which EDM & PROD data are deposited for Offline IM systems. Must be different than the identifier used to create the name of the file(s) in which data from other modules is deposited. Must not exceed 56 characters in length.
No EDM&PROD
NbLevelsBetweenClsDpt
Number Of Levels Between Class and Department
Number of levels between class and department.
Yes
PMFileName Interface File Name For Price Change Document
An identifier used to create the name of the file in which Price Change documents are deposited for Offline IM systems. Must be different than the identifier used to create the name of the file(s) in which data from other modules is deposited. Must not exceed 56 characters in length.
No PC
Path Interface File Directory
The directory in which the interface files containing IM transactions for Offline IM systems are built. The directory must be different than the directory in which data from other modules is deposited. Each company must also have it's own directory for the module.
No C:\NSB Interface\EDM & PROD to Offline IM File\In Progress
Segment 1032 - EDM & PROD To Offline IM File 113
Database ParametersNone.
Queue Segment DescriptionThe following pipeline components must be installed: STSPLEDMPRODToOIMFile.dll STSPLPMToOIMFile.dll STSPLINS.dllThe following document actions are sent to INS interface files (i.e., when a certain action occurs on an entity. For example, when a style is created or deleted, its information is sent to the INS interface file.):
Entity Action Description
Color (61) Insert (I) / Delete (D)
POS Update (PU) A POS Update occurs on a color when a color’s long description or short description is modified.
Location (101) POS Insert (PI) A POS Insert occurs on a location when: the location status is changed from Closed to not Closed and the
location’s Offline IM flag is on. the location is created (the location status is not Closed).
POS Update (PU) A POS Update occurs on a location when: an OIM address is added to the location whose status is not Closed. an OIM address is modified for the location whose status is not Closed. an OIM address is deleted from the location whose status is not Closed. an OIM contact is added to the location whose status is not Closed. an OIM contact is modified for the location whose status is not Closed. an OIM contact is deleted to the location whose status is not Closed.
POS Delete (PD) A POS Delete occurs on a location when: the Offline IM flag is changed from on to off (location status is not Closed
and the register type is INS). the location status is changed from not Closed to Closed.
Main merchandise hierarchy group (203)
Insert (I) / Update (U) / Delete (D)
Only hierarchy groups at the class level (specified by the segment parameter ‘ClassLevelId’) and the department level (specified by the segment parameter ‘DeptLevelId) are sent to the INS interface file.
Style links to main merchandise (221)
Update (U) Information on a Style and its Merch Group are retrieved from EDM & PROD and placed in an interface file for Offline IM Triversity stores. Compare At Retail (List Retail in POS) and the Primary Vendor Cost value (Current Cost in POS) for the same style can be different for stores in different jurisdictions. If the multi sales jurisdiction flag is set to true, a style can have multiple style retails – one style retail per sales jurisdiction. The stores in jurisdiction A only receive the Compare At Retails for jurisdiction A; the Style Current Costs sent to the stores in jurisdiction A are converted to the currency of jurisdiction A.
114 Segment Reference
TroubleshootingNo troubleshooting information is currently available for this segment.
Style (301) Insert (I) / POS Update (PU)
Information on a Style is retrieved from EDM & PROD and placed in an interface file for Offline IM Triversity stores. The Compare At Retail (List Retail in POS) and the Primary Vendor Cost value (Current Cost in POS) for the same style can be different for stores in different jurisdictions. If the multi sales jurisdiction flag is set to true, a style can have multiple style retails – one style retail per sales jurisdiction. The stores in jurisdiction A only receive the Compare At Retails for jurisdiction A; the Style Current Costs sent to the stores in jurisdiction A are converted to the currency of jurisdiction A. A style POS Update occurs when a style’s short description or PLU description is modified.
Delete (D)
Style size (321) Insert (I)
Size master (331) Update (U)
UPC (361) Insert (I) / Update (U) / Delete (D)
For a UPC Update, unlike all the other entities, a UPC Delete and a UPC Add are sent to the interface file.
Merchandise vendor (401)
POS Insert (PI) / POS Delete (PD)
Vendor POS Insert occurs at the same time as vendor Insert. Vendor POS Delete occurs at the same time as vendor Delete.
POS Update (PU) Vendor POS Update occurs when an Offline IM address is modified for the vendor. (An Offline IM address is the vendor address whose address type matches the IM Parameter “Vendor Return Address Type” or the vendor address of type Main if an address whose address type matches the IM Parameter “Vendor Return Address Type” doesn’t exist on the vendor.)
Price change (931) Insert (I) / Update (U) / Cancel (C)
The price change is sent to the INS interface file only if at least 1 of the price change locations is an INS store that uses offline stock.
Style Retail (316) Insert (I) / Update (U)
Information on a Style Retail is retrieved from EDM & PROD and placed in a interface file for the Offline IM Triversity stores that belong to the same jurisdiction as this Style Retail. The Compare At Retail (List Retail in POS) and the Primary Vendor Cost Value (Current Cost in POS) for the same style can be different for stores in different jurisdictions. If the multi sales jurisdiction flag is set to true, a style can have multiple style retails – one style retail per sales jurisdiction. The stores in jurisdiction A only receive the compare at retails for jurisdiction A; Style Current Costs sent to the stores in jurisdiction A are converted to the currency of jurisdiction A.
Entity Action Description
Segment 1033 - EDM & PROD To Offline IM File, Master Data 115
Segment 1033 - EDM & PROD To Offline IM File, Master DataThis segment creates an Interface file that contains an extract of the Merchandising data required by the Storeworks application (NOI) running at a “disconnected” store. The file created contains information about locations, vendors, departments, classes, colors, sizes, UPCs, styles and style sizes.
Note: This segment is only executed if the location is running a Triversity register.
Segment Parameters
Scheduling RequirementsThis segment should be configured as part of a scheduled job that includes the following segments: Segment 53002 – Offline IM to IM, Outbound Transfers Segment 3012 – IM To Offline IM File Segment 58003 – Offline IM File Internal - Prepare IM Files Segment 2000 – POM To Offline IM File Segment 58002 – Offline IM File Internal - Prepare POM Files
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Interface File Directory
The directory in which the interface files containing EDM & PROD entities for Offline IM systems are built. The directory must be different than that in which data from other modules is deposited. Each company must also have its own directory for the module.
No C:\NSB Interface\EDM & PROD to Offline IM File\In Progress
FileName Interface File Name
Identifier used to create the name of the file in which EDM & PROD entities are deposited for Offline IM systems. This name should be the value defined here. (Due to BSC polling restrictions, this name is not user-defined.)
No Descriptor
ClassLevelId Class Level Identifier specifying the class level from the merchandise hierarchy. Should be updated according to the specific client configuration.
No 0
DeptLevelId Department Level
Identifier specifying department level from the merchandise hierarchy. Should be updated according to the specific client configuration.
No 0
LevelBetweenClass
Number Of levels between class and department
Number of levels between the class and department levels in the merchandise location hierarchy. Should be updated according to the specific client configuration.
No 1
BatchSize Batch Size Batch size to use when selecting UPC, Style and Style Size by database trip.
Yes 5000
FileAccessTimeOut File Access Time Out
The maximum amount of time in seconds that the segment will wait to have access to a store's interface file before rejecting the transaction.
Yes 1800
116 Segment Reference
Segment 1006 – EDM & PROD to PLU Segment 1032 – EDM & PROD to Offline IM File Segment 1033 – EDM & PROD to Offline IM File, Master Data Segment 58001 – Offline IM File Internal - Prepare EDM & PROD Files Segment 58007 – Offline IM File Internal - Prepare Descriptor Files Segment 58008 – Offline IM File Internal - Submit Descriptor Files Segment 58004 – Offline IM File Internal - Submit EDM & PROD Files Segment 58005 – Offline IM File Internal - Submit POM Files Segment 58006 – Offline IM File Internal - Submit IM Files
Database ParametersNone.
Queue Segment DescriptionThe following Pipeline component must be installed:
STSPLToOIMMasterData.dll
The system parameter_price_lookup.uses_ftp_flag determines the type of Polling application that will be used to download the files to the INS store. If the value is True (1), BSC Polling will be used to download the files. When BSC Polling is used, the file name will include the location polling reference
formatted as follows: 1550Descriptor.cpm where 1550 is a 4 digit number representing the polling reference to use for the specific location.
If the value is False (0), NT Polling will be used to download the files. The information is written in the default system language and the store currency. The address that is part of the location information corresponds to the
address_type_ID passed in by the Pipeline engine. The vendor name comes from the vendor table not from the address table as is the
case for Segment 1032 EDM & PROD To Offline IM File. A log file is created in the same directory as the one used to store the interface file
(segment parameter: Path). This file is named Descriptor.log and it allows the user to see all the steps performed along with timing information and the number of rows
Entity Action Description
Location (101) MD The Location MD is published in the following cases: Store Use OIM Flag changed from off to on; location status is not Closed. The location status is changed from Closed to not closed and the OIM flag is
turned on. The location register type is changed from any other type to NSB Register
(location status is not Closed and OIM Flag is turned ON). A location is created (the OIM Flag Is ON and the status is not Closed).
Location (101) MD Stores that belong to the same jurisdiction as this Style Retail. The Compare At Retail (List Retail in POS) and the Primary Vendor Cost Value (Current Cost in POS) for the same style can be different for stores in different jurisdictions. If the multi sales jurisdiction flag is set to true, a style can have multiple style retails – one style retail per sales jurisdiction. The stores in jurisdiction A only receive the compare at retails for jurisdiction A; the Style Current Costs sent to the stores in jurisdiction A are converted to the currency of jurisdiction A.
Segment 1033 - EDM & PROD To Offline IM File, Master Data 117
written, by entity. The following is an example of the content of the log file after the segment finishes: Writing master data for location: 0063, language used is: 'English - United States' and the location currency is United States Dollar.Starting at time : 3-2-2004 10:17:00 AMLocation written: 401 rows.Vendor written: 159 rows.Department written: 24 rows.Class written: 67 rows.Color written: 82 rows.Size written: 1023 rows.UPC written: 47272 rows.Style written: 14183 rows.Style Size written: 41056 rows.end time : 3-2-2004 10:17:23 AM
TroubleshootingNo troubleshooting information is currently available for this segment.
118 Segment Reference
Segment 1034 - EDM & PROD To Offline IM File, StartupThis segment creates an Interface file containing an extract of the EDM & PROD data required by the Storeworks application (NOI) in order to be compatible with Merchandising. The file created contains information about location, vendor, department, class, color, size, UPC, style and style size. (Information on the format of the file can be found in the mapping document.)
This segment supports multi-jurisdictions so that stores can belong to different sales jurisdictions. Therefore, EDM and PROD data sent from this segment to the Offline IM Triversity stores can be different for each jurisdiction, that is, stores in different jurisdictions can receive different interface files.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Interface File Directory
The directory in which the interface files containing EDM & PROD entities for Offline IM systems are built. The directory must be different than that in which data from other modules is deposited. Each company must also have its own directory for the module.
Yes C:\NSB Interface\EDM & PROD to Offline IM File\In Progress
FileName File Name An identifier used to create the name of the file in which EDM & PROD entities are deposited for Offline IM systems. Should be the value set here. Due to restrictions related to BSC polling, this name is not user-defined.
Yes Descriptor
ClassLevelId Class Level Id An identifier that specifies the class level from the merchandise hierarchy. Should be updated according to the specific client configuration.
Yes 0
DeptLevelId Department Level Id
An identifier that specifies the department level from the merchandise hierarchy. Should be updated according to the specific client configuration.
Yes 0
LevelBetweenClass Number Of levels between class and department
Number of levels between the class and department levels in the merchandise location hierarchy. Should be updated according to the specific client configuration.
Yes 1
BatchSize Batch Size Batch size to use when selecting UPC, Style and Style Size by database trip.
Yes 5000
NTPollingPath NT Polling Path The directory in which the Descriptor interface file submitted for NT polling to Offline IM systems is placed.
Yes C:\NSB Interface\EDM & PROD to Offline IM File\Polling
Segment 1034 - EDM & PROD To Offline IM File, Startup 119
Scheduling RequirementsThis segment should be run when performing the startup for stores running Triversity cash registers. The segment should run before any of the following segments: 1032 - EDM & PROD to Offline IM File 1033 - EDM & PROD to Offline IM File, Master Data 3012 - IM To Offline IM File 2000 - POM To Offline IM File
UnixServer Unix Server Server where the BSC Polling application is installed. Should be updated according to the specific client configuration.
Yes Commrd
UnixUserName Unix User Name Valid user name to the Unix server. Should be updated according to the specific client configuration.
Yes root
UnixPassword Unix Password A valid password associated with the Unix user name. Should be updated according to the specific client configuration.
Yes System
PCDirectory PC Directory Directory on the PC where the files will be downloaded at the store. Should be updated according to the specific client configuration.
Yes c:\STS\in\
BSCPollingPath BSC Polling Path
Base Unix Path where all the polling reference directories (one per location) will be added. These location directories will receive all the control files and data files that will be downloaded to a store. Should be updated according to the specific client configuration. The name of this path must follow the Unix convention: that is, it must use root (“/”) instead of back-slash (“\”). Unix file names are also case-sensitive. This path should be limited to 20 characters or less.
Yes /SYSRES/plmsc/script
IsSendingFileManually
Is Sending File Manually
If the file will be downloaded manually to the store, the value should be set to 1 (yes), otherwise the value should be 0 (no). Should be updated according to the specific client configuration.
Yes 0
ManualPath Manual Path Name
Used to specify the directory of the Interface file when startup file is sent manually to INS stores. Should be updated according to the specific client configuration.
Yes C:\NSB Interface\EDM & PROD to Offline IM File\Manual
FileAccessTimeOut File Access Time Out
The maximum amount of time in seconds that the segment will wait to have access to a store's interface file before rejecting the transaction.
Yes 1800
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
120 Segment Reference
Database ParametersNone.
Non-queue Segment Description The following Pipeline component must be installed:
STSPLToOIMMasterData.dll At the beginning of the process the segment reads the value of the maximum
core_replication_queue_ID from the merchandising core_replication_queue. After creating the files, it sets the last sequence ID of segment 1032 and segment 1033 to this value. This allows INS stores to receive all the modifications for the entities they are interested in.
The information will be written in the default system language and the store currency. If a default address is defined for a location, this information will be used. Otherwise,
the Main address will be used. The vendor name comes from the Vendor table not from the Address table as is the
case for Segment 1032 EDM & PROD To Offline IM File. The system parameter_price_lookup.uses_ftp_flag determines the type of polling
application that will be used to download the files to the INS store. If the value is True (1), BSC Polling will be used to download the files. When BSC Polling is used, the file name will include the location polling reference
formatted this way: 1550Descriptor.cpm where 1550 is a 4-digit number representing the polling reference to use for the specific location.
If the value is False (0), NT Polling will be used to download the files. Once the file is complete, a copy is made for all the locations that satisfy the following
criteria: location is flagged as using Offline IM location runs Triversity cash registers the location status is not Closed
The files are moved to the directory specified in the segment parameter corresponding to the type of polling application used by the client.
If the parameter IsSendingFileManually is activated, files will not be sent to the location(s) immediately. The files can be prepared and then downloaded to the location(s) at a later time or the files can be put on a CD and mailed to the location(s) etc.
A log file is created in the same directory as the one used to create the interface file (segment parameter: Path). This file is named Descriptor.log and it allows the user to see all the steps performed along with timing information and the number of rows written, by entity. The following is an example of the content of the log file after the segment finishes: Writing descriptor: language used is: 'English - United States' , currency is: 'United States Dollar'.Starting at time : 3-2-2004 10:29:45 AMDefault address transfer type ID: 1Maximum core_replication_queue_ID: 381490Color written: 82 rows.Size written: 1023 rows.Vendor written: 159 rows.Department written: 24 rows.
Segment 1034 - EDM & PROD To Offline IM File, Startup 121
Class written: 67 rows.Location written: 401 rows.Style written: 14183 rows.StyleSize written: 41056 rows.UPC written: 47272 rows.Interface File copied successfully for store 0520Interface File copied successfully for store 0530Interface File copied successfully for store 0540Interface File copied successfully for store 1550In progress file deleted: C:\NSB Interface\EDM & PROD to Offline IM File, Startup\In Progress\Descriptor_InProgress.cpmLast Sequence ID of Segment '1032 - EDM & PROD to Offline IM File' updated.Last Sequence ID of Segment '1033 - EDM & PROD to Offline IM File, Master Data' updated.End time : 3-2-2004 10:30:23 AM
Master entity data required by Triversity stores that use Offline IM (i.e. color, vendor, department, class, store, style, style size and UPC) is retrieved from EDM & PROD and placed in the interface files for the Triversity stores that use Offline IM. The Compare At Retail (List Retail in POS) and the Primary Vendor Cost value (Current Cost in POS) for the same style can be different for stores in different jurisdictions. If the multi sales jurisdiction flag is set to true, a style can have multiple style retails – one style retail per sales jurisdiction. The stores in jurisdiction A only receive the Compare At Retails for jurisdiction A; the Style Current Costs sent to the stores in jurisdiction A are converted to the currency of jurisdiction A.
TroubleshootingNo troubleshooting information is currently available for this segment.
122 Segment Reference
Segment 1035 - EDM & PROD Internal – Make Jurisdiction Available
This segment is created in Merch 4.0. It calls a Merchandising scheduled task component to update all the “Sales” or “Sales and Sourcing” jurisdictions in EDM that are of status Pending Available to become status Available.
Segment Parameters
Scheduling RequirementsNone
Database ParametersNone
Non-Queue Segment Description No pipeline dlls are required for this segment This segment calls the Execute method of the Merchandising scheduled task
controller, which invokes the Merchandising scheduled task component “STSPRODScheduledTask.STSPRODJurisdictionMakeAvailable”
The Component “STSPRODScheduledTask.STSPRODJurisdictionMakeAvailable” does the following work: It finds all the “Sales” or “Sales and Sourcing” jurisdictions in EDM that are of
status Pending Available. For each of these jurisdictions, it adds a style retail to all the styles that have an
original selling retail for the home jurisdiction. It changes these jurisdictions to status Available.
Troubleshooting If any errors occur during the execution of this segment, an error log will be generated
at the path specified by HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog in the registry of the pipeline machine.
The error file name should be PRODScheduledTaskErrors_YYYYMMDD.log (YYYYMMDD is a timestamp)
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
APPLICATIONID Application ID Value specified is used by the segment for security purposes
No 100
COMPANYID Company ID Value specified is used by the segment to determine what company the segment should access.
No 1
TASKPROGID Task ProgID Indicates to the common process that runs scheduled tasks that the newly-created jurisdictions must be made available.
No STSPRODScheduledTask.STSPRODJurisdictionMakeAvailable
Segment 1038 - EDM & PROD to Price Look-up File Generate (CRS) 123
Segment 1038 - EDM & PROD to Price Look-up File Generate (CRS)
This segment generates PLU files for CRS stores. It may be run in conjunction with Segments 1006 and 1536 so that PLU can be generated for different store types (e.g. some stores have CRS registers and some have Coalition), however it cannot be run in parallel with Segments 1006 or 1536.Segment 1038 is a non-queued segment, so should any error occur, it can be rerun. When rerun, all the previously generated PLU files will be regenerated and data is appended to any existing PLU.CHG files. If the previously generated files have not been removed, they will be appended to, duplicating the data they contain.
Segment Parameters
Scheduling RequirementsSegment 1038 cannot be run in parallel with Segments 1006 or 1536.
Database Parameters
Note: The database parameters are not accessible from the Pipeline Administrator application. They are accessible from the Epicor Retail Merchandising solution, Enterprise Data Management component, PLU Parameters dialog.
Parameter Name
DescriptionModifiable with Pipeline Admin.
Default Value
Mutually Exclusive Segments
To ensure data integrity, prevents segment 1038 from running if segment 1006 or 1536 is already running.
No 1006, 1536
Column Name Example Description
main_directory c:\sts_plu\files Directory in which the PLU files are placed. Due to a CRS restriction, all PLU files must be named PLU.CHG. This means it is not possible to write the PLU files for all locations to the same folder. Instead, a folder is created for each location, named after the locationCode, and the associated PLU.CHG file is stored within that folder.
transmission_log_directory c:\sts_plu\log Directory in which the CRSFileGen.Log and CRSQuery.Log files are stored.
error_log_directory c:\sts_plu\error Directory in which the CRSFileGen.Err log is stored.
124 Segment Reference
Output files
File Name Description
<locationCode>\PLU.CHG A PLU.CHG file is created for every location and then stored in a folder named using the location code. If a PLU.CHG file already exists in that folder, then the new data is appended to the existing file. This means that, after the file has been successfully sent to the location, the client is responsible for removing it from the location folder.
Note: Note that if no price changes or regenerate needs to be processed, the log file will state "Execution of PLU File Generator completed successfully." However no PLU.CHG file will be generated.
CRSFileGen.Log This log file tracks the steps the Segment runs through while generating the PLU files. Its content is not restricted to the last time the routine was executed, as it contains the results of all previous runs.
CRSQuery.Log This file contains the SQL executed during the last run. When troubleshooting, it is possible to execute the file contents to help find a problem. It is safe to execute the file multiple times, as it does not contain the SQL used to generate the output files.
CRSFileGen.Err This file contains the errors from the last execution.
Segment 1536 - EDM & PROD to Price Look-Up - File Regenerate 125
Segment 1536 - EDM & PROD to Price Look-Up - File Regenerate
This segment generates files containing pricing information required by the Price Look-Up (PLU) applications running at point of sale (POS). The segment can export PLU data in the format required by three different PLU applications: Coalition PLU, Triversity PLU, and PC Register PLU. If a particular POS also uses the Coalition Store Inventory Tracking application, the segment generates files containing the enterprise and product data required by that application.
Segment Parameters
Note: If this segment is installed, Segment 1006 parameter “DisableFileRegenerate” must be set to 1.
Scheduling RequirementsSee scheduling requirements for segment 1006. For more details, see Queue Segment Description for this segment.
Database Parameters The parameters that need to be defined in order to run the segment are kept in the
Merchandising database. The main PLU parameter table is found in EDM/PROD, and is called parameter_price_lookup. The parameters stored in the table are explained in depth in the PLU User Guide under “Set the remaining PLU parameters”. main_directory transmission_log_directory error_log_directory plu_key use_mix_match_flag override_for_style_flag retrieve_group_code_flag send_price_change_flag shared_attribute_ID use_ftp_flag
There are other tables in EDM/PROD that also need to be set up in order to use PLU, and this setup is customized based on how the client intends to use PLU. The PLU User Guide details how to perform this setup.
Queue Segment DescriptionEDM, PROD, and PM publish events (rows) to the core replication queue, and segment EDM & PROD to PLU processes the events relevant to the PLU applications running at
Parameter Name
DescriptionModifiable with Pipeline Admin.
Default Value
Mutually Exclusive Segments
To ensure data integrity, prevents segment 1536 from running if segment 1038 is already running.
No 1038
126 Segment Reference
POS. For each event (PLU File Regenerate only for segment 1536) in the core replication queue, the segment calls the same method on Merchandising object STSPLUDispatcher providing it different parameters. That component then retrieves the data related to the event and accumulates it in memory with that of the other events processed by the run of the segment. When a segment has processed all the new events in the core replication queue that are relevant to PLU, it takes the data that has been accumulated in memory and calls a component that persists it to files (this is done by a component called by from the post batch script). Files are generated for each store that does not have a status of closed and that uses a PLU application at POS (for example, a store whose Generate PLU flag is set to true).
The following entity actions are processed by this segment:
The PLU files for a store are generated in a subfolder of the PLU directory specified in the PLU parameters (i.e., specified in the parameter_price_lookup table). The PLU directory contains a subfolder for every store for which a file is generated. The subfolders are named using the following convention:
location_ID, concatenated with an underscore, concatenated with the location_name. A subfolder named “Polling” also exists in the PLU directory. The following is an example of the directory structure in which the files are generated, where the PLU directory specified in the PLU parameters is “C:\sts_plu\files”:
TroubleshootingThe segment accumulates data in memory and waits until it has processed all the new events in the core replication queue that are relevant to PLU before persisting the data to file. In the event that the segment terminates abnormally (for example, a crash), it is necessary to roll back the last queue item for the segment in the Pipeline Repository
Entity Action Description
Plu File Regenerate (913) Insert (I)
Segment 1536 - EDM & PROD to Price Look-Up - File Regenerate 127
database and run the segment again. This will regenerate most of the required data, however it may also be necessary to use the PLU functions in Merchandising to regenerate PLU data for a location for the entire enterprise or specific hierarchy groups.
Use this SQL command roll back the last queue item. The target DB is the PipelineRepository.
update last_queue_itemset last_sequence_id = < last queue item id >where segment_id = 1006
The last queue item ID is the CORE replication queue ID to which the user would like to roll back. Check the segment history in Pipeline Administrator to determine the ID. This operation can be repeated if necessary.
128 Segment Reference
Segment 2000 - POM to Offline IM FileThis segment sends POM transactions from POM to interface files for Coalition stores and INS stores (see Mapping Document for this segment for file layouts).
Segment Parameters
Scheduling RequirementsNo info. is available.
Database ParametersNone.
Queue Segment DescriptionThe following pipeline components must be installed: STSPLPOMToOIMFile.dll STSPLSIT.dll STSPLINS.dllThe following document actions are sent to interface files:
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
FileAccessTimeOut File Access Time Out
The maximum amount of time in seconds that the segment will wait to have access to a store's interface file before rejecting the transaction.
No 1800
FileName Interface File Name
An identifier used to create the name of the file in which POM transactions are deposited for Offline IM systems. Must be different than the identifier used to create the name of the file(s) in which data from other modules is deposited. Must not exceed 56 characters in length.
No POM
Path Interface File Directory
The directory in which the interface files containing POM transactions for Offline IM systems are built. The directory must be different than that in which data from other modules is deposited. Each company must also have its own directory for the module.
No C:\NSB Interface\POM to Offline IM File\In Progress
Entity Action Description
PO (100) Offline IM Open (PO) When a Release or Standalone Dropship PO that is sourced from a vendor becomes Open and the vendor isn’t assigned EDI transaction set 856, the PO is sent to the appropriate interface file: For locations with Coalition POS using offline stock, the PO is sent to
the Coalition interface file. For locations with INS using offline stock, the PO is sent to the INS
interface file.
Segment 2000 - POM to Offline IM File 129
Offline IM Cancel (PC)
When an Open Release or Standalone Dropship PO that is sourced from a vendor is Canceled and the vendor isn’t assigned EDI transaction set 856, the deletion is sent to the appropriate interface file: For locations with Coalition POS using offline stock, the PO deletion is
sent to the Coalition interface file. For locations with INS using offline stock, the PO deletion is sent to
the INS interface file.
Offline IM Reinstate (PR)
When a Release or Standalone Dropship PO that is sourced from a vendor is Reinstated to Open and the vendor isn’t assigned EDI transaction set 856, the PO is sent to the appropriate interface file: For locations with Coalition POS using offline stock, the PO is sent to
the Coalition interface file. For locations with INS using offline stock, the PO is sent to the INS
interface file.
Offline IM Update (PU)
When the carrier code is modified in the header of an Open Release or Standalone Dropship PO that is sourced from a and the vendor isn’t assigned EDI transaction set 856, the update of the PO is sent to the appropriate interface file: For locations with Coalition POS using offline stock, the update of the
PO is sent to the Coalition interface file. For locations with INS using offline stock, the update of the PO is sent
to the INS interface file.
PO location (140) Offline IM Insert (PI) When a PO location is added to an Open Release or Standalone Dropship PO that is sourced from a vendor and the vendor isn’t assigned EDI transaction set 856, the PO location is sent to the appropriate interface file: For locations with Coalition POS using offline stock, the PO location is
sent to the Coalition interface file. For locations with INS using offline stock, the PO location is sent to
the INS interface file.
Offline IM Delete (PD)
When a PO location is deleted from an Open Release or Standalone Dropship PO that is sourced from a vendor and the vendor isn’t assigned EDI transaction set 856, the deletion of the PO location is sent to the appropriate interface file: For locations with Coalition POS using offline stock, the deletion of the
PO location is sent to the Coalition interface file. For locations with INS using offline stock, the deletion of the PO
location is sent to the INS interface file.
Offline IM Update (PU)
When a detail line is added/modified/deleted in a PO location of an Open Release or Standalone Dropship PO that is sourced from a vendor and the vendor isn’t assigned EDI transaction set 856, the update of the PO Location is sent to the appropriate interface file: For locations with Coalition POS using offline stock, the update of the
PO location is sent to the Coalition interface file. For locations with INS using offline stock, the update of the PO
location is sent to the INS interface file.
Entity Action Description
130 Segment Reference
TroubleshootingIf the segment itself fails, search the Manager log in the Pipeline folder on the Pipeline server for error messages. To determine whether errors occurred during the running of this segment, check the statistics tab for the individual segment in Pipeline Administrator; if errors occurred, details are reported in the Error queue.
Segment 2005 - POM To EDI Text File 131
Segment 2005 - POM To EDI Text FileThe segment allows the user to send an EDI Purchase Order to the vendor via Electronic Data Interchange (EDI). It creates an EDI file based on the EDI 850 transaction format.
Segment Parameters
Parameter Name Parameter Display Name DescriptionModifiable with Pipeline Admin.
Default Value
Path Path Specifies the directory where the EDI file is generated
No C:\Nsb Interface\POM to EDI Text File\
BillingAddressType BillingAddressType Billing Address Type to be used in the N1*BY section of the EDI file.
No MAIN
CreateBulkOutOfDropShipPOs
CreateBulkOutOfDropShipPOs
Determines whether a Bulk PO, one for each location on the Dropship, will be created from DropShip POs
No 0
InHouseOrVendorUPC InHouseOrVendorUPC Determines whether Inhouse Or Vendor UPC will be added to EDI file for SKUs. V = Vendor; I= Inhouse
No V
NetOrFirstCost NetOrFirstCost Net Or First Cost value to be used for styles in the PO1 and SLN sections
No NET
ShippingAddressType ShippingAddressType Shipping Address Type to be used in segment’s N1*ST section
No MAIN
Mod100 Mod100 If this parameter is set to 1 then an additional REF section will be added in the EDI file. This section will hold the External Document Number value from the PO. It will be added as REF*BT*{0} where {0} holds the external document number.
No 0
Mod74 Mod74 If this parameter is set to 1 then an additional VP element will be added to each of the PO1 and SLN sections in the EDI file. This element will hold the Vendor UPC Number value for the SKU on the PO. It will be added as REF*BT*{0} where {0} holds the external document number.
No 0
132 Segment Reference
Scheduling RequirementsShould be run regularly throughout the day as this is an online interface.
Database ParametersNone.
Queue Segment DescriptionThe segment requires the following Pipeline dll to be installed: STSPLPOMToEDI.dll
The segment requires that the Merchandising .Net dlls are installed and that the Nsb.Purchasing.Controller.Interfaces.tlb file has been created.
Mod216 Mod216 If this is set to 1 then additional information is added to file in sections BEG02 -> BEG04.If the external system name on the PO is 'Replendistro' then RE*{0}** will be added, where (0) holds the PO number. If the external system name is 'Allocdistro' then AL*{0}** will be added.
No 0
Mod135 Mod135 If this parameter is set to 1 then an additional DTM section will be added to the EDI file. This element will hold the System Cancel Date on the PO. It will be added as DTM*{0}*{1} where {0} holds the date type value of '001' and {1} holds the system cancel date. An additional requirement for the system cancel date to be added as above is that the edi_850_dtm_cancel_after_flag must be set to true in the vendor table. This is the 'Cancel after' parameter in the '850 - DTM Segment' section of the Vendor Maintenance form in the EDM module of Merchandising.
No 0
Parameter Name Parameter Display Name DescriptionModifiable with Pipeline Admin.
Default Value
Segment 2005 - POM To EDI Text File 133
Entities Published The follow entities and actions are published to the Merchandising replication queue when a PO is for an EDI vendor. POM subscribes to these entities and actions via this segment.
TroubleshootingThis segment populates a DB table called edi850temp. Any POs that were not successfully exported will remain in this table after the segment has been executed. To determine the error(s), Pipeline tracing should be turned on. The errors preventing the PO from being exported will be listed in the trace file.
Entity Action Description
PO (100) SendEDI (S) SendEDI is published to the Merchandising replication queue when the following conditions are true: EDI order flag is true
PO Status is Open Approval Status is Approved, Reapproved or None Export Status (po.edi_status) is Pending Send
ResendEDI (RS) ResendEDI is published to the Merchandising replication queue when the following conditions are true: EDI order flag is true
PO Status is Open Approval Status is Approved, Reapproved or None Export Status (po.edi_status) is Pending Resend
Once the PO has been processed its export status will be set to Sent or Resent.
134 Segment Reference
Segment 3000 - IM to WMThe segment advises WM of relevant inventory transactions that occur in IM.
Segment Parameters
Scheduling Requirements Should be run regularly throughout the day as this is an online interface. Replication queue entries processed by segments “POM & AR to WM” and “IM to WM”
may be rejected to the Pipeline error queue if they reference enterprise or product data not yet interfaced to WM via segment “EDM & PROD to WM”. For example, a PO may be rejected with a message indicating that it references invalid SKUs. These rejections will eventually be reprocessed successfully once segment “EDM & PROD to WM” runs. Scheduling segments “EDM & PROD to WM”, “POM & AR to WM” and “IM to WM” to run consecutively in a single job may reduce the number of such timing-related rejections, but will not completely eliminate them, as users in Merchandising may save POM, AR, and IM documents that reference new enterprise and product entities at the same time that the job is running, that is, while segment “EDM & PROD to WM” is finishing but before segments “POM & AR to WM” and “IM to WM” begin.
Database ParametersThere are no Pipeline parameters stored in the source or destination database for this segment.
Queue Segment DescriptionThe segment does not require any Pipeline dlls to be installed.
WM subscribes to the following entities and actions via this segment:
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
4Wall_Company WM Company The number of the WM company with which the segment integrates. The number specified must be the same as the number of the Merchandising company with which the segment integrates. The value specified must also match the company number for which the Pipeline segment has been configured in the Pipeline Repository database. WM requires all data and transactions it is sent to be accompanied by the value specified in this parameter. This is to support the inherited WM feature that enables WM to support multiple companies in one database. (This feature is no longer recommended and not fully supported when integrating with Epicor Merchandising.)
No The company number for which the Pipeline segment has been configured in the Pipeline Repository database.
Mod264 Mod264 Verify location in WM No 0
Entity Action Description
ASN (20) Insert (I)
Delete (D)
Segment 3000 - IM to WM 135
TroubleshootingNo troubleshooting information is currently available for this segment.
PO Receipt (10) Fully Matched (FM)
RTV Via DC (60) Insert (I)
Update (U)
Cancel (C)
RTV SKU (61) Insert (I)
Update (U)
Delete (D)
Transfer via DC (50) Insert (I)
Update (U)
Cancel (C)
Delete (D)
Transfer SKU via DC (51) Insert (I)
Update (U)
Delete (D)
Entity Action Description
136 Segment Reference
Segment 3002 - IM to WM, Store Shipment ConfirmationThe segment advises WM of relevant store shipment receipts that have occurred in IM.
Segment Parameters
Scheduling RequirementsShould be scheduled to run after hours, to ensure that it has the least possible performance impact on WM personnel. The segment does not advise WM of time-critical information.
Database ParametersThere are no Pipeline parameters stored in the source or destination database for this segment.
Queue Segment DescriptionThe segment does not require any Pipeline dlls to be installed.
WM subscribes to the following entities and actions via this segment:
TroubleshootingNo troubleshooting information is currently available for this segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
4Wall_Company WM Company The number of the WM company with which the segment integrates. The number specified must be the same as the number of the Merchandising company with which the segment integrates. The value specified must also match the company number for which the Pipeline segment has been configured in the Pipeline Repository database. WM requires all data and transactions it is sent to be accompanied by the value specified in this parameter. This is to support the inherited WM feature that enables WM to support multiple companies in one database. (This feature is no longer recommended and not fully supported when integrating with Epicor Merchandising.)
No The company number for which the Pipeline segment has been configured in the Pipeline Repository database.
Entity Action Description
Store Shipment (70) Insert Received (IR)
Store Shipment SKU (71) Update Received (UR)
Segment 3003 - IM Internal - System Receive Documents 137
Segment 3003 - IM Internal - System Receive DocumentsThis segment receives all the Sent transfers in IM that were shipped x days ago (where x is the transfer complete sent days) i.e., the transfer ship date + the transfer complete sent days is earlier than current system date.
Segment Parameters
Scheduling RequirementsNo info. is available.
Database ParametersIM parameter “transfer complete sent days”. In the Merchandising application this parameter is found under Enterprise Data\Parameters\Inventory Management\Outbound\Transfers\*No. of days to complete sent transfers. If a Sent transfer’s ship date + the days specified in this parameter is earlier than the current system date, the transfer will be received by this segment.
Non-queue Segment Description The segment calls Execute method on the Merchandising scheduled task controller. Merchandising scheduled task controller invokes the Merchandising component
specified by the segment parameter ‘TASKPROGID’ (i.e. “STSIMScheduledTask.STSIMAutoReceive”), which receives the transfers.
Troubleshooting If any error occurs when the Merchandising business object cleans up the styles, an
error log will be generated: The error logs of this segment are found in the path specified in
HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog of the registry
The error log name is IMSTErrors_yyyymmdd.log (where yyyymmdd is a timestamp)
Segment failure without an error log indicates a setup problem.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Application ID Value specified is used by the segment for security purposes.
No 100
CompanyID Company ID Value specified is used by the segment for connectivity purposes to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Task ProgID Indicates (to the common process that runs scheduled tasks) that the system receiving of transfers must be performed.
No STSIMScheduledTask.STSIMAutoReceive
138 Segment Reference
Segment 3004 - IM Internal - System Delete DocumentsThis segment cleans up different types of IM documents based on the document status and IM parameters.
Segment Parameters
Scheduling RequirementsNo info is available.
Database ParametersAll of the following IM parameters are found in Enterprise Data\Parameters\Inventory Management: “PO receipt cleanup weeks”. If a Fully Matched PO receipt has been received more
than x weeks ago (where x = PO receipt cleanup weeks), it will be deleted by this segment, i.e., the PO receipt receive date + PO receipt cleanup weeks is earlier than the current system date.
“unsolicited receipt cleanup weeks”. If a Fully Matched unsolicited receipt has been received more than x weeks ago (where x = unsolicited receipt cleanup weeks), it will be deleted by this segment, i.e., the unsolicited receipt receive date + unsolicited receipt cleanup weeks is earlier than the current system date.
“transfer cleanup weeks”. If a transfer has been received more than x weeks ago (where x = transfer cleanup weeks), it will be deleted by this segment, i.e., the transfer receive date + transfer cleanup weeks is earlier than the current system date.
“RTV cleanup weeks”. If a Fully Matched RTV has been returned more than x weeks ago (where x = RTV cleanup weeks), it will be deleted by this segment, i.e., the RTV return date + RTV cleanup weeks is earlier than the current system date.
“inventory move cleanup weeks”. If a Submitted inventory move request document that is not referenced by any RTV or transfer, was created more than x weeks ago (where x = inventory move cleanup weeks), it will be deleted by this segment, i.e. the IMRD create date + inventory move cleanup weeks is earlier than the current system date.
“user defined adjustment cleanup weeks”. If a user-defined adjustment document of status Submitted was submitted more than x weeks ago (where x = user defined adjustment cleanup weeks), it will be deleted by this segment, i.e., the UDA submit date + user defined adjustment cleanup weeks is earlier than the current system date.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Application ID Value specified is used by the segment for security purposes.
No 100
CompanyID Company ID Value specified is used by the segment for connectivity purposes to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Task ProgID Indicates (to the common process that runs scheduled tasks) that the system deletion of IM documents must be performed.
No STSIMScheduledTask.STSIMSystemDelete
Segment 3004 - IM Internal - System Delete Documents 139
“shrink adjustment cleanup weeks”. If a shrinkage adjustment document of status Submitted was submitted more than x weeks ago (where x = shrink adjustment cleanup weeks), it will be deleted by this segment, i.e., the adjustment submit date + shrink adjustment cleanup weeks is earlier than the current system date.
“stock status adjustment cleanup weeks”. If a stock status adjustment document of status Submitted was submitted more than x weeks ago (where x = stock status adjustment cleanup weeks), it will be deleted by this segment, i.e., the adjustment submit date + stock status adjustment cleanup weeks is earlier than the current system date.
“inventory count cleanup weeks”. If an inventory control document of status Posted was posted more than x weeks ago (where x = inventory count cleanup weeks), it will be deleted by this segment, i.e., the latest post date (in one of the inventory control locations) + inventory count cleanup weeks is earlier than the current system date.
“ASN cleanup weeks”. If an advanced shipping notice that is not referenced by any PO receipt and distribution, was created more than x weeks ago (where x = ASN cleanup weeks), it will be deleted by this segment, i.e., the ASN create date + ASN cleanup weeks is earlier than the current system date.
“average cost adjustment cleanup weeks”. If an average cost adjustment document of status Submitted was submitted more than x weeks ago (where x = average cost adjustment cleanup weeks), it will be deleted by this segment, i.e., the adjustment submit date + average cost adjustment cleanup weeks is earlier than the current system date.
“store shipment cleanup weeks”. If a store shipment was received more than x weeks ago (where x = store shipment cleanup weeks), it will be deleted by this segment, i.e., the store shipment receive date + store shipment cleanup weeks is earlier than the current system date.
Non-queue Segment Description The segment calls Execute method on the Merchandising scheduled task controller. Merchandising scheduled task controller invokes the Merchandising component
specified by the segment parameter ‘TASKPROGID’ (i.e., “STSIMScheduledTask.STSIMSystemDelete”), which deletes the IM documents.
IM documents of the following types and statuses will be deleted by this segment: PO receipt
PO receipt that is Canceled and is not referenced by any distribution A Fully Matched PO receipt that was received more than x weeks ago (where x
= PO receipt cleanup weeks) Unsolicited receipt
Unsolicited receipt that is Canceled A Fully Matched unsolicited receipt that was received more than x weeks ago
(where x = unsolicited receipt cleanup weeks) Transfer
Transfer that is Canceled A transfer that was received more than x weeks ago (where x = transfer
cleanup weeks) RTV (return to vendor)
RTV that is Canceled
140 Segment Reference
A Fully Matched RTV that was returned more than x weeks ago (where x = RTV cleanup weeks)
Inventory move request Inventory move request that is Canceled A Submitted inventory move request document that is not referenced by any
RTV or transfer and was created more than x weeks ago (where x = inventory move cleanup weeks)
User defined adjustment User-defined adjustment that is Canceled A user-defined adjustment document of status Submitted that was submitted
more than x weeks ago (where x = user defined adjustment cleanup weeks) Shrinkage adjustment
Shrinkage adjustment that is Canceled A shrinkage adjustment document of status Submitted that was submitted
more than x weeks ago (where x = shrink adjustment cleanup weeks) Stock status adjustment
A stock status adjustment that is Canceled A stock status adjustment document with a status of Submitted that was
submitted more than x weeks ago (where x = stock status adjustment cleanup weeks)
Inventory control An inventory control that is Canceled All the locations of an inventory control document with a status of Posted that
were posted more than x weeks ago (where x = inventory count cleanup weeks)
ASN (advanced shipping notice) An ASN that is not referenced by any PO receipt and distribution and that was
created more than x weeks ago (where x = ASN cleanup weeks) Average cost adjustment
An average cost adjustment document of status Submitted that was submitted more than x weeks (where x = average cost adjustment cleanup weeks)
Store shipment A store shipment that was received more than x weeks ago (where x = store
shipment cleanup weeks)
Troubleshooting If any errors occur, an error log will be generated:
The error logs of this segment are found in the path specified in HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog of the registry
The error log name is IMSTErrors_yyyymmdd.log (where yyyymmdd is a timestamp)
Segment failure without an error log indicates a setup problem.
Segment 3006 - IM Internal - Post Physical Inventory Counts 141
Segment 3006 - IM Internal - Post Physical Inventory CountsThis segment posts all the IM physical inventory control locations whose 'to be posted' flags are set to True.
Segment Parameters
Scheduling RequirementsNo information is available.
Database ParametersThere are no Pipeline parameters stored in the source or destination database for this segment.
Non-queue Segment Description The segment calls Execute method on the Merchandising scheduled task controller. Merchandising scheduled task controller invokes the Merchandising component
specified by the segment parameter ‘TASKPROGID’ (i.e. “STSIMScheduledTask.STSIMAutoPostCounts”), which posts locations on an IM inventory control document if the inventory control location’s 'to be posted' flag is set to True.
Troubleshooting If any error occurs when the Merchandising business object cleans up the styles, an
error log will be generated: The error logs of this segment are found in the path specified in
HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog of the registry
The error log name is IMSTErrors_yyyymmdd.log (where yyyymmdd is a timestamp)
Segment failure without an error log indicates a setup problem.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Application ID Value specified is used by the segment for security purposes.
No 100
CompanyID Company ID Value specified is used by the segment to determine what company to access.
No The company the segment has been installed for
TaskProgID Task ProgID Indicates to the process that runs scheduled tasks that posting of PI counts must be performed.
No STSIMScheduledTask.STSIMAutoPostCounts
142 Segment Reference
Segment 3008 - IM Internal - System Match PO ReceiptsThis segment fully matches the PO Receipts in IM that meet specific criteria.
Segment Parameters
Scheduling RequirementsNo information is available.
Database ParametersNone.
Non-queue Segment Description This segment should only be run if Invoice Matching is not installed. This segment fully matches the PO Receipts in IM that meet the following criteria:
The receive date is earlier than the cutoff date (system date less the value of the IM parameter ‘PO Receipt Clean Up Weeks’).
The PO Receipt was not generated by WMS. The PO Receipt’s document status is Received. The PO Receipt’s match status is Preliminary or Unmatched.
The following pipeline components must be installed: STSPLIM.dll
Troubleshooting An error file is only generated if errors have occurred. The error file is named as follows:
STSIMSystemMatchPOReceipt.yyyymmddhhmmss.ERR (where yyyymmddhhmmss is a timestamp)
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
CompanyID Company ID The ID of the Merchandising company.
No The company for which the segment has been installed
Module Module Name of the module of the Merchandising Application (i.e., EDM, PROD, IM etc.)
No IM
Path Path The location where the error file is found.
No C:\NSB Interface\IM Internal
Segment 3009 - IM To Sourcing 143
Segment 3009 - IM To Sourcing This segment sends PO Receipt Details from IM to Sourcing.
Segment ParametersNone.
Scheduling RequirementsThis segment must be run regularly throughout the day.
Database ParametersNone
Queue Segment DescriptionThe segment requires the following Pipeline dlls to be installed. STSPLIMToSrc.dll STSPLBase.dll
TroubleshootingNone available at this time.
Entity Action Description
PO Receipt Detail – (11)
Sourcing Receipt (SR) When a PO Receipt becomes received, advise Sourcing of a detail linked to a PO Receipt that has been created.
Sourcing Insert Received (SI) When a PO Receipt Detail is added, advise Sourcing of a detail linked to a PO Receipt that has been created.
Sourcing Update Received (SU) When a PO Receipt Detail is updated, advise Sourcing of a detail linked to a PO Receipt that has been updated.
Sourcing Delete Received (SD) When a PO Receipt Detail is deleted, advise Sourcing of a detail linked to a PO Receipt that has been deleted.
RTV (110 RT (Return) If the system parameters Installed Sourcing Flag and Send Rtv To Sourcing Flag are set to true, the system retrieves any RTV that has the status of Returned from IM and places it in the Sourcing interface database.
144 Segment Reference
Segment 3010 - IM Internal - System Match Unsolicited Receipts
This segment fully matches the Unsolicited Receipts in IM that meet specific criteria.
Segment Parameters
Scheduling RequirementsNo info. is available.
Database ParametersNone.
Non-queue Segment Description This segment should only be run if Invoice Matching is not installed. This segment fully matches the Unsolicited Receipts in IM that meet all the following
criteria: The receive date is earlier than the cutoff date (system date less the value of the
IM parameter ‘Unsolicited Receipt Clean Up Weeks’). The Unsolicited Receipt was not generated by WMS. The Unsolicited Receipt’s document status is Received. The Unsolicited Receipt’s match status is Preliminary or Unmatched.
Troubleshooting An error file is only generated if errors have occurred. The error file is named as follows: STSIM.yyyymmddhhmmss.ERR (where
yyyymmddhhmmss is a timestamp).
Parameter Name
Parameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Path The location where the error file is found. No C:\NSB Interface\IM Internal
Segment 3011 - IM Internal - System Match RTVs 145
Segment 3011 - IM Internal - System Match RTVsThis segment fully matches the RTVs in IM that meet specific criteria.
Segment Parameters
Scheduling RequirementsNo info. is available.
Database ParametersNone.
Non-queue Segment Description This segment should only be run if Invoice Matching is not installed. This segment fully matches the RTVs in IM that meet all the following criteria:
The returned date is earlier than the cutoff date (system date less the value of the IM parameter ‘RTV Clean Up Weeks’).
The RTV was not generated by WMS. The RTV’s document status is Returned. The RTV’s match status is Preliminary or Unmatched.
Troubleshooting An error file is only generated if errors have occurred. The error file is named as follows: STSIM.yyyymmddhhmmss.ERR (where
yyyymmddhhmmss is a timestamp).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Path The location where the error file is found.
No C:\NSB Interface\IM Internal
146 Segment Reference
Segment 3012 - IM to Offline IM FileThis segment sends IM transactions from IM to interface files for Coalition stores and INS stores (see Mapping Document for this segment for file layouts).
Segment Parameters
Scheduling RequirementsNo info. is available.
Database ParametersNone.
Queue Segment DescriptionThe following pipeline components must be installed: STSPLMEToOIMFile.dll STSPLIMToOIMFile.dll STSPLSIT.dll STSPLINS.dll
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
FileAccessTimeOut File Access Time Out
The maximum amount of time in seconds that the segment will wait to have access to a store's interface file before rejecting the transaction.
No 1800
FileName Interface File Name
An identifier used to create the name of the file in which IM transactions are deposited for Offline IM systems. Must be different than the identifier used to create the name of the file(s) in which data from other modules is deposited. Must not exceed 56 characters in length.
No STOCK
Path Interface File Directory
The directory in which the interface files containing inventory transactions for Offline IM systems are built.
No C:\NSB Interface\IM to Offline IM File\In Progress
SupportStyleAndStyleColor
Support Styles And Style Colors On IMRD Details
Indicates whether styles or style colors can be entered on the IMRD details instead of skus: 1 = Yes, 0 = No
No 0
Mod220 Block Store Shipments
Custom modification. Only installed when specifically required.
No 0
Segment 3012 - IM to Offline IM File 147
The following document actions are sent to interface files:
Entity Action Description
ASN Insert When an ASN is created, information is sent to the appropriate interface file: For locations with Coalition POS using offline stock, the ASN information is
sent to the Coalition interface file. For locations with INS using offline stock, the ASN information is sent to
the INS interface file.
ASN PO Location Low-level Delete When an ASN is deleted, the deletion of the ASN PO Location is sent to the appropriate interface file: For locations with Coalition POS using offline stock, the deletion of the ASN
PO location is sent to the Coalition interface file. For locations with INS using offline stock, the deletion of the ASN PO
location ASN information is sent to the INS interface file.
Transfer Insert When a transfer becomes Sent, the transfer information is sent to the appropriate interface file: If the transfer’s To Location is a location with Coalition POS using offline
stock, the transfer information is sent to the Coalition interface file. If the transfer’s To Location is a location with INS using offline stock, the
transfer information is sent to the INS interface file.
Cancel When a Sent transfer becomes Canceled, the deletion of the transfer is sent to the appropriate interface file: If the transfer’s To Location is a location with Coalition POS using offline
stock, the deletion of the transfer is sent to the Coalition interface file. If the transfer’s To Location is a location with INS using offline stock, the
deletion of the transfer is sent to the INS interface file.
Insert Ready To Send
When a transfer becomes Ready To Send, the transfer information is sent to the INS interface file if its From Location is a location with INS using offline stock.
Offline IM Update Ready To Send
When the From Location or To Location has been modified on a transfer that has a status of Ready To Send, the update of the transfer is sent to the INS interface file if its From Location is a location with INS using offline stock.
Cancel Ready To Send/Delete Ready To Send
When a transfer that has a status of Ready To Send is Canceled or Deleted, the deletion of the transfer is sent to the INS interface file if its From Location is a location with INS using offline stock.
Transfer Detail Insert When a detail is added to a transfer that has a status of Sent, the update of the transfer is sent to the appropriate interface file: If the transfer’s To Location is a location with Coalition POS using offline
stock, the update of the transfer is sent to the Coalition interface file. If the transfer’s To Location is a location with INS using offline stock, the
update of the transfer is sent to the INS interface file.
Offline IM Update When the units sent on a detail line is modified on a transfer that has a status of Sent, the update of the transfer is sent to the appropriate interface file: If the transfer’s To Location is a location with Coalition POS using offline
stock, the update of the transfer is sent to the Coalition interface file. If the transfer’s To Location is a location with INS using offline stock, the
update of the transfer is sent to the INS interface file.
148 Segment Reference
Delete When a detail is deleted from a transfer that has a status of Sent, the update of the transfer is sent to the appropriate interface file: If the transfer’s To Location is a location with Coalition POS using offline
stock, the update of the transfer is sent to the Coalition interface file. If the transfer’s To Location is a location with INS using offline stock, the
update of the transfer is sent to the INS interface file.
Insert Ready To Send
When a detail is added to a transfer that has a status of Ready To Send, the update of the transfer is sent to the INS interface file if its From Location is a location with INS using offline stock.
Offline IM Update Ready To Send
When the units sent of a detail line is modified on a transfer that has a status of Ready To Send, the update of the transfer is sent to the INS interface file if its From Location is a location with INS using offline stock.
Delete Ready To Send
When a detail is deleted from a transfer that has a status of Ready To Send, the update of the Transfer is sent to the INS interface file if its From Location is a location with INS using offline stock.
Store Shipment Insert When a Store Shipment becomes Sent, the store shipment information is sent to the appropriate interface file: For locations with Coalition POS using offline stock, the store shipment
information is sent to the Coalition interface file. For locations with INS using offline stock, the store shipment information
is sent to the INS interface file.
Store Shipment Detail
Offline IM Update When the units sent of a detail line are modified on a Store Shipment that has a status of Sent, the update of the Store Shipment is sent to the Coalition interface file if the location is a Coalition store using offline stock.
Delete When a detail line is deleted from a Store Shipment that has a status of Sent, the update of the Store Shipment is sent to the Coalition interface file if the location is a Coalition store using offline stock.
IMRD of type Transfer
Insert When an IMRD of type Transfer becomes Submitted, the IMRD is sent to the appropriate interface file: If at least one of its locations is a location with Coalition POS using offline
stock, the IMRD is sent to the Coalition interface file. If at least one of its locations is a location with INS using offline stock, the
IMRD is sent to the INS interface file.
Offline IM Update When the To Location has been modified on an IMRD of type Transfer that has a status of Submitted, the update of the IMRD is sent to the appropriate interface file: If at least one of its locations is a location with Coalition POS using offline
stock, the update of the IMRD is sent to the Coalition interface file. If at least one of its locations is a location with INS using offline stock, the
update of the IMRD is sent to the INS interface file.
IMRD of type Transfer From Location
Insert When a From Location is added to an IMRD of type Transfer that has a status of Submitted, the IMRD From Location is sent to the appropriate interface file: If the transfer’s From Location is a location with Coalition POS using offline
stock, the IMRD From Location is sent to the Coalition interface file. If the transfer’s From Location is a location with INS using offline stock,
the IMRD From Location is sent to the INS interface file.
Entity Action Description
Segment 3012 - IM to Offline IM File 149
Delete When a From Location is deleted from an IMRD of type Transfer that has a status of Submitted, the deletion of the IMRD From Location is sent to the appropriate interface file: If the transfer’s From Location is a location with Coalition POS using offline
stock, the deletion of the IMRD From Location is sent to the Coalition interface file.
If the transfer’s From Location is a location with INS using offline stock, the deletion of the IMRD From Location is sent to the INS interface file.
Low-level Cancel When an IMRD of type Transfer that has a status of Submitted becomes Canceled, the deletion of the IMRD From Location is sent to the appropriate interface file: If at least one of its From locations is a location with Coalition POS using
offline stock, the deletion of the IMRD From Location is sent to the Coalition interface file.
If at least one of its From locations is a location with INS using offline stock, the deletion of the IMRD From Location is sent to the INS interface file.
Low-level Delete When an IMRD of type Transfer that has a status of Submitted becomes Deleted, the deletion of the IMRD From Location is sent to the appropriate interface file: If at least one of its From locations is a location with Coalition POS using
offline stock, the deletion of the IMRD From Location is sent to the Coalition interface file.
If at least one of its From locations is a location with INS using offline stock, the deletion of the IMRD From Location is sent to the INS interface file.
IMRD of Type Transfer Detail
Insert When a detail is added to an IMRD of type Transfer that has a status of Submitted, the update of the IMRD From Location is sent to the appropriate interface file: If at least one of its From locations is a location with Coalition POS using
offline stock, the update of the IMRD From Location is sent to the Coalition interface file.
If at least one of its From locations is a location with INS using offline stock, the update of the IMRD From Location is sent to the INS interface file.
Offline IM Update When the units requested or comparison operator of a detail line is modified on an IMRD of type Transfer that has a status of Submitted, the update of the IMRD is sent to the appropriate interface file: If at least one of its From locations is a location with Coalition POS using
offline stock, the update of the IMRD is sent to the Coalition interface file. If at least one of its From locations is a location with INS using offline
stock, the update of the IMRD is sent to the INS interface file.
Delete When a detail is deleted from an IMRD of type Transfer that has a status of Submitted, the update of the IMRD is sent to the appropriate interface file: If at least one of its From locations is a location with Coalition POS using
offline stock, the update of the IMRD is sent to the Coalition interface file. If at least one of its From locations is a location with INS using offline
stock, the update of the IMRD is sent to the INS interface file.
Entity Action Description
150 Segment Reference
TroubleshootingIf the segment itself fails, search the Manager log in the Pipeline folder on the Pipeline server for error messages. To determine whether errors occurred during the running of this segment, check the statistics tab for the individual segment in Pipeline Administrator; if errors occurred, details are reported in the Error queue.
IMRD of Type RTV Insert When an IMRD of type RTV becomes Submitted, the IMRD is sent to the Coalition interface file.if at least one of its From Locations is a Coalition store using offline stock.
Offline IM Update When the vendor code has been modified on an IMRD of type RTV that has a status of Submitted, the update of the IMRD is sent to the Coalition interface file if at least one of its From Locations is a Coalition store using offline stock.
IMRD of Type RTV From Location
Insert When a From Location is added to an IMRD of type RTV that has a status of Submitted, the IMRD From Location is sent to the Coalition interface file if the From Location is a Coalition store using offline stock.
Delete When a From Location is deleted from an IMRD of type RTV that has a status of Submitted, the deletion of the IMRD From Location is sent to the Coalition interface file if the From Location is a Coalition store using offline stock.
Low-level Cancel When an IMRD of type RTV that has a status of Submitted becomes Canceled, the deletion of the IMRD From Location is sent to the Coalition interface file if one of its From Locations is a Coalition store using offline stock.
Low-level Delete When an IMRD of type RTV that has a status of Submitted is Deleted, the deletion of the IMRD From Location is sent to the Coalition interface file if one of its From Locations is a Coalition store using offline stock.
IMRD of Type RTV Detail
Insert When a detail is added to an IMRD of type RTV that has a status of Submitted, the update of the IMRD is sent to the Coalition interface file if at least one of its From Locations is a Coalition store using offline stock.
Offline IM Update When the units requested or comparison operator of a detail line is modified on an IMRD of type RTV that has a status of Submitted, the update of the IMRD is sent to the Coalition interface file if at least one of its From Locations is a Coalition store using offline stock.
Delete When a detail is deleted from an IMRD of type RTV that has a status of Submitted, the update of the IMRD is sent to the Coalition interface file if at least one of its From Locations is a Coalition store using offline stock.
Entity Action Description
Segment 3100 - IM to Infobase - Sales Posting 151
Segment 3100 - IM to Infobase - Sales PostingThis segment creates a series of job_ids to post sales from Sales Audit to Merchandising, and processes them.
Segment ParametersNone.
Scheduling RequirementsThis segment must be run before Segment 5105 - Infobase to MA - Initialize. This segment can be run several times during the day if Segment 5105 is run at night.
Database Pre-requisites and Notes SQL Server 2005 and higher; Oracle 10g SA 4.1.001.030 or higher release is required. Transaction type in the mew_sales_export table matches the transaction type in
Merchandising as shown in this table:.
In ib_inventory a 710 Price Status Change is generated for the following transactions: Retro Posting: 700 Price Change.Promotion: 701 Promo.
In mew_sale_export the sign of a discount transaction determines whether the transaction is associated with a sale or a return transaction; for example, the discount transaction 601 will be positive when associated with a sale and negative when associated with a return:a) Transaction 600 sold_at_price 25.00 pos_discount_amount = NULL
b) Transaction 601 sold_at_price 25.00 pos_discount_amount = 5.00c) Transaction 610 sold_at_price 25.00 pos_discount_amount = NULL
d) Transaction 601 sold_at_price 25.00 pos_discount_amount = -5.00
Partitioning ib_inventory: must be completed prior to the installation. Details are contained in the Pipeline installation documentation.
A database link must exist in Merch pointing to mew_sales_export in SA.
Old types from SA
New types being used
Sale 1 600
Customer return 2, 202 610
Discount for Sale and Customer Return 20, 21 601
Layaway Deposit 101 620
Discount on Layaway deposit 120 120
Layaway Cancel 102 621
Discount on Layaway cancel 121 121
Layaway Pickup 201 622
Discount on Layaway pickup 220 220
152 Segment Reference
Non-Queue Segment DescriptionThe following components must be installed:Nsb.SalePosting.dll
This segment creates several job_ids in the job_header table that: initiate posting of new transactions from SA to Merchandising process a batch of transactions based on a range of identity_ids and batch size. Batch
size is the number of transactions for a location that should be included per job. The transactions of one location are not split in to 2 batches.
validate SKUs, styles, locations and transaction reasons included in the range of transactions
build pricing information required to process the transactions track job completion; if there is incomplete job, the segment fails and the error is
reported in Manager.log when the segment starts, it tries to re-process any jobs that previously failed
Mapping DocumentsNone available
TroubleshootingTrace can be turned on: for all the jobs currently running via job_params.debug_flag for a specific job via job_header.debug_flag.
Once the flag is turned on then the process starts tracing steps in the job_debug table.Check for errors in: job_header: after completing the processing, a failed job will have an end_time = null
and a completed_flag = 0. Pipeline Manager.log: at the end of the posting process, if there are incomplete jobs in
job_header, the Pipeline Manager.log will display a segment failure and log the first error that resides in the job_error table.
job_error: the errors will be listed along with the procedure in which the error originated and the line at which it occurred.
Performance improvementsIt may be possible to improve performance by modifying the configuration files; however this should only be done in consultation with development.
There are 2 ways to modify the current configuration: In the DTS package, when calling the .Net assembly, the number of threads to use is
parameterized and defaults to 16, but it can be modified depending on the number of CPUs on the database server.
In the job_params table, there are 2 parameters used to define the number of transactions processed in parallel per job: range_batch_size: the default value is 500,000 representing the maximum
number of transactions that will be copied to im_sale; last_im_sale_copied keeps track of the copying.
job_batch_size: the default value is 10,000, representing the maximum number of transactions from a given range of transactions that is associated with a
Segment 3100 - IM to Infobase - Sales Posting 153
specific job. This number is approximate because all transactions for one location are processed in the same job.
The Job TablesJOB_INFO
This table defines the types of jobs that exist in Merch (currently, the only type is “1” for sales posting).
JOB_HEADER
Column name Column description
job_type Unique number representing the type of job to be executed
batch_job_name Name of procedure that executes the job
job_description Brief description of the job
Column name Column description
job_id Unique identifier for a job
job_type Value is 1 for sales posting.
range_start Corresponds to the starting point of a range of rows in im_sale. The number of rows included in the range corresponds to the number specified in job_params.range_batch_size.
range_end Corresponds to the end point of a range of rows in im_sale
batch_start Starting value: the location_id for the first location included in the job; the number of locations included in the batch corresponds to the number specified in job_params.job_batch_size. This number is only an approximation because we don't split transactions that belong to a specific location across multiple jobs.
batch_end Ending value for a batch in the job. This value is a location_id; the batch is all the transactions with transaction_id included between range_start and range_end that have the location_id included between batch_start and batch_end.
start_time Time the job starts
end_time Time the job ends
completed_flag Flag indicating whether the job has completed
debug_flag Flag indicating whether tracing in job_debug for the current job_id is turned on.
dbms_job_id For Oracle, the value of the “job” column from the user_jobs table generated when the job is submitted to the job queue through dbms_job.submit. Not used for SQL Server.
154 Segment Reference
JOB_ERROR
When an error occurs, during the posting process, a row containing the user-defined and the Oracle or DBMS error message is inserted in this table.
JOB_DEBUG
JOB_PARAMS
Column name Column description
job_type 1 (Sales posting)
job_id If the error happened during the execution of post_sales_batch, this value corresponds to the job_id where the error took place; otherwise the value will be -1, corresponding to post_sales (the super proc) or the shared procedures (job_debug_handler or job_error_handler).
proc_name Name of the procedure in which the error occurred
line_id The line number where the error occurred.
error_timestamp The time when the error occurred
sql_err_num The DBMS or Oracle error number
object_name Name of the object in the database where the error occurred
operation_name The database operation performed on the object
error_msg Combination of the user-defined error message and the DBMS or Oracle error message.
Column name Column description
job_id Unique number representing the job that logged the information.
proc_name Name of the procedure that was executed at the time of log_timestamp.
debug_line_id Identifier of the line in the procedure named by proc_name.
log_timestamp Time at the end of the execution of a particular step corresponding to the debug_line_id
Column name Column description
job_type Unique number representing the type of job: always 1 for Sales posting.
job_batch_size Parameter used when determining the start location_id and end location_id included in a batch.
range_batch_size Parameter used when determining the boundaries of im_sale_number associated with jobs. This range is later split by location batched.
debug_flag Flag indicating whether progress should be logged for this type of job
Segment 3100 - IM to Infobase - Sales Posting 155
JOB_STEP
This data is static and should be loaded at installation. job_type job_step_id job_step_desc--------- ------------ --------------------------------------1 1 ib_inventory/ib_inventory_total update1 2 sales_markdown_audit insert1 3 upc update1 4 style_detail update1 5 ib_activity_date insert/update
JOB_DETAIL
Reprocessing failed jobsWhen a job executes a step within its posting, it will insert a record into the job_detail table indicating that it has completed this step. If for some reason some steps are completed successfully but others are not, the job will have to be restarted; however, it will check to see which steps had already been executed and will not repeat them.
Column name Column description
job_type IB to MA posting correspond to type 1.
job_step_id Id representing a step within the job
job_step_desc Description of the job step.
Column name Column description
job_id Identifier of a job
job_step_id Identifier of a step within the job
time_stamp Time the step for a given job was completed
156 Segment Reference
Segment 4000 - PM Internal - Issue DocumentsThis segment is a scheduled task that is part of the Price Change overnight process. It retrieves price change documents and changes their status to “Issue”. This action notifies Infobase that a new price change document is coming and initiates the process of publishing this information to other modules like PLU.
The price change documents that are candidates for this action have the following settings: Approval_status Not approved OR approved price_change_status = Submitted price_change_duration = Permanent OR price_change_duration = Promotional issue_date <= system date
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according to the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database ParametersThe Merchandising database, parameter_pipeline table, Sequencing PC Docs By Loc Group parameter controls the sequencing of multiple price change documents, in scenarios where a combination of a chain document, pricing group document and/or location exception document has been created for the same style and same effective dates.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMAcceptedIssuedNoCom
Segment 4000 - PM Internal - Issue Documents 157
When Pipeline segment 4000 is run, if this parameter is set to: 0: (Default), price changes are issued in document order number (i.e. the order that
the price changes were created and first saved in). This can cause the chain price to take precedence over the exception price if that chain price was created after the exception price.
1: Price changes are issued in the following order: Chain first, Pricing Group next, and location last. This allows the correct lowest level price to be retrieved for the applicable location.
Note: This option does not address sequencing issues with other exception pricing documents, such as color exceptions.
Non-queue Segment Description Issuing a document can be done manually through the Price Change module of
Merchandising or automatically by running this segment. After having created a new Pricing document, the user may want to issue it
immediately (i.e., without waiting for the overnight process). The Pricing document must be approved in this case.
An approved pricing document becomes issued prior to the effective date. Price history is updated in Infobase. This allows PLU and subsequently the store registers to be notified of the upcoming price changes. Store personnel are notified of upcoming PCs by printing out the Pricing documents when they have been issued. The Approval Status required is: Approved or None.
This segment calls the DTS package called “Scheduled Task”. There is only one task in this package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
The SQL used to retrieve the price change documents that will become “issued” automatically is the following:SELECT price_change_ID, price_change_noFROM price_change
WHERE (approval_status = 0 OR approval_status = 2 ) //CNotApproved & CApproved
AND price_change_status = 2 //SubmittedAND (price_change_duration = 0 //Permanent
OR price_change_duration = 1) //Promotional
AND issue_date <= // system date
Troubleshooting For each error, a block of information is added to a log file. The log file,
PCMTaskError.log, is stored in the directory specified in the following registry key of the Pipeline server: HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog
The log file writes the following information: Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to issue the document.
158 Segment Reference
Segment 4002 - PM Internal - Make Promotional PCs EffectiveThis segment is a scheduled task and is part of the Price Change overnight process. It retrieves promotional price change documents issued and makes them effective by executing the action “Effect” on each document retrieved that has the following settings: price_change_status = Issued price_change_duration = Promotional effective_from_date <= system date
An effective pricing document goes into effect on the effective from date and the price change dollars are posted on the effective date.
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according to the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database ParametersNone.
Non-queue Segment Description A document can be made effective manually through the Price Change module or
automatically by running this segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMIssuedEffective
Segment 4002 - PM Internal - Make Promotional PCs Effective 159
This segment calls the DTS package “Scheduled Task”. There is only one task in this package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
The SQL used to retrieve the price change documents that will become “effective” automatically is the following:SELECT price_change_ID, price_change_no
FROM price_changeWHERE price_change_status = 3 //Issued
AND price_change_duration = 1 //Promo
AND effective_from_date <= // system date
Troubleshooting For each error, a block of information is added to a log file. The log file,
PCMTaskError.log, is stored in the directory specified in the following registry key of the Pipeline server:
HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog The log file writes the following information:
Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to make the price change document effective.
160 Segment Reference
Segment 4003 - PM Internal - Make Permanent PCs EffectiveThis segment is a scheduled task and is part of the Price Change overnight process. It retrieves permanent price change documents issued and makes them effective by executing the action “Effect” on each document retrieved that has the following settings: price_change_status = Issued price_change_duration = Permanent effective_from_date <= system date
An effective pricing document actually goes into effect on the effective from date. On the effective date, if the pricing document duration is Permanent, the inventory levels are revalued to reflect the changing prices. Price change dollars are posted on the effective from date.
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database ParametersNone.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMIssuedCompleted
Segment 4003 - PM Internal - Make Permanent PCs Effective 161
Non-queue Segment Description A document “issue” can be made effective manually through the Price Change
module or automatically by running this segment. This segment calls the DTS package “Scheduled Task”. There is only one task in this
package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
The SQL used to retrieve the price change documents that will become “effective” automatically is the following:SELECT price_change_ID, price_change_noFROM price_change
WHERE price_change_status = 3 //Issued
AND price_change_duration = 0 //PermanentAND effective_from_date <= system date
Troubleshooting For each error, a block of information is added to a log file. The log file,
PCMTaskError.log, is stored in the directory specified in the following registry key of the Pipeline server: HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog
The log file writes the following information: Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to make the price change document effective.
162 Segment Reference
Segment 4004 - PM Internal - Complete Promotional PCsThis segment is a scheduled task and is part of the Price Change overnight process. It retrieves promotional price change effective documents and makes them completed by executing the action “Complete” on each document retrieved that has the following settings: price_change_status = Effective price_change_duration = Promotional effective_to_date <= system date
A completed Pricing document implies no further action will result from the document. Price Change dollars have been posted (for permanent Pricing documents) on the ‘effective from’ date, or the ‘effective to’ date has been reached (for promotional Pricing documents). The document will remain on the system for reporting and inquiry purposes until it is cleaned up (parameter driven).
Segment Parameters
Scheduling RequirementsThese segments could be part of the Price Change overnight process and should be scheduled according to the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database ParametersNone.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMEffectiveCompleted
Segment 4004 - PM Internal - Complete Promotional PCs 163
Non-queue Segment Description A document can be completed manually through the Price Change module or
automatically by running this segment. This segment calls the DTS package “Scheduled Task”. There is only one task in this
package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
The SQL used to retrieve the price change documents that will become “Complete” automatically is the following:SELECT price_change_ID, price_change_no";FROM price_change";
WHERE price_change_status = 4 "; //Effective
AND price_change_duration = 1"; //PromoAND effective_to_date <=system date
Troubleshooting For each error, a block of information is added to a log file. The log file,
PCMTaskError.log, is stored in the directory specified in the following registry key of the Pipeline server:
HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog The log file writes the following information:
Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to complete the document.
164 Segment Reference
Segment 4005 - PM Internal - System Cancel Unapproved Documents
This segment is a scheduled task and is part of the Price Change overnight process. It retrieves submitted price change documents that have been pending approval or rejected for a period of time that exceeds the value specified in the system parameter (parameter_pcm.auto_cancel_unapproved_pc) and executes the action “SystemCancel” on them.
A canceled Pricing document has no further action and is awaiting deletion. It may be canceled manually or by the system. The price change may not have received an approval by the effective date or it may have been approved but the user wants to cancel it before it is issued.
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according to the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database ParametersThe following parameter stores the number of days to keep submitted documents without being approved: parameter_pcm.auto_cancel_unapproved_pc.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMPendingApprCancelled
Segment 4005 - PM Internal - System Cancel Unapproved Documents 165
Non-queue Segment Description This segment calls the DTS package “Scheduled Task”. There is only one task in this
package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
The SQL used to retrieve the price change documents that will become “SystemCancel” automatically is as follows:SELECT price_change_ID, price_change_no";
FROM price_change";WHERE (approval_status = 1 OR approval_status = 3) //CPendingApproval, CApprovalRejected
AND price_change_status = 2 //CSubmittedAND effective_from_date <= (system date – parameter stored in parameter_pcm.auto_cancel_unapproved_pc)
Troubleshooting For each error, a block of information is added to a log file. The log file,
PCMTaskError.log, is stored in the directory specified in the following registry key of the Pipeline server:
HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog The log file writes the following information:
Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to cancel the document.
166 Segment Reference
Segment 4006 - PM Internal - System Delete Cancelled & Completed Docs
This segment is a scheduled task and is part of the Price Change overnight process. It retrieves price change documents that meet the following criteria and deletes them: Price changes that have been canceled for a period of time that exceeds the value
defined in system parameters (parameter_pcm.auto_del_cancel_pc_after_days) Price changes that have been completed for a period of time that exceeds the value
defined in system parameters (parameter_pcm.auto_del_comp_pc_after_days)
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according to the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database Parameters Cancel days are stored in this column:
parameter_pcm.auto_del_cancel_pc_after_days. Delete days are stored in this column:
parameter_pcm.auto_del_comp_pc_after_days.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMSystemDelete
Segment 4006 - PM Internal - System Delete Cancelled & Completed Docs 167
Non-queue Segment Description The segment calculates the cancel date and the complete date based on system
parameters and then it retrieves the price change documents that meet these criteria:SELECT price_change_ID, price_change_no";FROM price_change";
WHERE ( price_change_status = 5 AND status_date <= <calculated cancel date>//status is CanceledOR
price_change_status = 6 AND status_date <= <calculated complete date> // status is Completed)
The segment then executes a Delete on each document retrieved. This segment calls the DTS package “Scheduled Task”. There is only one task in this
package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
Troubleshooting The log file, PCMTaskError.log, is stored in the directory specified in the following
registry key of the Pipeline server: HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog
The log file writes the following information: Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to delete the document.
168 Segment Reference
Segment 4007 - PM Internal - Remove Mix and Match CodesThis segment is a scheduled task and is part of the Price Change overnight process. The segment checks the value of the Remove Mix & Match codes on a permanent price change flag (remove_mixmatch_code_flag) in the PCM parameters table (parameter_pcm) and if the flag is turned on, the segment removes all the mix & match rules attached to permanent price change documents with a status of “Issue". (If the flag is turned off the segment terminates.)
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according to the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database Parameters parameter_pcm. remove_mixmatch_code_flag.
Non-queue Segment Description The SQL used to retrieve the price change documents is the following:
SELECT price_change_ID, price_change_noFROM price_change
WHERE price_change_status = 3 // Issue
AND price_change_duration = 0 //Permanent
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMRemoveMixMatch
Segment 4007 - PM Internal - Remove Mix and Match Codes 169
AND effective_from_date <= //system date + 1
Once the price change documents have been retrieved, the segment executes the action “RemoveMixMatch” on each document.
This segment calls the DTS package “Scheduled Task”. There is only one task in this package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
Troubleshooting For each error, a block of information is added to a log file. The name of the log file,
PCMTaskError.log, is stored in the directory specified in the following registry key of the Pipeline server: HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog
The log file writes the following information: Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to remove mix and match codes from the document.
170 Segment Reference
Segment 4008 - PM Internal - Issue Deal DocumentThis segment is a scheduled task and is part of the Price Change overnight process. It retrieves submitted deal documents and changes the current status to “Issue”. This status ensures that upcoming promotional deals are downloaded to the registers.
The issue date is set to the system date and the PLU files are updated. The action will only occur if the deal has at least one detail attached to it.
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according to the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database ParametersNone.
Non-queue Segment Description A deal document can be issued manually through the Price Change module of
Merchandising or automatically by running this segment. This segment calls the DTS package “Scheduled Task”. There is only one task in this
package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMDealPreliminaryIssued
Segment 4008 - PM Internal - Issue Deal Document 171
The SQL used to retrieve the price change documents that will become “issued” automatically is the following:SELECT deal_ID, deal_noFROM deal
WHERE document_status = 2 "//submitted
AND issue_date <= // system date
Troubleshooting For each error, a block of information is added to a log file. The log file,
PCMTaskError.log, is stored in the directory specified in the following registry key of the Pipeline server: HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog
The log file writes the following information: Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to issue the document.
172 Segment Reference
Segment 4009 - PM Internal - Complete Deal DocumentThis segment is a scheduled task and is part of the Price Change overnight process. It retrieves issued deal documents and executes the action “Complete” on each retrieved document that meets the following criteria: price_change_status = Issue effective_to_date <= system date A completed Pricing document implies no further action will result from the document.
Deal dollars are posted when the ‘effective to’ date is reached. The document remains on the system for reporting and inquiry purposes until it is cleaned up (parameter driven).
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according to the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database ParametersNone.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Def.ault Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMDealIssuedComplete
Segment 4009 - PM Internal - Complete Deal Document 173
Non-queue Segment Description A deal document can be “completed” manually through the Price Change module or
automatically by running this segment. This segment calls the DTS package “Scheduled Task”. There is only one task in this
package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId.)
The SQL used to retrieve the price change documents that will become “complete” automatically is the following:SELECT deal_ID, deal_noFROM deal
WHERE document_status = 3 //Issued
AND effective_to_date <= // system date
Troubleshooting For each error, a block of information is added to a log file. The log file,
PCMTaskError.log, is stored in the directory specified in the following registry key of the Pipeline server:
HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog The log file writes the following information:
Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to complete the document.
174 Segment Reference
Segment 4010 - PM Internal - Delete Completed & Cancelled Deal Docs
This segment is a scheduled task and is part of the Price Change overnight process. It retrieves price change documents that meet the following criteria: Price changes that have been canceled for a period of time that exceeds the value
defined in system parameters (parameter_pcm.auto_del_cancel_pc_after_days) Price changes that have been completed for a period of time that exceeds the value
defined in system parameters (parameter_pcm.auto_del_comp_pc_after_days)
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according to the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database Parameters Cancel days are stored in this column:
parameter_pcm.auto_del_cancel_pc_after_days. Completed days are stored in this column:
parameter_pcm.auto_del_comp_pc_after_days.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMDealSystemDelete
Segment 4010 - PM Internal - Delete Completed & Cancelled Deal Docs 175
Non-queue Segment Description The segment calculates the cancel date and the complete date based on system
parameters and then it retrieves the price change documents that meet these criteria:SELECT deal_ID, deal_no";FROM deal";
WHERE ( document_status = 6 AND status_date <= //strCompleteDate
OR document_status = 5 AND status_date <= //strCancelDate)
The segment then executes a Delete on each document retrieved. This segment calls the DTS package “Scheduled Task”. There is only one task in this
package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
Troubleshooting The log file, PCMTaskError.log, is stored in the directory specified in the following
registry key of the Pipeline server: HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog
The log file writes the following information: Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to delete the document.
176 Segment Reference
Segment 4011 - PM Internal - Update PC TotalsThis segment is a scheduled task and is part of the Price Change overnight process. Since the current retail price and units on hand change constantly and must be recaptured many times during the life cycle of a price change document, this segment is performed nightly. The segment retrieves all the price change documents that aren't yet effective in order to recalculate their total units and cost.
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according the client's needs: Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals
Database ParametersNone.
Non-queue Segment Description Calculate totals can be run at any time by the user through the user interface. It runs
automatically though this segment and will also run automatically when the pricing document changes from issued to effective.
This segment calls the DTS package “Scheduled Task”. There is only one task in this package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising application ID. No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes. It is used to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the PM Component called
Prog ID of the PM component called by the scheduled task controller.
No STSPCMScheduledTask.STSPCMUpdatePCTotals
Segment 4011 - PM Internal - Update PC Totals 177
This segment retrieves all the price change documents that aren't yet effective in order to recalculate their total units and cost. Since price change documents can only have units if they have style(s) assigned to them, the segment only retrieves the documents with a status of “new”, “preliminary” or “submitted” and that have styles attached to their headers.
The SQL used to retrieve the price change documents on which the “Calculate total” function will be executed automatically is the following:SELECT DISTINCTprice_change_no
FROM price_change pc, price_change_style pcs
WHERE pc.price_change_ID = pcs.price_change_ID AND price_change_status < 3 "; //Issued
Troubleshooting For each error, a block of information is added to a log file. The log file,
PCMTaskError.log, is stored in the directory specified in the following registry key of the Pipeline server:
HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog The log file writes the following information:
Segment: <segment name> Document: <price change document number> This is followed by the details related to all the errors that occurred when the
system tried to re-calculate totals on the document.
178 Segment Reference
Segment 4012 – PM Internal – PCM Update LocationsThis segment updates PCM documents with changes to locations that may be required as a result of the creation of a new pricing group. In addition, when new locations are added to or removed from pricing groups. they are added as entries in the location_update_queue database table. When this segment runs, a reference is added to the location in ib_price so that prices will be correctly sent to stores and used in the system.
Segment Parameters
Scheduling RequirementsThis segment must be scheduled before all other PCM segments. It should be run daily in off business hours if you are using pricing groups since it locks a large number of tables.
Database ParametersNA
Non-Queue Segment DescriptionNA
TroubleshootingIf this segment is not run after a location is added or removed from a pricing group, and orders or inventory update ib_on_order or ib_inventory, the segment may fail without an error message. If this occurs, delete the old entries from location_update_queue to resolve the issue.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Application ID Value specified is used by segment for security purposes.
No 100
CompanyID Company ID Value specified is used by segment for connectivity purposes to determine what company the segment should access.
No The company for which the segment has been installed.
Task ProdID Task ProdID Indicates to the common process that runs scheduled tasks that the system update of locations must be performed.
No STSPCMScheduledTasks.STSPCMUpdateLocations
Segment 4013 – PM Internal – System Cancel Unapproved Deal Documents 179
Segment 4013 – PM Internal – System Cancel Unapproved Deal Documents
This segment is a scheduled task and is part of the Price Change overnight process. It retrieves submitted deals documents that have been pending approval or rejected for a period of time that exceeds the value specified in the system parameter (parameter_pcm.auto_cancel_unapproved_pc) and executes the action “SystemCancel” on them.
A canceled Deal document has no further action and is awaiting deletion. It may be canceled manually or by the system. The deal document may not have received an approval by the effective date or it may have been approved but the user wants to cancel it before it is issued.
Segment Parameters
Scheduling RequirementsThese segments can be part of the Price Change overnight process and should be scheduled according to the client's needs. Segment 4000 – PM Internal - Issue Documents Segment 4002 – PM Internal - Make Promotional PCs Effective Segment 4003 – PM Internal - Make Permanent PCs Effective Segment 4004 – PM Internal - Complete Promotional PCs Segment 4005 – PM Internal - System Cancel Unapproved Documents Segment 4006 – PM Internal - System Delete Cancelled and Completed Docs Segment 4005 – PM Internal - System Cancel Unapproved Documents 199 Segment 4007 – PM Internal - Remove Mix and Match Codes Segment 4008 – PM Internal - Issue Deal Document Segment 4009 – PM Internal - Complete Deal Document Segment 4010 – PM Internal - Delete Completed & Cancelled Deal Documents Segment 4011 – PM Internal - Update PC Totals Segment 4012 – PM Internal – PM Internal – PCM Update Locations Segment 4013 – PM Internal – System Cancel Unapproved Deal Documents
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID ApplicationID Value specified is used by segment for security purposes.
No 100
CompanyID CompanyID Value specified is used by segment for connectivity purposes to determine what company the segment should access.
No The company for which the segment has been installed.
Task ProdID Task ProdID Indicates to the common process that runs scheduled tasks that the system update of locations must be performed.
No STSPCMScheduledTasks.STSPCMDealPendingApprCancelled
180 Segment Reference
Database ParametersThe following parameter stores the number of days to keep submitted documents without being approved: parameter_pcm.auto_cancel_unapproved_pc.
Non-Queue Segment Description This segment calls the DTS package “Scheduled Task”. There is only one task in this
package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
The SQL used to retrieve the price change documents that will become “SystemCancel” automatically is as follows:SELECT deal_id, deal_noFROM deal
WHERE (approval_status = 1 OR approval_status = 3)
AND document_status = 2 AND effective_from_date <= (system date – parameter stored in parameter_pcm.auto_cancel_unapproved_pc)
Troubleshooting For each error, a block of information is added to a log file. The log file,
PCMTaskError.log, is stored in the directory specified in the following registry key of the Pipeline server: HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog
The log file writes the following information: Segment: <segment name> Document: <deal document number> This is followed by the details related to all the errors that occurred when the
system tried to cancel the document. If the segment itself fails, check the Manager log in the Pipeline folder on the Pipeline
server for error messages.
Segment 5005 - Infobase to MA - Post Beginning Inventory 181
Segment 5005 - Infobase to MA - Post Beginning InventoryThis segment is executed once at startup to set the on hand tables in MA.
Segment Parameters
Scheduling RequirementsThis segment is executed to set the on hand tables in MA at startup. It must be run before the beginning of inventory, history load and regular daily posting segments, which can be run in any order. History load segments: 16021 to 160028; 11021 to 11028 and 11031 to 11038. Regular Daily posting segments:
5100 - Infobase to MA - Post Flash 5101 - Infobase to MA - Post History 5102 - Infobase to MA - Post Component 5103 - Infobase to MA - Post On Hand 5104 - Infobase to MA - Post On Order Allocation 5105 - Infobase to MA - Initialize
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment uses the following parameters:
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
preSegmentsCheck Mutually Exclusive Segments
This segment parameter prevents segment 5005 from running at the same time as segment 1030 EDM & PROD to MA & SL (Style Reclassification), in order to protect data integrity. This parameter lists the segment number (1030) of the Style Reclassification segment as parameter value.
No 1030 + (1000000 * (@company - 1))
Parameter ID Parameter Label
1 sku last history on_hand week
4 styleclr last history on_hand week
7 style last history on_hand week
10 group last history on_hand week
300 last_ib_inventory_binv_sku
304 Log File for Beg Inventory Sku
305 Log File for Beg Inventory Style
306 Log File for Beg Inventory Styleclr
307 Log File for Beg Inventory Group
308 live merchandising_year_week
309 BInv on_hand has been posted
182 Segment Reference
The Posting steps used by this segment are from 300 to 337 in post_sql. An application has been created in order to view/update the SQL by post_sql.posting_step: RetrieveSQL_ADO.exe.
Non-queue Segment Description This segment sets all the on hand tables for the following dimensions (hist_oh_sku/
styleclr/style/group_loc/chn_wk/pd/yr/li): merchandise hierarchy item (*): sku, style color, style and group; merchandise location hierarchy(**): location and chain time dimension (***): week, period, year and life
The previous posting is completed: if any transactions remain in the work tables post_oh_work_*_*** the following stored procedure runs: post_hist_oh_*_$sp.
The beginning of inventory transactions is retrieved (transaction type 590) from the source database (ib_inventory table) and populates the post_binv_*_sum tables.
The adjustments that need to be applied are calculated by running the post_binv_*_adj_hist_$sp procedure. This retrieves all the rows that are in the on hand history tables for the last history week (LiveWeek –1), multiplies the units, retail and cost values by –1 and enters these adjusted rows in the post_binv_*_adj table. The following flags in the post_parameter table are updated from a ‘N’ to a ‘Y’. 316 BInv_Sku_Hist_Adj_Done 317 BInv_Style_Hist_Adj_Done 318 BInv_StyleClr_Hist_Adj_Done 319 BInv_Group_Hist_Adj_Done
The post_binv_*_adj_$sp procedure populates the post_binv_*_adj table with the adjustments that will be posted to the history tables. The entries in the post_binv_*_sum table are deleted as insert/updates are performed on the post_binv_*_adj table.
The post_binv_*_$sp procedure updates or inserts beginning inventory adjustments in the on hand history tables. The entries in the post_binv_*_adj table are deleted as inserts/updates are performed on the on hand history tables.
Note: The client should go live (EOW live week -1) on the last day of the week.
Troubleshooting The log file name is built as follows: the path and the beginning of the log file name is
kept in post_parameter.parameter_ID 304 to 307 and a timestamp is added to this prefix.
Possible errors:
Error Reason
Error with Calendar tables. Missing past date information in calendar_date table...
Transaction_date –7 doesn't exist in the Merchandising database. – OR - Week –1 doesn't exist in the calendar date in Merchandising Analytics databases.
Err Beginning of Inventory transactions are not all the same day...Please remove transactions that are not the beginning of week day, from ib_inventory...
The transaction date from ib_inventory is not unique for all transaction_type_code 590.
Segment 5005 - Infobase to MA - Post Beginning Inventory 183
Errors reported at the end of segment execution. These errors involve transactions that didn’t make it out of the interface sum or adjustment tables. If this occurs, the package can be run again in the event that a task failed. If, after running the package again, the entries concerned are still in the sum or adjustment table there is likely a problem with the row that was rejected. Things to check: Make sure that all master data for this row that exists in Merchandising also exists
in MerchantView. Make sure the data types are compatible between Merchandising and
MerchantView.
Err there are no data in ib inventory table with transaction type code 590, greater than ib inventory ID .XXX.
No transactions 590 exist in ib_inventory.
Error with post_parameters. Value in parameter_ID 1, 4, 7, and 10 must be greater than or equal to the value in parameter_ID 308.
The regular posting occurred before Beginning of Inventory ran. These transactions should not be part of the History load but should go to a date greater than the live date.
Error, The beginning of Inventory transactions date is not equal to the live date in MV ... + CStr(Time)
Transaction date from ib_inventory is not equal to BOW of Live week in MA.
Error, The beginning of Inventory transactions date is not equal to the live date -1 in MV ... + CStr(Time).
Transaction date from ib_inventory is not equal to EOW of (Live week – 1) in MA
Error Reason
184 Segment Reference
Segment 5006 - Infobase to Stock Ledger - Post TransactionsThis segment updates Stock Ledger.
Segment Parameters
Scheduling Requirements This segment should be scheduled to run daily and cannot run at the same time as
Segment 1030. The segment should start after the sales have been posted from Sales Audit for the
day. This segment has 2 processes running concurrently with 4 working threads each and
is CPU and database-intensive. We recommend that this segment be scheduled with the following in mind: Number of CPUs of the Pipeline Server and the database server. Volume of transactions and data to be processed. Server capacity, amount of memory It should not be run at the same time as other CPU-intensive segments such as
the following: MA daily Posting MA to Planning – Send History
Database Parameters The following need to be configured through Stock Ledger prior to running this
segment:
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
LogFilePath Log File Name Folder where log files will be saved. No C:\STSInterface\SLLogs
ApplicationId Merchandising Application
The Merchandising application ID. No 100
CompanyId Database Company to Use
Company ID used by Epicor Foundation component that defines the database where the SL tables reside.
No The company for which the segment has been installed
ModuleName Stock ledger Registry Module name
This is a registry key on the Pipeline Server from where the Company ID can be read.
No SL
preSegmentsCheck Mutually Exclusive Segments
To ensure data integrity, segments listed cannot be running at the same time as segment 5006. List of segments must be comma separated.
No 1030 + (1000000 * (@company - 1))
CumValStartupOnly Startup Cum_Val_Hist Only
If set =1, only Cum_val_history is rebuilt. Used only when upgrading from 4.3.001 to 4.3.002.If set = 0 SL all history tables are regularly rebuilt from IB tables when this segment is run.
No 0
Segment 5006 - Infobase to Stock Ledger - Post Transactions 185
SL Components Cumulative Value Maps Initial Value Maps Accumulation Periods GL Periods GL Account Defaults
Any needs specific to the client and the method used for the retail inventory calculation are defined in the following tables: sl_component sl_component_ib_map sl_component_rim_map sl_ib_posting_list
Examples of some of the SL components defined:
component_label oh_flag transaction_type_code operator
Adjustment Cost 0 910 1
Adjustment Retail 0 910 1
Net Sales 0 600 1
Net Sales 0 610 -1
ReceiptsRetail 0 200 1
TransferConfirm 0 405 1
TransferRecRetail 0 401 1
TransferSendRetail 0 400 1
receiptcost 0 200 1
receiptcost 0 290 1
sl_onhand_cost 1 200 1
sl_onhand_cost 1 400 -1
sl_onhand_cost 1 401 1
sl_onhand_cost 1 600 -1
sl_onhand_cost 1 910 1
sl_onhand_retail 1 200 1
sl_onhand_retail 1 400 -1
sl_onhand_retail 1 401 1
sl_onhand_retail 1 600 -1
sl_onhand_retail 1 910 1
sl_sales_cost 0 600 1
sl_sales_cost 0 610 -1
sl_sales_retail 0 600 1
sl_sales_retail 0 610 -1
186 Segment Reference
Non-queue Segment Description
Note: SmartLook is used for queries and reports on the results of the segments.
Stock Ledger calculates the costs of goods removed and the cost of on hand. In the retail industry there are two methods for calculating cost of goods sold and removing value from inventory. These are the Retail Inventory Method (RIM) and the Cost Inventory Method (CIM).
Stock Ledger provides a reporting tool that gives clients information down to the store/merchandise level about the sales, receipts, transfers, returns and other pieces of required information on a period basis.
The client can choose a different method of costing by merchandise level. The client can create mapping rules that determine how Core components are posted
to Stock Ledger components.
Note: Balancing inventory between Stock Ledger and Infobase. Since Stock Ledger cannot post transactions for a period that is closed (in order to be consistent with the information sent to the General Ledger application), transactions that are associated with a closed period will go to the first open period that follows the date of the transaction.
Segment logs to an audit trail that lists all changes made to parameters and any other values.
Log files are created in the folder defined in segment parameter LogFilePath. The names of these files are shown in the following screenshot:
SLProcessingLog.log file contains information concerning the tasks that were performed during the execution of the segment. The file is overlaid each time a new run starts.
SPProcessingHistory.log appends a block of information each time the segment runs. The file will grow until it is manually dropped or backed up. The file will be created if it doesn’t exist. The following information is written to the log:Date: 9-19-2003
Segment 5006 - Infobase to Stock Ledger - Post Transactions 187
Processing started at: 11:48:21 AM
Processing ended at: 11:48:38 AMStarted right after History Period Date : 9-15-2003
Ended with History Period Date: 10-12-2003
Started right after IB Inventory ID : 0Ended with IB Inventory ID : 935
Started right after IB Cost Factor ID : 231
Ended with IB Cost Factor ID : 287 SLHist.log reports information concerning database transactions. RIMPostThreadX.log and CumValLowLvt.log retain information concerning their
respective tasks and are useful when troubleshooting. RIMPost.log is created but nothing is logged to this file at this time.
TroubleshootingNo troubleshooting information is currently available for this segment.
188 Segment Reference
Segment 5007 - Infobase to Stock Ledger - Stock Ledger Startup
This segment sets the initial values of on hand in Stock Ledger before the daily posting of Infobase starts posting new transactions. It should only be run if clients go live on Stock Ledger after going live on Merchandising.
Segment Parameters
Scheduling RequirementsThis segment should run once at Stock Ledger startup if the startup occurs after the client goes live on Merchandising.
Database ParametersA temporary table will be generated and deleted within the process. This table holds some of the information that is needed during the process (sl_load_oh_temp_table).
Non-queue Segment Description This segment will not likely be used since it’s unlikely that a client will go live on
Merchandising without going live on Stock Ledger at the same time. This is a one time only DTS Package that brings Stock Ledger up to date with
Merchandising.
Mapping DocumentThe following is an example only (actual data may vary).
Note: The SLComponent Label must match exactly what’s in the sl_component table in the database. The XML tags must be exactly as shown in the example below. Price Status is the price_status_code from the price_status table and Inventory Status is the inventory_status_code from the inventory_status table.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
PathForXMLFile Path and name of XML file
Drive, path and name for the XML file. (An example is given in the Mapping document section.)
Yes C:\STSInterface\StockLedger\sl.xml
StartDate Start date of Stock ledger
The date the client will go live on Stock Ledger in the format YYYY-MM-DD (for example, 2001-08-13).
No
preSegmentsCheck Mutually Exclusive Segments
To ensure data integrity, the segments listed cannot be running at the same time as segment 5007. The list of segments must be separated by commas.
No 5007 + (1000000 * (@company - 1))
Segment 5007 - Infobase to Stock Ledger - Stock Ledger Startup 189
TroubleshootingIf the segment itself fails, search the Manager log in the Pipeline folder on the Pipeline server for error messages.
190 Segment Reference
Segment 5010 - InfoBase To MA – Send Master EntitiesThis segment retrieves style details and IB activity dates from InfoBase and places them in MA.
Segment Parameters
Scheduling RequirementsThis segment must be scheduled after segment 1005 EDM & PROD To MA.
Database ParametersThese parameters are set up in the parameter pipeline table in Merchandising:
Parameter ID 7 (Last processed ib_replication_queue_id for MA): the value of this parameter is set to 0 during setup and is used in segment 5010 internally and updated by the segment automatically; it should never be updated manually.
Parameter ID 8 (Use IB Replication Queue Flag): the value of this parameter should be set to 1 if the client wants to run segment 5010 to send style details and IB activity dates from IB to MA. By default this parameter is set to 0, which prevents segment 5010 from running.
Parameter ID 9 (Cleanup CORE Replication Queue Flag): if this parameter is set to 1, when segment 5010 runs, it will clean up all the style detail entries in the CORE replication queue that have been processed by segment 1005 EDM & PROD To MA, segment 1003 EDM & PROD To SA (if it’s being used) and segment 1004 EDM & PROD To CIM (if it’s being used).
If this parameter is set to 1, segment 5010 also moves all the IB activity date entries in CORE replication queue that haven’t been processed by segment 1005 EDM & PROD To MA from the CORE replication queue to the IB replication queue.
If this parameter is set to 0, segment 5010 does nothing to CORE replication queue.
At startup, this parameter is set to 1; when segment 5010 runs initially, this parameter is updated to 0 by the segment, which means the cleanup of CORE replication queue only needs to be done once. Once the parameter is set to 0, if the client still needs to run
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSize Batch Size Specifies the number of records that can be retrieved from InfoBase and written to MA in one transaction
No 20000
ProcErrors Process previous errors
Indicates if the rejected transactions in the previous execution of this segment should be reprocessed when the segment runs: 1 = Yes; 0 = No
No 0
CleanupRepQeue Cleanup Processed IB Replication Queue Entries
Indicates if the processed IB replication queue entries should be cleaned up: 1 = Yes; 0 = No
No 0
SAInstalled SA Installed Flag Indicates if Sales Audit is installed:1 = Yes; 0 = No
No 0
CRMInstalled CRM Installed Flag Indicates if CRM is installed: 1 = Yes; 0 = No
No 0
Segment 5010 - InfoBase To MA – Send Master Entities 191
segment 5010 to clean up the CORE replication queue with style details and IB activity dates, this parameter should be manually set to 1.
Non-Queue Segment Description The following pipeline dll should be installed on the pipeline server locally, so segment
5010 can run: STSPLIBToMA.dll The new table IB replication queue should be created in Merchandising. Changes should be made in InfoBase to log style details and IB activity dates to IB
replication queue instead of CORE replication queue. The segment runs in 4 steps:
If the segment parameter Cleanup Processed IB Replication Queue Entries is set to 1, it cleans up all the entries that have been processed in the IB replication queue
If the Cleanup CORE Replication Queue Flag (parameter ID 9 in parameter pipeline table in Merchandising) is set to 1, it cleans up the processed style details from CORE replication queue and it moves the unprocessed IB activity dates from the CORE replication queue to the IB replication queue.
If the segment parameter Process previous errors is set to 1, it reprocesses all the IB replication queue entries that were rejected in previous runs of the segment.
It goes through the new entries in IB replication queue, retrieves style details and IB activity dates from InfoBase and sends them to MA.
TroubleshootingAfter the segment runs, the Pipeline Manager Log (i.e. manager.log) should be checked. The following error(s) might be found:
Error Reason
The InfoBase replication queue is empty; the segment has been terminated.
There’s no update of style details and IB activity dates logged to IB replication queue; nothing is to be processed.
Error updating MA with the data between IB replication queue IDs |1 and |2. Please contact NSB. The database error is:
An error occurred when the segment tries to update MA with Merch data. The database connection to MA might be down. The value of segment parameter Batch Size might be too high.
Error updating Merchandising with the data between IB replication queue IDs |1 and |2. Please contact NSB. The database error is:
An error occurred when the segment tried to update Merchandising. The database connection to Merchandising might be down. The value of segment parameter Batch Size might be too high.
Error cleaning up IB replication queue. Please contact NSB. The database error is:
An error occurred when the segment tried to clean up the processed entries from the IB replication queue. The database connection to Merchandising might be down.
Error cleaning up CORE replication queue. Please contact NSB. The database error is:
An error occurred when the segment tried to clean up the processed style details from the CORE replication queue. The database connection to Merchandising might be down.
Error moving CORE replication queue data to IB replication queue. Please contact NSB. The database error is:
An error occurred when the segment tried to move the unprocessed IB activity dates from CORE replication queue to IB replication queue. The database connection to Merchandising might be down.
The feature to use IB Replication Queue isn't active; the segment has been terminated.
Use IB Replication Queue Flag (parameter ID 8 in parameter pipeline table in Merchandising) is still set to 0.
Error updating the Cleanup CRQ flag. Please contact NSB. The database error is:
An error occurred when the segment tries to set the Cleanup CRQ flag (parameter ID 9 in parameter pipeline table in Merchandising) from 1 to 0. The database connection to Merch might be down.
192 Segment Reference
Segment 5100 - Infobase to MA - Post FlashThis segment posts the range of transactions that have been moved to the Flash tables in MA. It is part of a posting cycle initiated by segment 5105 - Infobase to MA - Initialize and it must complete before a new range of transactions can be posted. For additional information, see “Segment 5105 - Infobase to MA - Initialize” on page 202.
Segment ParametersNone.
Scheduling RequirementsSegment 5005 - Infobase to MA - Post Beginning Inventory must have been run once at startup before this segment or the posting cycle is run. This segment is part of the posting cycle which is run after Segment 5105 - Infobase to MA - Initialize. This segment can run at any time in the posting cycle.
Database Pre-requisiteMA database must be at release 4.3 or later.
SQL Server 2005 or higher; Oracle 10g
Non-Queue Segment DescriptionThe following components must be installed: Nsb.MAPosting.dll
This segment works in two phases, first populating Flash work tables, then updating the actual Flash tables.
During the first phase, the stored procedures create rows in the job_header table for type 530 and 540 corresponding to the work tables the job will populate; type 530 works at the style level, and type 540, at the group level.
If an error occurs while the work tables are being populated or validated, the segment fails and an error is logged.During the second phase, the stored procedures create jobs with type 10530 (style level) and 10540 (group level) corresponding to the work table the job will use as its source of data. If an error occurs while the system is preparing the data to post to Flash Sales, or while the posting is being validated, the segment will fail and an error will be logged.
If there are no errors, the flash posting flag in the posting_parameter table is updated to 1.
Mapping documentNone available
Segment 5100 - Infobase to MA - Post Flash 193
TroubleshootingTrace can be turned on in two ways: for all the jobs currently running for one of the job types linked to the posting of Flash
via job_params.debug_flag. The job types specific to the posting of flash for phase 1 are: 530, 540 and for phase 2: 10530, 10540.
for a specific job_id via job_header.debug_flag. Once the flag is turned ON then the process starts tracing steps in the job_debug table.
job_info shows the stored procedures that are executed for each job type. Check for errors in: job_header: after completing the processing, a failed job will have an end_time = null
and a completed_flag = 0. Pipeline Manager.log: at the end of the posting process, if there are incomplete jobs in
job_header, the Pipeline Manager.log will display a segment failure and log the first error that resides in the job_error table.
job_error: the errors will be listed with the procedure name from which the error originated and the line at which it occurred.
194 Segment Reference
Segment 5101 - Infobase to MA - Post HistoryThis segment posts the range of transactions that have been moved to MA. It is part of a posting cycle initiated by segment 5105 - Infobase to MA - Initialize and it must complete before a new range of transactions can be posted. For additional information, see “Segment 5105 - Infobase to MA - Initialize” on page 202.
Segment ParametersNone.
Scheduling RequirementsSegment 5005 - Infobase to MA - Post Beginning Inventory must have been run once at startup before this segment or the posting cycle is run. The posting cycle is run after Segment 5105 - Infobase to MA - Initialize. This segment can run at any time in the posting cycle.
Database Pre-requisitesMA database must be at release 4.3 or later.
The partitioning of the MA history tables must be completed as described in the Pipeline installation documents. SQL server 2005 or later; Oracle 10g
Non-Queue Segment DescriptionThe following components must be installed: Nsb.MAPosting.dll
This segment posts new transactions from work tables to the history tables in MA in two main steps: the first populates History work tables; the second step updates the actual History tables with the transactions from the work tables.
In the first step, the system creates jobs with types 210 (sku), 220 (Style-color), 230 (style), 240 (group), 231 and 241 (both cost factor) corresponding to which work tables the job will populate. Once the job of populating the work tables is finished, the system checks for incomplete jobs. If an error occurs while the work tables are being populated or validated, the segment fails and an error is logged.In the second step, the system creates jobs with types 10210 (sku), 10220 (style-color), 10230 (style), 10240 (group) corresponding to which work table the job will use as its source of data. After all the History tables have been updated with new transactions. the system checks for incomplete jobs. If an error occurs while the system is preparing the files to post to History, or while the posting is being validated, the segment will fail and an error will be logged.When there are no errors, the history posting flag in the posting_parameter table is updated to 1.
Mapping documentNone available
Segment 5101 - Infobase to MA - Post History 195
TroubleshootingTrace can be turned on in two ways: Turning on job_params.debug_flag for a job type linked to the posting of history turns
tracing on for all jobs linked to the specified job type. The job types specific to the posting of history for phase 1 are: 210, 220, 230, 231, 240, 241 and for phase 2: 10210, 10220, 10230, 10240.
Turning on job_header.debug_flag for a specific job_id. Once the flag is turned ON, the process starts tracing steps in the job_debug table.
job_info shows the stored procedures that are executed for each job type.
Check for errors in: job_header: after completing the processing, a failed job will have an end_time = null
and a completed_flag = 0. Pipeline Manager.log: at the end of the posting process, if there are incomplete jobs in
job_header, the Pipeline Manager.log will display a segment failure and log the first error that resides in the job_error table.
job_error: the errors will be listed along with the procedure from which the error originated and the line at which it occurred.
196 Segment Reference
Segment 5102 - Infobase to MA - Post ComponentThis segment posts the range of transactions that have been moved to MA. It is part of a posting cycle initiated by segment 5105 - Infobase to MA - Initialize and it must complete before a new range of transactions can be posted. For additional information, see “Segment 5105 - Infobase to MA - Initialize” on page 202.
Segment ParametersNone.
Scheduling RequirementsSegment 5005 - Infobase to MA - Post Beginning Inventory must have been run once at startup before this segment or the posting cycle is run. The posting cycle is run after Segment 5105 - Infobase to MA - Initialize. This segment can run at any time in the posting cycle.
Database Pre-requisitesMA database must be at release 4.3 or later.
The partitioning of the MA history tables should be completed as described in the Pipeline installation documents. SQL Server 2005 or later; Oracle 10g
Non-Queue Segment DescriptionThe following components must be installed: Nsb.MAPosting.dll
This segment posts new transactions from work tables to the component tables in MA in two main phases: the first populates cmp work tables; the second updates the actual cmp tables with the transactions from the work tables.
In the first phase, jobs with types 110 (sku), 120 (style-color), 121, 130 (style), 131, 140 (group), 141 corresponding to the work table the job will populate, are created. Once the job of populating the work tables is finished, the system checks for incomplete jobs. If an error occurs at any time during process of building or validating the work tables, the segment fails and an error is logged.In the second phase, the system creates jobs with types 10110 (sku), 10120 (style-color), 10130 (style), 10140 (group) corresponding to which work table the job will use as its source of data. After all the Component tables (hist_cmp_sku/styleclr/style/group_loc/chn_wk/pd/yr/li) have been updated with new transactions, the system checks for incomplete jobs. If an error occurs at any time during the process of updating and validating the Component tables, the segment fails and an error is logged.If there are no errors, the component posting flag in the posting_parameter table is updated to 1.
Mapping documentNone available
Segment 5102 - Infobase to MA - Post Component 197
TroubleshootingTrace can be turned on in two ways: Turning on job_params.debug_flag for a job type linked to the posting of to the cmp
tables turns on tracing for all jobs associated with the specified job type. The job types specific to posting to cmp tables for phase 1 are: 110, 120, 121, 130, 131, 140, 141 and for phase 2: 10110, 10120, 10130, 10140.
Turning on job_header.debug_flag for a specific job_id. Once the flag is turned ON, the process starts tracing steps in the job_debug table.
job_info shows the stored procedures that are executed for each job type.
Check for errors in: job_header: after completing the processing, a failed job will have an end_time = null
and a completed_flag = 0. Pipeline Manager.log: at the end of the posting process, if there are incomplete jobs in
job_header, the Pipeline Manager.log will display a segment failure and log the first error that resides in the job_error table.
job_error: the errors will be listed along with the procedure from which the error originated and the line at which it occurred.
198 Segment Reference
Segment 5103 - Infobase to MA - Post On HandThis segment posts the range of transactions that have been moved to MA.It is part of a posting cycle initiated by segment 5105 - Infobase to MA - Initialize and it must complete before a new range of transactions can be posted. For additional information, see “Segment 5105 - Infobase to MA - Initialize” on page 202.
Segment ParametersNone.
Scheduling RequirementsSegment 5005 - Infobase to MA - Post Beginning Inventory must have been run once at startup before this segment or the posting cycle is run. The posting cycle is run after Segment 5105 - Infobase to MA - Initialize. This segment can be run at any time in the posting cycle. We suggest that the posting cycle be kicked off early in the day (12:05 a.m.) to ensure that all segments run in the same calendar period.
Database Pre-requisitesMA database must be at release 4.3 or later.
The partitioning of the MA history tables should be completed as described in the Pipeline installation documents.
SQL Serve 2005 or later; Oracle 10g
Non-Queue Segment DescriptionThe following components must be installed: Nsb.MAPosting.dll
This segment posts new transactions from work tables to the History On Hand tables in MA in two main phases: in the first, the .NET class calls the rolling process by which beginning on hand values are inserted into the history on hand tables based on the transaction date (max_transaction_date). During this phase, the job_ids for the Rolling process are created and queued. After all the jobs in the queue have run to completion, the On Hand tables have been updated with beginning on hand values. If there are any errors during the rolling process, the segment stops and an error is logged.In the second part of the phase, another class populates On Hand work tables for job types 310 (sku), 320 (style-color), 330 (style), 340 (group). If there are any errors during the execution of this phase, the segment fails and an error is loggedThe second phase updates the On hand values in the actual MA tables with the transactions from the work tables. Jobs with type 10310 (sku), 10320 (style-color), 10330 (style), 10340 (group) corresponding to which work table the job will use as its source of data, are created. After all the On Hand tables(hist_oh_sku/styleclr/style/group_loc/chn_wk/pd/yr/li) have been updated with new transactions, the system checks for incomplete jobs. If an error occurs at any time during the process of updating the On Hand tables, the segment fails and an error is logged. When there are no errors, the system updates the on hand posting flag in the posting_parameter table to 1.
Mapping documentNone available
Segment 5103 - Infobase to MA - Post On Hand 199
TroubleshootingTrace can be turned on in two ways: Turning on job_params.debug_flag for a job type linked to posting to the on hand
history tables turns on tracing for all jobs associated with the specified job type. The job types specific to the Rolling process which is executed before the actual posting of the on_hand transactions are: 20010, 20020, 20030, 20040, 21010, 21020, 21030 and 21040 for a new week; 20110, 20120, 20130, 20140, 21110, 21120, 21130 and 21140 for a new period; 20210, 201220, 20230, 20240, 21210, 21220, 21230 and 21240 for a new year. The job types related to the posting of on hand are for phase 1: 310, 320, 330, 340 and for phase 2: 10310, 10320, 10330, 10340.
Turning on job_header.debug_flag for a specific job_id. Once the flag is turned ON, the process starts tracing steps in the job_debug table.
job_info shows the stored procedures that are executed for each job type. Check for errors in: job_header: after completing the processing, a failed job will have an end_time = null
and a completed_flag = 0. Pipeline Manager.log: at the end of the posting process, if there are incomplete jobs in
job_header, the Pipeline Manager.log will display a segment failure and log the first error that resides in the job_error table.
job_error: the errors will be listed along with the procedure from which the error originated and the line at which it occurred.
Possible errors:
Error Source/Error Message Meaning/Solution
On Hand Posting/ nn Rolling On Hand procedures did not complete. In job_error table ALTER TABLE SWITCH statement failed. The specified partition nn of target table <tablename> must be empty.
Can occur if the Initialize segment (5105) was run in one calendar period and the subsequent segments were run in another. To resolve, open a SQL query to the affected MA database and execute add_partitions_$sp with NO parameters.Then do you run 5103 again?
On Hand Posting/Error while rolling on hand posting. An entry is missing in job_header for job type <nnnnn>.
Check the following tables: job_header should have 73 rows (one row for each job type)job_info should have 89 rowsjob_params should have 91 rows.If job_header is missing a row for any job type, add it.
200 Segment Reference
Segment 5104 - Infobase to MA - Post On Order AllocationThis segment posts the range of transactions that have been moved to MA. It is part of a posting cycle initiated by segment 5105 - Infobase to MA - Initialize and it must complete before a new range of transactions can be posted. For additional information, see “Segment 5105 - Infobase to MA - Initialize” on page 202.
Segment ParametersNone.
Scheduling RequirementsSegment 5005 - Infobase to MA - Post Beginning Inventory must have been run once at startup before the posting cycle is run. The posting cycle is run after Segment 5105 - Infobase to MA - Initialize. S
Database Pre-requisitesMA database must be at release 4.3 or later.
SQL Server 2005 or later; Oracle 10g
Non-Queue Segment DescriptionThe following components must be installed: Nsb.MAPosting.dll
This segment posts new transactions from work tables to the On Order and Allocation tables in MA in two main steps: the first populates On Order Allocation work tables; the second updates the actual On Order and Allocation tables with the transactions from the work tables.
In the first step, jobs are created with type 612 (sku), 622 (style-color), 632 (style), 642 (group) , 613 (sku), 623 (style-color), 633 (style), 643 (group) corresponding to the work table the job will populate. To populate the work tables, jobs 612, 622, 632 and 642 work from ib_on_order; jobs 613, 623, 633 and 643 work from ib_allocation. Once the job of populating the work tables is finished, the system checks for incomplete jobs. If an error occurs at any time during process of building or validating the work tables, the segment fails and an error is logged.In the second step, jobs with type 10612 (sku), 10622 (style-color), 10632 (style) and 10642 (group) are created. These job types are related to the work tables that the job uses as its source of data. After all the On Order tables have been updated with new transactions, the system checks for incomplete jobs. If an error occurs at any time during the process of updating and validating the On order tables, the segment fails and an error is logged.When there are no errors, the on order allocation posting flag in the posting_parameter table is updated to 1.
Mapping documentNone available
Segment 5104 - Infobase to MA - Post On Order Allocation 201
TroubleshootingTrace can be turned on in two ways: Turning on job_params.debug_flag for a job type linked to the posting to the order
allocation history tables turns on tracing for all jobs associated with the specified job type. The job types specific to the posting of on hand for phase 1 are: 612, 613, 622, 623, 633, 642, 643 and for phase 2: 10612, 10622, 10632, 10642.
Turning on job_header.debug_flag for a specific job_id. Once the flag is turned ON, the process starts tracing steps in the job_debug table.
job_info shows the stored procedures that are executed for each job type.
Check for errors in: job_header: after completing the processing, a failed job will have an end_time = null
and a completed_flag = 0. Pipeline Manager.log: at the end of the posting process, if there are incomplete jobs in
job_header, the Pipeline Manager.log will display a segment failure and log the first error that resides in the job_error table.
job_error: the errors will be listed along with the procedure from which the error originated and the line at which it occurred.
202 Segment Reference
Segment 5105 - Infobase to MA - InitializeThis segment replaces Segment 5004 Infobase to MA - Initialize Posting. It initiates a new posting cycle and moves the transactions from Merch to MA database. The current version of Posting from Infobase to MA supports only MSSQL databases. It is divided into five areas, each with its own Pipeline segment. The segments use a .NET assembly called Nsb.MAPosting.dll that contains classes associated with a specific area: History Posting, On Hand Posting, Component Posting, Flash Posting and On-Order Allocation Posting.
Each class of the assembly creates jobs of different types in the job_header table. Each job is associated with a specific job type and a procedure name that will perform a portion of the posting process at execution. The jobs are queued and the .NET class creates threads that will execute the jobs in parallel until the job queue is empty. The job_header table contains information such as batch sizes and id ranges that the stored procedure uses while performing its tasks. Each posting process follows a pattern that has two main phases: the first posts data to work tables; the second posts data from the work tables to the actual MA tables. Each posting step maintains four work tables to store transactions at four different levels: sku, style-color, style, and hierarchy group.
Segment ParametersNone.
Scheduling RequirementsSegment 5005 - Infobase to MA - Post Beginning Inventory must have been run once at startup before this segment or the posting cycle is run.
This segment is run after segment 3100 - IM to Infobase - Sales Posting. It precedes the posting cycle, which contains these segments: 5100 - Infobase to MA - Post Flash 5101 - Infobase to MA - Post History 5102 - Infobase to MA - Post Component 5103 - Infobase to MA - Post On Hand 5104 - Infobase to MA - Post On Order Allocation
However, in order for segment 5105 to begin a new posting cycle, all the segments in a previous posting cycle must have been successfully completed. We suggest that to ensure all segments in the posting cycle run in the same calendar period, and to avoid errors that occur when periods are crossed during the execution of Segment 5103, the posting cycle be kicked off shortly after midnight on days when it runs.
Database Pre-requisitesMA database must be at release 4.3 or later.
Non-Queue Segment DescriptionThe following components must be installed: Nsb.MAPosting.dll This segment pulls new data from InfoBase that will be posted by the segments in the posting cycle. It populates four main work tables in MA that correspond to actual tables in
Segment 5105 - Infobase to MA - Initialize 203
InfoBase; ib_inventory, ib_allocation, ib_on_order, and ib_cost_factor_discount. The other segments will use the work tables in MA as their source of new data. There are three steps in Initialization. The first step reruns any incomplete Initialize jobs from the previous posting cycle and attempts to reprocess them. If reprocessing fails, an error is logged. If all previously run Initialize jobs were successful, it checks to make sure that all 5 segments for the previous posting cycle were completed successfully; if they were not, it fails and an error is logged. If all 5 segments completed successfully, it adds a new row to posting_parameter and sets the flag to 0 for each of the 5 posting steps.
If the actual posting crosses to a new week/period/year, it creates new partitions.If there are any errors during the running of this step, the segment fails and an error is logged.
The second step creates jobs with job types 50, 51, 52 and 53 corresponding to the 4 work tables, places the jobs in a queue and processes them. The system transfers all records that have been added to the following Infobase tables since the last time this segment was run: Max ib_inventory_id Max ib_cost_factor_discount_id Max ib_allocation_id Max ib_on_order_id
The system verifies that all jobs have run to completion. If any error occurs at any time during execution of step 2, the segment fails and an error message is logged.
Mapping documentNone available
TroubleshootingIf the segment fails, restart it.
Trace can be turned on in two ways: Turning on the job_params.debug_flag starts trace for all the jobs currently running
for the specified job type linked to the posting process. The job types specific to initialization are 50, 51, 52, 53.
Turning on job_header.debug_flag for a specific job_id. Once the flag is turned ON, the process starts tracing steps in the job_debug table.
job_info shows the stored procedures that are executed for each job type.
Note: Once the segment has completed without errors, you can truncate the debug table if you had trace turned on and set the debug flag = 0.
Table posting_parameter in MA keeps track of each posting cycle; it's very useful for monitoring, tracing and troubleshooting each posting cycle.
204 Segment Reference
Segment 6001 - Stock Ledger to General Ledger Exp Tbls - Export Trans
This segment makes Stock Ledger data available to the General Ledger application.
Segment Parameters
Scheduling RequirementsThis segment is the first step in the process that exports data from Stock Ledger to General Ledger. The second step is performed by Pipeline Segment 28000, which reads this data from a table in SL (gl_export), formats it and produces a text file. This segment should run before Segment 28000 General Ledger Export Tables to Text File – Export Trans.
Database Parameters General Ledger is a flexible application that must be configured to fit the financial
requirement of a particular client. A default configuration is provided and is kept in the following tables: gl_export_default gl_acc_struct_defaults
If the default configuration is not used, the following information contained in these tables must be validated prior to running this segment for the first time: gl_component gl_component_map gl_account gl_account_structure gl_account_structure_def
The output of this segment populates the gl_export table for a specific period.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
LogFilePath Log File Name The folder where the log files will be saved.
No C:\STSInterface\SLLogs
ApplicationId Merchandising Application
The Merchandising application ID. No 100
CompanyId Database Company to Use
Value specified is used by the segment for connectivity purposes to determine what company the segment should access.
No The company for which the segment has been installed
ModuleName Stock ledger Registry Module name
This is a registry key on the Pipeline Server from where the Company ID can be read.
No SL
Segment 6001 - Stock Ledger to General Ledger Exp Tbls - Export Trans 205
Non-queue Segment Description General Ledger defines the subset of transactions that must be captured from the
existing Stock Ledger components (contained in sl_component). Usually Stock Ledger accumulates transactions for a certain level of the Merchandise hierarchy by location/period. General Ledger is typically interested in the transactions summed at a higher level (by department/chain). The segment is the "summing" part of the Stock Ledger components at the level required by General Ledger. This data is stored in the sl_export table.
Before running the segment, the period to be exported must be selected. It need not be closed and it can be any period (since you may want to send data to GL on an ongoing basis, e.g., month to date). This also allows you to see what is in General Ledger before you close the period so you can make corrections if necessary. After making corrections another export must be sent.
GL transactions are defined and parameters for the export are set in Enterprise Data Management.
The content of sl_export becomes the input to produce a text file that will be exported to a General Ledger application.
The log file produced is called SLGLPosting.log. It contains information concerning the tasks performed by the segment and the SQL used to populate the export table. The file is overlaid each time the segment runs.
The most common errors found are related to the configuration. Once the configuration is set up properly, the segment runs smoothly.
Example of the SQL used to cumulate data:
INSERT into gl_export
(gl_company_no, gl_period_code, gl_date, gl_account_no, value,
statistical_flag, account_type, gl_source) SELECT glcomp.gl_company_no, glper.gl_period_code, glper.end_date, {fn CONCAT({fn CONCAT({fn CONCAT('AC059' ,',1,')}, {fn CONCAT({fn CONCAT({fn RTRIM({fn SUBSTRING(
hg2000002.hierarchy_group_label, 1, 4)})},{fn REPEAT('0',4 - {fn LENGTH({fn SUBSTRING(
hg2000002.hierarchy_group_label, 1, 4)})})})},',3,')})} , {fn CONCAT('2902' ,',1')})} , (1) *
sum(sl_history.history_value * (1-abs(sign({fn ifnull(sl_history.sl_component_ID,0)} - 2.000000 )))) val,
0, 0, 1 FROM history_period histper, sl_history, gl_company glcomp,
location loc, gl_period glper,sl_component slcomp , hierarchy_group hg2000002, location_parent lp2000002, hierarchy h2000002 WHERE histper.history_period_ID = sl_history.history_period_ID AND loc.location_ID = sl_history.location_ID AND loc.gl_company_ID = glcomp.gl_company_ID AND glper.gl_period_ID = 1000403.000000
AND slcomp.sl_component_ID = sl_history.sl_component_ID AND (
(glper.gl_period_ID = histper.gl_period_ID and slcomp.on_hand_flag = 0)
206 Segment Reference
OR(histper.start_date = (select max(h.start_date) from
history_period h where h.gl_period_ID =glper.gl_period_ID) and slcomp.on_hand_flag = 1)
) AND sl_history.location_ID = lp2000002.location_ID AND lp2000002.hierarchy_level_ID = 2.000000 AND lp2000002.parent_hierarchy_group_ID = hg2000002.hierarchy_group_ID AND hg2000002.hierarchy_ID = h2000002.hierarchy_ID AND h2000002.hierarchy_type = 2 AND h2000002.alternate_flag = 0 GROUP BY glcomp.gl_company_no, glper.gl_period_code, glper.end_date ,
hg2000002.hierarchy_group_label
Note:Gross Amount, Net amount and Non Terms Net Amount are exported in home currency, vendor currency and GL company currency. These fields are included in the Export Invoice File. GL Company currency is the jurisdiction currency defined for the GL company with which the subledger entry is associated.
TroubleshootingIf the segment itself fails, search the Manager log in the Pipeline folder on the Pipeline server for error messages.
Segment 6002 - Stock Ledger to MA – Send RIM Costs 207
Segment 6002 - Stock Ledger to MA – Send RIM Costs This segment retrieves RIM (Retail Inventory Method) values from Stock Ledger and places them in Merchandise Analytics.
Segment Parameters
Scheduling RequirementsThis segment should be scheduled to run after the IB to MA segments (i.e. segments 5104, 5100, 5102, 5101 and 5103).
Database ParametersThe following Stock Ledger Components must be set up in Stock Ledger:
Parameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Batch Size The amount of records that can be read from Stock Ledger and written to MA in 1 transaction.
No
Log File Directory
The directory where the log file is generated.
No
sl_component_id sl_component_label
7 Distributions (Net) Cost
8 Distributions (Net) Retail
10 Freight and Other Cost Factors
13 Markups Retail
14 On Hand Retail
17 Purchases (Net) Cost (before other costs)
18 Purchases (Net) Retail
20 Transfers (Net) Cost
21 Transfers (Net) Retail
22 RIM Actual Shrink Cost
24 RIM Employee Discounts Cost
25 RIM Inventory Reductions Cost
26 RIM Markdown (Net) Cost
27 RIM On Hand Cost
29 RIM POS Markdowns (Net) Cost
208 Segment Reference
Non-queue Segment DescriptionThe mapping between the business requirement, Stock Ledger components, the newly created columns in MA sales history tables and the created/modified plan elements in MA:
TroubleshootingAfter segment runs, check the pipeline manager log (i.e. manager.log) to see if any errors were raised.
RIM Costs described in Business Requirement
SL Component Id
SL Component Label MA new columnsPlan Element number
RIM Cost of Goods Sold 25 RIM Inventory Reductions Cost inventory_reductions_cost
113
RIM Shrink Total Cost 22 RIM Actual Shrink Cost shrink_total_cost 273
RIM Markdown Permanent Cost
26 RIM Markdown (Net) Cost markdown_cost 271
RIM Markdown Promotional Cost
29 RIM POS Markdowns (Net) Cost markdown_promo_cost 272
RIM Employee Discounts Cost
24 RIM Employee Discounts Cost
Purchases (net) cost (before other costs)
17 Purchases (Net) Cost (before other costs)
rim_additions_cost N/A
Distributions (net) cost 7 Distributions (Net) Cost
Transfers net cost 20 Transfers Net Cost
Freight 10 Freight and Other Cost Factors
On hand Retail 14 On Hand Retail rim_on_hand_retail N/A
Purchases (net) retail 18 Purchases (Net) Retail purchase_net_retail N/A
Distributions (net) retail 8 Distributions (Net) Retail distribution_net_retail N/A
Transfers (net) retail 21 Transfers (Net) Retail transfer_net_retail N/A
Markups 13 Markups markups_retail N/A
RIM on-hand cost 27 RIM On Hand Cost rim_on_hand_cost
Segment 7000 - Invoice Matching to Text File 209
Segment 7000 - Invoice Matching to Text FileThis segment loads Invoices from IMAT into text files.
Segment Parameters
Scheduling RequirementsNo info. is available.
Database ParametersNo Pipeline parameters are stored in the source or destination database for this segment.
Queue Segment Description The segment does not require any Pipeline dlls to be installed. When an output file is generated, it is named as follows:
STSIMATInvoiceExport.yyyymmddhhmmss.IP (yyyymmddhhmmss is a timestamp) After the output file is generated, it is renamed to:
STSIMATInvoiceExport.yyyymmddhhmmss.OUT
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Output File Directory
The directory where the output files are found.
No C:\NSB Interface\ Invoice Matching To Text File
Epicor9Format Epicor 9 Format Determines whether the “Terms code” is written to the header record of the output file.
No 0 - Not written
Entity Action Description
Invoice Create Flat File (1)
Create Flat File (IR) The following information is sent to the text file (see Mapping Document for this segment): Invoice header Invoice messages Invoice details Invoice references Invoice discounts Invoice charges Invoice adjustments The following tax information is exported: On an invoice header, the following tax columns are added:
Jurisdiction Tax valid flag
210 Segment Reference
TroubleshootingIf the segment itself fails, search the Manager log in the Pipeline folder on the Pipeline server for error messages. To determine whether errors occurred during the running of this segment, check the statistics tab for the individual segment in Pipeline Administrator; if errors occurred, details are reported in the Error queue.
Invoice Create Flat File (1) (cont’d)
Manually matched flag Total tax amount calculated Total tax amount charged
A new record type invoice total tax is added: Tax type Taxable amount Tax amount
On an invoice detail, the following tax columns are added: Tax amount
A new record type invoice detail tax is added (an invoice detail can have many detail taxes based on the jurisdiction tax or jurisdiction tax exception settings): Tax type Tax rate code Tax rate Surtax Taxable amount Tax amount
On an invoice subledger, the following tax columns are added: Gross amount foreign Net amount foreign Non terms net amount foreign Tax type Tax amount Tax amount foreign
Entity Action Description
Segment 7001 - Invoice Matching Internal - Exec outstanding processes 211
Segment 7001 - Invoice Matching Internal - Exec outstanding processes
This segment is a scheduled task that should run automatically on a daily/weekly basis according to the client's needs. It retrieves all matching processes that are outstanding and executes the action “Automated Matching”. This automated process matches the invoices contained in each process to a receipt.
Segment Parameters
Scheduling RequirementsThe segment should be scheduled to run daily or weekly according to the client's needs. If a client manually executes “Automated Matching” after creating a process there no need to run this segment. If a client creates processes in IMAT and lets the segment execute the automated matching, the segment should be run as often as processes are created.
Database ParametersThere are no Pipeline parameters in the source or destination database for this segment.
Non-queue Segment Description The Matching Process can be done manually through the Invoice Matching or
automatically by running this segment. The Matching Process consists of linking an invoice with a receipt in order to release
the invoice and send it to the accounts payable application. This segment calls the DTS package “Scheduled Task”. There is only one task in this
package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
Troubleshooting Each time the segment runs, a block of information is added to a log file. The name of
the log file is STSIMatMatchTask.log and it’s stored in the directory specified in the following registry key of the Pipeline server: HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog
A start block with the text Category: Undefined error appears at the beginning of the log file. This is normal and doesn’t indicate a problem with the execution of the segment. The following is an example of a scheduled task that ran successfully:
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising Application ID No 100
CompanyID Database Company to Use
The company ID used by the Epicor Foundation Component that defined the database where the IMAT tables reside.
No The company for which the segment has been installed
TaskProgID Prog ID of the IMAT Component called
Prog ID of the IMAT component called by the scheduled task controller.
No STSIMATScheduledTask.STSIMATAutoMatchTask
212 Segment Reference
CSTSPRODStyleDeleteSource: 0 () in CSTSPRODStyleDelete:doExecuteTaskDescription: === End of log for company ID = ' 73 ' ===Timestamp: 2003-08-28 13:01:34Category: Undefined error----------------------------------------------------------------CSTSPRODStyleDeleteSource: 0 () in CSTSPRODStyleDelete:doExecuteTaskDescription: === Start of log for company ID = ' 73 ' ===Timestamp: 2003-08-28 13:02:44Category: Undefined error----------------------------------------------------------------
CSTSPRODStyleDeleteSource: 0 () in CSTSPRODStyleDelete:doExecuteTaskDescription: === End of log for company ID = ' 73 ' ===Timestamp: 2003-08-28 13:02:44Category: Undefined error
If the segment doesn’t complete successfully, an error message is logged. Example:----------------------------------------------------------------CSTSPRODStyleDeleteSource: Style (100000247) in STSItemProc:XApproveDeletionDescription: Style can't be deleted. It is referenced in the following documents: (0 distribution rule record(s)) (0 location eligibility record(s)) (0 location protection record(s)) (0 merchandise location distribution parameter(s)) (0 pick review parameter(s)) (0 size scale(s)) (0 vendor review parameter(s))Timestamp: 2003-11-14 14:36:13Category: Referential integrity violation----------------------------------------------------------------CSTSPRODStyleDeleteSource: Style (100000311) in STSItemProc:XApproveDeletionDescription: Style can't be deleted. It is referenced in the following documents: (0 distribution rule record(s)) (0 location eligibility record(s)) (0 location protection record(s)) (0 merchandise location distribution parameter(s)) (0 pick review parameter(s)) (0 size scale(s)) (0 vendor review parameter(s))PO (PO No.: 55807)Inventory Management (User-Defined Adjustment Number: 000019)Infobase (Style is referenced in Infobase table.: On Order)Infobase (Style is referenced in Infobase table.: On Order Total)Pricing (Price Change Style of price change document: 000294, 000380)Timestamp: 2003-11-14 14:36:16Category: Referential integrity violation
Segment 7003 - Invoice Matching Internal - System Del Matched Invoice 213
Segment 7003 - Invoice Matching Internal - System Del Matched Invoice
This segment is a scheduled task that should run automatically on a daily/weekly basis according to the client's needs. The segment calculates the date corresponding to the latest history date that should be retained and then deletes all the invoices that have a "Matched" status code for which the match date time is older than the latest history date calculated.
Segment Parameters
Scheduling RequirementsThe segment should be scheduled to run daily or weekly based on the client's use of the IMAT module.
Database ParametersNone.
Non-queue Segment Description The System Delete Matched Invoices calculates the latest history date according the
value of the column: parameter_imat.invoice_history_days. The SQL used to retrieve the invoices that will be deleted is the following:
SELECT imat_header_ID, invoice_number, vendor_code
FROM imat_header, vendorWHERE match_status_code = STSIMATGlobals::CMatchedInvoice
AND match_date_time < calculates the latest history date
AND imat_header.vendor_ID = vendor.vendor_ID This segment calls the DTS package “Scheduled Task”. There is only one task in this
package and a script that calls STSScheduledTaskController.dll. This controller then calls the component specified in the Pipeline parameter (TaskProgId).
Parameter Name Parameter Display Name DescriptionModifiable with Pipeline Admin.
Default Value
ApplicationID Merchandising Application
The Merchandising Application ID No 100
CompanyID Database Company to Use
Value specified is used by the segment for connectivity purposes to determine what company the segment should access.
No The company for which the segment has been installed
TaskProgID Prog ID of the IMAT Component called
Prog ID of the IMAT component called by the scheduled task controller.
No STSIMATScheduledTask.STSIMATDeleteInvoices
214 Segment Reference
Troubleshooting Each time the segment runs, a block of information is added to a log file. The name of
the log file is STSIMATDeleteInvoices.log and it’s stored in the directory specified in the following registry key of the Pipeline server: HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\STSExceptionsLog
A start block with the text Category: Undefined error appears at the beginning of the log file. This is normal and doesn’t indicate a problem with the execution of the segment. The following is an example of a scheduled task that ran successfully: ----------------------------------------------------------------CSTSPRODStyleDelete
Source: 0 () in CSTSPRODStyleDelete:doExecuteTask
Description: === End of log for company ID = ' 73 ' ===Timestamp: 2003-08-28 13:01:34Category: Undefined error
----------------------------------------------------------------
CSTSPRODStyleDeleteSource: 0 () in CSTSPRODStyleDelete:doExecuteTask
Description: === Start of log for company ID = ' 73 ' ===
Timestamp: 2003-08-28 13:02:44Category: Undefined error
----------------------------------------------------------------CSTSPRODStyleDelete
Source: 0 () in CSTSPRODStyleDelete:doExecuteTask
Description: === End of log for company ID = ' 73 ' ===Timestamp: 2003-08-28 13:02:44Category: Undefined error
If the segment doesn’t complete successfully, an error message is logged. Example:
----------------------------------------------------------------
CSTSPRODStyleDeleteSource: Style (100000247) in STSItemProc:XApproveDeletion
Description: Style can't be deleted. It is referenced in the following documents:
(0 distribution rule record(s)) (0 location eligibility record(s))
(0 location protection record(s))
(0 merchandise location distribution parameter(s)) (0 pick review parameter(s))
(0 size scale(s))
(0 vendor review parameter(s))Timestamp: 2003-11-14 14:36:13Category: Referential integrity violation
----------------------------------------------------------------
CSTSPRODStyleDeleteSource: Style (100000311) in STSItemProc:XApproveDeletion
Description: Style can't be deleted. It is referenced in the following documents:
(0 distribution rule record(s)) (0 location eligibility record(s))
Segment 7003 - Invoice Matching Internal - System Del Matched Invoice 215
(0 location protection record(s))
(0 merchandise location distribution parameter(s)) (0 pick review parameter(s))
(0 size scale(s))
(0 vendor review parameter(s))PO (PO No.: 55807)
Inventory Management (User-Defined Adjustment Number: 000019)
Infobase (Style is referenced in Infobase table.: On Order)Infobase (Style is referenced in Infobase table.: On Order Total)
Pricing (Price Change Style of price change document: 000294, 000380)
Timestamp: 2003-11-14 14:36:16Category: Referential integrity violation----------------------------------------------------------------
216 Segment Reference
Segment 8000 - WM to MerchandisingThe segment advises IM and AR of relevant inventory and distribution transactions that have occurred in WM.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
4Wall_Company WM Company The number of the WM company with which the segment integrates. The number specified must be the same as the number of the Merchandising company with which the segment integrates and must also match the company number for which the Pipeline segment has been configured in the Pipeline Repository database. WM requires all data and transactions it is sent to be accompanied by the value specified in this parameter. This is to support the inherited WM feature that enables WM to support multiple companies in one database. (This feature is no longer recommended and not fully supported when integrating with Epicor Merchandising.)
No The company number for which the Pipeline segment has been configured in the Pipeline Repository database.
physical_ctrl_hierarchy_level
Physical Control Hierarchy Level
Indicates the main merchandising hierarchy level at which WM initiates physical inventory counts. Specifically, it indicates whether WM performs a physical inventory count of all merchandise at once or performs counts of selected merchandise by department. Allowable values are ”Enterprise” or ”Department”. If the value specified in this parameter is ”Enterprise”, the segment creates a physical inventory control document in IM for all merchandise when WM initiates a physical inventory count. If the value specified in this parameter is ”Department” the segment creates a physical inventory control document in IM for the specific departments being counted when WM initiates a physical inventory count. The value of this parameter should almost always be ”Enterprise”, as special steps must be taken in WM by Professional Services to allow for counts to be performed by department.
No Enterprise
Segment 8000 - WM to Merchandising 217
dept_mask_size Length Of Department Code Mask
The length of the mask for the level in the main merchandising hierarchy in PROD that is defined as department for WM. Because WM maintains department codes as numerics, this value is used by the segment to mask department codes when advising IM of department level physical inventory counts initiated by WM. Only used if WM initiates department level physical inventory counts (i.e., the value for parameter ”Physical Control Hierarchy Level” is set to ”Department”).
No 3
update_type Physical Control Update Type
Indicates whether WM-initiated inventory counts will update actual shrink or beginning inventory in Infobase. If the value specified is 2, actual shrink will be updated. If the value specified is 3, beginning inventory will be updated.
No 2
MatchStatusIfNoIMAT
Match status for documents if Invoice Matching not installed.
If the Epicor Invoice Matching module is not installed, this parameter governs the match status to which PO Receipt and RTV documents are set in IM once the corresponding documents are set to status Released in WM. A value of 'U' indicates that the match status of the documents should be set to unmatched. A value of 'F' indicates the match status of the documents should be set to fully matched. If the Epicor Invoice Matching module is installed, this parameter value is not used. If the Epicor Invoice Matching module is not installed, this parameter should always be set so that the match status of the documents is set to fully matched once the corresponding documents are set to status Released in WM, unless a custom process is installed that sets the match status of the IM documents to fully matched at a later time.
No F
TransReasonForIntWHXfer
Transaction Reason for Inter-Warehouse Transfer
Specifies the transaction reason code used to create Inter-Warehouse Transfers
No WMTR
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
218 Segment Reference
Scheduling RequirementsShould be run regularly throughout the day as this is an online interface.
Database ParametersThere are no Pipeline parameters stored in the source or destination database for this segment.
Queue Segment DescriptionThe segment requires the following Pipeline dlls to be installed: STSPLWMToIMAR.dll STSPLBase.dllIM and AR subscribe to the following entities and actions via this segment:
store_ship_no_size Desired Length Of Store Shipment Number
Because WM maintains shipment numbers as numerics, the numeric value specified in this parameter is used to mask store shipment numbers as the documents are created in IM. When the segment advises IM of a new store shipment, it pads the WM store shipment number with leading zeroes on the left until it matches the length specified by this parameter. This ensures all store shipments in IM have document numbers of a uniform length. The value specified must be less than 20, as store shipment numbers in IM can only be 20 characters long.
No 6
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Entity Action Description
Inventory Adjustment (10) Insert (I)
Physical Count Header (actions Insert and Abort) (15)
Preliminary (P)/ Cancel (C) / Counted (N)
Transfer Header Received in W/H (40) Insert (I)
Store-Store Transfer via DC (30) Insert (I)
RTV Shipment Header (60) Insert (I) / Release (R)
RM Header (20) Insert (I) / Release (R) / Delete (D) /
Preliminary (P) Preliminary Receipt Memos are sent to IM
RM Detail (21) Insert (I) / Update (U)
RM Processing Code (22) Insert (I) / Delete (D)
Request for Additional Distribution (220) Insert (I)
Request for Distribution (200) Insert (I)
Request for Distribution Modification (210) Insert (I)
Segment 8000 - WM to Merchandising 219
TroubleshootingNo troubleshooting information is currently available for this segment.
Distribution (300) Freeze (F) / Update (U) / Insert (I) / Completed (C)
Distribution Line (320) Freeze (F) / Completed (C)
Distribution Shipments (50) Insert (I)
Release/Receive (R) This is the second phase of the store shipment from warehouse to warehouse.
PO (100) Substitute (S) Used in pack substitution logic; a pack ID originating from WMS will be imported to PROD.
Pack (661) Insert (I) Used to interface a new pack created in WM, back to Merchandising. The pack ID for the new pack will be set to the value from WM (not the automatically generated ID from Merch).
Entity Action Description
220 Segment Reference
Segment 8002 - WM to InfobaseThe segment advises Infobase when WM breaks a pack into individual SKUs.
Segment Parameters
Scheduling RequirementsShould be run regularly throughout the day as this is an online interface.
Database ParametersThere are no Pipeline parameters stored in the source or destination database for this segment.
Queue Segment DescriptionThe segment does not require any Pipeline dlls to be installed.
Infobase subscribes to the following entities and actions via this segment:
TroubleshootingNo troubleshooting information is currently available for this segment.
Parameter Name
Parameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
4Wall_Company WM Company The number of the WM company with which the segment integrates. The number specified must be the same as the number of the Merchandising company with which the segment integrates and must also match the company number for which the Pipeline segment has been configured in the Pipeline Repository database. WM requires all data and transactions it is sent to be accompanied by the value specified in this parameter. This is to support the inherited WM feature that enables WM to support multiple companies in one database. (This feature is no longer recommended and not fully supported when integrating with Epicor Merchandising.)
No The company number for which the Pipeline segment has been configured in the Pipeline Repository database.
Entity Action Description
Break Pack (70) Insert (I) Advises Infobase that a specific number of packs in a specific location have been broken by WM. / WM always automatically publishes break pack transactions when merchandise in packs is packed into cartons (for shipping to stores). Accordingly, store shipment transactions sent to IM from WM via segment “WM to IM” never reference packs, only SKUs, and stores always receive shipments by SKU. / WM can also generate break pack transactions manually via an RF function. / Once advised that a pack has been broken, Infobase will no longer track the pack as part of pack inventory. It will however continue to track the individual SKUs that made up the pack as part of SKU inventory.
Segment 11009 - MA to Merch Planning - Send History 221
Segment 11009 - MA to Merch Planning - Send HistoryThis segment produces a text file called post.dat that will be used by Planning. This segment provides a way to post client data (actual or plans) to the Merchandise Planning system.
The data for this file is extracted from multiple tables in the Merchandising system. All clients will be given a standard set of export levels and export elements, however these can be customized by Epicor through a user interface designed for this purpose. A link to the document describing this user interface can be found under Mapping Documents for this segment.
Note: This segment is dependent on the parameters set via the Export Planning Utility which defines the scope of exported data. The wrong combination of these parameters will result in no data being exported. See Planning Export Utility on page 463 for additional information.
Segment Parameters
Note: Default values are intended as examples only. Values may change from client to client.
Parameter Name
Parameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
exportElements
Temporary list of elements to be exported
Comma delimited list of element numbers that will be exported. If all the elements are to be exported this parameter must be left empty. This parameter is always set to its default value (NULL) after the segment is run.
No 1,7,13,19,25,31,44,50
exportLevelIDs
Temporary list of export level IDs to be exported
Comma delimited list of export level IDs that will be exported. This parameter is only set if you want to specify a list of export level IDs. After the segment is run this parameter is set to its default value (NULL). If all the level IDs are to be exported this parameter must be left empty.
No 1,2,3,4,5
locationsToExclude
List of locations to be excluded in the export
All locations except for the location codes that are listed here will be exported.
Note: When this segment is run the parameter is not set to NULL.
No 150, 250
locationsToInclude
List of locations to be included in the export
Only the locations with the location codes specified here will be exported.
Note: When this segment is run the parameter is not set to NULL.
No 100, 200, 300, 400
222 Segment Reference
mvPlanningExportPath
Path to export folder in Planning Server
Drive and Path to mapped folder on remote Planning Server. In the example, the “I:” drive is mapped to the server and the path is “I:\batch”. “Batch” directory is the standard directory in every company for Planning export. This segment writes text files to the remote Planning server using this parameter.
No i:\batch
mvPlanningExportWorkingFolder
Working Folder in the Planning Server
Working folder in the Planning Server. The working folder contains the files that are generated by the segment. These files will have the date-time stamp along with a two-character suffix indicating the file content, for example, 0309160428HT.dat. This folder must be created in ..\batch directory in the path provided by the parameter mvPlanningExportPath: Example: i:\batch\MevWork
No MeVWork
mvPlanningExportDataFolder
Data Folder in Planning Server
Data folder in the Planning Server. During the runtime of the segment, the date-time stamped file indicated above will be copied to this folder and renamed to post.dat. This folder must be created in ..\batch directory in the path provided by the parameter mvPlanningExportPath: Example i:\batch\Intrans
No Intrans
mvPlanningExportBatchSize
Batch size This parameter is no longer used.The size of the batch to be processed is now determined per export level and is set in the MA database. This feature is described below in database requirements for this segment.
No 500
mvPlanningExportRangeOfPeriods
Range of periods to be exported
The periods of history to be extracted and sent to Planning. If only changes are being sent this parameter is set to ‘C’. Use the following syntax when defining this parameter: To send a range of periods: ryyyypp-yyyypp Example: r199905-200311 Data for the period range 5th period of 1999 to the 11th period of 2003 will be exported. To send the last x number of periods use the syntax Lx (where x is between 1-9)
No r199902-200112,l9, t
Parameter Name
Parameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Segment 11009 - MA to Merch Planning - Send History 223
mvPlanningExportRangeOfPeriods (cont’d)
Range of periods to be exported
Example: L4 Data for the last 4 periods will be exported. To send the current period use T. To send the current on hand for use as next period’s BOP OH, use N. All parameters can be sent in a comma-delimited string. Example: If the current period is 200405 and you want to send history from the beginning of 2002 up to a specific period in 2003, as well as history for the last 3 periods and the current period, your entry would be as follows: R200201-200306, L3, T If you are sending changes only, the parameter must be set to ‘C’. If this parameter is set to ‘C’ the parameter mvPlanningExportRangeofWeek must also be set to ‘C’.
Note: Do not set this parameter to ‘C’ if the segment has never been successfully run at the client site. Set it to the desired range the first time it is run, then once it has been successfully run, it can be set to ‘C’.If your merchandising system allows backdated transactions, you must set this parameter to accommodate them. Planning supports backdating transactions posted up to 9 months previously. If you choose to backdate transactions, you will incur processing overhead for all transactions for the full range of months chosen.
mvPlanningExportRangeOfWeeks
Range of weeks to be exported
The weeks of history to be extracted and sent to Planning. If sending only changes, this parameter is set to ‘C’. Use the following syntax when defining this parameter: To send a range of weeks: ryyyyww-yyyyww Example: r199905-200311
Data for the period range 5th week of 1999 to the
11th week of 2003 will be exported To send the last x number of periods use the syntax Lx (where x is between 1-9) Example: L4 Data for the last 4 weeks will be exported.
No r199902-200152,l9, t
Parameter Name
Parameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
224 Segment Reference
mvPlanningExportRangeOfWeeks (cont.)
Range of weeks to be exported
To send the current period use T. To send the current on hand for use as next period’s BOW OH, use N. All parameters can be sent in a comma-delimited string. Example: If the current week is 200419 and you want to send history from the beginning of 2002 to a specific week in 2003 and the last 3 weeks plus the current week, enter: R200201-200306, L3, T If you are sending changes only, the parameter must be set to ‘C’. If it is set to ‘C’, mvPlanningExportRangeofPeriodsmust also be set to ‘C’.
Note: Do not set this parameter to ‘C’ if the segment has never been successfully run at the client site. Set it to the desired range the first time it is run, then once the segment has been successfully run it can be set to ‘C’.If your merchandising system allows backdated transactions, you must set this parameter to accommodate them. Planning supports backdating transactions posted up to 9 weeks previously. If you choose to backdate transactions, you will incur processing overhead for all transactions for the full range of weeks chosen.
mvPlanningExportmvFactQLastQID
Last Queue ID in mv_fact_queue table
If only the changes in History Transactions are being exported to Planning, this parameter will contain the last queue ID that was exported. The next time the DTS package for History Transactions is run, the queue will begin with this ID. After the segment runs this parameter will be updated automatically.
Note: This parameter must be set to 0 until the first successful run of the segment.
No 0
mvPlanningShowZeroes
Print zero values in output file
1 = true and 0 = false. To print zeroes in the output file set this parameter to true.
No 0
Parameter Name
Parameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Segment 11009 - MA to Merch Planning - Send History 225
Scheduling RequirementsSegment 26000 – Merchandising Planning Internal – Import History and Hierarchy, if used, must be run after this segment.
planElementGroupCode
Plan Element Group Code from plan_element_group table
The unique code from the plan_element_group table defining the element groups. Weekly (W) and Daily (D) are the standard element groups. More rows can be added for a client in the plan_element_group table and assigned a unique 1 character code.
No W
planByDivision Planning by Division?
If planning by division, this value must be set to 1 (true). This parameter will be set to 0 (false) for the majority of clients since most don’t plan by division. If this value is set to true, the parameters that follow must also be set.
No 0
planDivLevelID
Hierarchy level ID of the Division
The level ID from the location hierarchy that represents division.
No 5
locationAffix Affix of the location hierarchy group code
Merchandising and location hierarchy group codes must be concatenated together for the ‘alias’ in the planning export output file. The location hierarchy group code can be either a prefix or a suffix. If location hierarchy group code is a prefix, the parameter must be set to ‘L’ , if it is a suffix it must be set to ‘R’.
No R
merchLocationSeparator
Separating Character between merchandising and location hierarchy group codes
The merchandising and location hierarchy group codes must be concatenated either as a prefix or a suffix. The value of this parameter is the character(s) separating the merchandising and location hierarchy group codes.
No -
merchModuleId
Module Id Connection broker module name. This should be a module that will allow for a connection to the Merchandising database via connection broker.
Yes EDM
SendInactiveStyles
Send History for Inactive Styles
Indicates whether history and modifications to inactive styles will be sent to Planning.If set to 0 (False), history is not sent for an inactive style even if there has been activity against it. This may result in balancing issues between Planning and SL, IB, BI and MA. If master entities (header flags, descriptions, colors, sizes) are modified for an inactive style, the Pipeline segment will check whether the style exists in Planning and if it does, the modifications will flow through to Planning even if the style is inactive. If set to 1 (True), the Active flag is ignored. All styles and history are sent at all times. This ensures that Planning and Merch (SL, IB, MA, BI) are in balance.
No 1
Parameter Name
Parameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
226 Segment Reference
Database ParametersThere are no Pipeline parameters stored in the source or destination database for this segment.
Database RequirementsIn the plan_exp_level table, there is a column set for the batch size for each level. Depending on the performance of the segment, Epicor can set values for each of the levels via a database editor such as Query Analyzer.
Non-queue Segment DescriptionThis segment produces a text file for History Transactions. This file can be found in MevWork folder with the timestamp and the suffix HT.dat.
TroubleshootingErrors may be related to parameter settings. For troubleshooting purposes there is a log file produced in the Working Folder (MevWork): HTLOG.dat. Most of the errors that can occur for this segment are database-related and details concerning the nature of the error are indicated when the error occurs. A few of the possible errors and their meanings follow. Since this segment is completely parameter-driven the errors that occur can vary.
Error Reason
ERROR: Plan Element Group ID: <1> is invalid. Must be an integer.
The parameter planElementGroupCode is invalid or the result of the following statement is not an integer.select plan_element_group_ID from plan_element_groupwhere
upper(plan_element_group_code) =< planElementGroupCode >
ERROR: Plan by Division has a none numeric value. Please check the segment parameters. Plan by Division must be 1 or 0.
The parameter planByDivision must contain a numeric value of either 1 or 0.
ERROR: Location Affix must be R,r, L or l.
The parameter locationAffix must be R or L. It is not case-sensitive.
ERROR: Plan by Division Hierarchy Level ID must be Numeric. Please check the segment parameters
The parameter planDivLevelID has an invalid entry. See parameter description for more information.
ERROR: Invalid format in parameter_value FROM pipeline parameters.
The syntax for the values defined for the mvPlanningExportRangeOfPeriods or mvPlanningExportRangeOfWeeks parameters is not valid. See the descriptions for these parameters for more information.
ERROR: There are no values in mv_fact_queue_table
This is not necessarily an error. If the only the changes are being sent to Planning and there were no changes made since the last successful run of this segment, this table could be empty. If there were changes, however, and the table is empty, run the EDM & PROD to MA and Infobase to MA segments to bring the changes over.
ERROR: Database type is not Oracle or SQL
Currently this segment only supports Oracle or SQLServer database types.
Segment 11009 - MA to Merch Planning - Send History 227
If there is no output file produced, the easiest way to debug is to run the SQL statements from the HTLOG.dat file on the MA database and see which table is missing the required data.
A sample log file is pictured below. The parameters that are read from the segment parameters and the SQL statements that are used to extract date are shown in this file each time the segment is run, as well as the start and end time of the segment.
ERROR: Merchandising calendar doesn't have enough rows to determine the range of weeks to select for on order values.
Error occurs if the statement below gives no result: SELECT relative_week FROM view_calendar_merchandising_wk_oo_rel
WHERE merchandising_year_wk = (select (merchandising_year *100)+ merchandising_week from calendar_date where calendar_date = TRUNC(sysdate))
ERROR: The above sql statement returns more than one row or, contains invalid values other than W or P for period_indictor
In the log file, there will be an SQL statement printed above this error message. This indicates that period_indicator from plan_exp_element_ind for a given plan_element_ID does not return ‘W’ or ‘P’. These are the only allowed values; if another character is returned in the result set, this must be changed in the MA database in plan_exp_element_ind table.
Error Reason
228 Segment Reference
start time : 11/10/2003 2:56:07 PM
Current Week from Database: 200335Locations to be Included:
Locations to be Excluded:
Parameters for weeks: R200201-200352Parameters for periods: R200201-200312
Show Zeros? 0
Batch Size: 1000Last Queue ID: 1475
Planning By Division: 0
Location Affix: RMerchandising/Location Separator: -
Plan By Division Level ID: 0
Plan Element Group Code: WMV Fact Queue ID: 1475
Export Levels:
Export Elements:
SELECT plan_exp_level_ID, plan_exp_level_label, merchandise_field_name, location_field_name, time_period_field_name, period_indicator, additional_from_clause, additional_where_clause, batch_column_name, batch_size, export_flag, distinct_list_sql, list_table_name, list_table_where_clause FROM plan_exp_level where export_flag = 1 ORDER BY plan_exp_level_ID
select a.plan_element_ID from plan_exp_element_level a, plan_element_group_list b Where plan_exp_level_ID = 1 and a.plan_element_ID = b.plan_element_ID and b.plan_element_group_ID = 2 order by plan_exp_level_ID, a.plan_element_ID
SELECT plan_element_ID, plan_element_number, plan_element_label, plan_exp_table_group_ID, export_flag, sql_statement, use_previous_period_flag, units_flag, plan_version_code FROM plan_element WHERE plan_element_ID = 4AND export_flag = 1ORDER BY plan_exp_table_group_ID
SELECT plan_exp_table_ID, plan_exp_table_name, plan_exp_table_group_ID, plan_exp_level_ID, build_list_sql FROM plan_exp_table WHERE plan_exp_table_group_ID = 2 AND plan_exp_level_ID = 1 ORDER BY plan_exp_level_ID
Segment 11009 - MA to Merch Planning - Send History 229
SELECT hierarchy_group_code, merchandising_year_wk, sum(x.on_hand_units) FROM hist_oh_group_chn_wk x, hierarchy_group h WHERE h.hierarchy_group_ID = x.hierarchy_group_ID AND (h.hierarchy_group_ID BETWEEN 10000092 AND 10000945) AND (( merchandising_year_wk BETWEEN 200152 AND 200351 )) GROUP BY hierarchy_group_code, merchandising_year_wk
select a.plan_element_ID from plan_exp_element_level a, plan_element_group_list b Where plan_exp_level_ID = 2 and a.plan_element_ID = b.plan_element_ID and b.plan_element_group_ID = 2 order by plan_exp_level_ID, a.plan_element_ID
SELECT plan_element_ID, plan_element_number, plan_element_label, plan_exp_table_group_ID, export_flag, sql_statement, use_previous_period_flag, units_flag, plan_version_code FROM plan_element WHERE plan_element_ID = 4AND export_flag = 1ORDER BY plan_exp_table_group_ID
SELECT plan_exp_table_ID, plan_exp_table_name, plan_exp_table_group_ID, plan_exp_level_ID, build_list_sql FROM plan_exp_table WHERE plan_exp_table_group_ID = 2 AND plan_exp_level_ID = 2 ORDER BY plan_exp_level_ID
SELECT hierarchy_group_code, merchandising_year_wk, location_code, sum(x.on_hand_units) FROM hist_oh_group_loc_wk x, hierarchy_group h, location l WHERE h.hierarchy_group_ID = x.hierarchy_group_ID and l.location_ID = x.location_ID AND (h.hierarchy_group_ID BETWEEN 10000092 AND 10000945) AND (( merchandising_year_wk BETWEEN 200152 AND 200351 )) GROUP BY hierarchy_group_code, merchandising_year_wk, location_code
select a.plan_element_ID from plan_exp_element_level a, plan_element_group_list b Where plan_exp_level_ID = 3 and a.plan_element_ID = b.plan_element_ID and b.plan_element_group_ID = 2 order by plan_exp_level_ID, a.plan_element_ID
SELECT plan_element_ID, plan_element_number, plan_element_label, plan_exp_table_group_ID, export_flag, sql_statement, use_previous_period_flag, units_flag, plan_version_code FROM plan_element WHERE plan_element_ID = 1009AND export_flag = 1ORDER BY plan_exp_table_group_ID
230 Segment Reference
SELECT plan_element_ID, plan_element_number, plan_element_label, plan_exp_table_group_ID, export_flag, sql_statement, use_previous_period_flag, units_flag, plan_version_code FROM plan_element WHERE plan_element_ID = 1010AND export_flag = 1ORDER BY plan_exp_table_group_ID
SELECT plan_element_ID, plan_element_number, plan_element_label, plan_exp_table_group_ID, export_flag, sql_statement, use_previous_period_flag, units_flag, plan_version_code FROM plan_element WHERE plan_element_ID = 1011AND export_flag = 1ORDER BY plan_exp_table_group_ID
SELECT plan_element_ID, plan_element_number, plan_element_label, plan_exp_table_group_ID, export_flag, sql_statement, use_previous_period_flag, units_flag, plan_version_code FROM plan_element WHERE plan_element_ID = 1012AND export_flag = 1ORDER BY plan_exp_table_group_ID
SELECT plan_element_ID, plan_element_number, plan_element_label, plan_exp_table_group_ID, export_flag, sql_statement, use_previous_period_flag, units_flag, plan_version_code FROM plan_element WHERE plan_element_ID = 1013AND export_flag = 1ORDER BY plan_exp_table_group_ID
SELECT plan_element_ID, plan_element_number, plan_element_label, plan_exp_table_group_ID, export_flag, sql_statement, use_previous_period_flag, units_flag, plan_version_code FROM plan_element WHERE plan_element_ID = 1014AND export_flag = 1ORDER BY plan_exp_table_group_ID
SELECT plan_exp_table_ID, plan_exp_table_name, plan_exp_table_group_ID, plan_exp_level_ID, build_list_sql FROM plan_exp_table WHERE plan_exp_table_group_ID = 1 AND plan_exp_level_ID = 3 ORDER BY plan_exp_level_ID
Segment 11009 - MA to Merch Planning - Send History 231
SELECT hierarchy_group_code, merchandising_year_pd, (select count( distinct x.location_ID) from hist_oh_group_loc_wk x, location l where x.location_ID = l.location_ID and l.location_status_ID = 3) , (select count( distinct x.location_ID) from hist_oh_group_loc_wk x, location l where x.location_ID = l.location_ID and l.location_status_ID = 2) , (select count( distinct x.location_ID) from hist_oh_group_loc_wk x, location l where x.location_ID = l.location_ID and l.location_status_ID = 4), (select count( distinct x.location_ID) from hist_oh_group_loc_wk x, location l where x.location_ID = l.location_ID and l.location_status_ID = 5), (select count( distinct x.location_ID) from hist_oh_group_loc_wk x, location l where x.location_ID = l.location_ID and l.location_status_ID = 5), (select count( distinct x.location_ID) from hist_oh_group_loc_wk x, location l where x.location_ID = l.location_ID and l.location_type=4) FROM hist_group_chn_pd x, hierarchy_group h WHERE h.hierarchy_group_ID = x.hierarchy_group_ID AND (h.hierarchy_group_ID BETWEEN 10000092 AND 10000945) AND (( merchandising_year_pd BETWEEN 200201 AND 200312 )) GROUP BY hierarchy_group_code, merchandising_year_pd
select a.plan_element_ID from plan_exp_element_level a, plan_element_group_list b Where plan_exp_level_ID = 4 and a.plan_element_ID = b.plan_element_ID and b.plan_element_group_ID = 2 order by plan_exp_level_ID, a.plan_element_ID
WARNING : There are no records in plan_Exp_Element_Level table for plan_exp_level_ID 4
HLQID:1475
Text File copied to post.dat successfully.
Lines printed : 15115
end time : 11/10/2003 2:56:41 PM
232 Segment Reference
Segment 11010 - MA Internal - HousekeepingThis segment is no longer used.
This segment was designed to clean up or reclassify styles and modify SKUs in MA based on entries in the MA housekeeping queue. That is, changes in EDM & PROD for style/SKU were reflected in MA by this segment.
Note: Style reclassification is now handled by Segment 1030. Style deletes are handled by Segment 1005.
Segment Parameters
Scheduling RequirementsIf a style is deleted in PROD, segment 1005 EDM & PROD To MA must be run prior to this segment.
Database ParametersThe following parameters in the MA post parameter tables are used: Post parameter 91 “Log File Path to Housekeeping”: specifies the path and file name
for the log file generated by this segment. Post parameter 24 “DBMS type”: specifies the DBMS type of the MA database – 1 =
Oracle; 2 = MS SQL.
Non-queue Segment DescriptionThis segment cleans up the deleted styles in the following tables: Style, style color and SKU history tables Style, style color and SKU on hand history tables Style, style color and SKU component history tables Style, style color and SKU on order allocation tables Style flash sales tables
A synchronization locking mechanism is applied on the segment, so that this segment only runs if the A&R service that posts Loss and Extra sales to MA is not in progress.
TroubleshootingNo troubleshooting information is currently available for this segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
FoundConnectString Foundation Database Connection String
The OLE DB Connection String used to connect to the Foundation database.The value of this parameter must match the string value of the registry key FoundationConnectStr at [HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\Pipeline\PipelineRepository] on the Pipeline Application server.
No
Segment 11011 - MA Internal - Location Comp Startup 233
Segment 11011 - MA Internal - Location Comp StartupThis segment calculates and places the comparative weeks of all the comparative stores in the MA location comparative weeks table.This is a one time only DTS package. Once this is run, MA Internal – Location Comp Update DTS (segment 11012) should be run regularly.
Segment ParametersNone.
Scheduling RequirementsThis is a one time only DTS package. Once this is run, MA Internal – Location Comp Update DTS (segment 11012) should be run regularly.
Database ParametersThe following parameters in the MA post parameter tables are used: Post parameter 92 “Log File Path to Comparative Stores”: specifies the path and file
name for the log file generated by this segment. Post parameter 23 “max week from Infobase”: specifies the current merchandising
week. Post parameter 500 “last location comp week”: this parameter is updated with the
current week (i.e., the value of post parameter 23) when the segment is run.
Non-queue Segment Description The segment does not require any Pipeline dlls to be installed. This segment places all comparative weeks for each comparative store into the
location comparative weeks table.
TroubleshootingNo troubleshooting information is currently available for this segment.
234 Segment Reference
Segment 11012 - MA Internal - Location Comp UpdateThis segment calculates and places the comparative weeks of all the comparative stores in the MA location comparative weeks table.
Segment ParametersNone.
Scheduling RequirementsThis segment should be run on a regular basis.
Database ParametersThe following parameters in the MA post parameter tables are used: Post parameter 92 “Log File Path to Comparative Stores”: specifies the path and file
name for the log file generated by this segment. Post parameter 23 “max week from Infobase”: specifies the current merchandising
week. Post parameter 500 “last location comp week”: this parameter is read and updated
with the current week (i.e., the value of post parameter 23) when the segment is run.
Non-queue Segment Description The segment does not require any Pipeline dlls to be installed. This segment places all comparative weeks for each comparative store into the
location comparative weeks table.
TroubleshootingNo troubleshooting information is currently available for this segment.
Segment 11013 - MA Internal - Purge History 235
Segment 11013 - MA Internal - Purge HistoryThis segment cleans up MA history tables for a certain period based on the MA post parameter settings.
Segment Parameters
Scheduling RequirementsA synchronization locking mechanism is applied on the segment, so that this segment only runs if the A&R service that posts Loss and Extra sales to MA is not in progress.
Database ParametersThe following parameters in the MA post parameter tables are used: Post parameter 23 “max week from Infobase”: specifies the current merchandising
week. Post parameter 97 – 100: the number of days to be cleaned up in the flash sales
history tables. Post parameter 101 – 124: the number of weeks, periods or years to be cleaned up in
the history, on hand history, component history and on order allocation history tables. Post parameter 81 – 88: specifies the number of styles or merchandise groups to be
deleted from different levels of history tables within a batch.
Non-queue Segment Description The segment does not require any Pipeline dlls to be installed. This segment cleans up the history, on hand history, component history and on order
allocation history tables on the following levels: Merchandise level (4) SKU Style Style color Merchandise group Summary period level (3)
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
FoundConnectString Foundation Database Connection String
The OLE DB Connection String used to connect to the Foundation database.
Note: The value of this parameter must match the string value of the registry key FoundationConnectStr at [HKEY_LOCAL_MACHINE\SOFTWARE\STS Systems\Pipeline\PipelineRepository] on the Pipeline Application server.
No
236 Segment Reference
Week Period Year Summary location level (2) Location Chain
This segment cleans up the flash sales history tables on the following levels: Merchandise level (2): Style Merchandise group Summary period level (1): Day Summary location level (2): Location Chain
TroubleshootingNo troubleshooting information is currently available for this segment.
Segment 11014 - MA Internal - Alternate Hierarchy Startup 237
Segment 11014 - MA Internal - Alternate Hierarchy StartupThis segment summarizes the history for alternate merchandise hierarchy groups in the style level history tables and places the results in the merchandise group level history tables.
Segment ParametersNone.
Scheduling RequirementsThis is a one-time only DTS package. This segment must be run if this is the first time that alternate hierarchies are being posted to MA. Once this is run, the IB To MA segments will bring the history tables up to date for regular posting.
Database ParametersThe following parameters in the MA post parameter tables are used: Post parameter 299 “Log File for Alternate Hierarchy Startup”: specifies the path and
file name for the log file generated by this segment Post parameter 264 “Batch Size for Alternate Hierarchy Startup”: the number of
merchandise hierarchy groups being summarized within 1 transaction Post parameter 265 – 298: the last processed merchandise hierarchy group IDs on
different levels of history tables. These parameters are updated with the last processed hierarchy group IDs when the segment is run.
Non-queue Segment Description The segment does not require any Pipeline dlls to be installed. This segment summarizes the history, on hand history, component history and on
order allocation history for alternate merchandise hierarchy groups from the style history tables into merchandise group history tables, on the following summary levels: Summary period level (4): Week Period Year Life Summary location level (2): Chain Location
This segment summarizes the flash sales history for alternate merchandise hierarchy groups from the style history tables into merchandise group history tables, on the following summary levels: Summary period level (1): Day Summary location level (2): Chain Location
TroubleshootingNo troubleshooting information is currently available for this segment.
238 Segment Reference
Segment 11021 - MA Internal - History Import, Update Live SKU Hist
This segment loads history from the Import ID History table and inserts it into the Location week live history table in the Merchandise Analytics database.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment: 11031 MA Internal – History Import, Summarize Sku Hist.This segment should be executed after Segment 16021 – Text File to MA – History Import, Update Imp Sku Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description This segment loads history from the import ID table and inserts it into the Location
Week live history table in the Merchandise Analytics database. After this segment successfully loads the history into the live history table on week
level and location level, segment 11031 will run to summarize the history in the live
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForLiveHistTable
Batch Size For Live History Table
Specifies the number of rows being retrieved from the Import ID History table and inserted into the week level Live History table in each batch.
No 150
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\MA Internal - History Import, Update Live Sku Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case SKU.
No Sku
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No Hist
ActionOnDuplicates Action On Duplicates
Specifies the action to be taken on the history record whose period, merchandise and component type already exist in MA: 1 = Ignore, 2= Increment, 3 = Replace.
No 1
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Segment 11021 - MA Internal - History Import, Update Live SKU Hist 239
week location table into other levels, i.e., from week level to period, year and life levels and from location level to chain level.
Troubleshooting Log file:
File name: STSMVSkuHist.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading history from the import ID table into the live week table.
Error file: File name: STSMVSkuHist.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors.
Possible errors:
Error Reason
History provided for weeks >= … - deleting…
The client can only provide history for weeks up to the week prior to the live week (specified by post parameter 308). If the history of any merchandise year week >= live week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the history from the import code table into the import ID table.
240 Segment Reference
Segment 11022 - MA Internal - History Import, Update Live SKU OH Hist
This segment loads on hand history from the import ID table and inserts it into the week location live on hand history table in the Merchandise Analytics database.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11032 MA Internal – History Import, Summarize Sku Oh Hist.This segment should be executed after Segment 16022 – Text File to MA – History Import, Imp Sku Oh Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForLiveHistOhTable
Batch Size For Live On Hand History Table
Specifies the number of rows being retrieved from the Import ID On Hand History table and inserted into the week level Live On Hand History table in each batch.
No 300
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\MA Internal - History Import, Update Live Sku Oh Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case SKU.
No Sku
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No HistOh
ActionOnDuplicates Action On Duplicates
Specifies the action to be taken on the history record whose period, merchandise and component type already exist in MA: 1 = Ignore, 2= Increment, 3 = Replace.
No 1
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Segment 11022 - MA Internal - History Import, Update Live SKU OH Hist 241
Non-queue Segment Description This segment loads on hand history from the Import ID table and inserts it into the
Location Week live on hand history table in the Merchandise Analytics database. After this segment successfully loads the on hand history into the live on hand history
table on week level and location level, segment 11032 will run to summarize the on hand history in the live week location table into other levels, i.e., from week level to period, year and life levels and from location level to chain level.
Troubleshooting Log file:
File name: STSMVSkuHistOh.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading on hand history from the import ID table into the live week table.
Error file: File name: STSMVSkuHistOh.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors.
Possible errors:
Error Reason
History provided for weeks >= … - deleting…
If Beginning Inventory On Hand has not been posted (specified by posted parameter 309), the client can only provide on hand history for weeks up to and including the week prior to the live week (specified by post parameter 308); if Beginning Inventory On Hand has been posted, the client can only provide on hand history for weeks up to, but not including, the week prior to the live week (specified by post parameter 308). If on hand history of any merchandise year week that is greater than or equal to (>=) the cutoff week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
“History has been provided for entity/weeks/location/inventory status/price status that are already on file - deleting.…“
The segment deletes any duplicate history that already exists in the import ID table before inserting the on hand history from the import code table into the import ID table.
242 Segment Reference
Segment 11023 - MA Internal - History Import, Update Live Color Hist
This segment loads history from the import ID table and inserts it into the week location live history table in the Merchandise Analytics database.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11033 MA Internal – History Import, Summarize Color Hist.This segment should be executed after Segment 16023 – Text File to MA – History Import, Update Imp Color Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForLiveHistTable
Batch Size For Live History Table
Specifies the number of rows being retrieved from the Import ID History table and inserted into the week level Live History table in each batch.
No 150
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\MA Internal - History Import, Update Live Color Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case StyleColor.
No StyleColor
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No Hist
ActionOnDuplicates Action On Duplicates
Specifies the action to be taken on the history record whose period, merchandise and component type already exist in MA: 1 = Ignore, 2= Increment, 3 = Replace.
No 1
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Segment 11023 - MA Internal - History Import, Update Live Color Hist 243
Non-queue Segment Description This segment loads history from the Import ID table and inserts it into the Location
Week live history table in the Merchandise Analytics database. After this segment successfully loads the history into the live history table on week
level and location level, segment 11033 will run to summarize the history in the live week location table into other levels, i.e., from week level to period, year and life levels and from location level to chain level.
Troubleshooting Log file:
File name: STSMVStyleColorHist.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading history from the import ID table into the live week table.
Error file: File name: STSMVStyleColorHist.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors.
Possible errors:
Error Reason
History provided for weeks >= … - deleting…
The client can only provide history for weeks up to the week prior to the live week (specified by post parameter 308). If the history of any merchandise year week >= live week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the history from the import code table into the import ID table.
244 Segment Reference
Segment 11024 - MA Internal - History Import, Upd Live Color Oh Hist
This segment loads on hand history from the import ID table and inserts it into the week location live on hand history table in the Merchandise Analytics database.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11034 MA Internal – History Import, Summarize Color Oh Hist.This segment should be executed after Segment 16024 – Text File to MA – History Import, Update Imp Color Oh Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForLiveHistOhTable
Batch Size For Live On Hand History Table
Specifies the number of rows being retrieved from the Import ID History table and inserted into the week level Live On Hand History table in each batch.
No 300
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\MA Internal - History Import, Update Live Color Oh Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case StyleColor.
No StyleColor
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No HistOh
ActionOnDuplicates Action On Duplicates
Specifies the action to be taken on the history record whose period, merchandise and component type already exist in MA: 1 = Ignore, 2= Increment, 3 = Replace.
No 1
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Segment 11024 - MA Internal - History Import, Upd Live Color Oh Hist 245
Non-queue Segment Description This segment loads on hand history from the Import ID table and inserts it into the
Location Week live on hand history table in the Merchandise Analytics database. After this segment successfully loads the on hand history into the live on hand history
table on week level and location level, segment 11034 will run to summarize the on hand history in the live week location table into other levels, i.e. from week level to period, year and life levels and from location level to chain level.
Troubleshooting Log file:
File name: STSMVStyleColorHistOh.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading on hand history from the import ID table into the live week table.
Error file: File name: STSMVStyleColorHistOh.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors.
Possible errors:
Error Reason
History provided for weeks >= … - deleting…
If Beginning Inventory On Hand has not been posted (specified by posted parameter 309), the client can only provide on hand history for weeks up and including to the week prior to the live week (specified by post parameter 308); if Beginning Inventory On Hand has been posted, the client can only provide on hand history for weeks up to, but not including, the week prior to the live week (specified by post parameter 308). If on hand history of any merchandise year week that is greater than or equal to (>=) the cutoff week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location/inventory status/price status that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the on hand history from the import code table into the import ID table.
246 Segment Reference
Segment 11025 - MA Internal - History Import, Update Live Style Hist
This segment loads history from the import ID table and inserts it into the week location live history table in the Merchandise Analytics database.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11035 MA Internal – History Import, Summarize Style Hist.This segment should be executed after Segment 16025 – Text File to MA – History Import, Update Imp Style Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForLiveHistTable
Batch Size For Live History Table
Specifies the number of rows being retrieved from the Import ID History table and inserted into the week level Live History table in each batch.
No 150
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\MA Internal - History Import, Update Live Style Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case Style.
No Style
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No Hist
ActionOnDuplicates Action On Duplicates
Specifies the action to be taken on the history record whose period, merchandise and component type already exist in MA: 1 = Ignore, 2= Increment, 3 = Replace.
No 1
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Segment 11025 - MA Internal - History Import, Update Live Style Hist 247
Non-queue Segment Description This segment loads history from the Import ID table and inserts it into the Location
Week live history table in the Merchandise Analytics database. After this segment successfully loads the history into the live history table on week
level and location level, segment 11035 will run to summarize the history in the live week location table into other levels, i.e., from week level to period, year and life levels and from location level to chain level.
Troubleshooting Log file:
File name: STSMVStyleHist.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading history from the import ID table into the live week table.
Error file: File name: STSMVStyleHist.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors.
Possible errors:
Error Reason
History provided for weeks >= … - deleting…
The client can only provide history for weeks up to the week prior to the live week (specified by post parameter 308). If the history of any merchandise year week >= live week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the history from the import code table into the import ID table.
248 Segment Reference
Segment 11026 - MA Internal - History Import, Upd Live Style Oh Hist
This segment loads on hand history from the import ID table and inserts it into the week location live on hand history table in the Merchandise Analytics database.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11036 MA Internal – History Import, Summarize Style Oh Hist.This segment should be executed after Segment 16026 – Text File to MA – History Import, Update Imp Style Oh Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForLiveHistOhTable
Batch Size For Live On Hand History Table
Specifies the number of rows being retrieved from the Import ID History table and inserted into the week level Live History table in each batch.
No 300
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\MA Internal - History Import, Update Live Style Oh Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case Style.
No Style
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No HistOh
ActionOnDuplicates Action On Duplicates
Specifies the action to be taken on the history record whose period, merchandise and component type already exist in MA: 1 = Ignore, 2= Increment, 3 = Replace.
No 1
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Segment 11026 - MA Internal - History Import, Upd Live Style Oh Hist 249
Non-queue Segment Description This segment loads on hand history from the Import ID table and inserts it into the
Location Week live on hand history table in the Merchandise Analytics database. After this segment successfully loads the on hand history into the live on hand history
table on week level and location level, segment 11036 will run to summarize the on hand history in the live week location table into other levels, i.e. from week level to period, year and life levels and from location level to chain level.
Troubleshooting Log file:
File name: STSMVStyleHistOh.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading on hand history from the import ID table into the live week table.
Error file: File name: STSMVStyleHistOh.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors.
Possible errors:
Error Reason
History provided for weeks >= … - deleting…
If Beginning Inventory On Hand has not been posted (specified by posted parameter 309), the client can only provide on hand history for weeks up to and including the week prior to the live week (specified by post parameter 308); if Beginning Inventory On Hand has been posted, the client can only provide on hand history for weeks up to, but not including, the week prior to the live week (specified by post parameter 308). If on hand history of any merchandise year week that is greater than or equal to (>=) the cutoff week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location/inventory status/price status that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the on hand history from the import code table into the import ID table.
250 Segment Reference
Segment 11027 - MA Internal - History Import, Update Live Group Hist
This segment loads history from the import ID table and inserts it into the week location live history table in the Merchandise Analytics database.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11037 MA Internal – History Import, Summarize Group Hist.This segment should be executed after Segment 16027 – Text File to MA – History Import, Update Imp Group Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForLiveHistTable
Batch Size For Live History Table
Specifies the number of rows being retrieved from the Import ID History table and inserted into the week level Live History table in each batch.
No 150
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\MA Internal - History Import, Update Live Group Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case MerchGroup.
No MerchGroup
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No Hist
ActionOnDuplicates Action On Duplicates
Specifies the action to be taken on the history record whose period, merchandise and component type already exist in MA: 1 = Ignore, 2= Increment, 3 = Replace.
No 1
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Segment 11027 - MA Internal - History Import, Update Live Group Hist 251
Non-queue Segment Description This segment loads history from the Import ID table and inserts it into the Location
Week live history table in the Merchandise Analytics database. After this segment successfully loads the history into the live history table on week
level and location level, segment 11037 will run to summarize the history in the live week location table into other levels, i.e. from week level to period, year and life levels and from location level to chain level.
Troubleshooting Log file:
File name: STSMVMerchGroupHist.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading history from the import ID table into the live week table.
Error file: File name: STSMVMerchGroupHist.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors.
Possible errors:
Error Reason
History provided for weeks >= … - deleting…
The client can only provide history for weeks up to the week prior to the live week (specified by post parameter 308). If the history of any merchandise year week >= live week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the history from the import code table into the import ID table.
252 Segment Reference
Segment 11028 - MA Internal - History Import, Upd Live Group Oh Hist
This segment loads on hand history from the import ID table and inserts it into the week location live on hand history table in the Merchandise Analytics database.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11038 MA Internal – History Import, Summarize Group Oh Hist.This segment should be executed after Segment 16028 – Text File to MA – History Import, Update Imp Group Oh Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForLiveHistOhTable
Batch Size For Live On Hand History Table
Specifies the number of rows being retrieved from the Import ID History table and inserted into the week level Live History table in each batch.
No 300
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\MA Internal - History Import, Update Live Group Oh Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case MerchGroup.
No MerchGroup
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No HistOh
ActionOnDuplicates Action On Duplicates
Specifies the action to be taken on the history record whose period, merchandise and component type already exist in MA: 1 = Ignore, 2= Increment, 3 = Replace.
No 1
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Segment 11028 - MA Internal - History Import, Upd Live Group Oh Hist 253
Non-queue Segment Description This segment loads on hand history from the Import ID table and inserts it into the
Location Week live on hand history table in the Merchandise Analytics database. After this segment successfully loads the on hand history into the live on hand history
table on week level and location level, segment 11038 will run to summarize the on hand history in the live week location table into other levels, i.e. from week level to period, year and life levels and from location level to chain level.
Troubleshooting Log file:
File name: STSMVMerchGroupHistOh.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading on hand history from the Import ID table into the live week table.
Error file: File name: STSMVMerchGroupHistOh.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors.
Possible errors:
Error Reason
History provided for weeks >= … - deleting…
If Beginning Inventory On Hand has not been posted (specified by posted parameter 309), the client can only provide on hand history for weeks up to the week prior to the live week (specified by post parameter 308); if Beginning Inventory On Hand has been posted, the client can only provide on hand history for weeks up to, but not including, the week prior to the live week (specified by post parameter 308). If on hand history of any merchandise year week that is greater than or equal to (>=) the cutoff week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location/inventory status/price status that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the on hand history from the import code table into the import ID table.
254 Segment Reference
Segment 11029 - MA Internal - History Import, Update Live Group Rim Oh
This segment loads RIM on hand history from the import ID table and inserts it into the period location live RIM on hand history table in the Merchandise Analytics database.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11039 MA Internal – History Import, Summarize Group Rim Oh.
This segment should be executed after Segment 16029 – Text File to MA – History Import, Update Imp Group Rim Oh.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter:
Queue Segment Description This segment loads RIM on hand history from the Import ID table and inserts it into the
Location period live RIM on hand history table in the Merchandise Analytics database. After this segment successfully loads the RIM on hand history into the live RIM on
hand history table on period level and location level, segment 11039 will run to summarize the RIM on hand history in the live period location table into other levels, i.e. from period level to year and life levels and from location level to chain level.
Mapping DocumentNone presently available.
Parameter NameParameter Display name
DescriptionModifiable with Pipeline Admin.
Default Value
ActionOnDuplicates
Action On Duplicates
Specifies the action to be taken on the history record whose period, merchandise and component type already exists in MA: 1 = Ignore, 2 = Increment, 3 = Replace
No 3
BatchSizeForLiveRimOhTable
Batch Size For Live On Hand History Table
Specifies the number of rows being retrieved from the Import ID RIM On Hand table and inserted into the period level Live Rim On Hand table in each batch.
No 300
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\MA Internal - History Import, Update Live Group Rim Oh
Parameter ID Parameter Label Description
308 live merchandising_year_week Specifies the live week.
Segment 11029 - MA Internal - History Import, Update Live Group Rim Oh 255
Troubleshooting Log file:
File name: STSMVRimOh.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading RIM on hand history from the Import ID table into the live week table.
Error file: File name: STSMVRimOh.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS
is a time stamp) This file is only generated when the segment encounters unexpected errors.
Possible errors:
If the segment itself fails, search the Manager log in the Pipeline folder on the Pipeline server for error messages.
Errors Description
History provided for periods >= … - deleting… The client can only provide RIM on hand history for periods up to the period prior to the live period. If RIM on hand history of any merchandise year period that is greater than or equal to (>=) the cutoff period is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/periods/location that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the RIM on hand history from the import code table into the import ID table.
256 Segment Reference
Segment 11031 - MA Internal - History Import, Summarize SKU Hist
This segment loads history from the Location Week History table and summarizes it into the Chain Week History table in the Merchandise Analytics database.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForHistChnLocWkToChnWkTask
Batch Size For History Location Week To Chain Week Task
Specifies the number of rows being retrieved from the Location Week History table and summarized into the Chain Week History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnPdToYrTask
Batch Size For History Chain Period To Year Task
Specifies the number of rows being retrieved from the Chain Period History table and summarized into the Chain Year History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnWkToPdTask
Batch Size For History Chain Week To Period Task
Specifies the number of rows being retrieved from the Chain Week History table and summarized into the Chain Period History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnYrToLiTask
Batch Size For History Chain Year To Life Task
Specifies the number of rows being retrieved from the Chain Year History table and summarized into the Chain Life History table in each batch.
No MSSQL: 1200 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistLocPdToYrTask
Batch Size For History Location Period To Year Task
Specifies the number of rows being retrieved from the Location Period History table and summarized into the Location Year History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistLocWkToPdTask
Batch Size For History Location Week To Period Task
Specifies the number of rows being retrieved from the Location Week History table and summarized into the Location Period History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
Segment 11031 - MA Internal - History Import, Summarize SKU Hist 257
Scheduling RequirementsThis segment should be executed after Segments 16021 – Text File to MA - History Import, Update Imp Sku Hist and 11021 MA Internal - History Import, Update Live Sku Hist.
BatchSizeForHistLocYrToLiTask
Batch Size For History Location Year To Life Task
Specifies the number of rows being retrieved from the Location Year History table and summarized into the Location Life History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
ExtentSizeForHistChnLocWkToChnWkTask
Extent Size For History Location Week To Chain Week Task
Extent size used to rebuild the index on the Chain Week History table (Oracle only).
No 5
ExtentSizeForHistChnPdToYrTask
Extent Size For History Chain Period To Year Task
Extent size used to rebuild the index on the Chain Year History table (Oracle only).
No 5
ExtentSizeForHistChnWkToPdTask
Extent Size For History Chain Week To Period Task
Extent size used to rebuild the index on the Chain Period History table (Oracle only).
No 5
ExtentSizeForHistChnYrToLiTask
Extent Size For History Chain Year To Life Task
Extent size used to rebuild the index on the Chain Life History table (Oracle only).
No 5
ExtentSizeForHistLocPdToYrTask
Extent Size For History Location Period To Year Task
Extent size used to rebuild the index on the Location Year History table (Oracle only).
No 5
ExtentSizeForHistLocWkToPdTask
Extent Size For History Location Week To Period Task
Extent size used to rebuild the index on the Location Period History table (Oracle only)
No 5
ExtentSizeForHistLocYrToLiTask
Extent Size For History Location Year To Life Task
Extent size used to rebuild the index on the Location Life History table (Oracle only)
No 5
Path Path Specifies the path where the log files and the error files are located.
No C:\NSB Interface\MA Internal - History Import, Summarize Sku Hist
SegmentIdentifier Segment Identifier
Specifies the level of history being loaded, in this case SKU.
No SKU
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No Hist
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
258 Segment Reference
Database ParametersPosting parameters can be found in the post_parameter table. This segment checks the following parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history from Location Week table to Location Period table Summarizes history from Location Period table to Location Year table Summarizes history from Location Year table to Location Life table
Chain workflow: Summarizes history from Location Week table to Chain Week table Summarizes history from Chain Week table to Chain Period table Summarizes history from Chain Period table to Chain Year table Summarizes history from Chain Year table to Chain Life table
Troubleshooting Log file for Location Summarizing:
File name: STSMVSkuHistLoc.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of summarizing history from Location Week table into Location Period table.
Shows the progress of summarizing history from Location Period table into Location Year table.
Shows the progress of summarizing history from Location Year table into Location Life table.
Log file for Chain Summarizing: File name: STSMVSkuHistChn.YYYYMMDDHHMMSS.LOG (where
YYYYMMDDHHMMSS is a time stamp) Shows the progress of summarizing history from Location Week table into Chain
Week table. Shows the progress of summarizing history from Chain Week table into Chain
Period table. Shows the progress of summarizing history from Chain Period table into Chain
Year table. Shows the progress of summarizing history from Chain Year table into Chain Life
table. Error file for Location Summarizing:
File name: STSMVSkuHistLoc.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors in the location workflow.
Parameter ID Parameter label Description
23 max week from Infobase Specifies the latest week posted from Infobase by running IB To MA segments.
Segment 11031 - MA Internal - History Import, Summarize SKU Hist 259
Error file for Chain Summarizing: File name: STSMVSkuHistChn.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors in the
chain workflow.
260 Segment Reference
Segment 11032 - MA Internal - History Import, Summarize Sku OH Hist
This segment loads history from the Location Week On Hand History table and summarizes it into the Chain Week On Hand History table in the Merchandise Analytics database.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForHistOhChnLocWkToChnWkTask
Batch Size For On Hand History Location Week To Chain Week Task
Specifies the number of rows being retrieved from the Location Week On Hand History table and summarized into the Chain Week On Hand History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnPdToYrTask
Batch Size For On Hand History Chain Period To Year Task
Specifies the number of rows being retrieved from the Chain Period On Hand History table and summarized into the Chain Year On Hand History table in each batch.
No MSSQL: 1200 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnWkToPdTask
Batch Size For On Hand History Chain Week To Period Task
Specifies the number of rows being retrieved from the Chain Week On Hand History table and summarized into the Chain Period History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnYrToLiTask
Batch Size For On Hand History Chain Year To Life Task
Specifies the number of rows being retrieved from the Chain Year On Hand History table and summarized into the Chain Life On Hand History table in each batch.
No MSSQL: 2400 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhLocPdToYrTask
Batch Size For On Hand History Location Period To Year Task
Specifies the number of rows being retrieved from the Location Period On Hand History table and summarized into the Location Year On Hand History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
Segment 11032 - MA Internal - History Import, Summarize Sku OH Hist 261
BatchSizeForHistOhLocWkToPdTask
Batch Size For On Hand History Location Week To Period Task
Specifies the number of rows being retrieved from the Location Week On Hand History table and summarized into the Location Period On Hand History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhLocYrToLiTask
Batch Size For On Hand History Location Year To Life Task
Specifies the amount of rows being retrieved from the Location Year On Hand History table and summarized into the Location Life On Hand History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
ExtentSizeForHistOhChnLocWkToChnWkTask
Extent Size For On Hand History Location Week To Chain Week Task
Extent size used to rebuild the index on the Chain Week On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnPdToYrTask
Extent Size For On Hand History Chain Period To Year Task
Extent size used to rebuild the index on the Chain Year On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnWkToPdTask
Extent Size For On Hand History Chain Week To Period Task
Extent size used to rebuild the index on the Chain Period On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnYrToLiTask
Extent Size For On Hand History Chain Year To Life Task
Extent size used to rebuild the index on the Chain Life On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhLocPdToYrTask
Extent Size For On Hand History Location Period To Year Task
Extent size used to rebuild the index on the Location Year On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhLocWkToPdTask
Extent Size For On Hand History Location Week To Period Task
Extent size used to rebuild the index on the Location Period On Hand History table (Oracle only)
No 5
ExtentSizeForHistOhLocYrToLiTask
Extent Size For On Hand History Location Year To Life Task
Extent size used to rebuild the index on the Location Life On Hand History table (Oracle only)
No 5
Path Path Specifies the path where the log files and the error files are located.
No C:\NSB Interface\MA Internal - History Import, Summarize Sku Oh Hist
SegmentIdentifier Segment Identifier Specifies the level of history being loaded, in this case SKU.
No SKU
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
262 Segment Reference
Scheduling RequirementsThis segment should be executed after Segments 16022 – Text File to MA - History Import, Update Imp Sku Oh Hist and 11022 MA Internal - History Import, Update Live Sku Oh Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table, this segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history from Location Week table to Location Period table Summarizes history from Location Period table to Location Year table Summarizes history from Location Year table to Location Life table
Chain workflow: Summarizes history from Location Week table to Chain Week table Summarizes history from Chain Week table to Chain Period table Summarizes history from Chain Period table to Chain Year table Summarizes history from Chain Year table to Chain Life table
On hand history of a merchandising period = on hand history of the last week in this period
On hand history of a merchandising year = on hand history of the last period in this year
On hand life history = on hand history of the current merchandising year On hand of the current merchandising year = on hand of the current merchandising
period On hand of the current merchandising period = on hand of the current merchandising
week The current week = the latest week posted from Infobase (i.e. the value of post
parameter 23) If the last week in the on hand history week location table doesn’t match post
parameter 23 (which normally means that at least 1 of the Infobase To MA segments wasn’t run successfully), this segment shouldn’t be run, otherwise there will be no on hand history in the life table. To verify if the last week in the week table matches post parameter 23, run segment 11042 MA Internal - History Import, Verify Oh Posting.
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History.
No HistOh
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Parameter ID Parameter label Description
23 max week from Infobase Specifies the latest week posted from Infobase by running IB To MA segments.
Segment 11032 - MA Internal - History Import, Summarize Sku OH Hist 263
Troubleshooting Log file for Location Summarizing:
File name: STSMVSkuHistOhLoc.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of summarizing on hand history from Location Week table into Location Period table.
Shows the progress of summarizing on hand history from Location Period table into Location Year table.
Shows the progress of summarizing on hand history from Location Year table into Location Life table.
Log file for Chain Summarizing: File name: STSMVSkuHistOhChn.YYYYMMDDHHMMSS.LOG (where
YYYYMMDDHHMMSS is a time stamp) Shows the progress of summarizing on hand history from Location Week table into
Chain Week table. Shows the progress of summarizing on hand history from Chain Week table into
Chain Period table. Shows the progress of summarizing on hand history from Chain Period table into
Chain Year table. Shows the progress of summarizing on hand history from Chain Year table into
Chain Life table. Error file for Location Summarizing:
File name: STSMVSkuHistOhLoc.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors in the location workflow.
Error file for Chain Summarizing: File name: STSMVSkuHistOhChn.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors in the
chain workflow.
264 Segment Reference
Segment 11033 - MA Internal - History Import, Summarize Color Hist
This segment loads history from the Location Week History table and summarizes it into the Chain Week History table in the Merchandise Analytics database.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForHistChnLocWkToChnWkTask
Batch Size For History Location Week To Chain Week Task
Specifies the number of rows being retrieved from the Location Week History table and summarized into the Chain Week History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnPdToYrTask
Batch Size For History Chain Period To Year Task
Specifies the number of rows being retrieved from the Chain Period History table and summarized into the Chain Year History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnWkToPdTask
Batch Size For History Chain Week To Period Task
Specifies the number of rows being retrieved from the Chain Week History table and summarized into the Chain Period History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnYrToLiTask
Batch Size For History Chain Year To Life Task
Specifies the number of rows being retrieved from the Chain Year History table and summarized into the Chain Life History table in each batch.
No MSSQL: 1200 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistLocPdToYrTask
Batch Size For History Location Period To Year Task
Specifies the number of rows being retrieved from the Location Period History table and summarized into the Location Year History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistLocWkToPdTask
Batch Size For History Location Week To Period Task
Specifies the number of rows being retrieved from the Location Week History table and summarized into the Location Period History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
Segment 11033 - MA Internal - History Import, Summarize Color Hist 265
Scheduling RequirementsThis segment should be executed after Segments 16023 – Text File to MA - History Import, Update Imp Color Hist and 11023 MA Internal - History Import, Update Live Color Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table; this segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
BatchSizeForHistLocYrToLiTask
Batch Size For History Location Year To Life Task
Specifies the number of rows being retrieved from the Location Year History table and summarized into the Location Life History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
ExtentSizeForHistChnLocWkToChnWkTask
Extent Size For History Location Week To Chain Week Task
Extent size used to rebuild the index on the Chain Week History table (Oracle only).
No 5
ExtentSizeForHistChnPdToYrTask
Extent Size For History Chain Period To Year Task
Extent size used to rebuild the index on the Chain Year History table (Oracle only).
No 5
ExtentSizeForHistChnWkToPdTask
Extent Size For History Chain Week To Period Task
Extent size used to rebuild the index on the Chain Period History table (Oracle only).
No 5
ExtentSizeForHistChnYrToLiTask
Extent Size For History Chain Year To Life Task
Extent size used to rebuild the index on the Chain Life History table (Oracle only).
No 5
ExtentSizeForHistLocPdToYrTask
Extent Size For History Location Period To Year Task
Extent size used to rebuild the index on the Location Year History table (Oracle only).
No 5
ExtentSizeForHistLocWkToPdTask
Extent Size For History Location Week To Period Task
Extent size used to rebuild the index on the Location Period History table (Oracle only)
No 5
ExtentSizeForHistLocYrToLiTask
Extent Size For History Location Year To Life Task
Extent size used to rebuild the index on the Location Life History table (Oracle only)
No 5
Path Path Specifies the path where the log files and the error files are located.
No C:\NSB Interface\MA Internal - History Import, Summarize Color Hist
SegmentIdentifier Segment Identifier Specifies the level of history being loaded, in this case StyleColor.
No StyleColor
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History.
No Hist
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Parameter ID Parameter label Description
23 max week from Infobase Specifies the latest week posted from Infobase by running IB To MA segments
266 Segment Reference
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history from Location Week table to Location Period table Summarizes history from Location Period table to Location Year table Summarizes history from Location Year table to Location Life table
Chain workflow: Summarizes history from Location Week table to Chain Week table Summarizes history from Chain Week table to Chain Period table Summarizes history from Chain Period table to Chain Year table Summarizes history from Chain Year table to Chain Life table
Troubleshooting Log file for Location Summarizing:
File name: STSMVStyleColorHistLoc.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of summarizing history from Location Week table into Location Period table.
Shows the progress of summarizing history from Location Period table into Location Year table.
Shows the progress of summarizing history from Location Year table into Location Life table.
Log file for Chain Summarizing: File name: STSMVStyleColorHistChn.YYYYMMDDHHMMSS.LOG (where
YYYYMMDDHHMMSS is a time stamp) Shows the progress of summarizing history from Location Week table into Chain
Week table. Shows the progress of summarizing history from Chain Week table into Chain
Period table. Shows the progress of summarizing history from Chain Period table into Chain
Year table. Shows the progress of summarizing history from Chain Year table into Chain Life
table. Error file for Location Summarizing:
File name: STSMVStyleColorHistLoc.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors in the location workflow.
Error file for Chain Summarizing: File name: STSMVStyleColorHistChn.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors in the
chain workflow.
Segment 11034 - MA Internal - History Import, Summarize Color OH Hist 267
Segment 11034 - MA Internal - History Import, Summarize Color OH Hist
This segment loads history from the Location Week History table and summarizes it into the Chain Week On Hand History table in the Merchandise Analytics database.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForHistOhChnLocWkToChnWkTask
Batch Size For On Hand History Location Week To Chain Week Task
Specifies the number of rows being retrieved from the Location Week On Hand History table and summarized into the Chain Week On Hand History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnPdToYrTask
Batch Size For On Hand History Chain Period To Year Task
Specifies the number of rows being retrieved from the Chain Period On Hand History table and summarized into the Chain Year On Hand History table in each batch.
No MSSQL: 1200 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnWkToPdTask
Batch Size For On Hand History Chain Week To Period Task
Specifies the number of rows being retrieved from the Chain Week On Hand History table and summarized into the Chain Period History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnYrToLiTask
Batch Size For On Hand History Chain Year To Life Task
Specifies the number of rows being retrieved from the Chain Year On Hand History table and summarized into the Chain Life On Hand History table in each batch.
No MSSQL: 2400 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
268 Segment Reference
BatchSizeForHistOhLocPdToYrTask
Batch Size For On Hand History Location Period To Year Task
Specifies the number of rows being retrieved from the Location Period On Hand History table and summarized into the Location Year On Hand History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhLocWkToPdTask
Batch Size For On Hand History Location Week To Period Task
Specifies the number of rows being retrieved from the Location Week On Hand History table and summarized into the Location Period On Hand History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhLocYrToLiTask
Batch Size For On Hand History Location Year To Life Task
Specifies the number of rows being retrieved from the Location Year On Hand History table and summarized into the Location Life On Hand History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
ExtentSizeForHistOhChnLocWkToChnWkTask
Extent Size For On Hand History Location Week To Chain Week Task
Extent size used to rebuild the index on the Chain Week On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnPdToYrTask
Extent Size For On Hand History Chain Period To Year Task
Extent size used to rebuild the index on the Chain Year On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnWkToPdTask
Extent Size For On Hand History Chain Week To Period Task
Extent size used to rebuild the index on the Chain Period On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnYrToLiTask
Extent Size For On Hand History Chain Year To Life Task
Extent size used to rebuild the index on the Chain Life On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhLocPdToYrTask
Extent Size For On Hand History Location Period To Year Task
Extent size used to rebuild the index on the Location Year On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhLocWkToPdTask
Extent Size For On Hand History Location Week To Period Task
Extent size used to rebuild the index on the Location Period On Hand History table (Oracle only)
No 5
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Segment 11034 - MA Internal - History Import, Summarize Color OH Hist 269
Scheduling RequirementsThis segment should be executed after Segments 16024 – Text File to MA - History Import, Update Imp Color Oh Hist and 11024 MA Internal - History Import, Update Live Color Oh Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history from Location Week table to Location Period table Summarizes history from Location Period table to Location Year table Summarizes history from Location Year table to Location Life table
Chain workflow: Summarizes history from Location Week table to Chain Week table Summarizes history from Chain Week table to Chain Period table Summarizes history from Chain Period table to Chain Year table Summarizes history from Chain Year table to Chain Life table
On hand history of a merchandising period = on hand history of the last week in this period
On hand history of a merchandising year = on hand history of the last period in this year
On hand life history = on hand history of the current merchandising year
ExtentSizeForHistOhLocYrToLiTask
Extent Size For On Hand History Location Year To Life Task
Extent size used to rebuild the index on the Location Life On Hand History table (Oracle only)
No 5
Path Path Specifies the path where the log files and the error files are located.
No C:\NSB Interface\MA Internal - History Import, Summarize Color Oh Hist
SegmentIdentifier Segment Identifier Specifies the level of history being loaded, in this case StyleColor.
No StyleColor
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History.
No HistOh
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Parameter ID Parameter label Description
23 max week from Infobase Specifies the latest week posted from Infobase by running IB To MA segments.
270 Segment Reference
On hand of the current merchandising year = on hand of the current merchandising period
On hand of the current merchandising period = on hand of the current merchandising week
The current week = the latest week posted from Infobase (i.e. the value of post parameter 23)
If the last week in the on hand history week location table doesn’t match post parameter 23 (which probably means at least 1 of the Infobase To MA segments wasn’t run successfully), this segment shouldn’t be run, otherwise there will be no on hand history in the life table. To verify if the last week in the week table matches post parameter 23, run segment 11042 MA Internal - History Import, Verify Oh Posting.
Troubleshooting Log file for Location Summarizing:
File name: STSMVStyleColorHistOhLoc.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of summarizing on hand history from Location Week table into Location Period table.
Shows the progress of summarizing on hand history from Location Period table into Location Year table.
Shows the progress of summarizing on hand history from Location Year table into Location Life table.
Log file for Chain Summarizing: File name: STSMVStyleColorHistOhChn.YYYYMMDDHHMMSS.LOG (where
YYYYMMDDHHMMSS is a time stamp) Shows the progress of summarizing on hand history from Location Week table into
Chain Week table. Shows the progress of summarizing on hand history from Chain Week table into
Chain Period table. Shows the progress of summarizing on hand history from Chain Period table into
Chain Year table. Shows the progress of summarizing on hand history from Chain Year table into
Chain Life table. Error file for Location Summarizing:
File name: STSMVStyleColorHistOhLoc.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors in the location workflow.
Error file for Chain Summarizing: File name: STSMVStyleColorHistOhChn.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors in the
chain workflow.
Segment 11035 - MA Internal - History Import, Summarize Style Hist 271
Segment 11035 - MA Internal - History Import, Summarize Style Hist
This segment loads history from the Location Week History table and summarizes it into the Chain Week History table in the Merchandise Analytics database.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForHistChnLocWkToChnWkTask
Batch Size For History Location Week To Chain Week Task
Specifies the number of rows being retrieved from the Location Week History table and summarized into the Chain Week History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnPdToYrTask
Batch Size For History Chain Period To Year Task
Specifies the number of rows being retrieved from the Chain Period History table and summarized into the Chain Year History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnWkToPdTask
Batch Size For History Chain Week To Period Task
Specifies the number of rows being retrieved from the Chain Week History table and summarized into the Chain Period History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnYrToLiTask
Batch Size For History Chain Year To Life Task
Specifies the number of rows being retrieved from the Chain Year History table and summarized into the Chain Life History table in each batch.
No MSSQL: 1200 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistLocPdToYrTask
Batch Size For History Location Period To Year Task
Specifies the number of rows being retrieved from the Location Period History table and summarized into the Location Year History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistLocWkToPdTask
Batch Size For History Location Week To Period Task
Specifies the number of rows being retrieved from the Location Week History table and summarized into the Location Period History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
272 Segment Reference
Scheduling RequirementsThis segment should be executed after Segments 16025 – Text File to MA - History Import, Update Imp Style Hist and 11025 MA Internal - History Import, Update Live Style Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table; this segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
BatchSizeForHistLocYrToLiTask
Batch Size For History Location Year To Life Task
Specifies the number of rows being retrieved from the Location Year History table and summarized into the Location Life History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
ExtentSizeForHistChnLocWkToChnWkTask
Extent Size For History Location Week To Chain Week Task
Extent size used to rebuild the index on the Chain Week History table (Oracle only).
No 5
ExtentSizeForHistChnPdToYrTask
Extent Size For History Chain Period To Year Task
Extent size used to rebuild the index on the Chain Year History table (Oracle only).
No 5
ExtentSizeForHistChnWkToPdTask
Extent Size For History Chain Week To Period Task
Extent size used to rebuild the index on the Chain Period History table (Oracle only).
No 5
ExtentSizeForHistChnYrToLiTask
Extent Size For History Chain Year To Life Task
Extent size used to rebuild the index on the Chain Life History table (Oracle only).
No 5
ExtentSizeForHistLocPdToYrTask
Extent Size For History Location Period To Year Task
Extent size used to rebuild the index on the Location Year History table (Oracle only).
No 5
ExtentSizeForHistLocWkToPdTask
Extent Size For History Location Week To Period Task
Extent size used to rebuild the index on the Location Period History table (Oracle only)
No 5
ExtentSizeForHistLocYrToLiTask
Extent Size For History Location Year To Life Task
Extent size used to rebuild the index on the Location Life History table (Oracle only)
No 5
Path Path Specifies the path where the log files and the error files are located.
No C:\NSB Interface\MA Internal - History Import, Summarize Style Hist
SegmentIdentifier Segment Identifier Specifies the level of history being loaded, in this case Style.
No Style
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History.
No Hist
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Parameter ID Parameter label Description
23 max week from Infobase Specifies the latest week posted from Infobase by running IB To MA segments.
Segment 11035 - MA Internal - History Import, Summarize Style Hist 273
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history from Location Week table to Location Period table Summarizes history from Location Period table to Location Year table Summarizes history from Location Year table to Location Life table
Chain workflow: Summarizes history from Location Week table to Chain Week table Summarizes history from Chain Week table to Chain Period table Summarizes history from Chain Period table to Chain Year table Summarizes history from Chain Year table to Chain Life table
Troubleshooting Log file for Location Summarizing:
File name: STSMVStyleHistLoc.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of summarizing history from Location Week table into Location Period table.
Shows the progress of summarizing history from Location Period table into Location Year table.
Shows the progress of summarizing history from Location Year table into Location Life table.
Log file for Chain Summarizing: File name: STSMVStyleHistChn.YYYYMMDDHHMMSS.LOG (where
YYYYMMDDHHMMSS is a time stamp) Shows the progress of summarizing history from Location Week table into Chain
Week table. Shows the progress of summarizing history from Chain Week table into Chain
Period table. Shows the progress of summarizing history from Chain Period table into Chain
Year table. Shows the progress of summarizing history from Chain Year table into Chain Life
table. Error file for Location Summarizing:
File name: STSMVStyleHistLoc.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encountered unexpected error in the location workflow
Error file for Chain Summarizing: File name: STSMVStyleHistChn.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors in the
chain workflow
274 Segment Reference
Segment 11036 - MA Internal - History Import, Summarize Style Oh Hist
This segment loads history from the Location Week History table and summarizes it into the Chain Week On Hand History table in the Merchandise Analytics database.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForHistOhChnLocWkToChnWkTask
Batch Size For On Hand History Location Week To Chain Week Task
Specifies the number of rows being retrieved from the Location Week On Hand History table and summarized into the Chain Week On Hand History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnPdToYrTask
Batch Size For On Hand History Chain Period To Year Task
Specifies the number of rows being retrieved from the Chain Period On Hand History table and summarized into the Chain Year On Hand History table in each batch.
No MSSQL: 1200 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnWkToPdTask
Batch Size For On Hand History Chain Week To Period Task
Specifies the number of rows being retrieved from the Chain Week On Hand History table and summarized into the Chain Period History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnYrToLiTask
Batch Size For On Hand History Chain Year To Life Task
Specifies the number of rows being retrieved from the Chain Year On Hand History table and summarized into the Chain Life On Hand History table in each batch.
No MSSQL: 2400 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhLocPdToYrTask
Batch Size For On Hand History Location Period To Year Task
Specifies the number of rows being retrieved from the Location Period On Hand History table and summarized into the Location Year On Hand History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhLocWkToPdTask
Batch Size For On Hand History Location Week To Period Task
Specifies the number of rows being retrieved from the Location Week On Hand History table and summarized into the Location Period On Hand History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
Segment 11036 - MA Internal - History Import, Summarize Style Oh Hist 275
Scheduling RequirementsThis segment should be executed after Segments 16026 – Text File to MA - History Import, Update Imp Style Oh Hist and 11026 MA Internal - History Import, Update Live Style Oh Hist.
BatchSizeForHistOhLocYrToLiTask
Batch Size For On Hand History Location Year To Life Task
Specifies the number of rows being retrieved from the Location Year On Hand History table and summarized into the Location Life On Hand History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
ExtentSizeForHistOhChnLocWkToChnWkTask
Extent Size For On Hand History Location Week To Chain Week Task
Extent size used to rebuild the index on the Chain Week On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnPdToYrTask
Extent Size For On Hand History Chain Period To Year Task
Extent size used to rebuild the index on the Chain Year On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnWkToPdTask
Extent Size For On Hand History Chain Week To Period Task
Extent size used to rebuild the index on the Chain Period On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnYrToLiTask
Extent Size For On Hand History Chain Year To Life Task
Extent size used to rebuild the index on the Chain Life On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhLocPdToYrTask
Extent Size For On Hand History Location Period To Year Task
Extent size used to rebuild the index on the Location Year On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhLocWkToPdTask
Extent Size For On Hand History Location Week To Period Task
Extent size used to rebuild the index on the Location Period On Hand History table (Oracle only)
No 5
ExtentSizeForHistOhLocYrToLiTask
Extent Size For On Hand History Location Year To Life Task
Extent size used to rebuild the index on the Location Life On Hand History table (Oracle only)
No 5
Path Path Specifies the path where the log files and the error files are located.
No C:\NSB Interface\MA Internal - History Import, Summarize Style Oh Hist
SegmentIdentifier Segment Identifier Specifies the level of history being loaded, in this case Style.
No Style
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History.
No HistOh
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
276 Segment Reference
Database ParametersMA keeps the posting parameters in the post_parameter table; this segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history from Location Week table to Location Period table Summarizes history from Location Period table to Location Year table Summarizes history from Location Year table to Location Life table
Chain workflow: Summarizes history from Location Week table to Chain Week table Summarizes history from Chain Week table to Chain Period table Summarizes history from Chain Period table to Chain Year table Summarizes history from Chain Year table to Chain Life table
On hand history of a merchandising period = on hand history of the last week in this period
On hand history of a merchandising year = on hand history of the last period in this year
On hand life history = on hand history of the current merchandising year On hand of the current merchandising year = on hand of the current merchandising
period On hand of the current merchandising period = on hand of the current merchandising
week The current week = the latest week posted from Infobase (i.e., the value of post
parameter 23) If the last week in the on hand history week location table doesn’t match post
parameter 23 (which probably means at least 1 of the Infobase To MA segments wasn’t run successfully), this segment shouldn’t be run, otherwise there will be no on hand history in the life table. To verify if the last week in the week table matches post parameter 23, run segment 11042 MA Internal - History Import, Verify Oh Posting.
Troubleshooting Log file for Location Summarizing:
File name: STSMVStyleHistOhLoc.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of summarizing on hand history from Location Week table into Location Period table.
Shows the progress of summarizing on hand history from Location Period table into Location Year table.
Shows the progress of summarizing on hand history from Location Year table into Location Life table.
Parameter ID Parameter label Description
23 max week from Infobase Specifies the latest week posted from Infobase by running IB To MA segments.
Segment 11036 - MA Internal - History Import, Summarize Style Oh Hist 277
Log file for Chain Summarizing: File name: STSMVStyleHistOhChn.YYYYMMDDHHMMSS.LOG (where
YYYYMMDDHHMMSS is a time stamp) Shows the progress of summarizing on hand history from Location Week table into
Chain Week table. Shows the progress of summarizing on hand history from Chain Week table into
Chain Period table. Shows the progress of summarizing on hand history from Chain Period table into
Chain Year table. Shows the progress of summarizing on hand history from Chain Year table into
Chain Life table. Error file for Location Summarizing:
File name: STSMVStyleHistOhLoc.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors in the location workflow.
Error file for Chain Summarizing: File name: STSMVStyleHistOhChn.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors in the
chain workflow.
278 Segment Reference
Segment 11037 - MA Internal - History Import, Summarize Group Hist
This segment loads history from the Location Week History table and summarizes it into the Chain Week History table in the Merchandise Analytics database.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForHistChnLocWkToChnWkTask
Batch Size For History Location Week To Chain Week Task
Specifies the number of rows being retrieved from the Location Week History table and summarized into the Chain Week History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnPdToYrTask
Batch Size For History Chain Period To Year Task
Specifies the number of rows being retrieved from the Chain Period History table and summarized into the Chain Year History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnWkToPdTask
Batch Size For History Chain Week To Period Task
Specifies the number of rows being retrieved from the Chain Week History table and summarized into the Chain Period History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistChnYrToLiTask
Batch Size For History Chain Year To Life Task
Specifies the number of rows being retrieved from the Chain Year History table and summarized into the Chain Life History table in each batch.
No MSSQL: 1200 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistLocPdToYrTask
Batch Size For History Location Period To Year Task
Specifies the number of rows being retrieved from the Location Period History table and summarized into the Location Year History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistLocWkToPdTask
Batch Size For History Location Week To Period Task
Specifies the number of rows being retrieved from the Location Week History table and summarized into the Location Period History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
Segment 11037 - MA Internal - History Import, Summarize Group Hist 279
Scheduling RequirementsThis segment should be executed after Segments 16027 – Text File to MA - History Import, Update Imp Group Hist and 11027 MA Internal - History Import, Update Live Group Hist.
BatchSizeForHistLocYrToLiTask
Batch Size For History Location Year To Life Task
Specifies the number of rows being retrieved from the Location Year History table and summarized into the Location Life History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
ExtentSizeForHistChnLocWkToChnWkTask
Extent Size For History Location Week To Chain Week Task
Extent size used to rebuild the index on the Chain Week History table (Oracle only).
No 5
ExtentSizeForHistChnPdToYrTask
Extent Size For History Chain Period To Year Task
Extent size used to rebuild the index on the Chain Year History table (Oracle only).
No 5
ExtentSizeForHistChnWkToPdTask
Extent Size For History Chain Week To Period Task
Extent size used to rebuild the index on the Chain Period History table (Oracle only).
No 5
ExtentSizeForHistChnYrToLiTask
Extent Size For History Chain Year To Life Task
Extent size used to rebuild the index on the Chain Life History table (Oracle only).
No 5
ExtentSizeForHistLocPdToYrTask
Extent Size For History Location Period To Year Task
Extent size used to rebuild the index on the Location Year History table (Oracle only).
No 5
ExtentSizeForHistLocWkToPdTask
Extent Size For History Location Week To Period Task
Extent size used to rebuild the index on the Location Period History table (Oracle only)
No 5
ExtentSizeForHistLocYrToLiTask
Extent Size For History Location Year To Life Task
Extent size used to rebuild the index on the Location Life History table (Oracle only)
No 5
Path Path Specifies the path where the log files and the error files are located.
No C:\NSB Interface\MA Internal - History Import, Summarize Group Hist
SegmentIdentifier Segment Identifier Specifies the level of history being loaded, in this case MerchGroup.
No MerchGroup
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History.
No Hist
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
280 Segment Reference
Database ParametersMA keeps the posting parameters in the post_parameter table; this segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history from Location Week table to Location Period table Summarizes history from Location Period table to Location Year table Summarizes history from Location Year table to Location Life table
Chain workflow: Summarizes history from Location Week table to Chain Week table Summarizes history from Chain Week table to Chain Period table Summarizes history from Chain Period table to Chain Year table Summarizes history from Chain Year table to Chain Life table
Troubleshooting Log file for Location Summarizing:
File name: STSMVMerchGroupHistLoc.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of summarizing history from Location Week table into Location Period table.
Shows the progress of summarizing history from Location Period table into Location Year table.
Shows the progress of summarizing history from Location Year table into Location Life table.
Log file for Chain Summarizing: File name: STSMVMerchGroupHistChn.YYYYMMDDHHMMSS.LOG (where
YYYYMMDDHHMMSS is a time stamp) Shows the progress of summarizing history from Location Week table into Chain
Week table. Shows the progress of summarizing history from Chain Week table into Chain
Period table. Shows the progress of summarizing history from Chain Period table into Chain
Year table. Shows the progress of summarizing history from Chain Year table into Chain Life
table. Error file for Location Summarizing:
File name: STSMVMerchGroupHistLoc.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encountered unexpected errors in the location workflow.
Parameter ID Parameter label Description
23 max week from Infobase Specifies the latest week posted from Infobase by running IB To MA segments.
Segment 11037 - MA Internal - History Import, Summarize Group Hist 281
Error file for Chain Summarizing: File name: STSMVMerchGroupHistChn.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors in the
chain workflow.
282 Segment Reference
Segment 11038 - MA Internal - History Import, Summarize Group OH Hist
This segment loads history from the Location Week History table and summarizes it into the Chain Week On Hand History table in the Merchandise Analytics database.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForHistOhChnLocWkToChnWkTask
Batch Size For On Hand History Location Week To Chain Week Task
Specifies the number of rows being retrieved from the Location Week On Hand History table and summarized into the Chain Week History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnPdToYrTask
Batch Size For On Hand History Chain Period To Year Task
Specifies the number of rows being retrieved from the Chain Period On Hand History table and summarized into the Chain Year On Hand History table in each batch.
No MSSQL: 1200 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnWkToPdTask
Batch Size For On Hand History Chain Week To Period Task
Specifies the number of rows being retrieved from the Chain Week On Hand History table and summarized into the Chain Period History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhChnYrToLiTask
Batch Size For On Hand History Chain Year To Life Task
Specifies the number of rows being retrieved from the Chain Year On Hand History table and summarized into the Chain Life On Hand History table in each batch.
No MSSQL: 2400 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhLocPdToYrTask
Batch Size For On Hand History Location Period To Year Task
Specifies the number of rows being retrieved from the Location Period On Hand History table and summarized into the Location Year On Hand History table in each batch.
No MSSQL: 300 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
BatchSizeForHistOhLocWkToPdTask
Batch Size For On Hand History Location Week To Period Task
Specifies the number of rows being retrieved from the Location Week On Hand History table and summarized into the Location Period On Hand History table in each batch.
No MSSQL: 150 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
Segment 11038 - MA Internal - History Import, Summarize Group OH Hist 283
Scheduling RequirementsThis segment should be executed after Segments 16028 – Text File to MA - History Import, Update Imp Group Oh Hist and 11028 MA Internal - History Import, Update Live Group Oh Hist.
BatchSizeForHistOhLocYrToLiTask
Batch Size For On Hand History Location Year To Life Task
Specifies the number of rows being retrieved from the Location Year On Hand History table and summarized into the Location Life On Hand History table in each batch.
No MSSQL: 600 Oracle: get parameter value in the log file generated by segment 11041 MA Internal – History Import, Initialize
ExtentSizeForHistOhChnLocWkToChnWkTask
Extent Size For On Hand History Location Week To Chain Week Task
Extent size used to rebuild the index on the Chain Week On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnPdToYrTask
Extent Size For On Hand History Chain Period To Year Task
Extent size used to rebuild the index on the Chain Year On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnWkToPdTask
Extent Size For On Hand History Chain Week To Period Task
Extent size used to rebuild the index on the Chain Period On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhChnYrToLiTask
Extent Size For On Hand History Chain Year To Life Task
Extent size used to rebuild the index on the Chain Life On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhLocPdToYrTask
Extent Size For On Hand History Location Period To Year Task
Extent size used to rebuild the index on the Location Year On Hand History table (Oracle only).
No 5
ExtentSizeForHistOhLocWkToPdTask
Extent Size For On Hand History Location Week To Period Task
Extent size used to rebuild the index on the Location Period On Hand History table (Oracle only)
No 5
ExtentSizeForHistOhLocYrToLiTask
Extent Size For On Hand History Location Year To Life Task
Extent size used to rebuild the index on the Location Life On Hand History table (Oracle only)
No 5
Path Path Specifies the path where the log files and the error files are located.
No C:\NSB Interface\MA Internal - History Import, Summarize Group Oh Hist
SegmentIdentifier Segment Identifier Specifies the level of history being loaded, in this case MerchGroup.
No MerchGroup
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History.
No HistOh
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
284 Segment Reference
Database ParametersMA keeps the posting parameters in the post_parameter table; this segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history from Location Week table to Location Period table Summarizes history from Location Period table to Location Year table Summarizes history from Location Year table to Location Life table
Chain workflow: Summarizes history from Location Week table to Chain Week table Summarizes history from Chain Week table to Chain Period table Summarizes history from Chain Period table to Chain Year table Summarizes history from Chain Year table to Chain Life table Summarizes on hand history from chain year table to chain life table
On hand history of a merchandising period = on hand history of the last week in this period
On hand history of a merchandising year = on hand history of the last period in this year
On hand life history = on hand history of the current merchandising year On hand of the current merchandising year = on hand of the current merchandising
period On hand of the current merchandising period = on hand of the current merchandising
week The current week = the latest week posted from Infobase (i.e. the value of post
parameter 23) If the last week in the on hand history week location table doesn’t match post
parameter 23 (which probably means at least 1 of the Infobase To MA segments wasn’t run successfully), this segment shouldn’t be run, otherwise there will be no on hand history in the life table. To verify if the last week in the week table matches post parameter 23, run segment 11042 MA Internal - History Import, Verify OH Posting.
Troubleshooting Log file for Location Summarizing:
File name: STSMVMerchGroupHistOhLoc.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of summarizing on hand history from Location Week table into Location Period table.
Shows the progress of summarizing on hand history from Location Period table into Location Year table.
Shows the progress of summarizing on hand history from Location Year table into Location Life table.
Parameter ID Parameter label Description
23 max week from Infobase Specifies the latest week posted from Infobase by running IB To MA segments.
Segment 11038 - MA Internal - History Import, Summarize Group OH Hist 285
Log file for Chain Summarizing: File name: STSMVMerchGroupHistOhChn.YYYYMMDDHHMMSS.LOG (where
YYYYMMDDHHMMSS is a time stamp) Shows the progress of summarizing on hand history from Location Week table into
Chain Week table. Shows the progress of summarizing on hand history from Chain Week table into
Chain Period table. Shows the progress of summarizing on hand history from Chain Period table into
Chain Year table. Shows the progress of summarizing on hand history from Chain Year table into
Chain Life table. Error file for Location Summarizing:
File name: STSMVMerchGroupHistOhLoc.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors in the location workflow
Error file for Chain Summarizing: File name: STSMVMerchGroupHistOhChn.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encountered unexpected error in the
chain workflow
286 Segment Reference
Segment 11039 - MA Internal - History Import, Summarize Group Rim Oh
This segment summarizes the RIM on hand history in the live period location table into other levels, i.e. from period level to year and life levels and from location level to chain level.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForRimOhChnLocPdToChnPdTask
Batch Size For RIM On Hand Location Period To Chain Period Task
Specifies the number of rows being retrieved from the Location Period RIM On Hand table and summarized into the Chain Period RIM On Hand table in each batch.
No 300
BatchSizeForRimOhChnPdToYrTask
Batch Size For RIM On Hand Chain Period To Year Task
Specifies the number of rows being retrieved from the Chain Period RIM On Hand table and summarized into the Chain Year RIM On Hand table in each batch.
No 1200
BatchSizeForRimOhChnYrToLiTask
Batch Size For RIM On Hand Chain Year To Life Task
Specifies the number of rows being retrieved from the Chain Year RIM On Hand table and summarized into the Chain Life RIM On Hand table in each batch.
No 2400
BatchSizeForRimOhLocPdToYrTask
Batch Size For RIM On Hand Location Period To Year Task
Specifies the number of rows being retrieved from the Location Period RIM On Hand table and summarized into the Location Year RIM On Hand table in each batch.
No 300
BatchSizeForRimOhLocYrToLiTask
Batch Size For RIM On Hand Location Year To Life Task
Specifies the number of rows being retrieved from the Location Year RIM On Hand table and summarized into the Location Life RIM On Hand table in each batch.
No 150
ExtentSizeForRimOhChnLocPdToChnPdTask
Extent Size For RIM On Hand Location Period To Chain Period Task
Extent size used to rebuild the index on the Chain Period RIM On Hand table (Oracle only).
No 5
ExtentSizeForRimOhChnPdToYrTask
Extent Size For RIM On Hand Chain Period To Year Task
Extent size used to rebuild the index on the Chain Year RIM On Hand table (Oracle only).
No 5
ExtentSizeForRimOhChnYrToLiTask
Extent Size For RIM On Hand Chain Year To Life Task
Extent size used to rebuild the index on the Chain Life RIM On Hand table (Oracle only).
No 5
ExtentSizeForRimOhLocPdToYrTask
Extent Size For RIM On Hand Location Period To Year Task
Extent size used to rebuild the index on the Location Year RIM On Hand table (Oracle only)
No 5
Segment 11039 - MA Internal - History Import, Summarize Group Rim Oh 287
Scheduling RequirementsThis segment should be executed after Segments 16029 – Text File to MA - History Import, Update Imp Rim Oh and 11029 MA Internal - History Import, Update Live Rim Oh.
Database ParametersMA keeps the posting parameters in the post_parameter table; this segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes RIM On Hand history from Location Period table to Location Year table
Summarizes RIM On Hand history from Location Year table to Location Life table Chain workflow:
Summarizes RIM On Hand history from Location Period table to Chain Period table Summarizes RIM On Hand history from Chain Period table to Chain Year table Summarizes RIM On Hand history from Chain Year table to Chain Life table
RIM On Hand history of a merchandising year = RIM On Hand history of the last period in this year
RIM On Hand life history = RIM On Hand history of the current merchandising year RIM On Hand of the current merchandising year = RIM On Hand of the current
merchandising period
Mapping DocumentNone presently available.
ExtentSizeForRimOhLocYrToLiTask
Extent Size For RIM On Hand Location Year To Life Task
Extent size used to rebuild the index on the Location Life RIM On Hand table (Oracle only).
No 5
Path Path Specifies the path where the log files and the error files are located.
No C:\NSB Interface\MA Internal - History Import, Summarize Group Rim Oh
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Parameter ID Parameter Label Description
23 max week from Infobase Specifies the latest week posted from Infobase by running IB To MA segments.
288 Segment Reference
Troubleshooting Log file for Location Summarizing:
File name: STSMVRimOhLoc.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of summarizing RIM on hand history from Location Period table into Location Year table.
Shows the progress of summarizing RIM on hand history from Location Year table into Location Life table.
Log file for Chain Summarizing: File name: STSMVRimOhChn.YYYYMMDDHHMMSS.LOG (where
YYYYMMDDHHMMSS is a time stamp) Shows the progress of summarizing RIM on hand history from Location Period
table into Chain Period table. Shows the progress of summarizing RIM on hand history from Chain Period table
into Chain Year table. Shows the progress of summarizing RIM on hand history from Chain Year table
into Chain Life table. Error file for Location Summarizing:
File name: STSMVRimOhLoc.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors in the location workflow
Error file for Chain Summarizing: File name: STSMVRimOhChn.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encountered unexpected error in the
chain workflow
Segment 11041 - MA Internal - History Import, Initialize 289
Segment 11041 - MA Internal - History Import, InitializeThis segment is run to clean up the working tables (i.e., the Pipeline import tables) before loading history into Merchandise Analytics.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to any of the following segments unless the working tables of the following segments contain data that need to be reposted to MA history live tables: 16021 Text File to MA – History Import, Update Imp Sku Hist 16022 Text File to MA – History Import, Update Imp Sku Oh Hist 16023 Text File to MA – History Import, Update Imp Color Hist 16024 Text File to MA – History Import, Update Imp Color Oh Hist 16025 Text File to MA – History Import, Update Imp Style Hist 16026 Text File to MA – History Import, Update Imp Style Oh Hist 16027 Text File to MA – History Import, Update Imp Group Hist 16028 Text File to MA – History Import, Update Imp Group Oh Hist
Note: If one of the segments 16021 – 16028 has been already run and there is some rejected history left in the working table, segment 11041 shouldn’t be run before segment 16021 – 16028 or the rejected history will be lost.
Database ParametersNone.
Non-queue Segment Description This segment is run to clean up the working tables (i.e. the Pipeline import tables)
before loading history into Merchandise Analytics. If the MA database is on Oracle, the second task of this segment updates the batch
size values for segment parameters 11031 – 11038 provided that segments 11031 – 11038 are run when there is no other process on the MA database server (otherwise this will cause a system overflow). If the MA database is on SQL Server, the batch size parameters for segments 11031 – 11038 do not change.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Path Specifies the path where the log and error files are generated.
No C:\NSB Interface\MA Internal - History Import, Initialize
SortAreaSize Sort Area Size Specifies the RAM available in the MA database server.
No To get the value of this parameter: in Oracle, run select value from
v$parameter where name= 'sort_area_size' on the MA database
in SQL Server, leave the existing value of this parameter
290 Segment Reference
Troubleshooting Log file:
File name: STSMVInitialize.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of cleaning up the working tables of MA history load. Shows the Batch Sizes that should be used by MA history summarizing.
Error file: File name: STSMVInitialize.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment encounters unexpected errors.
This segment displays the following information in the log file: The progress of cleaning up of import tables for Sku level history The progress of cleaning up of import tables for Sku level on hand history The progress of cleaning up of import tables for Style Color level history The progress of cleaning up of import tables for Style Color level on hand history The progress of cleaning up of import tables for Style level history The progress of cleaning up of import tables for Style level on hand history The progress of cleaning up of import tables for Merchandise Group level history The progress of cleaning up of import tables for Merchandise Group level on hand history The calculated values for segment parameters in segment 11031 MA Internal –
History Import, Summarize Sku Hist: BatchSizeForHistLocWkToPdTask BatchSizeForHistLocPdToYrTask BatchSizeForHistLocYrToLiTask BatchSizeForHistChnLocWkToChnWkTask BatchSizeForHistChnWkToPdTask BatchSizeForHistChnPdToYrTask BatchSizeForHistChnYrToLiTask
The calculated values for segment parameters in segment 11032 MA Internal – History Import, Summarize Sku OH Hist: BatchSizeForHistOhLocWkToPdTask BatchSizeForHistOhLocPdToYrTask BatchSizeForHistOhLocYrToLiTask BatchSizeForHistOhChnLocWkToChnWkTask BatchSizeForHistOhChnWkToPdTask BatchSizeForHistOhChnPdToYrTask BatchSizeForHistOhChnYrToLiTask
The calculated values for segment parameters in segment 11033 MA Internal – History Import, Summarize Color Hist: BatchSizeForHistLocWkToPdTask BatchSizeForHistLocPdToYrTask BatchSizeForHistLocYrToLiTask BatchSizeForHistChnLocWkToChnWkTask BatchSizeForHistChnWkToPdTask BatchSizeForHistChnPdToYrTask BatchSizeForHistChnYrToLiTask
Segment 11041 - MA Internal - History Import, Initialize 291
The calculated values for segment parameters in segment 11034 MA Internal – History Import, Summarize Color OH Hist: BatchSizeForHistOhLocWkToPdTask BatchSizeForHistOhLocPdToYrTask BatchSizeForHistOhLocYrToLiTask BatchSizeForHistOhChnLocWkToChnWkTask BatchSizeForHistOhChnWkToPdTask BatchSizeForHistOhChnPdToYrTask BatchSizeForHistOhChnYrToLiTask
The calculated values for segment parameters in segment 11035 MA Internal – History Import, Summarize Style Hist: BatchSizeForHistLocWkToPdTask BatchSizeForHistLocPdToYrTask BatchSizeForHistLocYrToLiTask BatchSizeForHistChnLocWkToChnWkTask BatchSizeForHistChnWkToPdTask BatchSizeForHistChnPdToYrTask BatchSizeForHistChnYrToLiTask
The calculated values for segment parameters in segment 11036 MA Internal – History Import, Summarize Style Oh Hist: BatchSizeForHistOhLocWkToPdTask BatchSizeForHistOhLocPdToYrTask BatchSizeForHistOhLocYrToLiTask BatchSizeForHistOhChnLocWkToChnWkTask BatchSizeForHistOhChnWkToPdTask BatchSizeForHistOhChnPdToYrTask BatchSizeForHistOhChnYrToLiTask
The calculated values for segment parameters in segment 11037 MA Internal – History Import, Summarize Group Hist: BatchSizeForHistLocWkToPdTask BatchSizeForHistLocPdToYrTask BatchSizeForHistLocYrToLiTask BatchSizeForHistChnLocWkToChnWkTask BatchSizeForHistChnWkToPdTask BatchSizeForHistChnPdToYrTask BatchSizeForHistChnYrToLiTask
The calculated values for segment parameters in segment 11038 MA Internal – History Import, Summarize Group Oh Hist: BatchSizeForHistOhLocWkToPdTask BatchSizeForHistOhLocPdToYrTask BatchSizeForHistOhLocYrToLiTask BatchSizeForHistOhChnLocWkToChnWkTask BatchSizeForHistOhChnWkToPdTask BatchSizeForHistOhChnPdToYrTask BatchSizeForHistOhChnYrToLiTask
292 Segment Reference
Segment 11042 - MA Internal - History Import, Verify OH Posting
The sole purpose of this segment is to check the dates in the historical on hand files to ensure that it's permissible to run the Summarize segments. To do so, the segment checks that the dates in the historical on hand tables (for SKU, Style Color, Style and Merchandise group) match the value of parameter 23 (Max week from infobase) in Segment 5004 (Infobase to MA - Initialize Posting). If the dates match, segments 16022, 24, 26, 28, segments 11022, 24, 26, 28 and segments 11032, 34, 36 and 38 can be run. The log file generated by the segment indicates the results of the verification.
Segment Parameters
Scheduling Requirements The segment must be executed prior to any of the following segments:
16022 Text File to MA – History Import, Update Imp Sku Oh Hist 16024 Text File to MA – History Import, Update Imp Color Oh Hist 16026 Text File to MA – History Import, Update Imp Style Oh Hist 16028 Text File to MA – History Import, Update Imp Group Oh Hist 11022 MA Internal – History Import, Update Live Sku Oh Hist 11024 MA Internal – History Import, Update Live Color Oh Hist 11026 MA Internal – History Import, Update Live Style Oh Hist 11028 MA Internal – History Import, Update Live Group Oh Hist
The following segments must only be run after this segment is successfully run: 11032 MA Internal – History Import, Summarize Sku Oh Hist 11034 MA Internal – History Import, Summarize Color Oh Hist 11036 MA Internal – History Import, Summarize Style Oh Hist 11038 MA Internal – History Import, Summarize Group Oh Hist
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks the parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description Log file:
File name: STSMVVerifyOnHandPosting.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the latest week posted from Infobase through the IB To MA segments.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Path Specifies the path where the log and error files are generated.
No C:\NSB Interface\MA Internal - History Import, Verify Oh Posting
Parameter ID Parameter Label Description
Path Path Specifies the path where the log and error files are generated.
Segment 11042 - MA Internal - History Import, Verify OH Posting 293
Shows the latest weeks in the historical on hand tables for SKU, Style, Style Color and Merchandise Group levels in Merchandising Analytics.
Shows if the latest weeks in the historical on hand tables match the latest week posted from Infobase.
Error file: File name: STSMVVerifyOnHandPosting.YYYYMMDDHHMMSS.ERR (where
YYYYMMDDHHMMSS is a time stamp) This file is only generated when the segment detects a mismatch between the
latest weeks in the historical on hand tables and the latest week posted from Infobase.
The following information displays in the log: The latest week in the historical on hand SKU table The latest week in the historical on hand Style Color table The latest week in the historical on hand Style table The latest week in the historical on hand Merchandise Group table The latest week posted from Infobase If all of the latest weeks in historical on hand tables match the latest week posted
from MA, or if all of the historical on hand tables are empty, the segment will run successfully, otherwise the segment fails and reports an error in the error file.
If all the latest weeks in historical on hand tables match the latest week posted from MA, the on hand history can be loaded (i.e., by running the 12 segments listed above).
If all the latest weeks in historical on hand tables do not match the latest week posted from MA, the on hand history should not be loaded as no units will be found in the historical on hand life table. If a mismatch is found, it usually means at least one of the IB To MA segments wasn’t run successfully. (Exception: when all of the historical on hand tables are empty, an error will not be
reported for the mismatch between the historical on hand tables and the latest week from Infobase because the historical on hand life will show no units, which is correct.)
TroubleshootingNo troubleshooting information is currently available for this segment.
294 Segment Reference
Segment 11051 - MA to Sales Audit - Send Plans to Flash SalesThis segment retrieves plans from Merchandise Analytics and place them into a text file for Sales Audit Flash Sales.
Segment Parameters
Scheduling RequirementsThis segment must be scheduled after segment 26001 Merch Planning to MA - Import
Database ParametersNA.
Non-Queue Segment DescriptionThe segment requires the following Pipeline dll to be installed: STSPLMAToFlashSales.dll
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSize Batch Size Specifies the number of records that can be read from MA and written to file in one transaction
No 10000
ChainStore Dummy Store Number For Chain
Specifies the location code of the dummy store that is associated with the chain level plans
No
InProgressPath In Progress File Directory
Specifies the directory where the output file is built
No C:\Nsb Interface\MA to Sales Audit - Send Plans to Flash Sales\
Path Flash Sales File Directory
Specifies the directory where output file is sent - i.e. the ..\awflash\ICT_BUDGET\ directory on the SA server
No \\"SA Server"\awflash\ICT_BUDGET\
PlanElementMD Plan Element For Markdowns
Specifies the number of the plan element that represents markdowns
No 114
PlanElementSales Plan Element For Sales
Specifies the number of the plan element that represents sales
No 061
PlanType Plan Type Specifies if the plans should be sent at chain level or store level: C = Chain level, S = Store level
No S
PlanVerBudget Plan Version For Budgeted
Specifies the version code of the planning version that is considered the "budget" in Flash Sales
No C
PlanVerForecast Plan Version For Forecasted
Specifies the version code of the planning version that is considered the "forecast" in Flash Sales
No
Segment 11051 - MA to Sales Audit - Send Plans to Flash Sales 295
Troubleshooting
Segment Error LogThe following new error messages can be found in manager log if the segment failed.
Error Reason
Parameter "ChainStore" (Dummy Store Number For Chain) must be set if "PlanType"(Plan Type) is set to "C"(Chain).
Segment parameter “Plan Type” is set to “C”, but parameter “Dummy Store Number For Chain” isn’t set.
Parameter "InProgressPath"(In Progress File Directory) must be set with a valid path.
Segment parameter “In Progress File Directory” doesn't have a valid path.
Parameter "Path"(Flash Sales File Directory) must be set with a valid path.
Segment parameter “Flash Sales File Directory” doesn't have a valid path.
Parameter "PlanType"(Plan Type) must be set to "C" or "S".
Segment parameter “Plan Type” isn’t set to “C” or “S”.
Either parameter "PlanElementSales"(Plan Element For Sales) or "PlanElementMD"(Plan Element For Markdowns) must be set.
Either segment parameter “Plan Element For Sales” or “Plan Element For Markdowns” is not set.
Either parameter "PlanVerBudget"(Plan Version For Budgeted) or "PlanVerForecast"(Plan Version For Forecasted) must be set.
Either segment parameter “Plan Version For Budgeted” and “Plan Version For Forecasted” is not set.
Parameter "ChainStore"(Dummy Store Number For Chain) contains an invalid location code.
Segment parameter "Dummy Store Number For Chain” contains an invalid location code.
Parameter "PlanElementMD"(Plan Element For Markdowns) contains an invalid plan element number.
Segment parameter " Plan Element For Markdowns” contains an invalid planning element number.
Parameter "PlanElementSales"(Plan Element For Sales) contains an invalid plan element number.
Segment parameter " Plan Element For Sales” contains an invalid planning element number.
Parameter "PlanVerBudget"(Plan Version For Budgeted) contains an invalid plan version code.
Segment parameter "Plan Version For Budgeted” contains an invalid plan version code.
Parameter "PlanVerForecast"(Plan Version For Forecasted) contains an invalid plan version code.
Segment parameter "Plan Version For Forecasted” contains an invalid plan version code.
No hierarchy level has POS Merch Group Key in MA. The classes in Merchandising and MA should have values on the field “POS Merch Group Key”, but in MA no merchandise hierarchy level has values for POS Merch Group Key.
Error copying file to flash sales: … Unable to copy the in progress file to the Flash Sales File directory due to a network failure.
Error creating GO file for flash sales: … A non-empty file named budget.go should be placed in the flash sales file directory to indicate that flash can pick up the flash sales data file and post it. The budget.go wasn’t generated successfully on the flash sales file directory due to network failure.
There's already a budget.tab file on the directory …! There is an old budget.tab file on the flash sales directory that is probably still unprocessed, the newly generated file can’t be placed on the flash sales directory otherwise it will replace the old file.
296 Segment Reference
Segment 11060 - MA Internal - Summarize Hist Component at SKU Level
This segment summarizes the SKU level history by component information in the Location Week, Location Period, Location Year and Location Life tables and updates the history by component tables in the Merchandise Analytics database (as described in the Non-queue Segment description).
Segment ParametersNone.
Scheduling RequirementsThis segment should be executed after Segment 16020 – Text File to MA Hist Component Import.
Database ParametersNone.
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history by component from Location Week to Location Period Summarizes history by component from Location Period to Location Year Summarizes history by component from Location Year to Location Life
Chain workflow: Summarizes history by component from Location Week to Chain Week Summarizes history by component from Location Period to Chain Period Summarizes history by component from Location Year to Chain Year Summarizes history by component from Location Life to Chain Life
TroubleshootingTo check if the segment executed successfully, open the Manager.log file on the Pipeline application server. This log file is usually located in: E:\Epicor\Logs\.
Segment 11061 - MA Internal - Summarize Hist Component Style Clr Lvl 297
Segment 11061 - MA Internal - Summarize Hist Component Style Clr Lvl
This segment summarizes the style color level history by component information in the Location Week, Location Period, Location Year and Location Life tables and updates the history by component tables in the Merchandise Analytics database (as described in the Non-queue Segment description).
Segment ParametersNone.
Scheduling RequirementsThis segment should be executed after Segment 16020 – Text File to MA Hist Component Import.
Database ParametersNone.
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history by component from Location Week to Location Period Summarizes history by component from Location Period to Location Year Summarizes history by component from Location Year to Location Life
Chain workflow: Summarizes history by component from Location Week to Chain Week Summarizes history by component from Location Period to Chain Period Summarizes history by component from Location Year to Chain Year Summarizes history by component from Location Life to Chain Life
TroubleshootingTo check if the segment executed successfully, open the Manager.log file on the Pipeline application server. This log file is usually located in: E:\Epicor\Logs\.
298 Segment Reference
Segment 11062 - MA Internal - Summarize Hist Component at Style Level
This segment summarizes the style level history by component information in the Location Week, Location Period, Location Year and Location Life tables and updates the history by component tables in the Merchandise Analytics database (as described in the Non-queue Segment description).
Segment ParametersNone.
Scheduling RequirementsThis segment should be executed after Segment 16020 – Text File to MA Hist Component Import.
Database ParametersNone.
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history by component from Location Week to Location Period Summarizes history by component from Location Period to Location Year Summarizes history by component from Location Year to Location Life
Chain workflow: Summarizes history by component from Location Week to Chain Week Summarizes history by component from Location Period to Chain Period Summarizes history by component from Location Year to Chain Year Summarizes history by component from Location Life to Chain Life
TroubleshootingTo check if the segment executed successfully, open the Manager.log file on the Pipeline application server. This log file is usually located in: E:\Epicor\Logs\.
Segment 11063 - MA Internal - Summarize Hist Component at Group Level 299
Segment 11063 - MA Internal - Summarize Hist Component at Group Level
This segment summarizes the group level history by component information in the Location Week, Location Period, Location Year and Location Life tables and updates the history by component tables in the Merchandise Analytics database (as described in the Non-queue Segment description).
Segment ParametersNone.
Scheduling RequirementsThis segment should be executed after Segment 16020 – Text File to MA Hist Component Import.
Database ParametersNone.
Non-queue Segment DescriptionThis segment has 2 workflows: Location workflow:
Summarizes history by component from Location Week to Location Period Summarizes history by component from Location Period to Location Year Summarizes history by component from Location Year to Location Life
Chain workflow: Summarizes history by component from Location Week to Chain Week Summarizes history by component from Location Period to Chain Period Summarizes history by component from Location Year to Chain Year Summarizes history by component from Location Life to Chain Life
TroubleshootingTo check if the segment executed successfully, open the Manager.log file on the Pipeline application server. This log file is usually located in: E:\Epicor\Logs\.
300 Segment Reference
Segment 12100 - Sales Audit Internal - Purge mew_sales_export
This segment purges sales transactions from the Sales Audit, mew_sales_export table, if they are older than the number of days specified.
Segment Parameters
Scheduling RequirementsShould be scheduled to run once a day.
Database ParametersNA.
Non-Queue Segment DescriptionThe DTS package associated with this segment creates a database connection to a Sales Audit database and then sends an execute command for the mew_purge_export_$sp procedure, passing the value of the segment parameter. If the procedure fails, it will return an error message which may be viewed in the Pipeline Manager log.
TroubleshootingIf the segment fails, re-run the segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
nbDaysKeepingTrans Number of days to keep Sale transactions
Number of days to keep Sale transactions in mew_sales_export
Yes 30
Segment 16001 - Text File To EDM, PROD & POM Import tables - Import 301
Segment 16001 - Text File To EDM, PROD & POM Import tables - Import
This segment loads EDM and PROD master entity information from input text files and imports the master data into EDM and PROD.
Note: This segment should not be run if Sourcing is installed.
Segment Parameters
Scheduling RequirementsThis segment should be run prior to segment 17000 EDM, PROD and POM Import tables to EDM, PROD & POM when Sourcing is not installed.
Database ParametersNone.
Non-queue Segment Description The segment does not require any Pipeline dlls to be installed. The segment uses the following Merchandising dlls:
STSFCClient.dll STSFCServer.dll
This segment loads EDM & PROD master entity information from input text files found in the location specified by the segment parameter “path”, and imports the master data into the EDM & PROD Import tables.
After this segment runs successfully, segment 17000 loads the master entities from the import tables (i.e., import_style, import_location etc.) into the live EDM & PROD tables (i.e., style, location etc.).
The following master entities are imported: Style Style color Vendor style UPC Style attribute set Style custom property Style attachment
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Mod64 Mod64 Indicates whether the customer modification Style Reclassification is supported. The value must be set to 1 (True) or 0 (False).
No 0
Path Path Specifies the path where the input text file and the error file are located.
No C:\NSB Interface\Text File to EDM & PROD Import Tables - Imp Master Entities
302 Segment Reference
Vendor Vendor address Vendor contact Vendor attribute set Vendor discount Vendor transaction set Vendor manufacturer ID Location Location address Location contact Location attribute set Location custom property Retail exception Merchandise group Merchandise group position Merchandise group attribute set Merchandise group PLU profile Employee Employee position Employee attribute set Employee address Employee contact Style description Style color description Style size description Merch group description Currency conversion Jurisdiction equivalency Jurisdiction tax exception Style retail Calendar Country Color Currency
In the import of pricing exceptions for start up, or ongoing style imports, the system uses the last entry in ib_price that includes given location / style / color as the current price even if exceptions such as pricing group exceptions have been loaded first. If jurisdiction price is loaded after the exception, it will override the price group exception. Therefore, at start-up, pricing exceptions should be imported in the following sequence: 1. Style/Color/Jurisdiction
2. Style/Pricing Group
3. Style/Pricing Group/Color4. Style/Location
5. Style/Location/Color
This is because when there is no document number in ib_price, the system applies the jurisdiction price and not the price group exception price.
Segment 16001 - Text File To EDM, PROD & POM Import tables - Import 303
TroubleshootingErrors for the segment are found in Pipeline Engine Manager.log, and in an error log specific to the segment whose path is defined by the segment parameter "Path".
Manager LogSome of the errors that the segment may log to the Manager.log include the following:
Segment Error LogThe errors generated by the segment are found in the directory specified by the segment parameter Path. The file is named following the convention: XXXX.timestamp.ERR (where XXXX is the file base name of the import text file).
Error Reason
The task reported failure on execution. This error occurs when there’s no valid text file found in the input directory (specified by the segment parameter Path)
Error Reason
Resulting PO Predistribution Type is mandatory when Replenish Flag = Y.
For style Add or Modify where the replenish flag is set to Y, the resulting PO predistribution type was not provided.
Resulting PO Predistribution Type must be a number between 1 and 4.
For style Add or Modify where the replenish flag is set to Y, a value other than 1, 2, 3 or 4 has been provided for resulting PO predistribution type.
'Pack Code' is mandatory for Pack UPC. For UPC imports where UPC type is set to P, the pack code was not provided.
Minimum on order cost for bulk or crossdock orders must be greater than or equal to 0 (value provided = |1).
For vendor Add or Modify, a negative value was provided for the column “minimum on order cost for bulk or cross dock orders”.
Minimum On Order Cost for Bulk and Crossdock Orders must be numeric.
For vendor Add or Modify, a non-numeric value is provided for the column “minimum on order cost for bulk or cross dock orders”.
Minimum on order cost for dropship orders must be greater than or equal to 0 (value provided = |1).
For vendor Add or Modify, a negative value is provided for the column “minimum on order cost for dropship orders”.
Minimum On Order Cost for Dropship Orders must be numeric.
For vendor Add or Modify, a non-numeric value is provided for the column “minimum on order cost for dropship orders”.
Uses Offline IM flag is mandatory. When importing a location, the value of the Uses Offline IM flag must be either Y or N.
Uses Offline IM flag must be set to 'Y' or 'N'.
When importing a location, a value other than Y or N was provided for Uses Offline IM flag.
Record has incorrect number of fields. Record of a certain entity doesn’t have the number of columns expected as indicated in the mapping document.
Style code is mandatory. When importing a style color description or style size description, the style code was not provided.
Color code is mandatory. When importing a style color description, the color code was not provided.
Locale identifier is mandatory. When importing a style color description, a style size description or merch group description, the locale identifier was not provided.
304 Segment Reference
Size code is mandatory. When importing a style size description, the size code was not provided.
Ticket label override is mandatory. When importing a style size description Add or Modify, the ticket label override was not provided.
Hierarchy Group Code is mandatory. When importing a merch group description, the hierarchy group code was not provided.
Merchandise group label is mandatory. When importing a merch group description Add or Modify, the hierarchy group label was not provided.
Merchandise group short label is mandatory.
When importing a merch group description Add or Modify, the hierarchy group short label was not provided.
Action type must be A, M, or D. When importing a style color description, style size description or merch group description, a value other than A, M or D was provided for the action type.
Country code is mandatory. When importing a country, the country code was not provided.
Country description is mandatory. When importing a country using action type A, the country description was not provided.
Currency code is mandatory. 1. When importing a country using action type A, the currency code was not provided. 2. When importing a currency, the currency code was not provided.
Currency description is mandatory. When importing a currency using action type A, the currency description was not provided.
Currency symbol is mandatory. When importing a currency using action type A, the currency symbol was not provided.
Calendar year code is mandatory. When importing a calendar year, the year code was not provided.
No. of weeks in period 1-12 is mandatory. When importing a calendar year, the number of weeks was not specified for one of periods 1 through 12.
A period can only have 4 or 5 weeks. When importing a calendar year, a value other than 4 or 5 was provided for the number of weeks for one of the 13 periods.
Action type must be ‘A’ or ‘D’. When importing a calendar, a color, a country or a currency, a value other than A or D has been provided for the action type.
Error Reason
Segment 16004 - Text File to IM Import - Import UDAs 305
Segment 16004 - Text File to IM Import - Import UDAsThis segment loads UDAs (user-defined adjustments) from the input text files found in the location defined by segment parameter Path and imports them to the Import UDA tables in IM.
Segment Parameters
Scheduling RequirementsThis segment should be run prior to segment 19000 IM Import tables to IM.
Database ParametersNone.
Non-queue Segment DescriptionThis segment loads UDAs from input text files found in the location specified by the segment parameter “path” and imports them into the Import UDA tables in IM.
After this segment runs successfully, segment 19000 controls the validation of business rules and the creation of UDA documents in IM. After the segment runs the input file is renamed from STSIMUDA…GO to STSIMUDA…BAK in the directory specified by segment parameter ‘Path’.
If any errors are found in the .GO file, a .ERR file and a .REP file (containing records to be reprocessed) are generated.
Troubleshooting Input file:
File name: STSIMUDA.timestamp.GO If no input file is found, the segment will fail and the following error will be
displayed: “The task reported failure on execution.” Error file:
File name: STSIMUDA.timestamp.ERR This file is only generated when the segment encounters unexpected errors. This file is located in the directory defined by the segment parameter "Path".
Possible errors:
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Path Specifies the path where the input text file and error file are located.
No C:\NSB Interface\Text File to IM Import tables – Import UDAs
Error Reason
Invalid record type/action. The only valid record type/actions are ‘H’eader/’A’dd, ‘D’etail/’A’dd and ‘M’essage/’A’dd
Invalid number of fields found in header record.
A header record expects 9 fields.
Invalid date submitted. A date must be provided in MM/DD/YYYY format.
306 Segment Reference
Source must be 3.
Either UPC No. or Style mandatory
Either Units or Cost mandatory.
Invalid number of fields found in message record.
A message record expects 5 fields.
Header must be followed by at least one detail.
Invalid number of fields found in detail record.
A detail record is expecting 13 fields.
Units must be numeric.
Cost must be numeric.
Record type must be 'P' or 'S'. Note: Applies to detail record.
If Record type = ‘P’, then pack code cannot be null
Error Reason
Segment 16005 - Text File to Stock Ledger - Imp Initial CC Percentages 307
Segment 16005 - Text File to Stock Ledger - Imp Initial CC Percentages
This segment imports the initial values used to calculate the Cumulative Cost Percent (cc%).
The Cumulative Cost Percent is used in the calculation of the cost according to the Retail Inventory Method. This method starts with a Retail Value and applies the Cumulative Cost Percent for the Merchandising Group and Location Group to compute a Cost Value.
Segment Parameters
Scheduling RequirementsThis segment is run one time only when the client is ready to go live on Stock Ledger.
Database Parameters Initially the segment truncates the cum_val_startup_temp table and re-loads it with
the data read from the source file. The second step inserts data inside cum_val_history using SQL:
insert into cum_val_history
select distinct mhg.hierarchy_group_ID, cp.calendar_period_ID,
loc.location_ID, tmp.cum_val_cost, tmp.cum_val_retail, 1from hierarchy_group mhg, location loc, cum_val_startup_temp tmp,
parameter_sl_accum_dep accm, calendar_period cp, calendar_year cy
where tmp.merchandising_code = mhg.hierarchy_group_code and tmp.location_code = loc.location_code
and cp.calendar_year_ID = cy.calendar_year_ID
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
LogFilePath Log File Name The folder where the fog files will be saved.
No C:\STSInterface\SLLogs
ApplicationId Merchandising Application
The Merchandising Application ID No 100
StartupPeriod First accumulation period
The Calendar Year code and the Calendar Period code where the Initial values are posted. This should be the first period of the Accumulation Period, e.g., 200201.
No
SourceFile Source File The folder and name of the Initial CC% file.
No
CompanyId Database Company to Use
The company ID used by the Epicor Foundation Component that defines the database where the SL tables reside.
No The company for which the segment has been installed
ModuleName Stock ledger Registry Module name
This is a registry key on the Pipeline Server from where the CompanyId can be read.
No SL
308 Segment Reference
and cp.calendar_period_code = '06'
and cy.calendar_year_code = '2004'and mhg.hierarchy_level_ID = accm.cum_val_merchandising_level_ID
and accm.effective_period_ID = 30000001
Non-queue Segment DescriptionThis segment imports the initial values used to calculate the Cumulative Cost Percent (cc%).
Mapping t
Merchandise Hierarchy Group Code Maximum 20 alphanumerics Must exist in PROD. The Merchandise Group must belong to the Merchandise Hierarchy Level defined in
EDM as the level at which Cumulative Values are tracked (Accumulation Period Dependant Parameters).
Location Hierarchy Group Code or Location Code If “Location” has been chosen in CORE as the location level at which Cumulative
Values are tracked this field must contain a Location Code or a Location Group Code. Maximum 20 alphanumerics. Must exist in PROD. If the value is a Location Group Code, it must be on the Cumulative Values Location
Level defined in EDM (Accumulative Period Dependant Parameters).Initial Cost Value in HOme Currency Initial cost value for the startup period (home currency).Initial Retail Value in Home Currency Initial retail value for the startup period (home currency)Initial Cost Value in Location Currency Initial cost value for the startup period (location currency).Initial Retail Value in Location currency Initial retail value for the startup period (location currency). These values can be also entered as:
Initial Cost Value = CC%/100 and corresponding Initial Retail Value = 1 (for example a CC% of 85% can be entered as Initial Cost Value = 0.85, Initial Retail Value = 1)
Column No. ValueCC% FILE LAYOUT (SourceFile) Column Name
1 20 AN Merchandise Hierarchy Group Code
2 20 AN Location Hierarchy Group Code or Location Code
3 N (999999999999.99) Initial Cost Value in Home Currency
4 N (999999999999.99) Initial Retail Value in Home Currency
5 N (999999999999.99) Initial Cost Value in Location Currency
6 N (999999999999.99) Initial Retail Value in Location Currency
7 20 AN Jurisdiction Code
Segment 16005 - Text File to Stock Ledger - Imp Initial CC Percentages 309
Jurisdiction code
The jurisdiction to which the initial startup values apply.Technical Notes All fields are tab delimited and each record ends with <CR><LF>. For example:
0100-1102-2122<tab>11<tab>.85<tab>1<cr><lf>
0100-1102-2123<tab>12<tab>78<tab>100<cr><lf>0100-1103-2123<tab>13<tab>928.34<tab>1020.5<cr><lf>
where
0100-1102-2122, 0100-1102-2123 are Merchandising Group Codes11, 12, 13 are Location Group Codes
.80, 78, 928.34 are Cost Values
1, 100, 1020.5 are Retail Values The definition of the alphanumeric fields (for example 20 AN) indicates the maximum
number of characters allowed. It is not necessary to pad with blanks. Numbers can have a maximum of 2 decimals and whole numbers can be entered
without decimals (i.e, 188 is the same as 188.00).
Troubleshooting
Stock Ledger DependenciesThe Pipeline segment StartupPeriod parameter (for example: 201112) and the following Stock Ledger parameters must be set to the same period: Valuation Method, Effective as of year and period (for example: Year: 2011 Period: 12). Accumulation Period Dependent, Effective as of year and period (for example: Year:
2011 Period: 12.
This means that the Accumulation Period parameter must be the parameter driving the others as it must be set to the first period of accumulation of period, semi-annual or annual period of accumulation.
Error fileAn error file is produced that allows the user to see the transactions committed and rollback. The file is located at c:\LoadCCPerFromFileErrLog. Example of the information contained in this file:
Thread#2832:Starting ExecuteNoId - 15-52-15 Thread#2832:Starting ExecuteNoId 2 - 15-52-15
Thread#2832:Commiting Transaction - 15-52-15
If the segment itself fails, search the Manager log in the Pipeline folder on the Pipeline server for error messages.
310 Segment Reference
Segment 16008 - Text File To Invoice Matching Imp Tbls - Imp Invoices
This segment loads invoices from text files into import invoice matching tables.
Segment Parameters
Scheduling RequirementsThis segment runs prior to segment 22000 Invoice Matching Import tables to Invoice Matching Import.
Database ParametersThere are no Pipeline parameters stored in the source or destination database for this segment.
Non-queue Segment Description The segment does not require any Pipeline dlls to be installed. The input file
File name: STSIMATIN.yyyymmddhhmmss.GO (yyyymmddhhmmss is a timestamp) While the file is being processed, it is temporarily renamed to
STSIMATIN.yyyymmddhhmmss.RCVD.GO After the file is processed, it is renamed to STSIMATIN.yyyymmddhhmmss.BAK
If any errors are encountered, an error file will be built to log the errors. File name: STSIMATIN.yyyymmddhhmmss.ERR
If any errors are encountered, an error file will be built to log the records that need to be reprocessed. File name: STSIMATIN.yyyymmddhhmmss.REP
When importing an invoice document from text files, tax information should be provided in the text files: On an invoice subledger record: The column gross amount and net amount have been renamed to gross amount
foreign and net amount foreign, and they must be provided in the invoice currency.
The GL distribution type ITC is supported (column Tax Type Code is provided on a invoice subledger record for GL distribution type ITC). For an ITC, the net amount foreign must always be provided. If the client does not provide an ITC record for a particular tax type, we assume the vendor is not charging that tax. Ideally, the client would provide an ITC record with a net amount foreign of 0 in this case.
GL distribution type Amount To Be Matched is supported (however a subledger of GL distribution type Amount To Be Matched may only be provided if no invoice detail is provided).
On an invoice detail record:
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Input File Directory
The directory where the input files, error files and reprocess files are found.
No C:\NSB Interface\Text File To Invoice Matching Import tables - Imp Invoices
Segment 16008 - Text File To Invoice Matching Imp Tbls - Imp Invoices 311
Style status is not used and should be blank. Either UPC, vendor style, style code or pack code must be provided. Detail records are not mandatory. New record type invoice subledger tax override is provided: For the invoice subledger of GL distribution type Amount To Be Matched, invoice
subledger tax overrides are only provided if no invoice detail is provided (if details are provided, then the tax overrides can only be provided in the invoice detail tax override level).
The column tax rate code provided in this record will override the tax rate code of the system-generated tax.
New record type invoice detail tax override is provided. The column tax rate code provided in this record will override the tax rate code of
the system-generated tax. After the segment has been successfully run, the data is loaded into the following
temporary tables in IMAT: import_invoice_header import_invoice_ref import_invoice_message import_invoice_discount import_invoice_charges import_invoice_details imp_invoice_charge_tax imp_invoice_detail_tax
TroubleshootingIf any errors occur due to bad import data, i.e., invalid payment status code etc. has been provided, fix the input text file and rerun segment 16008.
312 Segment Reference
Segment 16020 - Text File To MA Hist Component ImportThis segment loads history from input text files into the history by component tables in MA. The following component loads are supported: SKU History by week/location/component/price status/transaction reason Style Color History by week/location/component/price status/transaction reason Style History by week/location/component/price status/transaction reason Merchandise Group History by week/location/component/price status/transaction
reason
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
AddReplaceValues Values will be replaced in the hist_cmp_* tables
Whether to Add to or Replace the data in the history component table if the data to be posted for a given Entity Level (i.e. SKU, Style Color, Style or Merchandise Group), Merch Year Week, Location, Component, History Component already exists in the history component table. Values: A (Add), R (Replace).
Yes R
AllowMultiUpcSku Allow Multiple UPCs per SKU
Whether the history of multiple UPCs for the same SKU/location/week is allowed. Applicable only to the SKU level import files. Not applicable to the Style Color level, Style level and Merchandise Group level import files. Values: 0 (not allowed), 1 (allowed).
Yes 0
DefaultCurrencyProvided
Default currency provided in the import files
Whether the import file contains data in the Home currency, Local currency, or both currencies. Applicable to the Style Color level, Style level and Merchandise Group level import files. Not Applicable to the SKU level import files. Values: Home, Local, Both.
Yes Home
FieldsExpectedPerGroupRecord
Number of fields expected per Group record
The number of tab delimited fields expected in the Merchandise Group level import file provided. Values: 1-20.
No 14
FieldsExpectedPerSKURecord
Number of fields expected per SKURecord
The number of tab delimited fields expected in the SKU level import file. Values: 1-20.
No 7
FieldsExpectedPerStyleColorRecord
Number of fields expected per Style Color record
The number of tab delimited fields expected in the Style Color level import file. Values: 1-20.
No 15
FieldsExpectedPerStyleRecord
Number of fields expected per Style record
The number of tab delimited fields expected in the Style level import file. Values: 1-20.
No 14
ImportPath Import directory The location of the import files. Yes C:\Nsb Interface\MA_Startup\GOFiles\CMP
Segment 16020 - Text File To MA Hist Component Import 313
Scheduling RequirementsThis segment should be run after segment 5005.This segment should be executed prior to the following segments: 11060 - MA Internal - Summarize History Component at SKU Level, 11061 - MA Internal - Summarize History Component at Style Color Level, 11062 - MA Internal - Summarize Histroy Component at Style Level and 11063 - MA Internal - Summarize History Component at Merchandise Group Level.
Database ParametersMA keeps the posting parameters in the post_parameter table. The segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description This segment loads MA history by component, Price Status and Reason Data from input
text files found in the location specified by the segment parameter Import directory. Text files must be named as follows, based on the level (SKU, style color, style or
group) of information in the import file: STSMVSkuHistCmp.YYYYMMDDHHMMSS.GO STSMVStyleColorHistCmp.YYYYMMDDHHMMSS.GO STSMVStyleHistCmp.YYYYMMDDHHMMSS.GO STSMVGroupHistCmp.YYYYMMDDHHMMSS.GOFor example, a file named STSMVSKUHistCmp.20061231235959.GO must contain records of type SKU History By Week / Location / Component Type / Price Status; a file named STSMVGroupHistCmp.20061231235959.GO must contain records of type Merch Group History by Week / Location / Component Type / Price Status.
After segment 16020 has completed, run one of the following segments to populate the MA database with the summary information required: 11060 - MA Internal - Summarize History Component at SKU Level 11061 - MA Internal - Summarize History Component at Style Color Level 11062 - MA Internal - Summarize Histroy Component at Style Level 11063 - MA Internal - Summarize History Component at Merchandise Group Level
MaxErrorsAllowed Maximum number of errors allowed
Stops processing the import file after the specified number of errors is reached.Valid values: 0 to 999,999,999 and -1 (will not stop processing when errors are found).
Yes 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
314 Segment Reference
TroubleshootingTo check if the segment executed successfully, open the Manager.log file on the Pipeline application server. This log file is usually located in: E:\Epicor\Logs\.
There are two phases to the text file import.
In the first phase, the system validates the format of the import file. If an error is found (for example, the Merch YearWeek is not in the correct format), .ErrorDesc and .Reprocess files will be created in a subdirectory called ResultImportFile, in the location specified by the Import directory segment parameter. To reprocess the failed transactions, fix the errors in the .Reprocess file, rename the file extension to .GO and then copy the .GO file to the location specified by the Import directory segment parameter. Then rerun segment 16020.In the second phase, when records are inserted into the database, .ErrorDesc and .Reprocess files will be created in a subdirectory called ResultImportTable, in the location specified by the Import directory segment parameter. To reprocess the failed transactions, fix the errors in the .Reprocess file, rename the file as described in the Non-queue Segment Description (above) and then copy the .GO file to the location specified by the Import directory segment parameter. Then rerun segment 16020.
Possible errors
Error Reason
History provided for weeks >= … - deleting...
The client can only provide history for weeks up to the week prior to the live week (specified by post parameter 308). If the history of any merchandise year week >= live week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
Segment 16021 - Text File To MA - History Import, Update Imp Sku Hist 315
Segment 16021 - Text File To MA - History Import, Update Imp Sku Hist
This segment loads history from input text files into the Import ID table in MA.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to the following segment: 11021 MA Internal – History Import, Update Live Sku Hist.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
AllowMultiUpcSku Allow Multi UPC SKU
Indicates if history of multiple UPCs for the same SKU/location/week is allowed. Must be set to 0 (F) or 1 (T).
No 0
BatchSizeForImpCdHistTable
Batch Size For Import Code History table
The number of rows inserted into the Import Code History table in each batch.
No 1000
BatchSizeForImpIdHistTable
Batch Size For Import ID History table
The number of rows retrieved from the Import Code History table and inserted into the Import ID History table in each batch.
No 150
ExtentSizeForImpCdHistTable
Extent Size For Import Code History table
The extent size used to rebuild the index on the Import Code History table. Applies only to Oracle.
No 5
ExtentSizeForImpIdHistTable
Extent Size For Import ID History table
The extent size used to rebuild the index on the Import ID History table. Applies only to Oracle.
No 5
FieldsExpectedPerHistRecord
Fields Expected Per History Record
The number of tab delimited fields expected in each record of the import text file.
No 12
MaxErrorDetailsToPrint
Max Error Details To Print
The max number of reported errors that can be printed in the error file.
No 100
SegmentIdentifier Segment Identifier The level of history loaded, in this case SKU.
No SKU
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History. Must be set to “Hist” or “HistOh”.
No Hist
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\Text File To MA - History Import, Update Imp Sku Hist
316 Segment Reference
Database ParametersMA keeps the posting parameters in the post_parameter table. The segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description This segment loads history from input text files found in the location specified by the
segment parameter “path”, imports the history into the import code table, converts the entity codes of the history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
After this segment loads the history into import ID table successfully, segment 11021 loads history from import ID table into the live history table.
Troubleshooting Log file:
File name: STSMVSkuHist.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp) found in the directory defined by segment parameter "Path".
Shows the progress of loading history from input text file into the import code table
Shows the progress of loading history from import code table into the Import ID table
Shows the totals of the history loaded into import ID tables Error file:
File name: STSMVSkuHist.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp).
This file is only generated when the segment encounters unexpected errors. Error log is located in the directory defined by segment parameter "Path".
Possible errors:
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Error Reason
Import code table has contents, skipping to PreBuildImpIdHistTbl task.
This indicates that some rejected history was left in the import code table the last time the segment ran. When the segment detects this history in the code table it will jump to the step that posts history from code table to ID table instead of trying to first load history from the text file into the code table.
Aborted – record in textfile…does not contain the correct number of fields…
The segment fails and this error message displays if the number of fields in the records of the input file doesn’t match the segment parameter FieldsExpectedPerHistRecord.
Aborted processing of … textfile, number of acceptable errors exceeded.
Segment parameter MaxErrorDetailsToPrint specifies the maximum number of reported errors that can be printed in the error file for each Import History file. If the number of errors on an import file exceeds this number, the errors won’t be printed to the error file and this error message will be logged.
Aborted - no input files found to process.
If no history exists in the import code table and no input file is found, the segment will abort with this error.
Segment 16021 - Text File To MA - History Import, Update Imp Sku Hist 317
Aborted - errors encountered inserting from input file(s) to import code table.
If any error occurs while inserting data from the text file to the import code table, the segment will abort with this error.
Aborted - history has been provided for calendar weeks that do not exist in the calendar table.
If the history of any merchandise year week that is not currently defined in MA has been loaded, the segment will abort with this error.
History provided for weeks >= … - deleting...
The client can only provide history for weeks up to the week prior to the live week (specified by post parameter 308). If the history of any merchandise year week >= live week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the history from the import code table into the import ID table.
Duplicates found in import ID table (different upcs may have been provided for same sku) - summarizing...
If the segment parameter AllowMultiUpcSku is set to 1 and multiple UPCs have been provided for the same SKU/location/week, the segment summarizes them and continues.
Duplicates found in import ID table (different upcs may have been provided for same sku) - deleting…
If the segment parameter AllowMultiUpcSku is set to 0 and multiple UPCs have been provided for the same SKU/location/week, the segment deletes them and continues.
Invalid upc numbers were provided…
If the number of invalid UPCs rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid UPCs will be logged to the error file.
Too many bad upc numbers to log…
If the number of invalid UPCs rejected and left in the code table exceeds than the value of segment parameter MaxErrorDetailsToPrint this message will be logged to the error file.
Invalid locations numbers were provided…
If the number of invalid locations rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint this message and the invalid locations will be logged to the error file.
Too many bad location codes to log…
If the number of invalid locations rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint this message will be logged to the error file.
Error Reason
318 Segment Reference
Segment 16022 - Text File To MA - History Import, Upd Imp Sku OH Hist
This segment loads on hand history from input text files found in the location specified by the segment parameter “path”, imports the on hand history into the import code table, converts the entity codes of the on hand history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11022 MA Internal – History Import, Update Live Sku Oh Hist.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
AllowMultiUpcSku Allow Multi UPC SKU
Indicates if history of multiple UPCs for the same SKU/location/week/inventory status is allowed. This parameter must be set to 0 (False) or 1 (True).
No 0
BatchSizeForImpCdHisttable
Batch Size For Import Code History table
Specifies the number of rows inserted into the Import Code History table in each batch.
No 1000
BatchSizeForImpIdHisttable
Batch Size For Import ID History table
Specifies the number of rows retrieved from the Import Code History table and inserted into the Import ID History table in each batch.
No 300
ExtentSizeForImpCdHisttable
Extent Size For Import Code History table
Specifies the extent size used to rebuild the index on the Import Code History table. Only applicable for Oracle.
No 5
ExtentSizeForImpIdHisttable
Extent Size For Import ID History table
Specifies the extent size used to rebuild the index on the Import ID History table. Only applicable for Oracle.
No 5
FieldsExpectedPerHistRecord
Fields Expected Per History Record
Specifies the number of tab delimited fields expected in each record of the import text file.
No 12
MaxErrorDetailsToPrint
Max Error Details To Print
Specifies the maximum number of reported errors that can be printed in the error file.
No 100
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\Text File To MA - History Import, Update Imp Sku Oh Hist
SegmentIdentifier Segment Identifier Specifies the level of history loaded, in this case SKU.
No Sku
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History.
No HistOh
Segment 16022 - Text File To MA - History Import, Upd Imp Sku OH Hist 319
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks the parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description This segment loads on hand history from input text files found in the location specified
by the segment parameter “path”, imports the on hand history into the import code table, converts the entity codes of the on hand history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
After this segment successfully loads the on hand history into the import ID table, segment 11022 will load on hand history from the import ID table into the live on hand history table.
Troubleshooting Log file:
File name: STSMVSkuHistOh.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp) found in the directory defined by segment parameter "Path"
Shows the progress of loading on hand history from the input text file into the import code table.
Shows the progress of loading on hand history from the import code table into the import ID table.
Shows the totals of the on hand history loaded into the import ID tables. Error file:
File name: STSMVSkuHistOh.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors. The error log is located in the directory defined in the segment parameter "Path".
Possible errors:
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Error Reason
Import code table has contents, skipping to PreBuildImpIdHistOhTbl task.
This indicates that some rejected history was left in the import code table the last time the segment ran. When the segment detects this history in the code table it will jump to the step that posts history from code table to ID table instead of trying to first load history from the text file into the code table.
Aborted – record in textfile…does not contain the correct number of fields…
The segment fails and this error message displays if the number of fields in the records of the input file doesn’t match the segment parameter FieldsExpectedPerHistRecord.
Aborted processing of … textfile, number of acceptable errors exceeded.
Segment parameter MaxErrorDetailsToPrint specifies the maximum number of reported errors that can be printed in the error file for each Import History file. If the number of errors on an import file exceeds this number, the errors won’t be printed to the error file and this error message will be logged.
Aborted - no input files found to process. If no on hand history exists in the import code table and no input file is found, the segment will abort with this error.
320 Segment Reference
Aborted - errors encountered inserting from input file(s) to import code table.
If any error occurs while inserting data from the text file to the import code table, the segment will abort with this error.
Aborted - history has been provided for calendar weeks that do not exist in the calendar table.
If the on hand history of any merchandise year week that is not currently defined in MA has been loaded, the segment will abort with this error.
History provided for weeks >= … - deleting...
If Beginning Inventory On Hand has not been posted (specified by posted parameter 309), the client can only provide on hand history for weeks up to and including the week prior to the live week (specified by post parameter 308); if Beginning Inventory On Hand has been posted, the client can only provide on hand history for weeks up to, but not including, the week prior to the live week (specified by post parameter 308). If on hand history of any merchandise year week that is greater than or equal to (>=) the cutoff week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location/inventory status/price status that are already on file – deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the on hand history from the import code table into the import ID table.
Duplicates found in import ID table (different upcs may have been provided for same sku) - summarizing...
If the segment parameter AllowMultiUpcSku is set to 1 and multiple UPCs have been provided for the same SKU/location/week, the segment summarizes them and continues.
Duplicates found in import ID table (different upcs may have been provided for same sku) - deleting…
If the segment parameter AllowMultiUpcSku is set to 0 and multiple UPCs have been provided for the same SKU/location/week, the segment deletes them and continues.
Invalid upc numbers were provided… If the number of invalid UPCs rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid UPCs will be logged to the error file.
Too many bad upc numbers to log… If the number of invalid UPCs rejected and left in the code table exceeds than the value of segment parameter MaxErrorDetailsToPrint this message will be logged to the error file.
Invalid locations numbers were provided… If the number of invalid locations rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint this message and the invalid locations will be logged to the error file.
Too many bad location codes to log… If the number of invalid locations rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint this message will be logged to the error file.
Invalid inventory status were provided… If the number of invalid inventory statuses rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid inventory statuses will be logged to the error file.
Too many bad inventory status to log.…” If the number of invalid inventory statuses rejected and left in the code exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Invalid price status were provided… If the number of invalid price statuses rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid price statuses will be logged to the error file.
Too many bad price status to log… If the number of invalid price statuses rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Error Reason
Segment 16023 - Text File To MA - History Import, Upd Imp Color Hist 321
Segment 16023 - Text File To MA - History Import, Upd Imp Color Hist
This segment loads history from input text files found in the location specified by the segment parameter “path”, imports the history into the import code table, converts the entity codes of the history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11023 MA Internal – History Import, Update Live Color Hist.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForImpCdHistTable
Batch Size For Import Code History table
Specifies the number of rows inserted into the Import Code History table in each batch.
No 1000
BatchSizeForImpIdHistTable
Batch Size For Import ID History table
Specifies the number of rows retrieved from the Import Code History table and inserted into the Import ID History table in each batch.
No 150
ExtentSizeForImpCdHistTable
Extent Size For Import Code History table
Specifies the extent size used to rebuild the index on the Import Code History table. Only applicable for Oracle.
No 5
ExtentSizeForImpIdHistTable
Extent Size For Import ID History table
Specifies the extent size used to rebuild the index on the Import ID History table. Only applicable for Oracle.
No 5
FieldsExpectedPerHistRecord
Fields Expected Per History Record
Specifies the number of tab delimited fields expected in each record of the import text file.
No 39
MaxErrorDetailsToPrint
Max Error Details To Print
Specifies the maximum number of reported errors that can be printed in the error file.
No 100
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\Text File To MA - History Import, Update Imp Color Hist
SegmentIdentifier Segment Identifier Specifies the level of history loaded, in this case StyleColor.
No StyleColor
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History.
No Hist
defaultCurrencyProvided
Default Currency Provided
Determines whether the import file contains data in the Home currency, Local currency. or both currencies.
Yes Home
322 Segment Reference
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description This segment loads history from input text files found in the location specified by the
segment parameter “path”, imports the history into the import code table, converts the entity codes of the history data into entity ids defined in the MA system and imports the data with entity ids into the import ID table.
After this segment successfully loads the history into the import ID table, segment 11023 loads history from the import ID table into the live history table.
Troubleshooting Log file:
File name: STSMVStyleColorHist.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp) found in the directory defined by segment parameter "Path"
Shows the progress of loading history from the input text file into the import code table.
Shows the progress of loading history from the import code table into the import ID table.
Shows the totals of the history loaded into the import ID tables. Error file:
File name: STSMVStyleColorHist.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors. The error log is written to the directory defined by the segment parameter "Path".
Possible errors:
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Error Reason
Import code table has contents, skipping to PreBuildImpIdHistTbl task.
This indicates that some rejected history was left in the import code table the last time the segment ran. When the segment detects this history in the code table it will jump to the step that posts history from code table to ID table instead of trying to first load history from the text file into the code table.
Aborted – record in textfile…does not contain the correct number of fields…
The segment fails and this error message displays if the number of fields in the records of the input file doesn’t match the segment parameter FieldsExpectedPerHistRecord.
Aborted processing of … textfile, number of acceptable errors exceeded.
Segment parameter MaxErrorDetailsToPrint specifies the maximum number of reported errors that can be printed in the error file for each Import History file. If the number of errors on an import file exceeds this number, the errors won’t be printed to the error file and this error message will be logged.
Segment 16023 - Text File To MA - History Import, Upd Imp Color Hist 323
Aborted - no input files found to process. If no history exists in the import code table and no input file is found, the segment will abort with this error.
Aborted - errors encountered inserting from input file(s) to import code table.
If any error occurs while inserting data from the text file to the import code table, the segment will abort with this error.
Aborted - history has been provided for calendar weeks that do not exist in the calendar table.
If the history of any merchandise year week that is not currently defined in MA has been loaded, the segment will abort with this error.
History provided for weeks >= … - deleting...
The client can only provide history for weeks up to the week prior to the live week (specified by post parameter 308). If the history of any merchandise year week >= live week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the history from the import code table into the import ID table.
Invalid style codes were provided… If the number of invalid style codes rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid locations will be logged to the error file.
Too many bad style codes to log… If the number of invalid style codes rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Invalid color codes were provided … If the number of invalid colors rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid locations will be logged to the error file.
Too many bad color codes to log… If the number of invalid colors rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Invalid locations numbers were provided… If the number of invalid locations rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid locations will be logged to the error file.
Too many bad location codes to log… If the number of invalid locations rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Error Reason
324 Segment Reference
Segment 16024 - Text File To MA - History Import, Upd Imp Color OH Hist
This segment loads on hand history from input text files found in the location specified by the segment parameter “path”, imports the on hand history into the import code table, converts the entity codes of the on hand history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForImpCdHisttable
Batch Size For Import Code History table
Specifies the number of rows inserted into the Import Code History table in each batch.
No 1000
BatchSizeForImpIdHisttable
Batch Size For Import ID History table
Specifies the number of rows retrieved from the Import Code History table and inserted into the Import ID History table in each batch.
No 300
ExtentSizeForImpCdHisttable
Extent Size For Import Code History table
Specifies the extent size used to rebuild the index on the Import Code History table. Only applicable for Oracle.
No 5
ExtentSizeForImpIdHisttable
Extent Size For Import ID History table
Specifies the extent size used to rebuild the index on the Import ID History table. Only applicable for Oracle.
No 5
FieldsExpectedPerHistRecord
Fields Expected Per History Record
Specifies the number of tab delimited fields expected in each record of the import text file.
No 8
MaxErrorDetailsToPrint
Max Error Details To Print
Specifies the maximum number of reported errors that can be printed in the error file.
No 100
SegmentIdentifier Segment Identifier Specifies the level of history loaded, in this case StyleColor.
No StyleColor
WorkflowIdentifier Workflow Identifier Specifies whether the segment is loading History or On Hand History.
No HistOh
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\Text File To MA - History Import, Update Imp Color Oh Hist
defaultCurrencyProvided
Default Currency Provided
Determines whether the import file contains data in the Home currency, Local currency. or both currencies.
Yes Home
Segment 16024 - Text File To MA - History Import, Upd Imp Color OH Hist 325
Scheduling RequirementsThis segment should be executed prior to segment 11024 MA Internal – History Import, Update Live Color Oh Hist.
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description This segment loads on hand history from input text files found in the location specified
by the segment parameter “path”, imports the on hand history into the import code table, converts the entity codes of the on hand history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
After this segment successfully loads the on hand history into the import ID table, segment 11024 loads on hand history from the import ID table into the live on hand history table.
Troubleshooting Log file:
File name: STSMVStyleColorHistOh.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp) found in the directory defined by segment parameter "Path"
Shows the progress of loading on hand history from the input text file into the import code table.
Shows the progress of loading on hand history from the import code table into the import ID table.
Shows the totals of the on hand history loaded into the import ID tables. Error file:
File name: STSMVStyleColorHistOh.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors. The error log is written to the directory defined in segment parameter "Path".
Possible errors:
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Error Reason
Import code table has contents, skipping to PreBuildImpIdHistOhTbl task.
This indicates that some rejected history was left in the import code table the last time the segment ran. When the segment detects this history in the code table it will jump to the step that posts history from code table to ID table instead of trying to first load history from the text file into the code table.
326 Segment Reference
Aborted – record in textfile…does not contain the correct number of fields…
The segment fails and this error message displays if the number of fields in the records of the input file doesn’t match the segment parameter FieldsExpectedPerHistRecord.
Aborted processing of … textfile, number of acceptable errors exceeded.
Segment parameter MaxErrorDetailsToPrint specifies the maximum number of reported errors that can be printed in the error file for each Import History file. If the number of errors on an import file exceeds this number, the errors won’t be printed to the error file and this error message will be logged.
Aborted - no input files found to process. If no on hand history exists in the import code table and no input file is found, the segment will abort with this error.
Aborted - errors encountered inserting from input file(s) to import code table.
If any error occurs while inserting data from the text file to the import code table, the segment will abort with this error.
Aborted - history has been provided for calendar weeks that do not exist in the calendar table.
If the history of any merchandise year week that is not currently defined in MA has been loaded, the segment will abort with this error.
History provided for weeks >= … - deleting...
If Beginning Inventory On Hand has not been posted (specified by posted parameter 309), the client can only provide on hand history for weeks up to and including the week prior to the live week (specified by post parameter 308); if Beginning Inventory On Hand has been posted, the client can only provide on hand history for weeks up to, but not including, the week prior to the live week (specified by post parameter 308). If on hand history of any merchandise year week that is greater than or equal to (>=) the cutoff week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location/inventory status/price status that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the on hand history from the import code table into the import ID table.
Invalid style codes were provided… If the number of invalid style codes rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint this message and the invalid style codes will be logged to the error file.
Too many bad style codes to log… If the number of invalid style codes rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Invalid color codes were provided … If the number of invalid colors rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint this message and the invalid color codes will be logged to the error file.
Too many bad color codes to log… If the number of invalid colors rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint this message will be logged to the error file.
Invalid locations numbers were provided… If the number of invalid locations rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint this message and the invalid locations will be logged to the error file.
Too many bad location codes to log… If the number of invalid locations rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint this message will be logged to the error file.
Invalid inventory status were provided… If the number of invalid inventory statuses rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid inventory statuses will be logged to the error file.
Error Reason
Segment 16024 - Text File To MA - History Import, Upd Imp Color OH Hist 327
Too many bad inventory status to log… If the number of invalid inventory statuses rejected and left in the code exceeds the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid invalid inventory statuses will be logged to the error file.
Invalid price status were provided… If the number of invalid price statuses rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid price statuses will be logged to the error file.
Too many bad price status to log… If the number of invalid price statuses rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid price statuses will be logged to the error file.
Error Reason
328 Segment Reference
Segment 16025 - Text File To MA - History Import, Upd Imp Style Hist
This segment loads history from input text files found in the location specified by the segment parameter “path”, imports the history into the import code table, converts the entity codes of the history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11025 MA Internal – History Import, Update Live Style Hist.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForImpCdHisttable
Batch Size For Import Code History table
Specifies the number of rows inserted into the Import Code History table in each batch.
No 1000
BatchSizeForImpIdHisttable
Batch Size For Import ID History table
Specifies the number of rows retrieved from the Import Code History table and inserted into the Import ID History table in each batch.
No 150
ExtentSizeForImpCdHisttable
Extent Size For Import Code History table
Specifies the extent size used to rebuild the index on the Import Code History table. Only applicable for Oracle.
No 5
ExtentSizeForImpIdHisttable
Extent Size For Import ID History table
Specifies the extent size used to rebuild the index on the Import ID History table. Only applicable for Oracle.
No 5
FieldsExpectedPerHistRecord
Fields Expected Per History Record
Specifies the number of tab delimited fields expected in each record of the import text file.
No 47
MaxErrorDetailsToPrint
Max Error Details To Print
Specifies the maximum number of reported errors that can be printed in the error file.
No 100
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\Text File To MA - History Import, Update Imp Style Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case Style.
No Style
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No Hist
defaultCurrencyProvided
Default Currency Provided
Determines whether the import file contains data in the Home currency, Local currency. or both currencies.
Yes Home
Segment 16025 - Text File To MA - History Import, Upd Imp Style Hist 329
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description This segment loads history from input text files found in the location specified by the
segment parameter “path”, imports the history into the import code table, converts the entity codes of the history data into entity ids defined in the MA system and imports the data with entity ids into the import ID table.
After this segment successfully loads the history into the import ID table, segment 11025 loads history from the import ID table into the live history table.
Troubleshooting Log file:
File name: STSMVStyleHist.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp) found in the directory defined by segment parameter "Path"
Shows the progress of loading history from the input text file into the import code table.
Shows the progress of loading history from the import code table into the import ID table.
Shows the totals of the history loaded into the import ID tables. Error file:
File name: STSMVStyleHist.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors. The error log is located in the directory defined by the segment parameter "Path".
Possible errors:
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Error Reason
Import code table has contents, skipping to PreBuildImpIdHistTbl task.
This indicates that some rejected history was left in the import code table the last time the segment ran. When the segment detects this history in the code table it will jump to the step that posts history from code table to ID table instead of trying to first load history from the text file into the code table.
Aborted – record in textfile…does not contain the correct number of fields…
The segment fails and this error message displays if the number of fields in the records of the input file doesn’t match the segment parameter FieldsExpectedPerHistRecord.
Aborted processing of…textfile, number of acceptable errors exceeded.
Segment parameter MaxErrorDetailsToPrint specifies the maximum number of reported errors that can be printed in the error file for each Import History file. If the number of errors on an import file exceeds this number, the errors won’t be printed to the error file and this error message will be logged.
330 Segment Reference
Aborted - no input files found to process. If no on hand history exists in the import code table and no input file is found, the segment will abort with this error.
Aborted - errors encountered inserting from input file(s) to import code table.
If any errors occur while inserting data from text file to import code table, the segment will abort with this error.
Aborted - history has been provided for calendar weeks that do not exist in the calendar table.
If on hand history of any merchandise year week that is not currently defined in MA has been loaded, the segment will abort with this error.
History provided for weeks >= … - deleting.…
The client can only provide history for weeks up to the week prior to the live week (specified by post parameter 308). If the history of any merchandise year week >= live week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location that are already on file - deleting.…
The segment deletes any duplicate history that already exists in the import ID table before inserting the on hand history from the import code table into the import ID table.
Invalid style codes were provided… If the number of invalid style codes rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint this message and the invalid style codes will be logged to the error file.
Too many bad style codes to log… If the number of invalid style codes rejected and left in the code table exceeds the value of parameter MaxErrorDetailsToPrint this message will be logged to the error file.
Invalid location codes were provided… If the number of invalid locations rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint this message and the invalid locations will be logged to the error file.
Too many bad location codes to log… If the number of invalid locations rejected and left in the code table exceeds the value of parameter MaxErrorDetailsToPrint this message will be logged to the error file.
Error Reason
Segment 16026 - Text File To MA - History Import, Upd Imp Style OH Hist 331
Segment 16026 - Text File To MA - History Import, Upd Imp Style OH Hist
This segment loads on hand history from the input text files found in the location specified by the segment parameter “path”, imports the on hand history into the import code table, converts the entity codes of the on hand history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11026 MA Internal – History Import, Update Live Style Oh Hist.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForImpCdHisttable
Batch Size For Import Code History table
Specifies the number of rows inserted into the Import Code History table in each batch.
No 1000
BatchSizeForImpIdHisttable
Batch Size For Import ID History table
Specifies the number of rows retrieved from the Import Code History table and inserted into the Import ID History table in each batch.
No 350
ExtentSizeForImpCdHisttable
Extent Size For Import Code History table
Specifies the extent size used to rebuild the index on the Import Code History table. Only applicable for Oracle.
No 5
ExtentSizeForImpIdHisttable
Extent Size For Import ID History table
Specifies the extent size used to rebuild the index on the Import ID History table. Only applicable for Oracle.
No 5
FieldsExpectedPerHistRecord
Fields Expected Per History Record
Specifies the number of tab delimited fields expected in each record of the import text file.
No 8
MaxErrorDetailsToPrint
Max Error Details To Print
Specifies the maximum number of reported errors that can be printed in the error file.
No 100
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\Text File To MA - History Import, Update Imp Style Oh Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case Style.
No Style
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No HistOh
defaultCurrencyProvided
Default Currency Provided
Determines whether the import file contains data in the Home currency, Local currency. or both currencies.
Yes Home
332 Segment Reference
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description This segment loads on hand history from the input text files found in the location
specified by the segment parameter “path”, imports the on hand history into the import code table, converts the entity codes of the on hand history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
After this segment successfully loads the on hand history into the import ID table, segment 11026 loads on hand history from the import ID table into the live on hand history table.
Troubleshooting Log file:
File name: STSMVStyleHistOh.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp) found in the directory defined by segment parameter "Path"
Shows the progress of loading the on hand history from the input text file into the import code table.
Shows the progress of loading the on hand history from the import code table into import ID table.
Shows the totals of the on hand history loaded into the import ID tables. Error file:
File name: STSMVStyleHistOh.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp) found in the directory defined by the segment parameter "Path".
This file is only generated when the segment encounters unexpected errors. Possible errors:
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Error Reason
Import code table has contents, skipping to PreBuildImpIdHistOhTbl task.
This indicates that some rejected on hand history was left in the import code table the last time the segment ran. When the segment detects this on hand history in the code table it will jump to the step that posts on hand history from the code table to the ID table instead of trying to first load history from the text file into the code table.
Aborted – record in textfile…does not contain the correct number of fields….
The segment fails and this error message displays if the number of fields in the records of the input file doesn’t match the segment parameter FieldsExpectedPerHistRecord.
Aborted processing of … textfile, number of acceptable errors exceeded.
Segment parameter MaxErrorDetailsToPrint specifies the maximum number of reported errors that can be printed in the error file for each Import History file. If the number of errors on an import file exceeds this number, the errors won’t be printed to the error file and this error message will be logged.
Segment 16026 - Text File To MA - History Import, Upd Imp Style OH Hist 333
Aborted - no input files found to process. If no on hand history exists in the import code table and no input file is found, the segment will abort with this error.
Aborted - errors encountered inserting from input file(s) to import code table.
If any errors occur while inserting data from text file to import code table, the segment will abort with this error.
Aborted - history has been provided for calendar weeks that do not exist in the calendar table.
If on hand history of any merchandise year week that is not currently defined in MA has been loaded, the segment will abort with this error.
History provided for weeks >= … - deleting.…
If Beginning Inventory On Hand has not been posted (specified by posted parameter 309), the client can only provide on hand history for weeks up to and including the week prior to the live week (specified by post parameter 308); if Beginning Inventory On Hand has been posted, the client can only provide on hand history for
weeks up to, but not including, the week prior to the live week (specified by post parameter 308). If on hand history of any merchandise year week that is greater than or equal to (>=) the cutoff week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location/inventory status/price status that are already on file - deleting.…
The segment deletes any duplicate history that already exists in the import ID table before inserting the on hand history from the import code table into the import ID table.
Invalid style codes were provided .…. If the number of invalid style codes rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid style codes will be logged to the error file.
Too many bad style codes to log.… If the number of invalid style codes rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Invalid locations numbers were provided… If the number of invalid locations rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid locations will be logged to the error file.
Too many bad location codes to log.… If the number of invalid locations rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Invalid inventory status were provided.…. If the number of invalid inventory statuses rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid inventory statuses will be logged to the error file.
Too many bad inventory status to log.… If the number of invalid inventory statuses rejected and left in the code exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Invalid price status were provided.… If the number of invalid price statuses rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid price statuses will be logged to the error file.
Too many bad price status to log... If the number of invalid price statuses rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Error Reason
334 Segment Reference
Segment 16027 - Text File To MA - History Import, Upd Imp Group Hist
This segment loads history from input text files found in the location specified by the segment parameter “path”, imports the history into the import code table, converts the entity codes of the history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11027 MA Internal – History Import, Update Live Group Hist.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForImpCdHisttable
Batch Size For Import Code History table
Specifies the number of rows inserted into the Import Code History table in each batch.
No 1000
BatchSizeForImpIdHisttable
Batch Size For Import ID History table
Specifies the number of rows retrieved from the Import Code History table and inserted into the Import ID History table in each batch.
No 150
ExtentSizeForImpCdHisttable
Extent Size For Import Code History table
Specifies the extent size used to rebuild the index on the Import Code History table. Only applicable for Oracle.
No 5
ExtentSizeForImpIdHisttable
Extent Size For Import ID History table
Specifies the extent size used to rebuild the index on the Import ID History table. Only applicable for Oracle.
No 5
FieldsExpectedPerHistRecord
Fields Expected Per History Record
Specifies the number of tab delimited fields expected in each record of the import text file.
No 50
MaxErrorDetailsToPrint
Max Error Details To Print
Specifies the maximum number of reported errors that can be printed in the error file.
No 100
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\Text File To MA - History Import, Update Imp Group Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case MerchGroup.
No MerchGroup
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No Hist
defaultCurrencyProvided
Default Currency Provided
Determines whether the import file contains data in the Home currency, Local currency. or both currencies.
Yes Home
Segment 16027 - Text File To MA - History Import, Upd Imp Group Hist 335
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description This segment loads history from input text files found in the location specified by the
segment parameter “path”, imports the history into the import code table, converts the entity codes of the history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
After this segment successfully loads the history into the import ID table, segment 11027 will load history from the import ID table into the live history table.
Troubleshooting Log file:
File name: STSMVMerchGroupHist.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading history from the input text file into the import code table.
Shows the progress of loading history from the import code table into the import ID table.
Shows the totals of the history loaded into the import ID tables. Error file:
File name: STSMVMerchGroupHist.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors. Possible errors:
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Error Reason
Import code table has contents, skipping to PreBuildImpIdHistTbl task.
This indicates that some rejected history was left in the import code table the last time the segment ran. When the segment detects this history in the code table it will jump to the step that posts history from the code table to the ID table instead of trying to first load history from the text file into the code table.
Aborted – record in textfile…does not contain the correct number of fields…
The segment fails and this error message displays if the number of fields in the records of the input file doesn’t match the segment parameter FieldsExpectedPerHistRecord.
Aborted processing of…textfile, number of acceptable errors exceeded.
Segment parameter MaxErrorDetailsToPrint specifies the maximum number of reported errors that can be printed in the error file for each Import History file. If the number of errors on an import file exceeds this number, the errors won’t be printed to the error file and this error message will be logged.
Aborted - no input files found to process.
If no on hand history exists in the import code table and no input file is found, the segment will abort with this error.
336 Segment Reference
Aborted - errors encountered inserting from input file(s) to import code table.
If any errors occur while inserting data from text file to import code table, the segment will abort with this error.
Aborted - history has been provided for calendar weeks that do not exist in the calendar table.
If history of any merchandise year week that is not currently defined in MA has been loaded, the segment will abort with this error.
History provided for weeks >= … - deleting...
The client can only provide history for weeks up to the week prior to the live week (specified by post parameter 308). If the history of any merchandise year week >= live week is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the history from the import code table into the import ID table.
Invalid hierarchy group codes were provided…
If the number of invalid hierarchy group codes rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid hierarchy groups will be logged to the error file.
Too many bad hierarchy group codes to log…
If the number of invalid hierarchy group codes rejected and left in the code table exceeds the value of parameter MaxErrorDetailsToPrint this message will be logged to the error file.
Invalid location codes were provided… If the number of invalid location codes rejected and left in the code table is less than the value of parameter MaxErrorDetailsToPrint this message and the invalid locations will be logged to the error file.
Too many bad location codes to log… If the number of invalid locations rejected and left in the code table exceeds the value of parameter MaxErrorDetailsToPrint this message will be logged to the error file.
Error Reason
Segment 16028 - Text File To MA - History Import, Upd Imp Group OH Hist 337
Segment 16028 - Text File To MA - History Import, Upd Imp Group OH Hist
This segment loads on hand history from input text files found in the location specified by the segment parameter “path”, imports the on hand history into the import code table, convert the entity codes of the on hand history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11028 MA Internal – History Import, Update Live Group Oh Hist
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForImpCdHisttable
Batch Size For Import Code History table
Specifies the number of rows inserted into the Import Code History table in each batch.
No 1000
BatchSizeForImpIdHisttable
Batch Size For Import ID History table
Specifies the number of rows retrieved from the Import Code History table and inserted into the Import ID History table in each batch.
No 300
ExtentSizeForImpCdHisttable
Extent Size For Import Code History table
Specifies the extent size used to rebuild the index on the Import Code History table. Only applicable for Oracle.
No 5
ExtentSizeForImpIdHisttable
Extent Size For Import ID History table
Specifies the extent size used to rebuild the index on the Import ID History table. Only applicable for Oracle.
No 5
FieldsExpectedPerHistRecord
Fields Expected Per History Record
Specifies the number of tab delimited fields expected in each record of the import text file.
No 8
MaxErrorDetailsToPrint
Max Error Details To Print
Specifies the maximum number of reported errors that can be printed in the error file.
No 100
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\NSB Interface\Text File To MA - History Import, Update Imp Group Oh Hist
SegmentIdentifier Segment Identifier
Specifies the level of history loaded, in this case MerchGroup.
No MerchGroup
WorkflowIdentifier Workflow Identifier
Specifies whether the segment is loading History or On Hand History.
No HistOh
defaultCurrencyProvided
Default Currency Provided
Determines whether the import file contains data in the Home currency, Local currency. or both currencies.
Yes Home
338 Segment Reference
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the latest week posted by loading beginning inventory (segment 5005).
Non-queue Segment Description This segment loads on hand history from input text files found in the location specified
by the parameter “path”, imports the on hand history into the import code table, converts the entity codes of the on hand history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
After this segment successfully loads the on hand history into the import ID table, segment 11028 loads on hand history from the import ID table into the live on hand history table.
Troubleshooting Log file:
File name: STSMVMerchGroupHistOh.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading on hand history from the input text file into the import code table.
Shows the progress of loading on hand history from the import code table into the import ID table.
Shows the totals of the on hand history loaded into the import ID tables. Error file:
File name: STSMVMerchGroupHistOh.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors. Possible errors:
Parameter ID Parameter label Description
308 live merchandising_year_week Specifies the live week.
309 BInv on_hand has been posted Indicates whether Beginning Inventory On Hand has been posted.
Error Reason
Import code table has contents, skipping to PreBuildImpIdHistOhTbl task.
Indicates that some rejected history was left in the import code table the last time the segment ran. When the segment detects this history, it will jump to the step that posts history from the code table to the ID table instead of trying to first load history from the text file into the code table.
Aborted – record in textfile … does not contain the correct number of fields…
The segment fails and this error message displays if the number of fields in the records of the input file doesn’t match the segment parameter FieldsExpectedPerHistRecord.
Aborted processing of … textfile, number of acceptable errors exceeded.
Segment parameter MaxErrorDetailsToPrint specifies the maximum number of reported errors that can be printed in the error file for each Import History file. If the number of errors on an import file exceeds this number, the errors won’t be printed to the error file and this error message will be logged.
Aborted - no input files found to process.
If no on hand history exists in the import code table and no input file is found, the segment will abort with this error.
Segment 16028 - Text File To MA - History Import, Upd Imp Group OH Hist 339
Aborted - errors encountered inserting from input file(s) to import code table.
If any errors occur while inserting data from text file to import code table, the segment will abort with this error.
Aborted - history has been provided for calendar weeks that do not exist in the calendar table.
If on hand history of any merchandise year week that is not currently defined in MA has been loaded, the segment will abort with this error.
History provided for weeks >= … - deleting…
If Beginning Inventory On Hand has not been posted (specified by posted parameter 309), the client can only provide on hand history for weeks up to and including the week prior to the live week (specified by post parameter 308); if Beginning Inventory On Hand has been posted, the client can only provide on hand history for weeks up to, but not including, the week prior to the live week (specified by post parameter 308). If on hand history is provided for any merchandise year week that is later than or the same as (>=) the cutoff week, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/weeks/location/inventory status/price status that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the on hand history from the import code table into the import ID table.
Invalid hierarchy group codes were provided…
If the number of invalid hierarchy group codes rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid hierarchy groups will be logged to the error file.
Too many bad hierarchy group codes to log…
If the number of invalid hierarchy group codes rejected and left in the code table exceeds the value of parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Invalid location numbers were provided…
If the number of invalid location numbers rejected and left in the code table is less than the value of parameter MaxErrorDetailsToPrint, this message and the invalid locations will be logged to the error file.
Too many bad location codes to log… If the number of invalid locations rejected and left in the code table exceeds the value of segment MaxErrorDetailsToPrint, this message will be logged to the error file.
Invalid inventory status were provided… If the number of invalid inventory statuses rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid inventory statuses will be logged to the error file.
Too many bad inventory status to log… If the number of invalid inventory statuses rejected and left in the code exceeds the value of segment parameter MaxErrorDetailsToPrint, this will be logged to the error file.
Invalid price status were provided… If the number of invalid price statuses rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid price statuses will be logged to the error file.
Too many bad price status to log… If the number of invalid price statuses rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Error Reason
340 Segment Reference
Segment 16029 - Text File to MA - History Import, Upd Imp Grp RIM Oh
This segment loads RIM on hand history from input text files found in the location specified by the segment parameter “path”, imports the RIM on hand history into the import code table, convert the entity codes of the RIM on hand history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
Segment Parameters
Scheduling RequirementsThis segment should be executed prior to segment 11029 MA Internal - History Import, Update Live Group Rim Oh.
Parameter Name
Parameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
BatchSizeForImpCdRimOhTable
Batch Size For Import Code RIM On Hand Table
Specifies the number of rows inserted into the Import Code RIM On Hand table in each batch.
No 1000
BatchSizeForImpIdRimOhTable
Batch Size For Import ID RIM On Hand Table
Specifies the number of rows retrieved from the Import Code RIM On Hand table and inserted into the Import ID RIM On Hand table in each batch.
No 1000
ExtentSizeForImpCdRimOhTable
Extent Size For Import Code RIM On Hand table
Specifies the extent size used to rebuild the index on the Import Code RIM On Hand table. Only applicable for Oracle.
No 5
ExtentSizeForImpIdRimOhTable
Extent Size For Import ID RIM On Hand table
Specifies the extent size used to rebuild the index on the Import ID RIM On Hand table. Only applicable for Oracle.
No 5
FieldsExpectedPerRimOhRecord
Fields Expected Per History Record
Specifies the number of tab delimited fields expected in each record of the import text file.
No 5
MaxErrorDetailsToPrint
Max Error Details To Print
Specifies the maximum number of reported errors that can be printed in the error file.
No 100
Path Path Specifies the path where the input text file, the log file and the error file are located.
No C:\Nsb Interface\Text File to MA - History Import, Update Imp Group RIM Oh
defaultCurrencyProvided
Default Currency Provided
Determines whether the import file contains data in the Home currency, Local currency. or both currencies.
Yes Home
Segment 16029 - Text File to MA - History Import, Upd Imp Grp RIM Oh 341
Database ParametersMA keeps the posting parameters in the post_parameter table. This segment checks this parameter for the week when Merchandising goes live.
Queue Segment Description This segment loads RIM on hand history from input text files found in the location
specified by the segment parameter “path”, imports the RIM on hand history into the import code table, converts the entity codes of the RIM on hand history data into entity IDs defined in the MA system and imports the data with entity IDs into the import ID table.
After this segment successfully loads the RIM on hand history into the import ID table, segment 11029 loads RIM on hand history from the import ID table into the live RIM on hand history table.
Troubleshooting Log file:
File name: STSMVRimOh.YYYYMMDDHHMMSS.LOG (where YYYYMMDDHHMMSS is a time stamp)
Shows the progress of loading RIM on hand history from the input text file into the import code table.
Shows the progress of loading RIM on hand history from the import code table into the import ID table.
Shows the totals of the RIM on hand history loaded into the import ID tables. Error file:
File name: STSMVRimOh.YYYYMMDDHHMMSS.ERR (where YYYYMMDDHHMMSS is a time stamp)
This file is only generated when the segment encounters unexpected errors. Possible errors:
Parameter ID Parameter Label Description
308 live merchandising_year_week Specifies the live week.
Error Description
Aborted – record in textfile … does not contain the correct number of fields…
The segment fails and this error message displays if the number of fields in the records of the input file doesn’t match the segment parameter FieldsExpectedPerrimOhRecord.
Import code table has contents, skipping to PreBuildImpIdRimOhTbl task.
Indicates that some rejected history was left in the import code table the last time the segment ran. When the segment detects this history, it jumps to the step that posts history from the code table to the ID table instead of trying to first load history from the text file into the code table.
Aborted processing of … textfile, number of acceptable errors exceeded.
Segment parameter MaxErrorDetailsToPrint specifies the maximum number of reported errors that can be printed in the error file for each Import History file. If the number of errors on an import file exceeds this value the errors won’t be printed to the error file; this error message will be logged.
Aborted - no input files found to process. If no RIM on hand history exists in the import code table and no input file is found, the segment will abort with this error.
342 Segment Reference
Aborted - errors encountered inserting from input file(s) to import code table.
If any errors occur while inserting data from text file to import code table, the segment will abort with this error.
Aborted - history has been provided for calendar periods that do not exist in the calendar table.
If on hand history of any merchandise year period that is not currently defined in MA has been loaded, the segment will abort with this error.
History provided for periods >= … - deleting… The client can only provide RIM on hand history for periods up to the period prior to the live period. If RIM on hand history of any merchandise year period that is greater than or equal to the cutoff period is provided, it will be deleted from the import code table and it won’t be loaded into the MA system. The segment will continue after logging this error.
History has been provided for entity/periods/location that are already on file - deleting…
The segment deletes any duplicate history that already exists in the import ID table before inserting the RIM on hand history from the import code table into the import ID table.
Invalid hierarchy group codes were provided… If the number of invalid hierarchy group codes rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid hierarchy groups will be logged to the error file.
Too many bad hierarchy group codes to log… If the number of invalid hierarchy group codes rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message will be logged to the error file.
Invalid location numbers were provided… If the number of invalid location numbers rejected and left in the code table is less than the value of segment parameter MaxErrorDetailsToPrint, this message and the invalid locations will be logged to the error file.
Too many bad location codes to log… If the number of invalid locations rejected and left in the code table exceeds the value of segment parameter MaxErrorDetailsToPrint, this message is logged to the error file.
Error Description
Segment 16031 - Text File to IM Import tables - Import ASNs 343
Segment 16031 - Text File to IM Import tables - Import ASNsThis segment loads ASNs from input text files (see Mapping Document for this segment for file layout) found in the location specified by the segment parameter “path” and imports them into the Import ASN tables in IM.
Segment Parameters
Scheduling RequirementsThis segment should be run prior to segment 19000 IM Import tables to IM or segment 19010 IM Import Tables to IM - ASN Import.
Following the execution of this segment, the user has the option to run segment 19000 or 19010 to move the ASN data from the import tables into the ASN tables in IM. Refer to the segment descriptions for details.
Database ParametersNone.
Non-queue Segment Description This segment loads ASNs from input text files (see Mapping Document for this
segment for file layout) found in the location specified by the segment parameter “path” and imports them into the Import ASN tables in IM.
After this segment runs successfully segment 19000 or 19010 moves the ASN data from the import tables into the live EDM & PROD tables to create the ASNs in IM.
After the segment runs the input file is renamed from STSIMASN…GO to STSIMASN…BAK in the directory specified by segment parameter ‘Path’.
If any errors are found in the .GO file, a .ERR file and a .REP file (containing records to be reprocessed) are generated.
Troubleshooting Input file:
File name: STSIMASN.timestamp.GO If no input file is found, the segment will fail and the following error will be
displayed: “The task reported failure on execution.” Error file:
File name: STSIMASN.timestamp.ERR This file is only generated when the segment encounters unexpected errors.
Possible errors:
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Path Specifies the path where the input text file and the error file are located.
No C:\NSB Interface\Text File to IM Import tables - Import ASNs
Mod261 Mod261 Overrides the Selling Location code field for Dropship POs
No 0
344 Segment Reference
Error Reason
Invalid record type/action. The only valid record type/action is ‘H’eader/’A’dd and ‘D’etail/’A’dd
Invalid number of fields found in header record. A header record expects 16 fields.
Either vendor code or both vendor interchange ID qualifier and vendor interchange ID code must be provided.
Invalid expected receipt date. A date must be provided in MM/DD/YYYY format.
Weight must be a positive numeric value.
Unit weight code mandatory when weight provided and vice versa.
No. of containers must be a positive numeric value.
Container type code mandatory when no. of containers provided and vice versa.
Invalid ship date. A date must be provided in MM/DD/YYYY format.
Header must be followed by at least one detail.
Invalid number of fields found in detail record. A detail record is expecting 20 fields.
Blanket release no. must be numeric.
Either purchase order no. or both blanket purchase order no. and release no. must be provided.
Either UPC, style code or vendor style code must be provided.
Units shipped must be a positive numeric value.
Segment 16032 - Text File to EDM, PROD & POM Import Tbls - Import Pack 345
Segment 16032 - Text File to EDM, PROD & POM Import Tbls - Import Pack
This segment import packs and/or pack upcs from text file into Merchandising import tables (and then segment 17000 “EDM, PROD POM Import Tables to EDM, PROD & POM” imports them from import tables to merchandising live tables)
Segment Parameters
Scheduling RequirementsMust be scheduled before segment 17000 EDM, PROD & POM Import Tables to EDM, PROD & POM.
Database ParametersNA.
Non-Queue Segment Description The following 2 entities are imported by this interface:
pack pack upc
Troubleshooting
Segment Error LogThe following error messages can be logged to the error log by the segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Path Specifies the directory where the input file should be located
No C:\Nsb Interface\Text File to EDM, PROD & POM Import Tbls - Import Pack
Error Reason
Invalid record type/action The record type or action code isn’t set to a valid value as specified in the file layout
Invalid number of fields found in header record
The number of columns in the header record doesn’t match the number specified in the file layout
Vendor pack code must be provided Vendor pack code isn’t provided
Pack description must be provided Pack description isn’t provided
Pack status must be an integer between 1 and 4
Pack status isn’t an integer between 1 and 4
Pack type must be either 1 or 2 Pack type isn’t 1 or 2
Style code must be provided Style code isn’t provided
Vendor code must be provided Vendor code isn’t provided
Vendor UPC flag must be either "Y" or "N" Vendor UPC flag isn’t "Y" or "N"
Active flag must be either "Y" or "N" Active flag isn’t "Y" or "N"
346 Segment Reference
Header must be followed by at least one detail
A header record isn’t followed by any detail record
Invalid number of fields found in detail record
The number of columns in the detail record doesn’t match the number specified in the file layout
Sku quantity must be provided Sku quantity isn’t provided
Sku quantity must be a numeric value Sku quantity isn’t a numeric value
Invalid number of fields found in UPC record
The number of columns in the UPC record doesn’t match the number specified in the file layout
UPC number must be provided UPC number isn’t provided
UPC type must be "P" UPC type isn’t "P"
Activation date must be provided Activation date isn’t provided
Activation date must be a date in MM/DD/YYYY format
Activation date isn’t provided in MM/DD/YYYY format
Error Reason
Segment 16060 - Text File to PM Import - Import Price Changes 347
Segment 16060 - Text File to PM Import - Import Price Changes
This segment imports price change documents from text file into Merchandising import tables (and then segment 34000 “PM Import to PM” imports them from import tables to merchandising live tables)
Segment Parameters
Scheduling RequirementsMust be scheduled before segment 34000 PM Import to PM.
Database ParametersNA.
Non-Queue Segment Description The segment retrieves Price Change documents from the input files located in the
directory specified by the segment parameter “Path”, and place the data into the following import price change tables in Merchandising: imp_price_change imp_price_change_detail imp_price_change_loc imp_price_change_prc_grp imp_price_change_attrib imp_price_change_message import_pcm_repl_queue
Each Price Change input file can have multiple price change documents, where each Price Change document must begin with a Price Change header record, i.e. when the segment detects a new header record in the input file, it will assume that it has finished reading information of the previous Price Change document and starts to reads information of a new Price Change document.
Troubleshooting
Segment Error LogThe following new error messages can be logged to the error log by the segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Input File Directory
Specifies the directory where the input file should be located.
No C:\Nsb Interface\Text File to PM Import
Error Reason
Invalid record type/action The record type or action code isn’t set to a valid value as specified in the file layout.
Invalid number of fields found in header record
The number of columns in the header record doesn’t match the number specified in the file layout.
348 Segment Reference
Price change duration is mandatory No value has been provided for the field “price change duration” on a header record.
Location grouping is mandatory No value has been provided for the field “location grouping” on a header record.
Header must be followed by at least one pricing group record when location grouping = 2 (Pricing group list)
The location grouping of the price change document has been set to 2 (pricing group list), but no pricing group record has been provided for the price change document.
Header must be followed by at least one location record when location grouping = 1 (Location list)
The location grouping of the price change document has been set to 1 (location list), but no location record has been provided for the price change document.
Invalid location grouping. It must be 0, 1 or 2
A value other than 0 (chain / jurisdiction), 1 (location list) and 2 (pricing group list) has been provided for the field “location grouping” on a header record.
Category code is mandatory No value has been provided for the field “category code” on a header record.
Buyer(employee position) code is mandatory
No value has been provided for the field “employee position” on a header record.
Effective from date is mandatory No value has been provided for the field “effective from date” on a header record.
Invalid effective from date The value provided for the field “effective from date” isn’t in the MM/DD/YYYY format.
Invalid effective to date The value provided for the field “effective to date” isn’t in the MM/DD/YYYY format.
Invalid issue date The value provided for the field “issue date” isn’t in the MM/DD/YYYY format.
The calculation method is mandatory on header
No value has been provided for the field “calculation method” on a header record.
Invalid Base-Calculation-On. It must be 0, 1, 2 or 3
A value other than 0 (original retail), 1 (current retail), 2 (compare at retail) and 3 (last net PO cost) has been provided for the field “base calculation on” on a header or detail record.
Generate tickets is mandatory No value has been provided for the field “generate tickets” on a header record.
Attribute code is mandatory No value has been provided for the field “attribute code” on an attribute record.
Calculation value must be a valid numeric value
An alphanumeric value has been provided for the field “calculation value” on a header or detail record.
Invalid price change duration. It must be 0 or 1
A value other than 0 (permanent) and 1 (promotional) has been provided for the field “price change duration” on a header record.
New price must be a valid numeric value
An alphanumeric value has been provided for the field “new price” on a header or detail record.
Invalid calculation method. It must be 0, 1 or 2
A value other than 0 (percent change), 1 (amount change) and 2 (new price) has been provided on a header or detail record.
Style code must be provided No value has been provided for the field “style code” on a detail record.
Header must be followed by at least one detail style level record
A header record isn’t followed by any detail record.
Invalid number of fields found in detail record
The number of columns in the detail record doesn’t match the number specified in the file layout.
Invalid number of fields found in message record
The number of columns in the message record doesn’t match the number specified in the file layout.
Error Reason
Segment 16060 - Text File to PM Import - Import Price Changes 349
Invalid number of fields found in attribute record
The number of columns in the attribute record doesn’t match the number specified in the file layout.
Invalid number of fields found in pricing group record
The number of columns in the pricing group record doesn’t match the number specified in the file layout.
Invalid number of fields found in location record
The number of columns in the location record doesn’t match the number specified in the file layout.
Message type description is mandatory
No value has been provided for the field “message type description” on a message record.
Message is mandatory No value has been provided for the field “message” on a message record.
Attribute set code is mandatory No value has been provided for the field “attribute set code” on an attribute record.
Location code is mandatory No value has been provided for the field “location code” on a location record.
Pricing group code is mandatory No value has been provided for the field “pricing group code” on a pricing group record.
Error Reason
350 Segment Reference
Segment 17000 - EDM, PROD & POM Import tables to EDM, PROD & POM
This segment loads master entities from import tables into the EDM, PROD and POM live tables.
Note: Sourcing writes directly to the POM import tables.
Segment Parameters
Note: If Startup parameters are set to T(rue), fields that are not modifiable through the GUI can be changed. For example, normally the current selling retail of an ordered style can't be modified manually (a price change has to be made), but if the parameter StartupStyle is turned on, then the pipeline segment can update the current selling retail on the ordered style directly. This would normally be done only at startup.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Mod52 Mod 52 Custom Mod “Build in-house upc from 6 digit sku for Life uniforms”. The parameter must be set to 0 (false) or 1 (true).
No 0
Mod64 Mod 64 Custom Mod “Sony - Style Reclassification”. The parameter must be set to 0 (false) or 1 (true).
No 0
Mod136 Mod136 Custom Mod, Carters. Add .nb and .inf suffixes to Styles on Import. Set to 1 for Carter's, to 0 for all others.
No 0
MomentisFlag Momentis Flag Indicates whether the EDM & PROD import entities are coming from Sourcing (Momentis). Must be set to F (false) or T (true).
No F
MomentisVersion Momentis Version The version of Sourcing. No
StartupEmployee Startup Employee Indicates whether the segment is doing its initial run to import employees (parameter is set to T) or its ongoing run (the parameter is set to F).
No
StartupLocation Startup Location Indicates if the segment is doing its initial run to import locations (parameter is set to T) or its ongoing run (the parameter is set to F).
No
StartupStyle Startup Style Indicates if the segment is doing its initial run to import styles (parameter is set to T) or its ongoing run (the parameter is set to F).
No
Segment 17000 - EDM, PROD & POM Import tables to EDM, PROD & POM 351
StartupVendor Startup Vendor Indicates if the segment is doing its initial run to import vendors (parameter is set to T) or its ongoing run (the parameter is set to F).
No
ValidateVendorUPCCheckDigit
Validate Vendor UPC Check Digit
Indicates whether the UPC check digit should be validated when loading a vendor UPC. The parameter must be set to F (false) or T (true).
No T
OwnedByMerch Style Columns Maintained By Merchandising
Lists the style fields, separated by commas, whose Sourcing modifications should not be sent to Merchandising; can contain any of the following six fields: FashionFlag, ConsignmentFlag, DistributionMultiple, OrderMultiple, EmployeePosition, ReplenishFlag. Any of these fields that is not included in the values for this parameter is maintained in Sourcing and the Sourcing change will flow to Merchandising.For style creates, Merchandising will set the values for these fields to the values sent from Sourcing.
No (Blank)
Mod219 Mod219 Custom modification. Only installed when specifically required. Allows Style Retail price changes made in Sourcing to update Merch.
No 0
Mod224 Mod224 Allow distribution_multiple to be modified from Sourcing
No 0
PCMCategoryCodeMU
PCM Category Code for MU
The price change category code used to create a price change for a Markup or Markdown Cancellation from Sourcing. This parameter is only used when MomentisFlag is set to T.
No blank
PCMCategoryCodeMD
PCM Category Code for MD
The price change category code used to create a price change for a Markdown or Markup Cancellation from Sourcing. This parameter is only used when MomentisFlag is set to T.
No blank
PCMDescription PCM Description The price change description used to create a price change when retail price on an ordered style coming from Sourcing has been changed. This parameter is only used when MomentisFlag is set to T.
No Momentis Modified
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
352 Segment Reference
Scheduling RequirementsThis segment is run after segment 16001 (i.e. this segment only works if the master data has already been loaded in the import tables). However, if Sourcing is installed, segment 16001 should not be run.
For integration with Merchandising, it is important that Sourcing jobs be run regularly throughout the day.
Database ParametersNone.
Queue Segment Description The segment requires the following Pipeline dll to be installed:
STSPLEDMPRODPOMImp.dll The segment requires the following Pipeline dlls to be installed:
Nsb.Pipeline.System.Interop.dll. (this segment uses NsbSystem.Security.dll) Nsb.Pipeline.EDMPRODPOMImport.Interop.dll (this segment uses
Nsb.Purchasing.Controller.Interfaces.dll) The segment requires the following Merchandising dlls to be installed:
STSFCClient.dll STSFCServer.dll STSMEHierarchyRemote.dll STSMEEmployeeRemote.dll STSMELocationRemote.dll STSMEMerchRemote.dll STSMEVendorRemote.dll
PCMDocumentType PCM Document Type
The price change document type used to create a price change when retail price on an ordered style coming from Sourcing has been changed. This parameter is only used when MomentisFlag is set to T.
No 0
PCMPosition PCM Position The position code to be added to the new price change created when retail price on an ordered style coming from Sourcing has been changed. This parameter is only used when MomentisFlag is set to T.
No 0
PCMPricingRule PCM Pricing Rule The pricing rule used to create a price change when retail price on an ordered style coming from Sourcing has been changed. This parameter is only used when MomentisFlag is set to T.
No 1
Mod260 Mod260 Allow Style Attributes to be imported by Vendor Style
No 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Segment 17000 - EDM, PROD & POM Import tables to EDM, PROD & POM 353
STSMEGeneralRemote.dll STSMECommerceRemote.dll
This segment loads master entities from import tables into the EDM & PROD live table. The following entities are loaded:
Entity Action Description
Import style (2) Insert (I) Add/modify/delete a style
Import vendor style (4) Insert (I) Add/modify a vendor to an existing style, or delete a non-primary vendor from a style
Import UPC (5) Insert (I) Add/modify/delete a UPC on an existing style
Import style attribute (6) Insert (I) Add/delete an attribute on an existing style
Import style custom property (7) Insert (I) Add/delete a custom property on an existing style
Import style attachment (8) Insert (I) Add/update/delete an attachment on an existing style
Import style description (9) Insert (I) Add/modify/delete a style description on an existing style
Import vendor (20) Insert (I) Add/modify/delete a vendor
Import vendor discount (21) Insert (I) Add/modify/delete a discount on an existing vendor
Import vendor address (22) Insert (I) Add/modify/delete an address on an existing vendor
Import vendor contact (23) Insert (I) Add/modify/delete a contact on an existing vendor
Import vendor attribute (24) Insert (I) Add/delete an attribute on an existing vendor
Import vendor transactions sets (25)
Insert (I) Add/modify/delete an EDI transaction set on an existing vendor
Import vendor manufacturer ID (26)
Insert (I) Add a manufacturer ID to an existing vendor
Import location (30) Insert (I) Add/modify a location
Import location address (31) Insert (I) Add/modify/delete an address on an existing location
Import location contacts (32) Insert (I) Add/modify/delete a contact on an existing location
Import location attribute (33) Insert (I) Add/delete an attribute on an existing location
Import location cust prop (34) Insert (I) Add/delete a custom property on an existing location
Import price exception (40) Insert (I) Add a price exception on a style (on color, location, location color, pricing group or pricing group location level)
Import merchandise groups (50) Insert (I) Add/modify/delete a merchandising hierarchy group
Import merchandising attribute (51)
Insert (I) Add/delete an attribute on an existing merchandising group
Import merchandising plu profiles (52)
Insert (I) Add/delete a PLU profile on an existing merchandising group
Import merchandising positions (53)
Insert (I) Add/delete a position on an existing merchandising group
Import employee (60) Insert (I) Add/modify/delete an employee
Import employee attrib set (61) Insert (I) Add/delete an attribute on an existing employee
Import employee position (62) Insert (I) Add/modify/delete a position on an existing merchandising group
Import employee contacts (63) Insert (I) Add/modify/delete a contact on an existing employee
Import employee address (64) Insert (I) Add/modify/delete an address on an existing employee
354 Segment Reference
TroubleshootingThis segment should not produce errors. If an error occurs, it’s a setup issue, or it's caused by invalid data, or there has been a system failure, or it's a defect.
Style Color Attribute Assignment (67)
Insert (I) Add/Modify/Delete a style color attribute
Import currency conversion (70) Insert (I) Add/modify/delete a currency conversion rate.
Import jurisdiction equivalency (71)
Insert (I) Add/modify/delete a jurisdiction equivalency exception.
Import jurisdiction tax exception (72)
Insert (I) Add/modify/delete a jurisdiction tax exception.
Import style retail (73) Insert (I) Modify a style retail.Style retail change that comes from Sourcing will make a Price Change request in PCM
Import style color description (74)
Insert (I) Add/modify/delete a style color description.
Import style size description (75) Insert (I) Add/modify/delete a style size description.
Import merch group description (76)
Insert (I) Add/modify/delete a merch group description.
Import calendar (77) Insert (I) Retrieve a calendar from the EDM & PROD import table and place it in EDM & PROD.
Import color (78) Insert (I) Retrieve a color from the EDM & PROD import table and place it in EDM & PROD.
Import country (79) Insert (I) Retrieve a country from the EDM & PROD import table and place it in EDM & PROD.
Import currency (80) Insert (I) Retrieve a currency from the EDM & PROD import table and place it in EDM & PROD.
PO (100) Add (A)/Modify (M)
Add a PO / Modify a PO
Pack (661) Add (A) Retrieve a pack from the import pack tables and create the pack in PROD.
Delete (D) Retrieve information of a deleted pack from the import pack tables and delete the pack from PROD.
Entity Action Description
Segment 19000 - IM Import Tables to IM 355
Segment 19000 - IM Import Tables to IMThis segment loads ASNs from import ASN tables into the ASN tables in IM (i.e., creates ASN documents in IM), if the ‘Perform ASN Import’ parameter is set to true.It will also load UDAs from import UDA tables into the UDA tables in IM.
Segment Parameters
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Mod11 Custom Mod 11 Installed
Custom Mod “Import PO Receipt” No 0
Mod59 Custom Mod 59 Installed
Custom Mod “Auto Generate ASN Receipt” Yes 0
Mod84 Custom Mod 84 Installed
Custom Mod “Import Store Shipment into Merchandising”
No 0
Mod85 Custom Mod 85 Installed
Custom Mod “Import RTV into Merchandising” No 0
Mod92 Custom Mod 92 Installed
Custom Mod “Transfer Export in the form of PO via Pipeline to Text file and Import in the form of PO receipts converted to transfer receipts via text file to pipeline”
No 0
Mod140 Custom Mod 140 Installed
Parameter used to determine if Mod 140 is supported or not. Can be 1 (True) Y (Yes) or 0 (False) N (No). If set to Yes, the import of UDAs is supported.
No 0
Mod149 Custom Mod 149 Installed
Used to determine if Mod 149 is supported. Can be 1 (True) Y (Yes) or 0 (False) N (No). If set to Yes, importing ASNs is supported.
No 0
GenRMForOIMLoc
Generate PO Receipts for Offline IM Stores
Used to generate PO Receipt for ASNs when the IM parameter "Generate PO Receipt For ASN" is True and the Warehouse System Flag is false on the Ship To Location as follows: If the Vendor's "ASN Auto Receive Flag" is true,
then no matter what value the Location's "Offline IM Flag" has and no matter what value this segment parameter has, a PO Receipt is generated and received.
No
GenRMForOIMLoc (cont’d)
Generate PO Receipt for Offline IM Stores
If the Vendor's "ASN Auto Receive Flag" is false, and the Ship To Location is an Offline IM Store, and this parameter is true, then a PO Receipt is generated with status "Preliminary".
If the Vendor's "ASN Auto Receive Flag" is false, and the Ship To Location is an Offline IM Store, and this parameter is False, then no PO Receipt is generated.
If the Vendor's "ASN Auto Receive Flag" is false, and the Ship To Location is not an Offline IM Store, then no matter what value this parameter has, a PO Receipt is generated with status "Preliminary".
356 Segment Reference
Scheduling RequirementsThis segment runs after segment 16031 (i.e. this segment only works if the ASN data has already been loaded in the import ASN tables).
Database ParametersNone.
Queue Segment Description The segment does not require any Pipeline dlls to be installed. IM subscribes to the following entities and actions via this segment:
Mod136 Custom Mod 136 Installed
Custom Mod ”Use INF or NB suffix”: 1 = True; 0 = False
No 0
Mod185 Mod185 If on, we save transfer in preliminary status rather then ready to send.
No 0
Perform ASN Import When set to 0, this segment will not import ASNs to IM. In this case, the user must use segment 19010 to import ASNs to IM.When set to 1, this segment will import ASNs to IM. In this case, the user must not run segment 19010.
No 1
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Entity Action Description
ASN (10) Add (A) If no vendor has been provided, the vendor will be retrieved using the Vendor Interchange ID Qualifier and Vendor Interchange ID Code.
Only ASNs of a vendor linked to an EDI 856 transaction set will be processed.
If the combination of a shipment reference number and a vendor already exists on an ASN document, it cannot be used for another ASN.
If the expected receipt date is not provided, it will default to the system date.
If the color is not provided on a detail line, the system default color (“No Color”) will be used.
If the style suffix additional information about sizing, the style suffix is also passed to IM.
The ASN is created in IM. If segment parameter Mod59 is set to 1, an ASN Receipt is created
for each location on the ASN that is not a warehouse. The units received is set to 0 on each detail line of the ASN Receipt.
If Mod59 is set to 0 and the IM parameter Generate PO Receipt For ASN is set to True, a PO Receipt is generated for each location on the ASN that is not a warehouse and that doesn’t use Offline IM (if ASN Auto Receive is set to False for the ASN vendor), or for each location on the ASN that is not a warehouse (if ASN Auto Receive flag is set to True for the ASN vendor). If the ASN Auto Receive flag is True, the generated PO Receipts will become status Received.
Packs can be imported in the ASN import process.
Segment 19000 - IM Import Tables to IM 357
Troubleshooting If any error occurs due to bad import data, i.e., invalid UPC, vendor etc. has been
provided, the user should: Delete the error from the error queue. Fix the input text file (see Mapping Document for segment 16031, Text File to IM
Import tables - Import ASNs) and rerun segments 16031 and 19000.
User Defined Adjustment (112)
Add (A) Retrieves a User Defined Adjustment from the IM import tables and places it in Merchandising.
PO Receipt Match Status (22)
Add (A) Import PO Receipt match status. For each PO Receipt document, the system will set the status to Fully Matched.
Entity Action Description
358 Segment Reference
Segment 19010 - IM Import Tables to IM - ASN ImportThis segment loads ASNs from import ASN tables into the ASN tables in IM (in other words, creates ASN documents in IM). The process for importing ASN's is as follows:
1. The client (or vendor) provides a text file conforming to Epicor's standard ASN import layout.
2. EDI transaction set 856 must be defined for the vendor in EDM (Vendor > Vendor Maintenance > EDI Transaction Sets).
3. The client runs pipeline segment 16031 - Text File to IM Import Tables. This segment will load the ASN text file into ASN import tables.
4. The client must then run pipeline segment 19010 IM Import to IM - ASN Import. This segment will load the ASNs from the ASN import tables into IM. This is the segment that will create the actual ASN document and potentially auto-generate PO receipts off the ASNs.The existing segment 19000 - IM Import Tables to IM, has been left as is for 4.3.2 since this segment is also used to import UDA transactions. To reduce risk, existing customers in 4.3.2 who do not have performance issues can continue to run the current segment rather than the new segment. For 4.3.2, a new parameter has been added to segment 19000 to disable existing ASN related code if the client does decide to import ASNs using the new 19010 segment. This then allows the client to continue to run 19000 for other IM imports (such as UDAs) while running segment 19010 for the ASN import.In 4.3.3, the 19000 segment has been modified to remove all ASN related code; the user can only run 19010 for the ASN import.
Segment Parameters
Scheduling RequirementsThis segment runs after segment 16031 (i.e. this segment only works if the ASN data has already been loaded in the import ASN tables).
Database ParametersNone.
Parameter Name DescriptionModifiable with Pipeline Admin.
Default Value
Import ASN SP The procedure run to create the ASN Import batches
No dbo.import_asn_$sp
Import ASN Batch SP
The procedure run by multiple threads to import ASNs by batch.
No dbo.import_asn_batch_$sp
Cleanup ASN SP The procedure run to cleanup imp_asn and imp_asn_sku
No dbo.purge_imp_asn_$sp
Error Path The path to the error report. Should be set to the folder on the application server where the ASN Import error log will be saved.
Yes C:\Nsb Interface\ASN_Import\ErrorReport
Segment 22000 - Invoice Matching Import Tables To Invoice Matching 359
Segment 22000 - Invoice Matching Import Tables To Invoice Matching
This segment loads Invoices from the import invoice matching tables into live invoice matching tables (i.e., the segment creates and posts invoice matching documents in Merchandising).
Segment ParametersNone.
Scheduling RequirementsThis segment runs after segment 16008 Text File To Invoice Matching Import tables – Imp Invoices.
Database ParametersThere are no Pipeline parameters stored in the source or destination database for this segment.
Queue Segment Description The segment does not require any Pipeline dlls to be installed. IMAT subscribes to the following entities and actions via this segment:
Entity Action Description
Invoice Create (1) Insert (I) The entry mode of the invoice header is hard coded to 1 (Imported). The employee code of the invoice header is hard coded to "Import". On the invoice header, if the due date is provided but the discount date is not
provided, the discount date defaults to the due date. On the invoice header, if the due date is provided, the terms provided are
ignored. If a UPC is provided on a detail, SKU information will be retrieved using the
UPC number. If a UPC is not provided or the UPC number is invalid, the vendor style provided will be applied to the invoice detail.
The discount applicability of the invoice details is hard coded to 1 (Discountable Item).
If gross unit prices are provided on the invoice details, gross unit prices and gross amount are applied on the invoice details and Inventory Account charge. If gross unit prices are not provided and the net unit prices are provided on the invoice details, the net unit prices and net amount will be applied on invoice details and Inventory Account charge.
The entry type of an invoice charge (subledger) defaults to 1 (Invoice). The deferral flag of an invoice charge is hard coded to 0 (Not Deferred). The GL effect of an invoice charge is hard coded to 1 (Debit). The charge code (cost factor code) provided on an invoice charge is used to
retrieve its associated GL account structure import code, which is applied on the invoice charge as the GL account number.
The invoice document is created and becomes status Posted.
360 Segment Reference
TroubleshootingIf any errors occur due to the bad import data, i.e. invalid UPC and no vendor style has been provided on a invoice detail etc., the user should: Delete the error from the error queue. Fix the input text file (see Mapping Document for segment 16008, Text File to Invoice
Matching Import tables - Imp Invoices) and rerun segments 16008 and 22000.
Invoice Create (1) (cont’d)
Insert (I) On an invoice subledger record: The column gross amount and net amount are renamed to gross amount
foreign and net amount foreign now, and they must be provided in the invoice currency.
The new GL distribution type ITC is supported (new column tax type code is provided on a invoice subledger record for GL distribution type ITC). For an ITC, the net amount foreign must always be provided. Basically, if the client does not provide an ITC record for a particular tax type, we will assume the vendor is not charging that tax. Note that ideally though, the client would have provided an ITC record with a net amount foreign of 0 in this case.
GL distribution type Amount To Be Matched is supported (however a subledger of GL distribution type Amount To Be Matched may only be provided if no invoice detail is provided).
On an invoice detail record: Style status is no longer used and should be blank. Either UPC, vendor style, style code or pack code must be provided.
Detail records are no longer mandatory. When the action “GetTaxDefaults” is called on the IMAT business object, all the taxes are retrieved and calculated on the invoice subledgers and details. Tax overrides for a subledger or detail (as shown bellow) can be provided by the import to override the system-calculated taxes.
New record type invoice subledger tax override is provided: For the invoice subledger of GL distribution type Amount To Be Matched,
invoice subledger tax overrides are only provided if no invoice detail is provided (if details are provided, then the tax overrides can only be provided in the invoice detail tax override level).
The column tax rate code provided in this record will override the tax rate code of the system-generated tax.
New record type invoice detail tax override is provided. The column tax rate code provided in this record will override the tax rate
code of the system-generated tax.
Entity Action Description
Segment 26000 - Merch Planning Internal - Import History and Hierarchy 361
Segment 26000 - Merch Planning Internal - Import History and Hierarchy
This segment posts the output files generated by segments 1009 and 11009 to Merchandise Planning. The output files are posted by executing script files that are bundled in this segment.
Segment Parameters
Note: Default values are intended as examples only. Values may change from client to client.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
drive/pathMappedRemoteServer
Drive and path for the mapped Planning server
Drive and path for the mapped Planning server.
No I:
dataFolderRemoteServer
Data Folder on Planning server
Data folder on the Planning server. No Intrans
workingFolderRemoteServer
Working Folder on Planning server
Working folder on Planning server. No MeVWork
drive/pathAllocationsFolder
Drive and Path to mapped Allocation Folder Planning server
Drive and Path to mapped Allocation Folder on the Planning server.
No I:\alloc
pathMKSPlanningFilesRemoteServer
MKS folder on Planning server
During runtime there are several script files that will be generated on the Planning server. This parameter indicates the path and folder to the mapped drive. There should be a folder called ‘MKS’ that will be created during first installation.
No i:\mks
pathToMKS_REXECLocalPC
Path to mks_rexec.exe in local PC
Path to mks_rexec.exe on local PC. No c:\mkstest
pathForSHFile Path for “sh.exe” file on Planning server
Path for “sh.exe” file on Planning server.
No c:\planora20212\mks
nameOfRemoteServer
Name of the Planning server
Name of the Planning server. No MMSMEW
nameOfOutputFileInLocalPC
Name of the output file in local PC
Name of the output file on local PC. No return.dat
firstParameterForRemoteRun
Name of the Planning folder in remote server
Name of the Planning folder on remote server.
No planora20212
loginForRemoteServer
Login for Planning server
Login for Planning server. No administrator
passwordForRemoteServer
Password for remote server
Password for remote server. No Password
362 Segment Reference
Scheduling RequirementsSegments 1009, 1010 and 11009 should be run before Segment 26000, if Segment 26000 is being used.
Database ParametersNone.
Non-queue Segment Description The segment looks in the workingFolderRemoteServer to determine if there are any
.err files for the three postings. (For example, for Batch Tree Processing, the segment looks for *BT.err file, for Location Tree Processing, it looks for *LT.err and for History Transactions, it looks for *HT.err.)
If the segment finds any files with *BT.err, it will not execute the script files to post Batch Tree or History Transactions but it will continue with the location tree assuming no *LT.err files were found.
If the segment finds *LT.err files it will not execute the script files for location tree processing or History Transactions but it will continue with the Batch Tree Processing if no *BT.err files were found.
If no errors occurring during processing, extensions of date-time stamped files are renamed to .dun and the next process continues.
Troubleshooting .err files are logged in log files in i:\batch\log folder on the Planning server. These
errors must be corrected before running this segment. If errors occur during execution of any of the postings, the extension of the date-time
stamp file that is being processed is renamed to .err, the process stops and the processing of history transactions stops.
The first script file executed is for BTree processing. If any errors occur during execution, the extension of the date-time stamp file that is being processed is renamed to .err, the process stops and processing of history transactions stops. The segment then continues with LTree processing. If errors occur during Location Tree processing, the file’s extension is renamed and processing of history transactions stops.
Segment 26001 - Merch Planning to MA - Import 363
Segment 26001 - Merch Planning to MA - ImportThis segment reads from a text file that is generated by the Planning Application and feeds it into Merchandising.
Segment Parameters
Note: Default values are intended as examples only. Values may change from client to client.
Scheduling RequirementsNo info. is available.
Database ParametersThe Posting steps used by this segment are from 801 to 887 in post_sql. An application (RetrieveSQL_ADO.exe) has been created in order to view/update the SQL by post_sql.posting_step.The following MA tables are also involved in this segment:
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
folderPath Path to .go files to be Imported
This is the path to the *.go file that is generated by Planning.
Yes C:\Temp
numOfLines Number of lines to be read from the input file at each batch.
Number of lines to be read from the input file at each batch.
Yes 1000
planByLocHierGrp Plan by Location Hierarchy Group?
1 : True 0 : False
Yes 0
numOfChar Number of characters for Location Hierarchy Group
Value must be between 1-20. For example, if the first 10 characters represent Location Hierarchy Group, the parameter value must be set to 10.
Yes 10
lengthOfSeparator Length of the separator between Merch Hierarchy Group Code and Location Hierarchy Group Code
Number of characters included in the separator between the merchandising and location hierarchy group codes. If there is no separating character between the group codes the value of this parameter should be zero.
Yes 1
locHierGrpAffix Affix of the Location Hierarchy Group Code
If the location hierarchy group code is a suffix the value is R. If it is a prefix the value is L.
Yes R
merchModuleId Module Id Connection broker module name. This should be a module that will allow for a connection to the Merchandising database via connection broker.
Yes EDM
364 Segment Reference
import_plan_group_work_init import_plan_group_work plan_*_loc_wk_work plan_*_chn_wk_work plan_*_loc_pd_work plan_*_chn_pd_work
* = group, style etc.
Non-queue Segment DescriptionBefore running this segment, .GO files must exist in the batch/OutTrans folder on the Planning server. These files are generated by Planning background processes in the format that segment 26001 recognizes.
Before the .GO files are created, these steps must be executed:1. Create a Data Extract background job in Planning application whose output file format
is: Style: COBOL Record Separator: Microsoft Windows Destination: Server
2. Run the background job in Korn Shell: runExtract –code
3. When runExtract is successfully completed, a text file in fixed length format is created in batch/Extract folder. Another background job will convert it to the format that segment 26001 recognizes. Rename this file to budget.dat.
4. Verify that the Planning parameters in the batch.ini file are set properly. The parameter ‘storelength’ in the section STSBUDGET must be set to match the location code format in MA database. For example, if location code in MA is a string of 3 characters, ‘storelength’ must be set to 3 as shown below:[STSBUDGET] …STORELENGTH=3 …
5. Set parameters CLASSSTART and CLASSLTH. The CLASSSTART parameter must be set to 1.The CLASSLTH parameter must be set to the maximum length of the level you will be extracting from, including the dashes. For example: 99-1000-1-9999 is a class in the hierarchy. The maximum class length is 14 including all the dashes. Thus the value of CLASSLTH must be set to 14. 99-1000-1-9999-02 is a subclass in the hierarchy. The maximum subclass length is 17 including all the dashes and thus must be the value of CLASSLTH.
6. Run stsBudget job in Korn Shell. When it’s successfully completed, a .GO file is created in batch/OutTrans folder.
All source data files have an extension of “.GO”. When the processing starts, the “.GO” files are renamed to “.RCVD.GO”. When posting successfully completes, the source file is renamed as a “.BAK” file. If duplicate data is present in a single source file, the package will be aborted. If duplicate data is present in separate files, the updating rule is based on the
“Modified” property of files where the last “Modified” file has the most up-to-date data.
Segment 26001 - Merch Planning to MA - Import 365
Troubleshooting Errors may be related to parameter settings. For troubleshooting purposes an error
file is produced in the path given by the parameter “folderPath” with an extension .err. <packagename.log> (STSMVPlanImport.LOG) and <packagename.err>
(STSMVPlanImport.Err) are generated in the same file folder as the source data files. The log file records information such as the starting and ending of each subtask. In case of error, the error message will be logged to the error file.
Parameter errors
Database errors
Additional details are provided when an error occurs.
Error Reason
The value for locHierGrpAffix is invalid. The value must be either R or L.
The value for numOfChar is invalid. The value must be numeric.
The value for numOfChar is invalid. The value must be between 1-20.
The value for lengthOfSeparator is invalid. The value must be 0 or above
Path not found: folderPath
Error Reason
Error occurred when attempting to truncate import_plan_group_work_init table.
Error occurred while attempting to drop index pl_gr_wk_init_$NDX.
Error occurred while inserting data to import_plan_group_work_init table from file
Error occurred while attempting to create index on import_plan_group_work_init table.
Error: No .Go file found in the specific directory: folderPath
Error: Checking if view exists or dropping the view.
Error: Creating View.
Error: Deleting duplicates.
Error: Drop index on IMPORT_PLAN_GROUP_WORK table.
Error: Removing duplicates before insertion to import_plan_group_work table.
366 Segment Reference
Input File errors
Error: Creating index on import_plan_group_work table.
Error: truncate table import_plan_group_work_init
Error: Updating hierarchy_group_code
Error: Truncate plan_group_*_*_work table
Error: Drop index on plan_group_*_*_work table.
Error: create index on plan_group_*_*_work.
Error: delete duplicate rows from plan_group_*_*
Error: Drop primary key
Error: Add primary key on plan_group_*_*.
Error Reason
Error Reason
Invalid data in the source file <File Name>
Duplicate found in file. File(s) <file list>
You have specified to plan by division; however, appropriate hierarchy_group_code is not found in the file.
Segment 28000 - General Ledger Exp Tables to Text File - Export Trans 367
Segment 28000 - General Ledger Exp Tables to Text File - Export Trans
This segment creates a text file that will be exported to a General Ledger application according to one of three pre-defined formats.
Segment Parameters
Scheduling RequirementsThis segment should be scheduled to run after segment 6001 Stock Ledger to General Ledger Export tables – Export Trans.
Database ParametersThe input of this segment is the content of the gl_export table.The text file will be exported to a General Ledger application according to one of three pre-defined formats: STSSLProcessing.STSLawsonFormat is the General Ledger interface file created for
Lawson (comma delimited except for the columns amount and sign).
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
LogFilePath Log File Name The folder where the log files will be saved.
No C:\STSInterface\GLLogs
ApplicationId Merchandising Application
The Merchandising Application ID. No 100
AccountNumberLength
Length of the General Ledger account number
This parameter represents the number of characters allocated for the GL Account Number in the generated flat file.
No 14
GLExportProgId Prog ID of the component that formats the data
Prog ID of the FileFormat component. Possible valid values are: STSSLProcessing.STSLawsonFormat / STSSLProcessing.STSGLFormatSTS / STSSLProcessing.STSStdGLFormat /STSSLProcessing.STSJDEFormat
No STSSLProcessing.STSStdGLFormat
OutputFileName Name of the file to be exported to General Ledger
Name of the output file generated by the segment.
No GLExport.txt
OutputFilePath Path used to store the output file
The folder where the output file will be saved.
No C:\STSInterface\GL
CompanyId Database Company to Use
The company ID used by the Epicor Foundation Component that defines the database where the GL tables reside.
No The company for which the segment has been installed
ModuleName General Ledger Registry Module Name
This is a registry key on the Pipeline Server from where the CompanyId is read.
No GL
368 Segment Reference
STSSLProcessing.STSGLFormatSTS is the General Ledger interface file created for Auditworks.
STSSLProcessing.STSStdGLFormat is the standard output file created as a flat ascii, variable length, comma-delimited file.
STSSLProcessing.STSLawsonFormat
Column No. Column Name Format Default Value
1 run_group X(12) ' '
2 seq_number X(6) <counter where first rec. is 1, second is 2 etc.>
3 company X(4) gl_company
4 old_company X(35) gl_company
5 old_acct_no X(25) gl_account_no
6 source_code X(2) ' '
7 calendar_date X(8), in 'yyyymmdd' format system date
8 refer X(10) ' '
9 description X(30), date in 'mm/dd/yy' format journal_entry_description+" "+getdate()
10 currency X(5) 'USD '
11 units_amt X(15) 0
12 units_amt_s X '+'
13 trans_amt 999999999999.99 sum(amount)
14 trans_amt_s X '+' if s.amount >= 0; / '-' if s.amount < 0
15 base_amt 999999999999.99 0
16 base_amt_s X '+'
17 baserate 99999.999999 0
18 baserate_s X '+'
19 system X(2) 'GL'
20 source X(4) ' 1'
21 autorev X(1) 'N'
22 posting_date X(8), in 'yyyymmdd' format period_end_date
23 activity X(15) ' '
24 acct_catg X(5) ' '
25 doc_nbr X(15) ' '
26 to_base_amt X(15) 0
27 to_base_amt_s X '+'
28 effect_date X(8) '00000000'
29 jnl_book_nbr X(12) ' '
30 mx1 X(20) ' '
31 mx2 X(20) ' '
32 mx3 X(20) ' '
Segment 28000 - General Ledger Exp Tables to Text File - Export Trans 369
STSSLProcessing.STSGLFormatSTS Record Length: Fixed Record Length of 66 bytes or variable comma delimited. Each record ends with a <cr><lf>
File Type: ASCII format only
Remarks: No Headers, No Labels.The Interface File is made up of three record types:
1. The Batch Header Record
2. The Detail Record3. The Trailer Record
The Batch Header Record is the first record of the Batch followed by an infinite number of Detail Records. The Trailer Record is the last record for the Batch. The combination of Batch Header and Detail Records followed by one Trailer Record represents one journal entry. Many journal entries can exist in one file. The maximum file size is 32700 details.
1. Batch Header Record
2. Detail Record
Position Description Remark
1-2 RECORD TYPE Always "BH" for Batch Header.
3-46 UNUSED Blanks
47-57 TOTAL BATCH DEBITS Numeric integer value indicating total debit amount in batch. Right justified, zero filled. (e.g., 00123456789).
58-59 G.L. PERIOD NO. Numeric integer value from 00 to 13 indicating the period the entry is to be posted to in General Ledger.
60-64 PERIOD ENDING DATE Numeric integer value of period ending date, in Julian format (e.g., 87125).
65-66 G.L. COMPANY NUMBER Numeric integer value. / Company number must exist in the General Ledger Company Status file.
Position Description Remark
1-2 RECORD TYPE Always "DT" for all Detail type records.
3-31 JOURNAL ENTRY DESCRIPTION
A description to represent the entire Journal Entry. Example: "DETAIL FROM ??????? MM/DD/YY" where MM/DD/YY equals the period ending date.Date can correspond to Batch Header's Julian date.
32-32 DETAIL TYPE INDICATOR " " if record is a normal dollar record. "*" if record contains statistical information.
33-46 G.L. ACCOUNT NUMBER Numeric integer value. GL account number must be an existing and postable account in General Ledger. If the Detail Type indicator is " " the account type must be an existing dollar type account (i.e., account type = A/L/R/E). If the Detail Type indicator is "*" the account type must be an existing management account (i.e., account type = M). Right justified, zero filled (e.g., 00000425155218 ).
370 Segment Reference
3. Trailer Record
STSSLProcessing.STSJDEFormat
47-57 AMOUNT Numeric integer value indicating amount in pennies. Credit amounts are preceded by a negative sign ("-"), otherwise zero filled. Right justified, zero filled. (e.g., -0123456789 or 00123456789).
58-59 G.L. PERIOD NO. Numeric integer value from 00 to 13 indicating the period the entry is to be posted to in General Ledger. Same value as Batch Header.
60-64 PERIOD ENDING DATE Numeric integer value of period ending date in Julian format. Same value as Batch Header.
65-66 G.L. COMPANY NUMBER Numeric integer value. Company number must exist in the General Ledger Company Status. Same value as Batch Header.
Position Description Remark
Position Description Remark
1-2 RECORD TYPE Always "TH" for the Batch Trailer.
3-46 UNUSED Blanks
47-57 TOTAL BATCH CREDITS Numeric integer value indicating total credit amount in batch. Credit amount is preceded by a negative sign ("-"). Right justified, Zero filled (e.g., -0123456789).
58-59 G.L. PERIOD NO. Numeric integer value from 00 to13 indicating the period the entry is to be posted to in General Ledger. Same as in Batch Header.
60-64 PERIOD ENDING DATE Numeric integer value of period ending date in Julian Format (e.g., 87125). Same as in Batch Header.
65-66 G.L. COMPANY NUMBER Numeric integer value. Company number must exist in the General Ledger Company Status file. Same as in Batch Header.
JDE FieldData Type/Length
M/O Notes EPICOR (Stock Ledger) Field
User ID Char(10) Mandatory User ID EPICORSL
Record Type Char(1) Blank
Record Seq Num(2,0) 0
Transaction Number
Char(22) Mandatory User Transaction Number within batch number
Batch and Transaction number make up the key. Together they must be unique. Per JDE, we can set this to 1 as long as we generate a unique batch number with this file.
1
Doc Ty Char(2) Blank
Segment 28000 - General Ledger Exp Tables to Text File - Export Trans 371
Line Number Num(7,0) Mandatory Line number within Transaction Number
Incremented by 1 (starting with 1) for every detail record that belongs to the same batch Header record.Refer to Standard GL Export layout for relationship between a batch header record and a detail record.
Tran Set Char(6) Blank
Translation Format
Char(10) Blank
Tran Date Num(6,0) Mandatory System Date System date dd/mm/yyyy
S/R Ind Char(1) Mandatory Constant R
# Lines Num(5,0) 0
S P Char(1) Mandatory Constant 0
T C Char(1) Mandatory Constant A
T T Char(1) Mandatory Constant J
Batch Number Char(15) Mandatory User Batch Number
JDE only uses this in the staging tables – It is not loaded on to the actual voucher or journal.
Set to yymmddhhmmss.seq# for each batch header record written to Epicor standard GL export file.
Every detail in the batch will have the same batch number, the line number together with the batch number will be the unique identifier.
G L Char(1) Blank
Address Number Num(8,0) 0
Doc Co Char(5) Mandatory Document Company GL company number
Doc Type Char(2) Mandatory Constant JE
Document Number
Num(8,0) 0
G/L Date Num(6,0) Mandatory General Ledger Date GL period ending date (julian format)
JE Line Number Num(7,1) Mandatory Journal Line Number within Transaction Number.Per JDE, this can be set to the same number as the Line Number
Incremented by 1 (starting with 1) for every detail record that belongs to the same batch Header record.Refer to Standard GL Export layout for relationship between a batch header record and a detail record.
Line Extension Char(2) Blank
P C Char(1) Blank
Batch Number Num(8,0) 0
Bth Ty Char(2) Blank
Batch Date Num(6,0) 0
ICU Sys Date Num(6,0) 0
JDE FieldData Type/Length
M/O Notes EPICOR (Stock Ledger) Field
372 Segment Reference
Batch Time Num(6,0) 0
Co Char(5) Mandatory Company Number GL company number
Account Number Char(29) Mandatory Account Number GL account number
A M Char(1) Mandatory Constant 2
Account ID Char(8) Mandatory Short Account Number Blank(will be set to blank since Account number will be supplied)
Business Unit Char(12) Blank
Obj Acct Char(6) Blank
Sub Char(8) Blank
Sub- ledger Char(8) Blank
Sub Type Char(1) Blank
LT Char(2) Mandatory Constant AA
Per No Num(2,0) 0
Century Num(2,0) 0
FY Num(2,0) 0
Fisc Qtr Char(4) Blank
Cur Cod Char(3) Mandatory Currency Code GL company currency code
Exchange Rate Num(15,7) 0
Historical Rate Num(15,7) 0
Historical Date Num(6,0) 0
Amount Num(15,0) Mandatory Amount GL amount expressed in the GL company currencyCredits are expressed as positiveDebit amounts are preceded by a negative sign
Expressed in pennies
Units Char(2) Optional Units Blank
UM Char(4) Blank
G/L Offset Char(1) Blank
R V Char(30) Blank
Explanation Alpha Name
Char(30) Optional Universal Incorporated Line Description
Blank
Explanation Remark
Char Optional Line Description Blank
Reference 1 Char(8) Blank
Reference 2 Char(8) Blank
Reference 3 Char(8) Blank
Pay Itm Char(3) Blank
JDE FieldData Type/Length
M/O Notes EPICOR (Stock Ledger) Field
Segment 28000 - General Ledger Exp Tables to Text File - Export Trans 373
Original Document
Num(8,0) 0
Orig Do Ty Char(2) Blank
Orig PayItm Char(3) Blank
Doc Co Char(5) Blank
Doc Co Char(5) Blank
PO Do Ty Char(2) Blank
Address Number Num(8,0) 0
Payment Number
Char(8) Blank
Check Date Num(6,0) 0
Check Cleared Num(6,0) 0
Serial Number Char(25) Blank
BRE Post Char(1) Blank
R ND Char(1) Blank
S C Char(1) Blank
P C Char(1) Blank
1099 Flag Char(1) Blank
P C Char(1) Blank
P C Char(1) Blank
H D Char(1) Blank
H D Char(1) Blank
H D Char(1) Blank
H D Char(1) Blank
Commitment Relief
Char(1) Blank
Billing Control Char(1) Blank
C U Char(1) Blank
L C Char(1) Blank
F U Char(1) Blank
F U Char(1) Blank
S C Char(1) Blank
ALT W Char(1) Blank
C T Char(1) Blank
A D Char(1) Blank
Delete Not Allowed
Char(1) Blank
F U Char(1) Blank
JDE FieldData Type/Length
M/O Notes EPICOR (Stock Ledger) Field
374 Segment Reference
F U Char(1) Blank
L C Char(1) Blank
B C Char(1) Blank
Invoice Number Char(25) Blank
Invoice Date Num(6,0) 0
Pha se Char(4) Blank
Purchase Order Char(8) Blank
PO Sfx Char(3) Blank
Or Ty Char(2) Blank
Line Number Num(6,0) 0
Fiscal Year Num(2,0) 0
Fiscal Period Num(2,0) 0
Closed Item Char(1) Blank
Oper Seq# Num(5,0) Mandatory Constant 1
Job Typ Char(6) Blank
Job Step Char(4) Blank
Home Business Unit
Char(12) Mandatory Business UnitPer JDE will can set this value to the GL company code created in Merch and concatenate it with 3 trailing 0’s
2 digit GL company code + 000
DOI Sub Num(2,0) 0
Outsider Lease Or Well ID
Char(25) Blank
I.D. Type Char(2) Blank
Service/ Tax Date
Num(6,0) 0
Transaction Originator
Char(10) Mandatory User Id EPICORSL
Register Number Num(8,0) 0
Payment ID Num(15,0) 0
User ID Char(10) Mandatory User Id EPICORSL
Program ID Char(10) Mandatory Constant ZP0411Z1
Work Stn ID Char(10) Mandatory IMPLEMATIC Workstation Reference
EPICORSL
Date Updated Num(6,0) Mandatory System Date System date dd/mm/yyyy
Time Updated Num(6,0) Mandatory System Time HHMMSS System time
F/ D Char(1) Mandatory Constant ‘D’omestic‘F’oreign
D
JDE FieldData Type/Length
M/O Notes EPICOR (Stock Ledger) Field
Segment 28000 - General Ledger Exp Tables to Text File - Export Trans 375
Currency Amount
Num(15,0) 0
G/L Date- dd Num(2,0) 0
G/L Date- mm Num(2,0) 0
G/L Date- yy Num(2,0) 0
G/L Date- cy Num(2,0) 0
ICU Date- dd Num(2,0) 0
ICU Date-mm Num(2,0) 0
ICU Date-yy Num(2,0) 0
ICU Date-cy Num(2,0) 0
ICU Sys Date-dd Num(2,0) 0
ICU Sys Date-mm
Num(2,0) 0
ICU Sys Date-yy Num(2,0) 0
ICU Sys Date-cy Num(2,0) 0
Check Date-dd Num(2,0) 0
Check Date-mm Num(2,0) 0
Check Date-yy Num(2,0) 0
Check Date-cy Num(2,0) 0
Service Date-dd Num(2,0) 0
Service Date-mm
Num(2,0) 0
Service Date-yy Num(2,0) 0
Service Date-cy Num(2,0) 0
Historical Date-dd
Num(2,0) 0
Historical Date-mm
Num(2,0) 0
Historical Date-yy
Num(2,0) 0
Historical Date-cy
Num(2,0) 0
Check Cleared-dd
Num(2,0) 0
Check Cleared-mm
Num(2,0) 0
Check Cleared-yy
Num(2,0) 0
Check Cleared-cy
Num(2,0) 0
JDE FieldData Type/Length
M/O Notes EPICOR (Stock Ledger) Field
376 Segment Reference
Invoice Date-dd Num(2,0) 0
Invoice Date-mm Num(2,0) 0
Invoice Date-yy Num(2,0) 0
Invoice Date-cy Num(2,0) 0
Managrl Code 1 Char(1) Blank
Managrl Code 2 Char(1) Blank
Managrl Code 3 Char(1) Blank
Managrl Code 4 Char(1) Blank
M T Char(1) Blank
M T Char(1) Blank
M T Char(1) Blank
M T Char(1) Blank
Short Item No Num(8,0) 0
PC 01 Char(1) Blank
PC 02 Char(1) Blank
PC 03 Char(1) Blank
PC 04 Char(1) Blank
PC 05 Char(1) Blank
PC 06 Char(1) Blank
PC 07 Char(1) Blank
PC 08 Char(1) Blank
PC 09 Char(1) Blank
PC 10 Char(1) Blank
Base Curr Char(3) Blank
Tx Ex Char(2) Blank
Tax Y/N Char(1) Blank
Tax Item No Char(10) Blank
Activity-Based Costing Actvity Code
Char(4) Blank
Tax Num(15,0) 0
Foreign Tax Num(15,0) 0
Gross Amount Num(15,0) 0
Foreign Gross Amount
Num(15,0) 0
Track Taxes Num(15,0) 0
Distribution Line Number
Num(tbd) 0
JDE FieldData Type/Length
M/O Notes EPICOR (Stock Ledger) Field
Segment 28000 - General Ledger Exp Tables to Text File - Export Trans 377
STSSLProcessing.STSStdGLFormat
Non-queue Segment Description No client is currently using the format STSSLProcessing.STSStdGLFormat. The name of the log file produced is SLGLExportToGL.log; it contains information
concerning the tasks performed by the segment, the parameters used to produce the file and the time the task was executed, in the format hh-mm-ss. Example:Starting GLExport to GL ... - 15-51-15
Creating Employee Info... - 15-51-15Initializing Employee Info with 100,855... - 15-51-15
Employee Info released. - 15-51-17
Creating Connection Factory... - 15-51-17Initializing Connection Factory... - 15-51-17
Getting DBConnection for Export... - 15-51-17
Creating Export Object with ProgId : STSSLProcessing.STSGLFormatSTS - 15- 51-17Creating Export Def Object... - 15-51-17
Initializing Export Def Object... - 15-51-17
Receipt Number Num(8,0) 0
Burdening Posted Code
Char(4) Blank
Alternate Home Business Unit
Char(12) Blank
Employee Pool Grouping Code
Char(4) Blank
Job Pool Grouping Code
Char(4) Blank
File Line Identifier
Num(2,0) 0
Pay Ext Char(2) Blank
Offset Method Num(4,0) 0
JDE FieldData Type/Length
M/O Notes EPICOR (Stock Ledger) Field
Column Type Length Allow Nulls
Gl_company_no char 2 Not Null
Gl_period_no char 2 Not Null
Period_ending_date char 5 Not Null
Record_type char 2 Not Null
Gl_account_no char 160 Not Null
Journal_entry_description char 29 Not Null
Detail_type_indicator char 1 Not Null
Amount int 6 (precision 10) Not Null
378 Segment Reference
Setting AccountNumberLength to '20' ... - 15-51-17
Setting the export default object... - 15-51-17Setting the output file path (c:\)... - 15-51-17
Setting the output file name ({DateTimeStamp}SLExport.txt)... - 15-51-17
Initializing the Export Object... - 15-51-17Start Exporting... - 15-51-17
The most common errors are related to configuration. Once the segment is set up properly, it runs smoothly.The output file is renamed at the end of the execution of the segment. The renamed file begins with a timestamp in the format YYYYMMDDHHMM). Example: 200302041551SLExport.txt. Example of the output file that matches the log file produced:
BH 66429975840203088 1
DTJournalTest 02/04/03 *11-2-21-SPSH-4012345 15882399960203088 1DTJournalTest 02/04/03 *11-2-21-SPSH-4012345 1457287360203088 1
DTJournalTest 02/04/03 *11-2-21-SPSH-4712345 617390203088 1
DTJournalTest 02/04/03 *11-2-22-SUIT-5012345 28643292380203088 1
DTJournalTest 02/04/03 *11-2-22-SUIT-5112345 494742040203088 1DTJournalTest 02/04/03 *12-1-20-NEWA-9012345 6197503750203088 1
DTJournalTest 02/04/03 *12-2-21-NEWB-9112345 10694211310203088 1
DTJournalTest 02/04/03 *GL000000000000000000 -186856540203088 1DTJournalTest 02/04/03 12-1-2000000000ABCDE 00203088 1
DTJournalTest 02/04/03 11-2-2200000000ABCDE 00203088 1
DTJournalTest 02/04/03 11-2-2200000000ABCDE 00203088 1DTJournalTest 02/04/03 11-2-2100000000ABCDE 00203088 1
DTJournalTest 02/04/03 11-2-2100000000ABCDE 00203088 1
DTJournalTest 02/04/03 *GL009900000000000000 -691124090203088 1DTJournalTest 02/04/03 *GL006600000000000000 -465532950203088 1
DTJournalTest 02/04/03 *GL003300000000000000 -4503317200203088 1
DTJournalTest 02/04/03 *GL000300000000000000-60770001600203088 1
TroubleshootingNo troubleshooting information is currently available for this segment.
Segment 32000 - RTP Internal - System Cancel and Delete RTP Documents 379
Segment 32000 - RTP Internal - System Cancel and Delete RTP Documents
This segment deletes RTP documents (tickets that have been completely printed and non-printed tickets for which no activity has occurred for a parameter-defined period of time) to prevent these tables from becoming too large if users don’t manually delete tickets that have been printed.
Segment Parameters
Scheduling Requirements This segment should only be run for clients that use Ticket Printing. The segment should be scheduled to run regularly once a week.
Database ParametersThis segment uses the following parameters from parameter_system table in the Merchandising database:
Non-queue Segment Description This segment deletes rows in the rtp_generated_header and rtp_generated_detail
tables according to the value of the database parameters listed previously. This task prevents these tables from becoming too large if users don’t want to manually delete tickets that have been printed. There is a delete trigger in the rtp_generated_detail table that will also delete rtp_format_tag_value table.
Business rules implemented: Non-printed tickets will be deleted if they were generated and no activity occurred
on the document within the number of days allowed. Printed tickets will be deleted if they are flagged as having been printed
completely (i.e., all the detail tickets related to a document have been printed and all activity related to the document occurred within the number of days allowed.)
If any errors occur during the delete of one batch, a log file will be created at the path defined by parameter “Path” and error messages will be recorded for each error that occurred during the execution of the segment. The segment won’t stop if errors occur.
TroubleshootingNo troubleshooting information is currently available for this segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Path Log error path name
Path on the Pipeline server where a log file will be created if the segment runs into errors.
No C:\NSB Interface\TP
Column Name Default Value
tkt_days_to_keep_printed_tkts 100
tkt_days_to_keep_non_print_tkt 30
tkt_cleanup_batch_size 30
380 Segment Reference
Segment 34000 - PM Import To PMThis segment retrieves price change information from PCM import tables and places them in PCM live tables.When importing price change documents from a 3rd party source:
1. Provide a tab-delimited text file conforming to the standard PC import layout.
2. Run pipeline segment 16060 (Text File to PM Imports) to load the text file into the price change import tables.
3. Run pipeline segment 34000 (PM Import to PM) to create the price change documents.
When importing price change documents from Sourcing: Sourcing will send the style retail price modification to Merchandising via pipeline
segment 17000 (EDM&PROD&POM Import to EDM&PROD&POM). If the style retail modification is for an ordered or received style, then pipeline segment 17000 will automatically request a price change document by directly updating the PC import tables with the style retail modification.
Run pipeline segment 34000 (PM Import to PM) to create the price change documents.
Segment Parameters
Scheduling RequirementsThis segment must be scheduled after segment 16060 “Text File to PM Import – Import Price Changes” is run.
Database ParametersNone.
TroubleshootingNo troubleshooting information is currently available for this segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Issue Imported PCs
Indicates whether imported Price Change documents are issued.
Yes 0
IssueMakeEffective Issue And Make Effective
Indicates whether a price change document should be issued and made effective immediately in this segment: 1=Yes, 0=No
Yes 0
Cleanup Import Price Change SP
Stored procedure for cleanup. No dbo.import_pc_purge_$sp
Import Price Change Batch SP
Stored procedure containing the batch job.
No dbo.import_pc_batch_$sp
Import Price Change SP
Stored procedure for setting up the batch job.
No dbo.import_pc_$sp
SplitPriceChanges Split Price Changes
Whether to split the import of price change details across multiple price change documents: 0=No, any value greater than or equal 1=Yes.
Yes 0
Segment 53001 - Offline IM To IM 381
Segment 53001 - Offline IM To IMThis segment sends RTVs and Inbound Transfers from Offline IM (Sales Audit) to IM.
Segment Parameters
Scheduling RequirementsBefore the segment runs, RTVs and Inbound Transfers must have been sent to Sales Audit from POS.
Database ParametersNone.
Queue Segment DescriptionThe following pipeline components must be installed:
STSPLOIMToIM.dll
If the segment parameter ‘ReportSysErrsToPub’ is set to 1, errors are sent to if_error table in Offline IM (Sales Audit). Errors will not be found in the Pipeline error queue.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
RTVPrintedStatus RTV Printed Status
A value of 1 indicates that RTVs should be created with their printed status set to “Printed”, 0 indicates that RTVs should be created with printed status set to “Not printed”.
Yes 1
ReportSysErrsToPub
Report System Errors To Sales Audit
A value of 1 indicates that system errors should be reported to Sales Audit, 0 indicates that these should be reported in Pipeline. We recommend that system errors be reported to Sales Audit to ensure that Sales Audit does not accept (freeze) a store/register/date while there are any outstanding errors for the store/register/date. (This is very important as it will not be possible to modify the transactions for a store/register/date in Sales Audit once they have been accepted.)
No 1
382 Segment Reference
The following document actions are sent from Offline IM to IM:
TroubleshootingNo troubleshooting information is currently available for this segment.
Entity Action Description
RTV (60) Insert (I) The segment uses the data in the Offline IM RTV tables in Sales Audit to create and return an RTV document in IM. When creating an RTV: if the terms code is not provided, the segment uses the terms of the PO
referenced by the RTV. If no PO is provided, the segment uses the terms of the vendor of the RTV.
if an IMRD No. is provided (i.e., the RTV is initiated by host), the segment uses the transaction reason of the IMRD document as the transaction reason of the RTV.
if an IMRD No. isn’t provided (i.e., the RTV is initiated by POS), and if no transaction reason has been provided for the RTV, the segment uses the default reason “EXTRV” (POS Initiated RTV Reason).
if a detail line has no Unit Cost, the default cost of the SKU will be applied (the SKU default cost is retrieved by a IB function that checks the value of the IM parameter ‘cost default’).
if a detail line has no From Stock Status Code, it defaults to “001” (available inventory).
if no detail line with Units Sent > 0 has been found, the Offline IM RTV will be ignored (i.e., it won’t be posted to IM).
if the same SKU, carton and From Stock Status has been provided in more than 1 detail line in an RTV, they are summarized into 1 line (the average cost is calculated and applied as the unit cost).
the RTV is Returned and Posted To IMAT.
Inbound Transfer (130)
Insert (I) The segment uses the data in the Offline IM Inbound Transfer tables in Sales Audit to find and receive a Transfer document in IM. When receiving a Transfer, a parameter transfer_dupl_doc_action is added in the IM parameters. When sending a Transfer Receipt to IM, if the Transfer is already of status Received, then if the parameter is set to reject, the new receipt will be rejected; if the parameter is set to replace, the received units on the Transfer will be replaced by the units provided in the new receipt; and if the parameter is set to increment, the received units on the Transfer will be incremented by the units provided in the new receipt. The parameter transfer_force_substit_flag has been added to the IM parameters. When a Transfer Receipt is sent to IM containing a SKU or SKU/carton that doesn’t exist in the Transfer document, the Transfer Receipt will be rejected if the transfer_force_substit_flag is set to false and the force flag on that detail line is set to false; the line will be added to the transfer with 0 Sent Units if transfer_force_substit_flag is set to true.
User Defined Adjustment (160)
Insert (I) Publishes user-defined adjustment documents from Sales Audit to Inventory Management when a user-defined adjustment is inserted into the Offline IM UDA tables in Sales Audit.
Segment 53002 - Offline IM To IM, Outbound Transfers 383
Segment 53002 - Offline IM To IM, Outbound TransfersThis segment sends the Offline IM (Sales Audit) Outbound Transfers and Transfers Ready To Send to IM.
Segment Parameters
Scheduling RequirementsBefore the segment runs, POS must send Outbound Transfers (Transfers created at POS and initiated by host or POS) and Transfers Ready To Send (Transfers created at host) to Sales Audit.
Database ParametersNone.
Queue Segment DescriptionThe following pipeline components must be installed:STSPLOIMToIM.dll If the segment parameter ‘ReportSysErrsToPub’ is set to 1 errors are sent to if_error
table in Offline IM (Sales Audit). Errors will not be found in the Pipeline error queue.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
OutXferPrintedStatus
Outbound Transfer Printed Status
A value of 1 indicates that Outbound Transfers should be created with their printed status set to “Printed”, 0 indicates that Outbound Transfers should be created with printed status set to “Not printed”.
Yes 1
ReportSysErrsToPub
Report System Errors To Sales Audit
A value of 1 indicates that system errors should be reported to Sales Audit, 0 indicates that these should be reported in Pipeline. We recommend that system errors be reported to Sales Audit to ensure that Sales Audit does not accept (freeze) a store/register/date while there are any outstanding errors for the store/register/date. (This is very important as it will not be possible to modify the transactions for a store/register/date in Sales Audit once they have been accepted.)
No 1
384 Segment Reference
The following document actions are sent from Offline IM to IM:
TroubleshootingNo troubleshooting information is currently available for this segment.
Entity Action Description
Outbound Transfer (50) Insert (I) The segment uses the data in the Offline IM Outbound Transfer tables in Sales Audit to create and send a Transfer document in IM. When creating the Transfer: if the ship date is not provided by Offline IM, Pipeline uses the system
date as the default value. if an IMRD No. is provided (i.e., the Transfer is initiated by the host), the
segment uses the transaction reason of the IMRD document as the transaction reason of the Transfer.
if an IMRD No. isn’t provided (i.e., the Transfer is initiated by POS), and if no transaction reason has been provided for the RTV, the segment uses the default reason “EXTRV” (POS Initiated RTV Reason).
if multiple detail lines have been provided for the same SKU/carton, their units sent will be summarized and the transaction reason of the first SKU/carton in these lines will be applied. (If no transaction reason is provided in the first line, the transaction reason will default to the transaction reason of the header.)
all the lines with Units Sent = 0 will be ignored. If no detail lines with Units Sent <> 0 are found, the Offline IM Outbound Transfer will be ignored (i.e., it won’t be created in IM).
the Transfer will be created and the status will become Sent in IM.
Transfer Ready To Send (150)
Insert (I) The segment uses the data in the Offline IM Outbound Transfer tables in Sales Audit to find and send the Transfer document in IM. When sending the Transfer: if the ship date is not provided by Offline IM, Pipeline uses the system
date as the default value. if multiple detail lines have been provided for the same SKU/carton,
their units sent will be summarized and the transaction reason of the first SKU/carton in these lines will be applied. (If no transaction reason is provided in the first line, the transaction reason will default to the transaction reason of the header.)
all the lines with Units Sent = 0 will be ignored. If no detail lines with Units Sent <> 0 are found, the Offline IM Outbound Transfer will be ignored (i.e., it won’t be created in IM).
the Transfer Ready To Send will becomes Sent in IM.
Segment 53003 - Offline IM To IM, Store Shipment Receipts 385
Segment 53003 - Offline IM To IM, Store Shipment ReceiptsThis segment finds a Store Shipment in IM and receives it using the receipt information coming from Offline IM (Sales Audit).
Segment Parameters
Scheduling RequirementsBefore the segment runs, Store Shipment Receipts must have been sent to Sales Audit from POS.
Database ParametersNone.
Queue Segment DescriptionThe following pipeline components must be installed: STSPLOIMToIM.dllIf the segment parameter ‘ReportSysErrsToPub’ is set to 1, errors are sent to if_error table in Offline IM (Sales Audit). Errors will not be found in the Pipeline error queue.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ReportSysErrsToPub Report System Errors To Sales Audit
A value of 1 indicates that system errors should be reported to Sales Audit, 0 indicates that these should be reported in Pipeline. We recommend that system errors be reported to Sales Audit to ensure that Sales Audit does not accept (freeze) a store/register/date while there are any outstanding errors for the store/register/date. (This is very important as it will not be possible to modify the transactions for a store/register/date in Sales Audit once they have been accepted.)
No 1
386 Segment Reference
The following document actions are sent from Offline IM to IM:
TroubleshootingNo troubleshooting information is currently available for this segment.
Entity Action Description
Store Shipment Receipts (140)
Insert (I) The segment uses the data in the Offline IM Store Shipment Receipt tables in Sales Audit to find and receive a Store Shipment document in IM. When receiving a Store Shipment if receive date is not provided by Offline IM, Pipeline uses the system date as the default value. When sending a Store Shipment Receipt to IM, if the Store Shipment is already of status Received, then if the store_ship_dupl_doc_action parameter is set to reject, the new receipt will be rejected; if the parameter is set to replace, the received units on the Store Shipment will be replaced by the units provided in the new receipt; and if the parameter is set to increment, the received units on the Store Shipment will be incremented by the units provided in the new receipt. When a Transfer Receipt is sent to IM containing a SKU or SKU/carton that doesn’t exist in the Transfer document, the Transfer Receipt will be rejected if transfer_force_substit_flag parameter is set to false and the force flag on that detail line is set to false; the line will be added to the Transfer with 0 Sent Units if the transfer_force_substit_flag is set to true. If weight has been provided by Offline IM, Pipeline increments or replaces the existing weight in the IM Store Shipment with the weight provided by Offline IM, based on the value of store_ship_dupl_doc_action parameter in IM.
User Defined Adjustment (160)
Insert (I) Publishes user-defined adjustment documents from Sales Audit to Inventory Management when a user-defined adjustment is inserted into the Offline IM UDA tables in Sales Audit.
Segment 53004 - Offline IM To IM, PO Receipts 387
Segment 53004 - Offline IM To IM, PO ReceiptsThis segment creates a PO Receipt in IM using the receipt information coming from Offline IM (Sales Audit).
Segment Parameters
Scheduling RequirementsBefore the segment runs, PO Receipts must have been sent to Sales Audit from POS.
Database ParametersNone.
Queue Segment DescriptionThe following Pipeline components must be installed: STSPLOIMToIM.dll
If the segment parameter ‘ReportSysErrsToPub’ is set to 1, errors are sent to if_error table in Offline IM (Sales Audit). Errors will not be found in the Pipeline error queue.
The following document actions are sent from Offline IM to IM:
TroubleshootingNo troubleshooting information is currently available for this segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ReportSysErrsToPub
Report System Errors To Sales Audit
A value of 1 indicates that system errors should be reported to Sales Audit, 0 indicates that these should be reported in Pipeline. We recommend that system errors be reported to Sales Audit to ensure that Sales Audit does not accept (freeze) a store/register/date while there are any outstanding errors for the store/register/date. (This is very important as it will not be possible to modify the transactions for a store/register/date in Sales Audit once they have been accepted.)
No 1
Entity Action Description
PO Receipts (10) Insert (I) The segment uses the data in the Offline IM PO Receipt tables in Sales Audit to create a PO Receipt document in IM. When creating a PO Receipt: / if the receive date is not provided by Offline IM, Pipeline uses the system date as the default value. / the IM PO Receipt document is Received and Posted To IMAT. / if no detail lines with Units Received <> 0 or Units Damaged <> 0 are found, the Offline IM PO Receipt is ignored (i.e., it won’t be posted to IM).
388 Segment Reference
Segment 53005 - Offline IM To IM, Inventory CountsThis segment finds the corresponding Inventory Control document in IM and counts it using the inventory count information coming from Offline IM (Sales Audit).
Segment Parameters
Scheduling RequirementsBefore the segment runs, Inventory Counts must have been sent to Sales Audit from POS.
Database ParametersNone.
Queue Segment DescriptionThe following Pipeline components must be installed: STSPLOIMToIM.dll
If the segment parameter ‘ReportSysErrsToPub’ is set to 1 errors are sent to if_error table in Offline IM (Sales Audit). Errors will not be found in the Pipeline error queue.
The following document actions are sent from Offline IM to IM:
TroubleshootingNo troubleshooting information is currently available for this segment.
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ReportSysErrsToPub
Report System Errors To Sales Audit
A value of 1 indicates that system errors should be reported to Sales Audit, 0 indicates that these should be reported in Pipeline. We recommend that system errors be reported to Sales Audit to ensure that Sales Audit does not accept (freeze) a store/register/date while there are any outstanding errors for the store/register/date. (This is very important as it will not be possible to modify the transactions for a store/register/date in Sales Audit once they have been accepted.)
No 1
Entity Action Description
Inventory Counts (120) Insert (I) The segment uses the data in the Offline IM Inventory Count tables in Sales Audit to find the corresponding Inventory Control document in IM and create a Inventory Count in IM. When creating the Inventory Count: If the inventory control is of type Beginning Inventory, the segment will
reject the count. If any invalid SKUs are provided, the segment will commit the Inventory
Counts and report the rejected SKUs to Offline IM.
Segment 58001 - 58008 Offline IM File Internal 389
Segment 58001 - 58008 Offline IM File InternalThese segments prepare files for polling.
Segment parameters for Segment 58001 - Offline IM File Internal - Prepare EDM & PROD Files
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ActionIdentifier Action Identifier Combined with the value specified for the module identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing enterprise and product data must be moved to the ready directory.
No Prepare
ModuleIdentifier Module Identifier
Combined with the value specified for the action identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing enterprise and product data must be moved to the ready directory.
No EDM&PROD
SourcePath Interface File Directory For Enterprise and Product Data
Should be updated according the specific client configuration. The directory in which the interface files containing enterprise and product data for Offline IM systems are built.
Note: This directory does not contain files being built for the Coalition Store Inventory Tracking application.
No C:\NSB Interface\EDM & PROD to Offline IM File\In Progress
DestPath Prepare File Directory For Enterprise and Product Data
Should be updated according the specific client configuration. The directory in which the enterprise and product interface files that are ready to be submitted for polling to Offline IM systems are placed.
No C:\NSB Interface\EDM & PROD to Offline IM File\Prepare
FileAccessTimeOut File Access Time Out
The maximum amount of time in seconds that the segment will wait to have access to an interface file before aborting the operation.
No 1800
AsyncPolling Using Async Polling Between POS and HO
If set to 1 (True) the system applies an 8 digit sequential number in file name for Legacy Polling for Triversity
No 0
390 Segment Reference
Segment parameters for Segment 58002 - Offline IM File Internal - Prepare POM Files
Segment parameters for Segment 58003 - Offline IM File Internal - Prepare IM Files
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ActionIdentifier Action Identifier Combined with the value specified for the module identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing order transactions must be moved to the ready directory.
No Prepare
ModuleIdentifier Module Identifier
Combined with the value specified for the action identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing order transactions must be moved to the ready directory.
No POM
SourcePath Interface File Directory For Order Transactions
Should be updated according the specific client configuration. The directory in which the interface files containing order transactions for Offline IM systems are built.
No C:\NSB Interface\POM to Offline IM File\In Progress
DestPath Prepare File Directory For Order Transactions
Should be updated according the specific client configuration. The directory in which the order interface files that are ready to be submitted for polling to Offline IM systems are placed.
No C:\NSB Interface\POM to Offline IM File\Prepare
FileAccessTimeOut File Access Time Out
The maximum amount of time in seconds that the segment will wait to have access to an interface file before aborting the operation.
No 1800
AsyncPolling Using Async Polling Between POS and HO
If set to 1 (True) the system applies an 8 digit sequential number in file name for Legacy Polling for Triversity
No 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ActionIdentifier Action Identifier Combined with the value specified for the module identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing inventory transactions must be moved to the ready directory.
No Prepare
ModuleIdentifier Module Identifier
Combined with the value specified for the action identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing inventory transactions must be moved to the ready directory.
No IM
Segment 58001 - 58008 Offline IM File Internal 391
Segment parameters for Segment 58004 - Offline IM File Internal - Submit EDM & PROD Files
SourcePath Interface File Directory For Inventory Transactions
Should be updated according the specific client configuration. The directory in which the interface files containing inventory transactions for Offline IM systems are built.
No C:\NSB Interface\POM to Offline IM File\In Progress
DestPath Prepare File Directory For Inventory Transactions
Should be updated according the specific client configuration. The directory in which the order interface files that are ready to be submitted for polling to Offline IM systems are placed.
No C:\NSB Interface\POM to Offline IM File\Prepare
FileAccessTimeOut File Access Time Out
The maximum amount of time in seconds that the segment will wait to have access to an interface file before aborting the operation.
No 1800
AsyncPolling Using Async Polling Between POS and HO
If set to 1 (True) the system applies an 8 digit sequential number in file name for Legacy Polling for Triversity
No 0
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ActionIdentifier Action Identifier Combined with the value specified for the module identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing enterprise and product data must be moved to the polling directory.
No Submit
ModuleIdentifier Module Identifier
Combined with the value specified for the action identifier, this parameter indicates to the common process that prepares files for Polling, that interface files containing enterprise and product data must be moved to the polling directory.
No EDM&PROD
SourcePath Prepare File Directory For Enterprise and Product Data
Should be updated according to the client configuration. The directory in which the enterprise and product interface files that are ready to be submitted for polling to Offline IM systems are placed.
No C:\NSB Interface\EDM & PROD to Offline IM File\Prepare
NTPollingPath NT Polling Path Should be updated according the client configuration. The directory in which the enterprise and product interface files that have been submitted for polling to Offline IM systems are placed.
No C:\NSB Interface\EDM & PROD to Offline IM File\Polling
392 Segment Reference
Segment parameters for Segment 58005 - Offline IM File Internal - Submit POM Files
BSCPollingPath BSC Polling Path
Should be updated according the client configuration. Base Unix Path from where all the polling reference directories (one per location) will be added. These location directories will receive all the control and data files that will be downloaded to a store. The name of this path must follow the Unix convention: that is, it must use root (“/”) instead of back-slash (“\”). Unix file names are also case-sensitive. This path should be limited to 20 characters or less.
Yes /SYSRES/plmsc/script
PCDirectory PC Directory Should be updated according the client configuration. Directory on the PC where the files will be downloaded at the store.
Yes c:\STS\in\
UnixServer Unix Server Should be updated according the client configuration. Name of the Unix Server where BSC Polling is installed.
Yes commrd
UnixUserName Unix User Name Should be updated according the client configuration. The valid User Name to use to connect to the Unix Server.
Yes root
UnixPassword Unix Password Should be updated according the client configuration. The valid password to use in conjunction with the User Name specified to connect to the Unix server.
Yes commrd
FileAccessTimeOut File Access Time Out
Maximum amount of time in seconds that the segment will wait to have access to an interface file before aborting the operation.
No 1800
UseFileTransfer MiscPath
miscellaneous file transfer
Allows the use of a filename greater than 26 characters for bisync polling path
Yes /SYSRES/EMAIL.FD/misc/script
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ActionIdentifier Action Identifier Combined with the value specified for the module identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing order transactions must be moved to the polling directory.
No Submit
ModuleIdentifier Module Identifier
Combined with the value specified for the action identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing order transactions must be moved to the polling directory.
No POM
Segment 58001 - 58008 Offline IM File Internal 393
SourcePath Prepare File Directory For Order Transactions
Should be updated according the specific client configuration. The directory in which that are ready to be submitted for polling to Offline IM systems are placed.
No C:\NSB Interface\POM to Offline IM File\Prepare
NTPollingPath NT Polling Path Should be updated according the specific client configuration. The directory in which the order transaction interface files that have been submitted for NT polling to Offline IM systems are placed.
No C:\NSB Interface\POM to Offline IM File\Polling
BSCPollingPath BSC Polling Path
Should be updated according the client configuration. Base Unix Path from where all the polling reference directories (one per location) will be added. These location directories will receive all the control and data files that will be downloaded to a store. The name of this path must follow the Unix convention: that is, it must use root (“/”) instead of back-slash (“\”). Unix file names are also case sensitive. This path should be limited to 20 characters or less.
Yes /SYSRES/plmsc/script
PCDirectory PC Directory Should be updated according the client configuration. Directory on the PC where the files will be downloaded at the store.
Yes c:\STS\in\
UnixServer Unix Server Should be updated according the client configuration. Name of the Unix Server where BSC Polling is installed.
Yes commrd
UnixUserName Unix User Name Should be updated according the client configuration. The valid User Name to use to connect to the Unix Server.
Yes root
UnixPassword Unix Password Should be updated according the client configuration. The valid password to use in conjunction with the User Name specified to connect to the Unix server.
Yes commrd
FileAccessTimeOut File Access Time Out
Maximum amount of time in seconds that the segment will wait to have access to an interface file before aborting the operation.
No 1800
UseFileTransfer MiscPath
miscellaneous file transfer
Allows the use of a filename greater than 26 characters for bisync polling path
No /SYSRES/EMAIL.FD/misc/script
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
394 Segment Reference
Segment parameters for Segment 58006 - Offline IM File Internal - Submit IM Files
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ActionIdentifier Action Identifier Combined with the value specified for the module identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing inventory transactions must be moved to the polling directory.
No Submit
ModuleIdentifier Module Identifier
Combined with the value specified for the action identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing inventory transactions must be moved to the polling directory.
No IM
SourcePath Prepare File Directory For Inventory Transactions
Should be updated according the specific client configuration. The directory in which the inventory transactions interface files that are ready to be submitted for polling to Offline IM systems are placed.
No C:\NSB Interface\IM to Offline IM File\Prepare
NTPollingPath NT Polling Path Should be updated according the specific client configuration. The directory in which inventory transaction interface files that have been submitted for polling to Offline IM systems are placed.
No C:\NSB Interface\IM to Offline IM File\Polling
BSCPollingPath BSC Polling Path
Should be updated according the specific client configuration. Base Unix Path from where all the polling reference directories (one per location) will be added. These location directories will receive all the control and data files that will be downloaded to a store. The name of this path must follow the Unix convention: that is, it must use root (“/”) instead of back-slash (“\”). Unix file names are also case sensitive. This path should be limited to 20 characters or less.
Yes /SYSRES/plmsc/script
PCDirectory PC Directory Should be updated according the client configuration. Directory on the PC where the files will be downloaded at the store.
Yes c:\STS\in\
UnixServer Unix Server Should be updated according the client configuration. Name of the Unix Server where BSC Polling is installed.
Yes commrd
UnixUserName Unix User Name Should be updated according the client configuration. The valid User Name to use to connect to the Unix Server.
Yes root
UnixPassword Unix Password Should be updated according the client configuration. The valid password to use in conjunction with the User Name specified to connect to the Unix server.
Yes commrd
Segment 58001 - 58008 Offline IM File Internal 395
Segment parameters for Segment 58007 - Offline IM File Internal - Prepare Descriptor Files
FileAccessTimeOut File Access Time Out
Maximum amount of time in seconds that the segment will wait to have access to an interface file before aborting the operation.
No 1800
UseFileTransfer MiscPath
miscellaneous file transfer
Allows the use of a filename greater than 26 characters for bisync polling path
Yes /SYSRES/EMAIL.FD/misc/script
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ActionIdentifier Action Identifier Combined with the value specified for the module identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing descriptor data must be moved to the ready directory.
No Prepare
ModuleIdentifier Module Identifier
Combined with the value specified for the action identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing descriptor data must be moved to the ready directory.
No Descriptor
SourcePath Source Path Should be updated according the client configuration. The directory in which the interface files containing descriptor data for Offline IM systems are built.
Note: Directory does not contain files being built for the Coalition Store Inventory Tracking application.
Yes C:\NSB Interface\Descriptor to Offline IM File\In Progress
DestPath Destination Path
Should be updated according the client configuration. The directory in which the descriptor interface files that are ready to be submitted for polling to Offline IM systems are placed.
Yes C:\NSB Interface\Descriptor to Offline IM File\Prepare
FileAccessTimeOut File Access Time Out
Maximum amount of time in seconds that the segment will wait to have access to an interface file before aborting the operation.
Yes 1800
AsyncPolling Using Async Polling between POS and HO
If set to 1 (True) the system applies an 8 digit sequential number in file name for Legacy Polling for Triversity
No 0
396 Segment Reference
Segment parameters for Segment 58008 - Offline IM File Internal - Submit Descriptor Files
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
ActionIdentifier Action Identifier Combined with the value specified for the module identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing descriptor data must be moved to the polling directory.
No Submit
ModuleIdentifier Module Identifier
Combined with the value specified for the action identifier, this parameter indicates to the common process that prepares files for Polling that interface files containing descriptor data must be moved to the polling directory.
No Descriptor
SourcePath Source Path Should be updated according the client configuration. The directory in which the descriptor interface files that are ready to be submitted for polling to Offline IM systems are placed.
Yes C:\NSB Interface\Descriptor to Offline IM File\Prepare
NTPollingPath NT Polling Path Should be updated according the client configuration. The directory in which the descriptor interface files that have been submitted for polling to Offline IM systems are placed.
Yes C:\NSB Interface\Descriptor to Offline IM File\Polling
BSCPollingPath BSC Polling Path
Should be updated according the client configuration. Base Unix Path from where all the polling reference directories (one per location) will be added. These location directories will receive all the control and data files that will be downloaded to a store. The name of this path must follow the Unix convention: that is, it must use root (“/”) instead of back-slash (“\”). Unix file names are also case sensitive. This path should be limited to 20 characters or less.
Yes /SYSRES/plmsc/script
PCDirectory PC Directory Should be updated according the client configuration. Directory on the PC where the files will be downloaded at the store.
Yes c:\STS\in\
UnixServer Unix Server Should be updated according the client configuration. Name of the Unix Server where BSC Polling is installed.
Yes commrd
UnixUserName Unix User Name Should be updated according the client configuration. The valid User Name to use to connect to the Unix Server.
Yes root
UnixPassword Unix Password Should be updated according the client configuration. The valid password to use in conjunction with the User Name specified to connect to the Unix server.
Yes commrd
Segment 58001 - 58008 Offline IM File Internal 397
Scheduling RequirementsThese segments should be scheduled in a single job, in the order listed below, with all but the first 3 steps set up to abort the entire job should they fail, because this guarantees referential integrity between the different files exported from the EDM, PROD, POM, and IM modules. Transactions must first be exported from IM (via segment “IM to Offline IM”), then from POM (via segment “POM to Offline IM”, and then from EDM & PROD (via segments “EDM & PROD to PLU”, “EDM & PROD to Offline IM”, and “EDM & PROD to Offline IM, Master Data”) to ensure that all the necessary EDM & PROD data is extracted for the exported POM and IM transactions that reference EDM & PROD data, and all the necessary POM transactions are extracted for the exported IM transactions that referencing POM data. For example, if a style is created in PROD, a PO is created in POM referencing the style, and an ASN is created in IM referencing both the PO and the style, it is important that an export of the ASN from IM, be followed by an export of the referenced PO from POM and an export of the referenced style from PROD before any of the EDM& PROD, POM, or IM interface files are sent to POS, otherwise the exported ASN transaction will be rejected by the Offline IM application because it references a PO or style of which the Offline IM application is not yet aware.Segments “Offline IM File Internal - Prepare IM Files”, “Offline IM File Internal - Prepare POM Files”, “Offline IM File Internal - Prepare EDM & PROD Files” provide an additional level of safety by moving the files generated by segments “IM & to Offline IM”, “POM to Offline IM”, and “EDM & PROD to Offline IM” respectively to temporary directories where they cannot be modified by any manual runs of the segments that may occur before the scheduled job has completed.Finally, segments “Offline IM File Internal - Submit EDM & PROD Files”, “Offline IM File Internal - Submit POM Files”, and “Offline IM File Internal - Submit IM Files” ensure that the files extracted from EDM & PROD are submitted to a directory accessible to Polling for downloading to POS before files extracted from POM, and files extracted from POM are submitted a directory accessible to Polling before files extracted from IM. Offline IM to IM, Outbound Transfer IM to Offline IM Files Offline IM File Internal - Prepare IM Files POM To Offline IM Files Offline IM File Internal - Prepare POM Files EDM & PROD To PLU EDM & PROD To Offline IM Files EDM & PROD To Offline IM Files, Master Data Offline IM File Internal - Prepare EDM & PROD Files Offline IM File Internal – Submit EDM & PROD Files
FileAccessTimeOut File Access Time Out
Maximum amount of time in seconds that the segment will wait to have access to an interface file before aborting the operation.
Yes 1800
UseFileTransfer MiscPath
miscellaneous file transfer
Allows the use of a filename greater than 26 characters for bisync polling path
Yes /SYSRES/EMAIL.FD/misc/script
Parameter NameParameter Display Name
DescriptionModifiable with Pipeline Admin.
Default Value
398 Segment Reference
Offline IM File Internal - Submit POM Files Offline IM File Internal - Submit IM Files
Database ParametersNone.
Non-queue Segment Description These segments call the same component (STSPLOIMFile.dll) that moves the files to
the appropriate destination based on the segment parameters.
Two action identifiers are supported: Prepare:
The files corresponding to the module specified will be moved from the In Progress directory to the ready directory (c:\NSB Interface\Descriptor to Offline IM File\Prepare).
A timestamp will be added to the file name before the extension (1550Descriptor20040302102942.cpm).
The files are moved (not copied) from the source directory. The files will no longer exist in the source directory when the segment finishes running.
Submit: For files generated for Triversity and PC Registers, the merchandising database is
queried (SELECT use_ftp_flag FROM parameter_price_lookup) in order to determine the kind of polling used. If the flag is set, BSC Polling will be used for all the files, otherwise the NT Polling destination will be used to move the files. Files generated for Coalition registers are always transferred using NT Polling.
The first 4 characters of the file name is the polling_reference used to create the Unix sub-directory that will receive the data file and control file when BSC polling is used.
The file extension must be for EDM & PROD and Descriptor module identifiers and for POM, PM and IM module identifiers.
For BSC Polling, the files need to be automatically FTP’d over to a Unix server. STSPLOIMFile.dll will call another component STSNOIFileTransfer.dll.
Troubleshooting If the source or destination directory cannot be accessed, an error displays indicating
that the “Path … is invalid or unavailable”. If the Init call to STSNOIFileTransfer.dll fails, the following error message displays:
"Unable to open connection on the Unix Server." If the BSC Polling Path name + “/” + polling reference (usually 4 char) exceeds 26
characters, the following message will display: "Error in the SetBSCPollingPath, the length of Unix directory should not exceed 26 characters: …”.
If the component doesn’t have create privileges on the Unix server, the following error will display: "Unable to set the BSC Polling path … on the Unix Server."
Segment 60001 - POM & AR to WM 399
Segment 60001 - POM & AR to WMThe segment advises WM of relevant purchase order and distribution transactions that occur in POM and AR.
Segment ParametersNone.
Scheduling Requirements Should be run regularly throughout the day as this is an online interface. Replication queue entries processed by segments “POM & AR to WM” and “IM to WM”
may be rejected to the Pipeline error queue if they reference enterprise or product data not yet interfaced to WM via segment “EDM & PROD to WM”. For example, a PO may be rejected with a message indicating that it references invalid SKUs. These rejections will eventually be reprocessed successfully once segment “EDM & PROD to WM” runs. Scheduling segments “EDM & PROD to WM”, “POM & AR to WM” and “IM to WM” to run consecutively in a single job may reduce the number of such timing-related rejections, but will not completely eliminate them, as users in Merchandising may save POM, AR, and IM documents that reference new enterprise and product entities at the same time that the job is running, that is, while segment “EDM & PROD to WM” is finishing but before segments “POM & AR to WM” and “IM to WM” begin.
Database ParametersNone.
Queue Segment DescriptionThe segment requires the following Pipeline dlls to be installed: STSPLPOMARToWM.dll STSPLBase.dll
Note: The follow entities and actions are published to the Merchandising replication queue, and not the POM replication queue as was the case in earlier releases of Merchandising. These entries are only published when WM is installed on the system and only when the POM or AR transaction is deemed relevant to WM.
WM subscribes to the following entities and actions via this segment:
Entity Action Description
PO (100) WM Open (WO) WM Open is published to the Merchandising replication queue when a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM becomes Open.
WM Update (WU) WM Update is published to the Merchandising replication queue when any of the following occur and the number of items modified on the PO is equal to or greater than 3: A Release or Standalone Bulk or Crossdock PO, whose Receive into
Location uses WM, is modified. The header of a Release or Standalone Bulk or Crossdock PO,
whose Receive into Location uses WM, is modified.
400 Segment Reference
WM Update (WU) (cont’d)
A message of type WM is added to a Release or Standalone Bulk or Crossdock PO with a status of Open, whose Receive into Location uses WM.
A message of type WM is modified on a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM.
A message of type WM is deleted from a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM.
A header level processing code is added to a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM.
A header level processing code is modified on a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM.
A header level processing code is deleted from a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM.
A line is added to a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM.
A line is modified on a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM.
A line is deleted from a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM.
WM Need Re-approval (WN)
WM Need Re-approval is published to the Merchandising replication queue when PO Approval is used, and a Release or Standalone Bulk or Crossdock PO with a status of Open whose Receive into Location uses WM, is modified such that it requires re-approval.
WM Re-approved (WA) WM Re-approved is published to the Merchandising replication queue when PO Approval is used, and a Release or Standalone Bulk or Crossdock PO with a status of Open whose Receive into Location uses WM, is re-approved.
WM Cancel (WC) WM Cancel is published to the Merchandising replication queue when a Release or Standalone Bulk or Crossdock PO with a status of Open, whose Received into Location uses WM, is canceled.
WM Reinstate (WR) WM Reinstate is published to the Merchandising replication queue when a Release or Standalone Bulk or Crossdock PO with a status of Canceled whose Received into Location uses WM, is re-instated.
PO Header (110) WM Update (WU) WM Update is published to the Merchandising replication queue when the header of a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM, is modified. (This only applies if the number of items modified on the PO is less than 3.)
PO Line (120) WM Insert (WI) WM Insert is published to the Merchandising replication queue when a line is added to a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM. (This only applies if the number of items modified on the PO is less than 3.)
WM Update (WU) WM Update is published to the Merchandising replication queue when a line is modified on a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM. (This only applies if the number of items modified on the PO is less than 3.)
Entity Action Description
Segment 60001 - POM & AR to WM 401
WM Delete (WD) WM Delete is published to the Merchandising replication queue when a line is deleted from a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM. (This only applies if the number of items modified on the PO is less than 3.)
PO Message (112) WM Insert (WI) WM Insert is published to the Merchandising replication queue when a message of type WM is added to a Release or Standalone Bulk or Crossdock PO with a status of Open, whose Receive into Location uses WM. (This only applies if the number of items modified on the PO is less than 3.)
WM Update (WU) WM Update is published to the Merchandising replication queue when a message of type WM is modified on a Release or Standalone Bulk or
Crossdock PO whose Receive into Location uses WM. (This only applies if the number of items modified on the PO is less than 3.)
WM Delete (WD) WM Delete is published to the Merchandising replication queue when a message of type WM is deleted from a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM. (This only applies if the number of items modified on the PO is less than 3.)
PO Processing Code (117)
WM Insert (WI) WM Insert is published to the Merchandising replication queue when a header level processing code is added to a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM. (This only applies if the number of items modified on the PO is less than 3.)
WM Update (WU) WM Update is published to the Merchandising replication queue when a header level processing code is modified on a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM. (This only applies if the number of items modified on the PO is less than 3.)
WM Delete (WD) WM Delete is published to the Merchandising replication queue when a header level processing code is deleted from a Release or Standalone Bulk or Crossdock PO whose Receive into Location uses WM. (This only applies if the number of items modified on the PO is less than 3.)
Distribution (300) WM Release (WL) A Distribution whose Shipped From Location uses WM becomes Released.
Entity Action Description
402 Segment Reference
WM Update (WU) WM Update is published to the Merchandising replication queue when any of the following occur and the number of items modified on the Distribution is equal to or greater than the value specified by the parameter* that indicates the items that need to be modified on a Distribution as part of a transaction for it to be preferable for a full Distribution overlay to be sent to WM: A message of type WM is added to a Distribution with a status of
Released whose Shipped From Location uses WM. A message of type WM is modified on a Distribution with a status of
Released whose Shipped From Location uses WM. A message of type WM is deleted from a Distribution with a status of
Released whose Shipped From Location uses WM. A Distribution SKU corresponding to a distribution line of state None
is modified on a distribution with a status of Released whose Shipped From Location uses WM.
A Distribution line of state None is added to a Distribution with a status of Released whose Shipped From Location uses WM.
A Distribution line of state None is modified on a Distribution with a status of Released whose Shipped From Location uses WM.
A Distribution line of state None is deleted from a distribution with a status of Released whose Shipped From Location uses WM.
WM Cancel (WC) WM Cancel is published to the Merchandising replication queue when a Distribution with a status of Released, whose Shipped From Location uses WM, is Canceled.
WM Reinstate (WR) WM Reinstate is published to the Merchandising replication queue when a Distribution with a status of Canceled whose Shipped From Location uses WM is reinstated to a status of Released.
Distribution Line (320)
WM Insert (WI) WM Insert is published to the Merchandising replication queue when a Distribution line of state None is added to a Distribution with a status of Released whose Shipped From Location uses WM. (This only applies if the number of items modified on the Distribution is equal to or greater than the value specified by the parameter* that indicates the number of items that need to be modified on a Distribution as part of a transaction for it to be preferable to send a full Distribution overlay to WM.)
WM Update (WU) WM Update is published to the Merchandising replication queue when any of the following occur and the number of items modified on the Distribution is equal to or greater than the value specified by the parameter* that indicates the items that need to be
WM Update (WU)(cont’d)
modified on a PO as part of a transaction for it to be preferable for a full PO overlay to be sent to WM: A Distribution line of state None is modified on a Distribution with a
status of Released whose Shipped From Location uses WM. A Distribution SKU corresponding to a distribution line of state None
is modified on a distribution with a status of Released whose Shipped From Location uses WM.
A Distribution line of state None is added to a Distribution with a status of Released whose Shipped From Location uses WM.
Entity Action Description
Segment 60001 - POM & AR to WM 403
*This value is set to 2 by default, but a different value can be specified in the following files: ARMainService.config
Nsb.AllocationReplenishment.Review.SystemProcessDistributionProcess.config
Nsb.AllocationReplenishment.Review.VendorReviewProcess.configNsb.AllocationReplenishment.Review.PickReviewProcess.config
The value is specified by adding the following tag to the <configuration><appSettings> section of the files, where the value specified is the number of items that need to be modified on a Distribution as part of a transaction for it to be preferable to send a full Distribution overlay to WM:
<configuration>
<appSettings>
<add key="ARMaxItemsPublishedToMerchReplicationQueueIndividual" value="10" />
</appSettings>
TroubleshootingNo troubleshooting information is currently available for this segment.
WM Delete (WD) WM Delete is published to the Merchandising replication queue when a Distribution line of state None is deleted from a distribution with a status of Released whose Shipped From Location uses WM. (This only applies if the number of items modified on the Distribution is equal to or greater than the value specified by the parameter* that indicates the number of items that need to be modified on a Distribution as part of a transaction for it to be preferable to send a full Distribution overlay to WM.)
Distribution Message (310)
WM Insert (WI) WM Insert is published to the Merchandising replication queue when a message of type WM is added to a Distribution with a status of Released whose Shipped From Location uses WM. (This only applies if the number of items modified on the Distribution is equal to or greater than the value specified by the parameter* that indicates the number of items that need to be modified on a Distribution as part of a transaction for it to be preferable to send a full Distribution overlay to WM.)
WM Update (WU) WM Update is published to the Merchandising replication queue when a message of type WM is modified on a Distribution with a status of Released whose Shipped From Location uses WM. (This only applies if the number of items modified on the Distribution is equal to or greater than the value specified by the parameter* that indicates the number of items that need to be modified on a Distribution as part of a transaction for it to be preferable to send a full Distribution overlay to WM.)
WM Delete (WD) WM Delete is published to the Merchandising replication queue when a message of type WM is deleted from a Distribution with a status of Released whose Shipped From Location uses WM. (This only applies if the number of items modified on the Distribution is equal to or greater than the value specified by the parameter* that indicates the number of items that need to be modified on a Distribution as part of a transaction for it to be preferable to send a full Distribution overlay to WM.)
Entity Action Description
404 Segment Reference
Segment Cross-reference TableThe table below lists segments by subscriber.
Application Segment Number Segment Name Page
Allocation & Replenishment
8000 WM to Merchandising 216
Customer Information Management
1004 EDM & PROD to Customer Info Mgmt 60
EDM & PROD 1008 EDM & PROD Internal – Update Location Status 88
1013 EDM & PROD to Text File 98
1031 EDM & PROD Internal – System Delete Styles 110
1035 EDM & PROD Internal - Make Jurisdiction Available 122
17000 EDM, PROD & POM Import Tables to EDM, PROD & POM 347
16001 Text File to EDM, PROD & POM Import Tables – Import 301
16032 Text File to EDM, PROD & POM Import Tbls - Import Pack 345
General Ledger 6001 Stock Ledger to General Ledger Exp Tbls – Export Trans 204
28000 General Ledger Exp Tables to Text File – Export Trans 367
IMAT 7000 Invoice Matching to Text File 209
7001 Invoice Matching Internal – Exec Outstanding Processes 211
7003 Invoice Matching Internal – System Del Matched Invoice 213
16008 Text File To Invoice Matching Imp Tbls – Imp Invoices 310
22000 Invoice Matching Import Tables to Invoice Matching 359
Inventory Management
3003 IM Internal – System Receive Documents 137
3004 IM Internal – System Delete Documents 138
3006 IM Internal – Post Physical Inventory Counts 141
3008 IM Internal – System Match PO Receipts 142
3010 IM Internal – System Match Unsolicited Receipts 144
3011 IM Internal – System Match RTVs 145
8000 WM to Merchandising 216
16004 TextFile to IM Import - Import UDAs 305
16031 Text File to IM Import Tables – Import ASNs 343
19000 IM Import Tables to IM 355
19010 IM Import Tables to IM - ASN Import 358
53001 Offline IM to IM 381
53002 Offline IM to IM, Outbound Transfers 383
53003 Offline IM to IM, Store Shipment Receipts 385
53004 Offline IM to IM, PO Receipts 387
53005 Offline IM to IM, Inventory Counts 388
Segment Cross-reference Table 405
Infobase 3100 IM to Infobase - Sales Posting 151
8002 WM to Infobase 220
MA 1001 EDM & PROD to MA - Style Retail Startup 51
1005 EDM & PROD to MA 74
1030 EDM & PROD to MA & SL 107
5005 IB to MA – Post Beginning Inventory 181
5010 Infobase to MA –Send Master Entities 190
5100 Infobase to MA - Post Flash 192
5101 Infobase to MA - Post History 194
5102 Infobase to MA - Post Component 196
5103 Infobase to MA - Post On Hand 198
5104 Infobase to MA - Post On Order Allocation 200
5105 Infobase to MA - Initialize 202
6002 Stock Ledger to MA - Send RIM Costs 207
11010 MA Internal - Housekeeping 232
11011 MA Internal – Location Comp Startup 233
11012 MA Internal – Location Comp Update 234
11013 MA Internal – Purge History 235
11014 MA Internal – Alternate Hierarchy Startup 237
11021 MA Internal – History Import, Update Live SKU Hist 238
11022 MA Internal – History Import, Update Live SKU OH Hist 240
11023 MA Internal – History Import, Update Live Color Hist 242
11024 MA Internal – History Import, Upd Live Color OH Hist 244
11025 MA Internal – History Import, Update Live Style Hist 246
11026 MA Internal – History Import, Upd Live Style OH Hist 248
11027 MA Internal – History Import, Update Live Group Hist 250
11028 MA Internal – History Import, Upd Live Group OH Hist 252
11029 MA Internal - History Import, Update Live Group Rim Oh 254
11031 MA Internal – History Import, Summarize SKU Hist 256
11032 MA Internal – History Import, Summarize SKU OH Hist 260
11033 MA Internal – History Import, Summarize Color Hist 264
11034 MA Internal – History Import, Summarize Color OH Hist 267
11035 MA Internal – History Import, Summarize Style Hist 271
11036 MA Internal – History Import, Summarize Style OH Hist 274
11037 MA Internal – History Import, Summarize Group Hist 278
11038 MA Internal – History Import, Summarize Group OH Hist 282
11039 MA Internal - History Import, Summarize Group Rim Oh 286
11041 MA Internal – History Import, Initialize 289
Application Segment Number Segment Name Page
406 Segment Reference
11042 MA Internal – Verify OH Posting 292
11060 MA Internal - Summarize Hist Component at SKU Level 296
11061 MA Internal - Summarize Hist Component Style Clr Lvl 297
11062 MA Internal - Summarize Hist Component at Style Level 298
11063 MA Internal - Summarize Hist Component at Group Level 299
16020 Text File to MA Hist Component Import, All Prod Levels 312
16021 Text File To MA – History Import, Update Imp SKU Hist 315
16022 Text File To MA – History Import, Upd Imp SKU OH Hist 318
16023 Text File To MA – History Import, Upd Imp Color Hist 321
16024 Text File To MA – History Import, Upd Imp Color OH Hist 324
16025 Text File To MA – History Import, Upd Imp Style Hist 328
16026 Text File To MA – History Import, Upd Imp Style OH Hist 331
16027 Text File To MA – History Import, Upd Imp Group Hist 334
16028 Text File To MA – History Import, Upd Imp Group OH Hist 337
16029 Text File to MA - History Import, Upd Imp Grp RIM Oh 340
26001 Merch Planning to MA – Import 363
Offline IM 1032 EDM & PROD to Offline IM File 112
1033 EDM & PROD to Offline IM File, Master Data 115
1034 EDM & PROD to Offline IM File, Startup 118
2000 POM to Offline IM File 128
3012 IM to Offline IM File 146
58001 Offline IM File Internal - Prepare EDM & PROD Files 389
58002 Offline IM File Internal - Prepare POM Files 389
58003 Offline IM File Internal - Prepare IM Files 389
58004 Offline IM File Internal - Submit EDM & PROD Files 389
58005 Offline IM File Internal - Submit POM Files 389
58006 Offline IM File Internal - Submit IM Files 389
58007 Offline IM File Internal - Prepare Descriptor Files 389
58008 Offline IM File Internal - Submit Descriptor Files 389
Planning 1010 EDM & PROD To Merch Planning, Merch Entity 93
1023 EDM & PROD Location Attributes To Planning 104
1009 EDM & PROD to Merch Planning – Send Loc Hierarchy 89
11009 MA to Merch Planning – Send History 221
26000 Merch Planning Internal – Import History and Hierarchy 361
PLU 1006 EDM & PROD To Price Look-up 83
1038 EDM & PROD To Price Look-up File Generate (CRS) 123
1536 EDM & PROD To Price Look-up - File Regenerate 125
Price Management 4000 PM Internal – Issue Documents 156
Application Segment Number Segment Name Page
Segment Cross-reference Table 407
4002 PM Internal – Make Promotional PCs Effective 158
4003 PM Internal – Make Permanent PCs Effective 160
4004 PM Internal – Complete Promotional PCs 162
4005 PM Internal – System Cancel Unapproved Documents 164
4006 PM Internal – System Delete Cancelled and Completed Docs 166
4007 PM Internal – Remove Mix and Match Codes 168
4008 PM Internal – Issue Deal Document 170
4009 PM Internal – Complete Deal Document 172
4010 PM Internal – Delete Completed & Cancelled Deal Docs 174
4011 PM Internal – Update PC Totals 176
4012 PM Internal – PCM Update Locations 178
4013 PM Internal – System Cancel Unapproved Deal Documents 179
16060 Text File To PM Import - Import Price Changes 347
34000 PM Import to PM 380
Purchase Order Management (POM)
2005 POM to EDI Text File 131
Remote Ticket Printing
32000 RTP Internal – System Cancel and Delete RTP Documents 379
Sales Audit 1003 EDM & PROD to Sales Audit 52
11051 MA to Sales Audit - Send Plans to Flash Sales 294
Sourcing 1015 EDM & PROD To Sourcing 102
3009 IM To Sourcing 143
Stock Ledger 5006 Infobase to Stock Ledger – Post Transactions 184
5007 Infobase to Stock Ledger – Stock Ledger Startup 188
16005 Text File to Stock Ledger – Imp Initial CC percentages 307
Warehouse Management
1000 EDM & PROD to WM 46
3000 IM to WM 134
3002 IM to WM, Store Ship Confirmation 136
60001 POM & AR to WM 399
Application Segment Number Segment Name Page
3 Scheduled Jobs
You can use the Server Management that is part of Services Administration, to manage the following jobs in Merchandising: Allocation & Replenishment Purchase Order Management Physical Inventory Product Management Enterprise Selling Enterprise Data Management
Jobs can be added, set to run periodically, and triggered to run immediately.
Note: The Server Manager is used to run many job types. This manual discusses only jobs of type Epicor Retail Server Job. For information about other job types, see the Services Administration User Guide.
Overview 409
OverviewThe Epicor Retail Server Job is a generic job type that runs using Foundation's .NET Services, including security authentication. It can perform a variety of functions; in Merchandising it executes the jobs listed below, primarily for Allocation and Replenishment and Purchase Order Management.
Configuration files for these jobs must contain connection information for the Foundation database. In addition, each job requires certain additional configuration information, as indicated.
The following is an overview of the jobs available. For a more detailed description, including the trace switches for each job and any technical errors that may occur while a specific job is running, see the detailed description of the job later in this chapter.
For troubleshooting purposes, see Troubleshooting Scheduled Jobs on page page 461 for generic errors that may occur when running jobs through Server Management before checking the specific errors that are listed in each job section.
PO Export (Nsb.Purchasing.OrderExport.Exe)This job exports purchase orders from the Merchandising system into an XML data file.
The configuration file must contain an ExportFolder value that indicates the location of the export file.
PO Import (Nsb.Purchasing.OrderImport.Exe)This job imports purchase orders into the Merchandising system from an XML data file.The configuration file must contain an ImportFolder value that indicates the location of the import file.
It must also contain an ImportBluePrint value that indicates a filename and path containing the blueprint mappings of the import file.
PO Cancellation (Nsb.Purchasing.POCancellationScheduler.Exe)This job periodically scans all purchase orders in the Merchandising system and cancels those that satisfy PO cancellation parameters.PO cancellation parameters are set up in Enterprise Data Management.
PO Deletion (Nsb.Purchasing.PODeleteionScheduler.Exe)This job periodically scans all purchase orders in the Merchandising system and deletes those that satisfy PO deletion parameters.
PO deletion parameters are set up in Enterprise Data Management.
Unconfirmed On-order Calculation (Nsb.Purchasing.UnconfirmedOnOrderCalculationScheduledProcess.exe)Nsb.Purchasing.UnconfirmedOnOrderCalculationScheduledProcess.exe reads from on order Sourcing PO's tables and populates unconfirmed on order tables in the MA database.
410 Scheduled Jobs
The configuration file must contain an SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql.
It must also contain a NumberOfThreads value indicating the number of pooled threads on which the job will execute and a MerchGroupBatchSize indicating the number of records to be calculated in one batch when the calculation of unconfirmed on order is at the merch group level.
The execution of this job is meant to be scheduled by the user via SUSM.
PO Mass Modify (Nsb.Purchasing.POMassModifyExE.exe)Job to periodically scan through all the PO Mass Modification jobs in the system and to modify all the POs in the job that satisfy the mass modify parameters, and check if the job’s status is “pending”. The mass modify parameters are set up in the PO Mass Modify Wizard.
PO Cost & Style Cost Modify (Nsb.Purchasing.POCostModsProcess.exe)This job imports changes to style costs and updates both the style master files and POs for the style. It also affects on order cost in Infobase for the balance on order for the style.
The configuration file must contain an ImportFolder value that indicates the location of the import file, which is a tab-delimited .GO file.
Style Mass Modify (Nsb.Product.StyleMassModifyExE.exe:)Job to periodically scan through all the Style Mass Modification jobs in the system and to modify all the styles in the job that satisfy the mass modify parameters, and check if the job’s status is “pending”. The mass modify parameters are set up in the Style Mass Modify Wizard.
Vendor Review (Nsb.AllocationReplenishment.VendorReview.Process.Exe)This job creates purchase orders and distribution documents based on store demand.
The configuration file must contain an SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql.
It must also contain a NumberOfThreads value indicating the number of pooled threads on which the job will execute.
Generate Min/Max Profiles (Nsb.AllocationReplenishment.ScheduledJob.GenerateMinMaxProfilesUsingWOSProcess.Exe)This job creates min/max profiles for items by location, based on weeks of supply.
The configuration file must contain an SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql.
It must also contain a NumberOfThreads value indicating the number of pooled threads on which the job will execute.
Generate Size Scales (Nsb.AllocationReplenishment.SystemGenerateSize Scale.Process.Exe) 411
Generate Size Scales (Nsb.AllocationReplenishment.SystemGenerateSizeScale.Process.Exe)This job determines the distribution of styles by size and color to the locations that will receive them.The configuration file must contain an SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql.It must also contain a NumberOfThreads value indicating the number of pooled threads on which the job will execute.
Auto Delete/Release Distribution Document (Nsb.AllocationReplenishment.Review.SystemProcessDistributionProcess.Exe)This job processes existing distribution documents, and deletes or releases them as appropriate.
The configuration file must contain an SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql.
It must also contain a NumberOfThreads value indicating the number of pooled threads on which the job will execute.
Pick Review (Nsb.AllocationReplenishment.Review.PickReviewProcess.Exe)This job calculates store demand and creates distribution documents based on warehouse on hand.
The configuration file must contain an SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql.
It must also contain a NumberOfThreads value indicating the number of pooled threads on which the job will execute.
Generate Seasonal Indices (Nsb.Forecasting.GenerateSeasonalIndicesScheduledProcess.exe)This job calculates seasonal indices for seasonal profile groups/ locations/years based on annual sales.
The configuration file must contain an SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql.
It must also contain a NumberOfThreads value indicating the number of pooled threads on which the job will execute.
412 Scheduled Jobs
Ranking Group Import (Nsb.AllocationReplenishment.RankingGroupImportProcess.exe)This job imports externally-prepared location ranking groups into the Merchandising system from an xml or csv file.
Import Queued Counts (PIQueuedCountScheduledJob.exe)This job imports the counts that were submitted through the Send File for Offline Import action in Physical Inventory allowing counts to be batched, rather than imported on the fly.The configuration file must contain an SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql.It must also contain a NumberOfThreads value indicating the number of pooled threads on which the job will execute.
Adjust Lost and Extra Sales (Nsb.Forecasting.AdjustLostAndExtraSalesScheduleProcess.exe)This job posts lost and extra sales figures for the style and merch group based on the results of the Nsb.Forecasting.CalculateLostAndExtraSalesScheduleProcess.exe scheduled job.
The configuration file must contain a SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql.
It must also contain an AdjustLostAndExtraSalesNumberOfThreads value indicating the number of pooled threads on which the job will execute.
Calculate Lost and Extra Sales (Nsb.Forecasting.CalculateLostAndExtraSalesScheduledProcess.exe)This job calculates lost and extra sales.
The configuration file must contain an SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql.
It must also contain the following:a CalculateLostAndExtraSalesNumberOfThreads value indicating the number of pooled threads on which the job will execute.
a CalculateLostAndExtraSalesMerchGroupBatchSize value indicating the number of records to be calulated in one batch when the calculation of lost and extra sales is at the merch group level.
a CalculateLostAndExtraSalesStyleBatchSize value indicating the number of records to be calulated in one batch when the calculation of lost and extra sales is at the style level.
Generate Sales Forecast (Nsb.Forecasting.GenerateSalesForecastScheduledProcess.exe)This job generates sales forecasts for item/locations based on a schedule you define. If the EDM Allocation and Replenishment Parameter (Forecast tab) Auto-update min/max
Generate Store Shipments (Nsb.AllocationReplenishment.GenerateStoreShipmentsScheduledProcess.exe) 413
profiles from forecasts is selected, this job will also update the dynamic min/max profile for all SKU/store locations belonging to the forecasted item/location (including items that are the primary style color of a comparable set).
The configuration file contains the following:
an SqlBatchMode value indicating to Foundation database classes how to execute batches of SQL statements. Possible values are Binding, ParameterSql and NoParameterSql. Default is “Binding”.
a BatchSize value indicating the number of item/locations to be forecast in a batch. a NumberOfThreads value indicating the number of pooled threads on which the job will execute.
a WriteBatch value indicating the number of records to be written to the database in one batch after forecasting is complete.
a ForecastTimeout value that indicates how long the forecast job should be allowed to run before it throws an error.
Generate Store Shipments (Nsb.AllocationReplenishment.GenerateStoreShipmentsScheduledProcess.exe)This job creates store shipments for selected distributions, relieving the warehouse of the allocated inventory, and moving it from the warehouse to a store. It is executed on the specific date that you specify in A&R as part of the normally scheduled jobs for the day.
Generate Store Transfers (Nsb.AllocationReplenishment.GenerateStoreTransfers.exe)This job creates store transfers for selected distributions. It is executed on the date you specify with the normally scheduled jobs for the day.
IMRD Submit (SubmitIMRDProcess.exe)This job submits IMRDs that the user has selected.
Merchandising Export Financials to E9 (Nsb.Merchandising. Financials.exe)This job processes the text files output from Segments 7000 and 28000, creates xml files for input to E9 Financials, and moves GL and IMAT information from source to destination queues for interfacing from E9 to Merchandising.
414 Scheduled Jobs
Enterprise Selling Generate Refresh Files (Nsb.EnterpriseSelling.GenerateRefreshFiles.exe )This job retrieves data from EDM & PROD, places them into Enterprise Selling data feed files, and sends them down to Enterprise Selling on a nightly basis. The files are: Outlet Refresh: the file includes all locations defined in the Merchandising system,
regardless of location type or whether the location is active or inactive. SKU Refresh: The file includes all SKUs whose style status is Received regardless of
the SKU type or whether the SKU is active or inactive. This file includes a SKU ID and UPC.
Outlet-SKU Cross Reference: The file includes the OH for each SKU/Location, for which the SKU’s style status is Received.
Outlet Group Refresh: all location groups that belong to the location hierarchy level selected as the grouping identifier for ES are exported. For example, if Region is the grouping identifier, then this file will contain all the region groups.
Outlet Group Cross Reference: all locations defined in the system cross-referenced to identifier of the location group they belong to are exported. All location types are included; alllocations, whether active or inactive, are included.
This job should be scheduled to run after completion of the Sales Posting job and Warehouse Pick job (if applicable). Make sure that it doesn't run when Nsb.EnterpriseSelling.SendInventoryMovements.exe is running.InProgressPath defines the path to the temporary directory in which the files are being generated prior to being sent to the ES server. By default, is set to C:\NSB Interface\ES Interface\In Progress. The directory specified must exist.BatchSize defines the number of records that should be read from Merchandising and sent to Enterprise Selling within each transaction. Defaults to 1000000. This value can be changed based on performance requirements.
Enterprise Selling Send Inventory Movements (Nsb.EnterpriseSelling.SendInventoryMovements.exe Enterprise Selling requires that On-Hands be updated throughout the day so that customer order reservations can be based on real-time information. This avoids reserving items that have already been sold during the day or are in process of being transferred and allows ES to take into account shipments that have been received during the day.
This job calls an Enterprise Selling web service to send down the inventory movements to Enterprise Selling. Once initiated, this job will publish the net effect of the inventory movements for each sku/location since last generation.
You schedule the frequency at which the inventory movements are sent to Enterprise Selling (i.e. every 5 minutes). This job must not run while Nsb.EnterpriseSelling.GenerateRefreshFiles.exe is running.
BatchSize indicates the number of records that should be read from Merchandising and sent to Enterprise Selling within each transaction. Defaults to 1000000. This value can be changed based on performance requirements.
Create Employee Import Files (Nsb.EnterpriseDataManagement.EmployeeImportProcess.exe) 415
Create Employee Import Files (Nsb.EnterpriseDataManagement.EmployeeImportProcess.exe)This job gives a client the option of providing one employee import file (XML format) instead of the 3 separate import files usually required to load employees into Merchandising, POS and CRDM. This job will pick up the XML file and split it up into the 3 standard import files required by the applications. The files are then put into a designated folder as defined by the user (config parameter). Once the job is executed, the current import mechanism that is used to load employees into each application is still required to complete the process.
Merch Extension Queue Process (Nsb.Merchandising.ExtensionQueueProcess.exe.config)This job handles calling Foundation Extensions (for example, sending MSMQ messages) for all documents that get modified by the following jobs: ASN Import Price Change Import Price Change Issue PO Cost and Style Cost Modify
This job must be scheduled to run periodically (at least after any of above jobs have been executed). Applies only to clients sites who have been configured to use Foundation extensions.
416 Scheduled Jobs
Scheduling JobsMachine and Server names will vary from one Merchandising installation to another.
Accessing the Merchandising server1. Launch Services Administration from the Epicor Retail Start Page.
2. Click Server Manager > Job Scheduler and find your machine name in the machine list.3. Click the machine name and then the server name.
4. Ensure that its current status is Active: the Server Status traffic light will be green.
Detailed information about Server Management is provided in the Services Administration User Guide.
Add New Job windowTo add a new jobs:
1. Click Add New Job and enter the name of the job you want to add.
2. Then select the type of job. The scheduled jobs for POM, A&R, Physical Inventory and Product Management are Epicor Retail.
3. Click OK. The Details window for the job appears:
4. Enter the appropriate information for your job. Information required in the Details fields varies, depending on the job type selected. This chapter describes only information required for jobs of type Epicor Retail job.Specific settings, such as the file name component of Command Line, for individual jobs are listed below.
Job Info tab
Active Select this check box to activate the job; otherwise, it will not run.
Job Name User-defined description that identifies the job.
Add New Job window 417
5. Use the Schedule tab to define a schedule for running the job. It is also possible to force a job to run immediately from this tab.
Command Line Full path and file name of the job to be run. To create a scheduled job for order import, for example, you enter a command line similar to this: C:\Program Files\NSB Group\Merchandising 3.0\Purchase Order Management\Client\ Nsb.Purchasing.OrderImport.exe The actual path will vary, depending on where the files were installed on your machine.
Username Name of the user to be used to authenticate the job. For more information about users, see Services Administration User Guide.
Password / Confirm Password
Password of the user to be used to authenticate the job. Enter the password a second time to confirm that it is correct.
Company Id Unique numeric identifier for the company to be used to authenticate the job. For more information about companies, see Services Administration User Guide.
Max. number of threads
Enter the maximum number of asynchronous server threads that can run simultaneously for this one job. The value depends on processing demand on the server.
Next Job to perform
Enables the job to be linked to another job. Select a job from the drop-down list. When the current job is complete, the selected job will execute, even if it is on an inactive server or the Job Shelf, or has inactive status.
Job Schedule tab
Set number of execution times
Select this option if you want the job to run a specified number of times. This option is also used if you need to run a job immediately.
Number of times to execute
Enter the number of times that the job should run. This value must be higher than Number of times actually executed; otherwise, the job will not run.
Number of times actually executed
System-maintained. Indicates how many times the job has already run.
Set the time of the Job
Select this option if you want the job to run on a specific schedule.
Start date/time The date and time that the job is to run. Click the parts of the time or the day and year to change them.
End date/time Select to set a date/time that the job is to cease running. Click the parts of the time or the day and year to change them.
Next date/time System maintained. The date/time that the job will run next. It is set when you save a job schedule and reset each time that the job runs.
Interval (count) The number of intervals to elapse between occurrences of the job. Works with Interval (type). If a job is to run every 3 hours, this value would be 3.
Job Info tab
418 Scheduled Jobs
6. On the Date tab, you can identify specific days and periods when you don't want the job to run as scheduled.
Clear the box corresponding to each day, date, month or week when the job should not run. For example, to prevent the job from running on Saturdays and Sundays, clear the boxes for Saturday and Sunday in Days of Week.
7. On the Time tab, define one or more periods within a 24-hour day when the job should run. For instance, to run a job only between 10:00 pm and 3:00 am, define two periods, one from 10:00 pm to 12:00 am and the other from 12:00 am to 3:00 am. Periods when the job will run are indicated on the 24-hour clock graphic; yellow indicates morning periods and blue indicates evening periods.
Click Add to enter a timeframe, then click Update to save the change and update the graphic. The times you define are shown in green around the inside of the clock.
Interval (type) The type of interval to elapse between occurrences of the job. Works with Interval (count). Select one of the following from the list: Minutes Hours Days Weeks
Job Schedule tab
Scheduling a job 419
8. On the Trace tab, define whether you want the error and execution trace files to be saved and what information they should contain.
9. Save your definition.
Scheduling a job1. Click the Job Schedule tab.2. Select Set the time of the Job.
3. Enter a Start date/time to set the first time to run the job.
4. Set an Interval count and Interval type.
5. If required, enter an End date/time to set the final time to run the job.6. If required, click Date and/or Time and do the following:
In Date, clear the box for each day, week and/or month when you don't want the job to run.
In Time, click Add and enter a Start Time and End Time for each period when you want the job to run. Then click Update.
7. Save your changes..
Running a job immediately1. Click the Job Schedule tab.
2. Click Set Number of Execution times.3. Press F5 to refresh job status.
4. Set the value in Number of time to execute one higher than the value in Number of times actually executed.
5. Save your changes.
6. Monitor the status of the job by pressing F5 periodically.When the white job icon in the server list turns green, the job is currently running. This indicator can lag the actual start of the job by a few seconds, because the refresh rate may be slow.When the Number of time to execute is the same value as Number of times actually executed, the job has completed.
If the job was successful, the job icon returns to its original color. If it turns red, an error occurred. To view the error, click Last Execution Trace and Last Execution Error from the Navigation bar.
420 Scheduled Jobs
Mass Modify scheduled jobs for A&RWhen new locations are added for your company, the location must be added to all schedules. You can select the schedules that must be changed, specify the new location and execute the mass modify to add the location to all the schedules you specified. This procedure can be run against schedules for: Generate size scales Min/max profiles Vendor review Pick ReviewFor instructions about mass modifying scheduled jobs, see "Scheduled Processes" in the Allocation & Replenishment User Guide.
Job SettingsAll these jobs can be scheduled using whatever settings are most appropriate for Start Date, Start Time, Interval Count and Interval Type.
Allocation & Replenishment
Job File Name
Generate Size Scales Nsb.AllocationReplenishment.SystemGenerateSizeScale.exe
Generate Min/Max Profiles Nsb.AllocationReplenishment.ScheduledJob.GenerateMinMaxProfilesUsingWOSProcess.exe
Vendor Review Nsb.AllocationReplenishment.Vendor.Review.Process.exe
Pick Review Nsb.AllocationReplenishment.Review.PickReviewProcess.exe
Auto Delete/Release Distribution Document
Nsb.AllocationReplenishment.Review.SystemProcessDistributionProcess.exe
Generate Seasonal Indices Nsb.Forecasting.GenerateSeasonalIndicesScheduledProcess.exe
Calculate Lost and Extra Sales Nsb.Forecasting.CalculateLostAndExtraSalesScheduledProcess.exe
Adjust Lost and Extra Sales Nsb.Forecasting.AdjustLostAndExtraSalesScheduleProcess.exe
Generate Sales Forecast Nsb.Forecasting.GenerateSalesForecastScheduledProcess.exe
Purchase Order Management 421
The following A&R jobs must use the following settings:
Purchase Order Management
Product Management
Inventory Management
Start Date: Next day.
Start Time: After sales posting has completed. (If sales posting occurs only during a specified period, use Time Restrictions to prevent scheduling conflicts.)
Interval Count: 1
Interval Type: Days
Job File Name
Ranking Group Import Nsb.AllocationReplenishment.RankingGroupImportProcess.exe
Generate Store Transfers Nsb.AllocationReplenishment.GenerateStoreTransfers.exe
Generate Store Shipments Nsb.AllocationReplenishment.GenerateStoreShipmentsScheduledProcess.exe
Job File Name
PO Import Nsb.Purchasing.OrderImport.exe
PO Export Nsb.Purchasing.OrderExport.exe
PO Cancellation Nsb.Purchasing.PoCancellationScheduler.exe
PO Deletion Nsb.Purchasing.PoDeleteionScheduler.exe
Unconfirmed On-order Calculation Nsb.Purchasing.UnconfirmedOnOrderCalculationScheduledProcess.exe
PO Mass Modify Nsb.Purchasing.POMassModifyExE.exe
PO Cost & Style Cost Modify Nsb.Purchasing.POCostModsProcess.exe
Job File Name
Style Mass Modify Nsb.Product.StyleMassModifyExE.exe
Job File Name
Import Physical Inventory Queued Count PIQueuedCountScheduledJob.exe
Submit IMRD SubmitIMRDProcess.exe
422 Scheduled Jobs
EDM
Enterprise Selling
General
Purchase Order Management Scheduled JobsThese are the POM scheduled jobs: PO Import PO Export PO Cancellation PO Deletion Unconfirmed On-order Calculation PO Mass Modify Style Mass Modify PO Cost & Style Cost Modify
Job File Name
Create Employee Import Files Nsb.EnterpriseDataManagement.EmployeeImportProcess.exe
Job File Name
Enterprise Selling Send Inventory Movements Nsb.EnterpriseSelling.SendInventoryMovements.exe
Enterprise Selling Generate Refresh Files Nsb.EnterpriseSelling. GenerateRefreshFiles.exe
Job File Name
Merch Extension Queue Process Nsb.Merchandising.ExtensionQueueProcess.exe.config
Merchandising Export Financials to E9 Nsb.Merchandising.Financials.exe
PO Import 423
PO ImportNsb.Purchasing.OrderImport.exe processes an XML file to perform the following actions on the POs contained in the XML file: Create Modify Submit Approve Cancel Reinstate Delete RejectWhen performing a cancel or a delete using the PO Importer, only the documents indicated in the XML file will be canceled/deleted. The system will check those documents against the business rules and cancel/delete them as appropriate. This is the same as canceling or deleting a document POM.
The PO Cancellation and PO Deletion scheduled jobs are different. They check the entire database and generate a list of candidates that should be canceled/deleted based on the system parameters; the process then cancels/deletes the purchase orders one by one.The associated config file for this executable is Nsb.Purchasing.OrderImport.exe.config. The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switches
Switch Purpose of Switch Comments
OrderMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
ImportBp If this switch is enabled, when the system is processing the XML blueprint file, detailed entries are added at every step.
Setting this switch to ON (1) is useful if the blueprint file is either improperly formatted or incomplete.
OrderMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
OrderPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
424 Scheduled Jobs
Possible Order Import error messagesThe errors listed in the table below are specific to the Order Import job. For other error messages, see Troubleshooting Scheduled Jobs on page 461.
PO ExportNsb.Purchasing.OrderExport.exe exports purchase orders to an XML file. The associated config file for this executable is Nsb.Purchasing.OrderExport.exe.config. The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switches
ImportLoad If this switch is enabled, entries will be added to the trace file throughout the import process.
Setting this switch to ON (1) is useful in determining where an error occurs while importing orders.
Switch Purpose of Switch Comments
Error Cause Solution
Could not find a part of the path "C:\MyImportFolder\"
The import folder specified in the .config file doesn't exist.
Ensure that Nsb.Purchasing.OrderImport.exe.config contains a valid import folder name.
No import data file can be found in “C:\MyImportFolder\”
The import folder doesn't contain any valid XML PO documents.
Ensure that valid XML PO documents are located in the specified import folder.
Could not find file "C\POMImportBlueprint.xml"
The blueprint file can't be found. Ensure the blueprint file exists in the folder specified in the .config file.
Switch Purpose of Switch Comments
OrderMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
OrderMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
Possible Order Export error messages 425
Possible Order Export error messagesThe errors listed in the table below are specific to the Order Export job. For other error messages, see Troubleshooting Scheduled Jobs on page 461.
PO CancellationNSB.Purchasing.PoCancellationScheduler.exe looks for POs that meet parameterized criteria for cancellation and sets their status to Cancelled. The associated config file for this executable is Nsb.Purchasing.PoCancellationScheduler.exe.config. The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switchesFor a list of errors you may receive, see Troubleshooting Scheduled Jobs on page 461.
OrderPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Export If this switch is enabled, entries will be added to the trace file throughout the export process.
Setting this switch to ON (1) is useful in determining where an error occurs while exporting .
Switch Purpose of Switch Comments
Error Cause Solution
Access to the path "C:\MyExportPath\MyExportFile.xml" is denied.
The Windows® account calling the job doesn't have write access to the export folder.
In Windows Explorer, give the account write access to the folder.
Switch Purpose of Switch Comments
OrderMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
OrderMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
426 Scheduled Jobs
PO DeletionNSB.Purchasing.PoDeleteionScheduler.exe checks for POS that meet parameterized criteria for deletion and removes them from the system. The associated config file for this executable is Nsb.Purchasing.PoDeletionScheduler.exe.config. The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switchesFor a list of errors you may receive, see Troubleshooting Scheduled Jobs on page 461.
Unconfirmed On-order CalculationNsb.Purchasing.UnconfirmedOnOrderCalculationScheduledProcess.exe will: trigger the calculation of the latest unconfirmed on order figures in the Sourcing
database copy those figures to the MA database, and uses the figures to populate summary tables in MA that can be used for reporting
purposes.
OrderPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Switch Purpose of Switch Comments
Switch Purpose of Switch Comments
OrderMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
OrderMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
OrderPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Config file switches 427
The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switchesErrors are written to a log file whose path is defined in the config file.
PO Mass ModifyNSB.Purchasing.POMassModifyExE.exe periodically scans all the PO Mass Modification jobs in the system and modifies all the POs in the job that satisfy the mass modify parameters, and checks if the job’s status is “pending”. The mass modify parameters are set up in the PO Mass Modify Wizard. The associated config file for this executable is Nsb.Purchasing.POMassModify.exe.config.
The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Switch Purpose of Switch Comments
OrderMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
OrderMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
OrderPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
ImportBp If this switch is enabled, when the system is processing, detailed entries are added at every step.
Setting this switch to ON (1) can be useful if there is an error.
ImportLoad If this switch is enabled, entries will be added to the trace file throughout the process.
Setting this switch to ON (1) is useful in determining where an error occurs.
428 Scheduled Jobs
Config file switchesFor a list of errors you may receive, see Troubleshooting Scheduled Jobs on page 461.
Style Mass ModifyNSB.Product.StyleMassModifyExE.exe periodically scans all the Style Mass Modification jobs in the system and modifies all the styles in the job that satisfy the mass modify parameters, and checks if the job’s status is “pending”. The mass modify parameters are set up in the Style Mass Modify Wizard. The associated config file for this executable is Nsb.Product.StyleMassModify.exe.config. The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switchesFor a list of errors you may receive, see Troubleshooting Scheduled Jobs on page 461.
Switch Purpose of Switch Comments
OrderMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
OrderMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
OrderPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Switch Purpose of Switch Comments
OrderMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
OrderMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
PO Cost & Style Cost Modify 429
PO Cost & Style Cost ModifyNsb.Purchasing.POCostModsProcess.exe processes a tab-delimited .GO file to update the styles' current costs, last net PO cost and last net final PO cost and the PO cost for the styles on any POs containing the styles. The associated config file for this executable is Nsb.Purchasing.POCostModsProcess.exe.config. The configuration file indicates: the trace file name and where it can be found; where the foundation.config file and ServerObjectFactory.config file can be found; the database server and Foundation database server used to run the application..
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run
Config file switches
OrderPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Switch Purpose of Switch Comments
Detail Description
Executable name Nsb.Purchasing.POCostModsProcess.exe
Typical location D:\Epicor\Services\Mer4.3\
Configuration file name Nsb.Purchasing.POCostModsProcess.exe.config
Input file name format <anything>.GO
Output Files If there are no errors, the input file will be renamed to <originalFilename>.StylePOCost.<DateTime>.SUCCEEDEDFor example: TC.GO.StylePOCost.20110121124741.SUCCEEDED
If there are errors, the input file will be renamed to <originalFilename>.StylePOCost.<DateTime>.FAILEDFor example: TC.GO.StylePOCost.20110121124741.FAILEDThe .FAILED file is the complete input file, so it contains not only the lines that failed, but those that succeeded as well.
If there are errors, an error file containing detailed information will be generated and called: <originalFilename>.StylePOCost.<DateTime>.ERROR.For example:e.g. TC.GO.StylePOCost.20110121124741.ERROR
Switch Purpose of Switch Comments
OrderMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
430 Scheduled Jobs
A&R Scheduled JobsThe scheduled jobs for A&R are: Generate Size Scales Generate Min/Max Profiles Vendor Review Pick Review Auto delete/Release Distribution Document Generate Seasonal Indices Adjust Lost and Extra Sales Calculate Lost and Extra Sales Generate Sales Forecasts Ranking Group Import Generate Store Transfers Generate Store Shipments
Generate Size Scales Nsb.AllocationReplenishment.SystemGenerateSizeScale.Process.exe processes an XML file to generate size scales. The associated config file for this executable is Nsb.AllocationReplenishment.SystemGenerateSizeScale.Process.exe.config. The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.
OrderMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
Errors If this switch is enabled, errors encountered are written to the trace file.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
OrderPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Switch Purpose of Switch Comments
Config file switches 431
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switches
Possible error messages for Generate Size ScaleThe errors listed in the table below are specific to the Generate Size Scales job. For a list of other errors, see Troubleshooting Scheduled Jobs on page 461.
Switch Purpose of Switch Comments
ARMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
ARMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set to ON (1), the system writes the error message defined in the code to the trace file. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Error Message Cause Solution
A System Generate Size Scale Process is already running; can't run more than one System Generate Size Scale at the same time.
The system can run only one size scale job at a time and one is already running.
Try the job again later.
Following Exception(s) occurred: Type of Exception:NsbSystemTechnicalExceptionException Message: An error occurred during authentication: 'Error validating security data: invalid ApplicationID/CompanyID combination.'.Exception Source: NsbSystem.Security
The user name and password used to create the job failed validation .
Through Server Manager, check that the user name and password exist in the security table, that they match those associated with the job and that the user has access to the company specified in the job.
Nothing due, ending size scale parameters review process...
This is not error. The parameter defining the next time/date for the Generate Size Scale job does not match the server date/time and/or server name where the job is running.
Check that the values of Next Run Date and Application Server Name in A&R/Schedules/Size Scale are correct.
432 Scheduled Jobs
Generate Min/Max Profiles Nsb.AllocationReplenishment.ScheduledJob.GenerateMinMaxProfilesUsingWOSProcess.exe processes an XML file to generate min/max profiles using weeks of supply. The associated config file for this executable is Nsb.AllocationReplenishment.ScheduledJob.GenerateMinMaxProfilesUsingWOSProcess.exe.config. The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switches
Possible error messages for Generate min/max profiles The errors listed in the table below are specific to the Generate Min/Max Profiles job. For a list of other errors, see Troubleshooting Scheduled Jobs on page 461.
Switch Purpose of Switch Comments
ARMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
ARMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set to ON (1), the system writes the error message defined in the code to the trace file. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Error Message Cause Solution
“The Min Max Profiles Generation Process is already running, can't run more than one at the same time.”
The system can run only one Generate min/max job at a time and there is one running already.
Try to run the job later.
XML file layout 433
XML file layout
Opening tagsAt the beginning of the file
<?xml version="1.0" encoding="utf-8" ?>
<Nsb.AllocationReplenishment>
<MinMaxProfileList>
MinMaxProfile ElementFor each Min Max Profile
Nothing due; ending Generate Min Max Profiles process ...
The parameter defining the next time/date for the Generate min/max profiles job does not match the server date/time and/or server name where the job is running.
Check that the values of Next Run Date and Application Server Name in A&R/Schedules/Size Scale are correct.
Cannot generate Min Max Profiles from a Forecast when the Coverage Period method is based on Actual Sales WOS; ending Generate Min Max Profiles process ...
Min/max profiles can't be generated from forecasts whose Generate method parameter (Enterprise Data/Parameters/Allocation Replenishment/Forecast) is set to Actual sales using WOS.
As designed.
The Forecast contains no style/locations; ending Generate Min Max Profiles process ...
A sales forecast for the SKU/store or its parent does not exist, so the min/max profile will not be generated.
As designed.
Error Message Cause Solution
Attribute name Type Description Mandatory
StyleCode String Style Code of the SKU Mandatory
ColorCode String Color Code of the SKU Mandatory
SizeCode String Size Code of the SKU Mandatory
LocationCode String Location Code Mandatory
PresentationStock Integer Presentation Stock Optional
CapacityMaximum Integer Capacity Maximum Optional
Minimum Integer Minimum Optional; initially defaulted to 0
Maximum Integer Maximum Optional; initially defaulted to 0
OrderPoint Enumerated (Minimum or Maximum)
Order Point: Minimum or Maximum Optional; initially defaulted to Minimum
InclPresStockWithOrdPtFlag
Boolean (true or false)
Include Presentation Stock With Order Point Flag
Optional; initially defaulted to false
434 Scheduled Jobs
Optional AttributesIf any of the optional attributes is provided with a value of empty string, it is assumed that that attribute needs to be set to null.
Any optional attribute that is not provided will not be updated. However, when a Min Max Profile is saved for the first time, initial default value will be used if one is not provided.
Closing tagsAt the end of the file:
</MinMaxProfileList>
</Nsb.AllocationReplenishment>
Example<?xml version="1.0" encoding="utf-8" ?>
<Nsb.AllocationReplenishment>
<MinMaxProfileList><MinMaxProfile StyleCode="100000050" ColorCode="001" SizeCode="30" LocationCode="0033" PresentationStock="10" CapacityMaximum="30" Minimum="8" Maximum="40" OrderPoint="Minimum" InclPresStockWithOrdPtFlag="true"/>
<MinMaxProfile StyleCode="100000050" ColorCode="004" SizeCode="30" LocationCode="0033" PresentationStock="10" CapacityMaximum="30" Minimum="8" Maximum="40" OrderPoint="Minimum"InclPresStockWithOrdPtFlag="true" />
</MinMaxProfileList>
</Nsb.AllocationReplenishment>
PerformanceOrder MinMaxProfile Elements by Style Code to maximize the performance of the import.
ErrorsErrors will be logged to an error file in the same format, with Errors attribute indicating the error. This file will contain only entries that failed to save. The name of the error file will be: <OriginalFileName>.Errors.xml. For example, if the original file were C:\Import\MinMaxProfiles.xml, the error file would be C:\Import\MinMaxProfiles.xml.Errors.xml. An exception will be thrown to indicate that such file was produced. This new file could be fixed and reprocessed.
Vendor Review Nsb.AllocationReplenishment.VendorReview.Process.exe processes an XML file to generate vendor orders. The associated config file for this executable is Nsb.AllocationReplenishment.VendorReview.Process.exe.config. The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.
Config file switches 435
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switches
Possible error messages for Vendor ReviewThe errors listed in the table below are specific to the Vendor review job. For a list of other errors, see Troubleshooting Scheduled Jobs on page 461.
Switch Purpose of Switch Comments
ARMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
ARMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set to ON (1), the system writes the error message defined in the code to the trace file. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Error Message Cause Solution
A Vendor Review Process is already running, can't run more than one Vendor Review at the same time.
The system can run only one vendor review job at a time and there is already one running.
Try to run the job later.
Nothing due, ending Vendor Review process...
The parameter defining the next time/date for the Vendor Review job does not match the server date/time and/or server name where the job is running. OR The criteria for some business rule has not been satisfied.
Check that the values of Next Run Date and Application Server Name in A&R/Schedules/Size Scale are correct. Verify the business rule criteria:The style must be active and replenishable, and the vendor must be the primary vendor for the style.If Location type = store, then the merchandise ResultingPOPredistribType must be one of Dropship, Crossdock or BulkPreAllocated If Location type = Warehouse or DistributionCenter, the merchandise ResultingPOPredistribType must be Bulk.
436 Scheduled Jobs
Pick Review Nsb.AllocationReplenishment.Review.PickReview.Process.exe processes an XML file to generate pick slips for the warehouse. The associated config file for this executable is Nsb.AllocationReplenishment.Review.PickReview.Process.exe.config. The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switches
Could not find Parameter The Vendor Review parameter for this style ID can't be found.
Requires development attention.
Style XXX ResultingPOPredistribType is undefined.
The ResultingPOPredistribType type defined for the style in the Vendor Order parameter (Style Maintenance/General tab) is incorrect .
In Merchandising, retrieve the style from Product and make the necessary correction.
...Error creating PO and saving document: ...
This error indicates that a possible database exception has occurred when saving the document and updating the To Do List; it could also indicate that a deadlock has been encountered.
Retry the transaction. If the error recurs, bring to the attention of development.
Error saving document This error results from either one of the conditions described in Troubleshooting Scheduled Jobs in this manual or the violation of a business rule.
If the information in Troubleshooting Scheduled Jobs or the trace file is insufficient to help resolve the problem, bring to the attention of development.
Style with id XXX and location with id XXX are not linked to any warehouse.
In Merchandising, set up the Distribution parameters (Allocation Replenish/Table Maintenance/Lead Times/Warehouse).
Error Message Cause Solution
Switch Purpose of Switch Comments
ARMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
ARMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. We recommend that this switch be ON at all times.
Possible error messages for warehouse pick review 437
Possible error messages for warehouse pick reviewThe errors listed in the table below are specific to the Pick Review job. For a list of other errors, see Troubleshooting Scheduled Jobs on page 461.
Auto Delete/Release Distribution DocumentNsb.AllocationReplenishment.Review.SystemProcessDistributionProcess.exe processes an XML file to delete and release distribution documents. The associated config file for this executable is Nsb.AllocationReplenishment.Review.SystemProcessDistributionProcess.exe.config. The configuration file indicates the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application.If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
ARErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set to ON (1), the system writes the error message defined in the code to the trace file. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Switch Purpose of Switch Comments
Error Message Cause Solution
“A Pick Review Process is already running, can't run more than one Pick Review at the same time.”
The system can run one warehouse pick review job at a time and there is already one running.
Try to run the job later.
“Nothing due, ending Pick Review process...”
Pick review job does not match the server date/time and/or server name where the job is running. OR The criteria for some business rules have not been satisfied.
Check that the values of Next Run Date and Application Server Name in A&R/Schedules/Size Scale are correct. Verify the business rule criteria: The style must be replenishable, and ResultingPOPredistribType must be = 1 (Bulk)
"Could not find Parameter" The Warehouse Pick Review parameter for this style ID/location ID/warehouse ID can't be found.
Requires development attention.
“Error saving document” Error results from one of the conditions described in Troubleshooting Scheduled Jobs on page 461 or the violation of a business rule.
If the information in Troubleshooting Scheduled Jobs or the trace file is insufficient to help resolve the problem, bring to the attention of development.
438 Scheduled Jobs
Config file switches
Possible error messages for Auto-Delete/Release Distribution DocumentThe errors listed in the table below are specific to the Auto-Delete/Release Distribution Document job. For other errors, see Troubleshooting Scheduled Jobs on page 461.
Switch Purpose of Switch Comments
ARMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
ARMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set to ON (1), the system writes the error message defined in the code to the trace file. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Error Message Cause Solution
A System auto delete/release distribution document Process is already running, can't run more than one system auto delete/release distribution document process at the same time.
The system can run only one auto delete/release distribution document job at a time and there is already one running.
Try to run the job later.
Following Exception(s) occurred: Type of Exception: NsbSystem.TechnicalException Exception Message: An error occurred during authentication: 'Error validating security data: invalid ApplicationID/CompanyID combination.'.Exception Source: NsbSystem.Security”
The user name and password used to create the job failed validation.
Through Server Manager, check that the user name and password exist in the security table, that they match those associated with the job and that the user has access to the company specified in the job.
Generate Seasonal Indices 439
Generate Seasonal IndicesNsb.Forecasting.GenerateSeasonalIndicesScheduledProcess.exe processes an XML file to generate seasonal indices. The assocaited config file for this executable is Nsb.Forecasting.GenerateSeasonalIndicesScheduledProcess.exe.config' The configuration file indicates: the trace file name and where it can be found; where the foundation.config file and ServerObjectFactory.config file can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switches
Possible error messages for Generate Seasonal Indices
Switch Purpose of Switch Comments
ARMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
ARMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set to ON (1), the system writes the error message defined in the code to the trace file. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Error Message Cause Solution
A Seasonal Indices Process is already running, can't run more than one at a time.
The system can run only one generate seasonal indices job at a time and there is already one running.
Try to run the job later.
440 Scheduled Jobs
Following Exception(s) occurred:Type of Exception: NsbSystem.TechnicalExceptionException Message: An error occurred during authentication: 'Error validating security data: invalid ApplicationID/CompanyID combination.'.Exception Source: NsbSystem.Security
The user name and password used to create the job failed validation.
Through Server Manager, check that the user name and password exist in the security table, that they match those associated with the job and that the user has access to the company specified in the job.
One or more threads could not successfully finish their task, see error logging for details.
There are many possible reasons for this error, among them, memory full, database connection lost.
Bring to development attention.
An invalid value is specified for an application setting in the application configuration file. Application setting GenerateSeasonalIndicesNumberOfThreads
The value of GenerateSeasonalIndicesNumberOfThreads in the .config file is not an integer. Default is 2.
If the job is running through Server Manager, check the Nsb.Forecasting. GenerateSeasonalIndicesScheduledProcess.exe.config file. This is a mandatory field. If it does not appear in the file, the system will use the default. If the job is running online through UI, check the ARMainService.exe.config file.
An invalid value is specified for an application setting in the application configuration file. Application setting GenerateSeasonalIndicesBatchSize
The value of GenerateSeasonalIndicesBatchSize in the .config file is not an integer. Default is 1.
If the job is running through Server Manager, check the Nsb.Forecasting.GenerateSeasonalIndicesScheduledProcess.exe.config file. This is a mandatory field. If it does not appear in the file, the system will use the default. // If the job is running on line through UI, check the ARMainService.exe.config file.
Current year has not been defined in the calendar.
The current year is not defined in the table calendar_year in the Merchandising database.
In Enterprise Data in Merchandising, set up the calendar year.
Seasonal Indices for one or more Seasonal Profile Groups are already being generated on this application server.
More than one Generate Seasonal Indices job is running either online through the GUI or through the Server Manager.
Wait for the other job to finish and try again.
Error Message Cause Solution
Calculate Lost and Extra Sales 441
Calculate Lost and Extra SalesNsb.Forecasting.CalculateLostAndExtraSalesScheduledProcess.exe processes an XML file to calculate lost and extra sales. The associated config file for this executable is Nsb.Forecasting.CalculateLostAndExtraSalesScheduledProcess.exe.config. The configuration file indicates: the trace file name and where it can be found; where the foundation.config file and ServerObjectFactory.config file can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switches
Possible error messages for Calculate Lost and Extra Sales
Switch Purpose of Switch Comments
ARMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
ARMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set to ON (1), the system writes the error message defined in the code to the trace file. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Error Message Cause Solution
A Calculate Lost And Extra Sales Process is already running, can't run more than one at a time.
The system can run only one calculate lost and extra sales job at a time and there is already one running.
Try to run the job later.
442 Scheduled Jobs
Adjust Lost and Extra SalesNsb.Forecasting.AdjustLostAndExtraSalesScheduledProcess.exe processes an XML file to update lost and extra sales figures. The associated config file for this executable is Nsb.Forecasting.AdjustLostAndExtraSalesScheduledProcess.exe.config. The configuration file indicates: the trace file name and where it can be found; where the foundation.config file and ServerObjectFactory.config file can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Following Exception(s) occurred : Type of Exception: NsbSystem.TechnicalException Exception Message: An error occurred during authentication: 'Error validating security data: invalid ApplicationID/CompanyID combination.'.Exception Source: NsbSystem.Security”
The user name and password used to create the job failed validation.
Through Server Manager, check that the user name and password exist in the security table, that they match those associated with the job and that the user has access to the company specified in the job.
An invalid value is specified for an application setting in the application configuration file. Application setting CalculateLostAndExtraSalesNumberOfThreads” An invalid value is specified for an application setting in the application configuration file. Application setting CalculateLostAndExtraSalesMerchGroupBatchSize An invalid value is specified for an application setting in the application configuration file. Application setting CalculateLostAndExtraSalesStyleBatchSize”
The value of CalculateLostAndExtraSalesNumberOfThreads in the .config file is not an integer.
The value of CalculateLostAndExtraSalesMerchGroupBatchSize in the .config file is not an integer.
The value of CalculateLostAndExtraSalesStyleBatchSize in the .config file is not an integer.
Check the Nsb.Forecasting.CalculateLostAndExtraSalesScheduledProcess.exe.config file
The current week has not been defined in the calendar.
The current week is not defined in the table calendar_week in the Merchandising database.
In Enterprise Data in Merchandising, set up the calendar year weeks.
A week that has not been defined in the calendar can't be reviewed for lost and extra sales. A week that has not been defined in the calendar can't be used as an observation week for the calculation of lost and extra sales.
A week that is within the range of Review Last X weeks is not defined in the table calendar_week.
In Enterprise Data in Merchandising, set up the calendar year weeks.
Error Message Cause Solution
Config file switches 443
Config file switches
Generate Sales ForecastNsb.Forecasting.GenerateSalesForecastScheduledProcess.exe processes an XML file to generate sales forecasts. The associated config file for this executable is Nsb.Forecasting.GenerateSalesForecastScheduledProcess.exe.config. The configuration file indicates: the trace file name and where it can be found; where the foundation.config file and ServerObjectFactory.config file can be found; the database server and Foundation database server used to run the application.
The config file is also used to set optional parameters that filter out styles that should not be forecast. You can set up filters so that only styles that sold in the last X days will be forecast, and optionally, these will be forecast if the warehouse/DC locations have at least x OH units or x On-Order units. These parameters are used in addition to all eligibility parameters.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Switch Purpose of Switch Comments
ARMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
ARMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set to ON (1), the system writes the error message defined in the code to the trace file. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
ARPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
444 Scheduled Jobs
Config File Parameters
Config file switches
Parameter Function Possible Values
ApplyStyleForecastFilter
Determines whether the optional forecast filters are to be applied.
True: Filters as defined in the parameters are applied. False: Filters are not applied. Parameter values are ignored.
MinimumOnHand The system will verify if the style has at least the specified number of units whose status is available on hand in any location flagged as type Warehouse or DC.
-1 or 0: This parameter is ignored.1 -32767: The minimum on hand units If MinimumOnOrder > 0 and MinimumOnHand > 0, then only one of these conditions must be adhered to.
MinimumOnOrder The system will verify if the style has at least the specified number of units whose status is on order for any location flagged as type Warehouse or DC.
-1 or 0: This parameter is ignored.1 - 32767: The minimum on order units If MinimumOnOrder > 0 and MinimumOnHand > 0, then only one of these conditions must be adhered to.
NumberOfSaleWeeks
If ApplyStyleForecastFilter is set to True, the item will be forecast only if the style it belongs to has sold at least 1 unit in the last X weeks and if it meets the criteria for either MinimumOnHand or MinimumOnOrder.
-1 or 0: parameter is ignored. If ApplyStyleForecastFilter is True, only the thresholds apply. 1 - 106: The system will look back at the number of weeks specified, starting with the current week. Net units = total sales - returnIf this parameter is enabled, then at all times this criteria must be met regardless of the setting of the thresholds.
Switch Purpose of Switch Comments
ARMethods If enabled, an entry is added to the trace output file when an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
ARMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch ON (1) can help determine the approximate location of the error within a method, which is generally indicated by the last message entry. Although it will impact performance, we recommend that this switch be ON for the first couple of months of operation and turned off once the system is stable.
ARErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set ON (1), the system writes the error message defined in the code to the trace file. We recommend that it be ON for the first couple of months of operationand turned off once the system is stable, although it will impact performance.
ARPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Possible error messages for Generate Sales Forecasts 445
Possible error messages for Generate Sales Forecasts
Error Message Cause Solution
Not enough calendar years on file. or GetYearWeekIds() threw an exception. or Not enough future weeks orNot enough future periods
Before you can create a forecast, the forecasted year(s) must be defined in EDM.
In Merchandising, Enterprise Data > Paramters > Calendar, set up the calendar year.
Following Exception(s) occurred : Type of Exception: NsbSystem.TechnicalException Exception Message: An error occurred during authentication: 'Error validating security data: invalid ApplicationID/CompanyID combination.'Exception Source: NsbSystem.Security”
The user name and password used to create the job failed validation.
Through Server Manager, check that the user name and password exist in the security table, that they match those associated with the job and that the user has access to the company specified in the job.
Method RetrieveList() on IForecastModelGroupServer through an exception.
Retrieve Forecast Model has generated an exception. This could be caused by a database connection problem, or missing dlls or a bad entry in ServerObjectFactory.config.
Refer to Troubleshooting Scheduled Jobs in this manual or bring development attention.
Methods RetrieveSkuIds on IMechandiseInformationServer through an exception
Retrieve merchandise information has generated an exception. This could be caused by a database connection problem, or missing dlls or a bad entry in ServerObjectFactory.config.
Refer to Troubleshooting Scheduled Jobs in this manual or bring development attention.
Method RetrieveLocationIdList(LocationType.Store) on ILocationReferenceListServer through an exception.
Retrieve location information has generated an exception. This could be caused by a database connection problem, or missing dlls or a bad entry in ServerObjectFactory.config.
Refer to Troubleshooting Scheduled Jobs in this manual or bring development attention.
Current forecast date not found in calendar. Update merchandise calendar to include all required periods for this forecast and retry.
The calendar year used to forecast does not exist in merchandise calendar_year table.
In Merchandising, Enterprise Data>Paramters>Calendar, set up the calendar year.
Method RetrieveYears on ICalendarServer through an exception
Retrieve calendar year information has generated an exception. This could be caused by a database connection problem, or missing dlls or a bad entry in ServerObjectFactory.config.
Refer to Troubleshooting Scheduled Jobs in this manual or bring development attention.
446 Scheduled Jobs
XXXXXX not supported. Supported Forecast Period Types are: CalendarPeriod CalendarWeek This is an internal error and should not occur unless there is a bug in the code.
Bring to development attention.
Forecast level XXXX not supported.
Supported forecast levels are: Style, style/color, skuThis is an internal error and should not occur unless there is a bug in the code.
Bring to development attention.
Forecast algorithm XXXX not supported by Forecast Service.
Supported forecast algorithms are: Adaptive Smoothing Base Factor Double Exponential Smoothing Exponential Smoothing Simple Moving Average SimpleRegression This Year/Last Year Season This Year/Last Year Trend Weighted Moving Average This is an internal error and should not occur unless there is a bug in the code.
Bring to development attention.
GenerateForecastSimulation() threw an exception.
This is an internal error and should not occur unless there is a bug in the code.
Bring to development attention.
CreateForecastBEAndAttachParameterForSimulation() threw an exception.
This is an internal error and should not occur unless there is a bug in the code.
Bring to development attention.
OverrideWithSimulationParameters() threw an exception.
This is an internal error and should not occur unless there is a bug in the code.
Bring to development attention.
Forecast Load Type XXXX not supported.
Supported Forecast Load Types are: LocationMerchandiseGroupLocationVendorLocation MerchandiseGroup MerchandiseGroupVendorVendor This is an internal error and should not occur unless there is a bug in the code.
Bring to development attention.
Error Message Cause Solution
Other forecasting issues - FAQs 447
Other forecasting issues - FAQs
Symptoms Cause Resolution
No forecast results were generated.
Forecast did not run. (There are no new entries in the log file.) SRMain service did not run the process. Nothing was scheduled to run on that day on that application server (“Nothing scheduled for today.” appears in the log file.). An error occured during the forecast process; check the log file for details.
Verify the job settings in the Job Scheduler of Server Management. For additional troubleshooting information see the Services Administration User Guide. Check the Forecast Schedule, update schedule days and/or application server. Error-specific action needs to be taken.
A forecast was generated but no forecast item locations (or some but not all forecast item locations) have been saved.
Mandatory forecast parameters were not defined for the missing item/location. Check the Process Error Log to see if there are any entries for that item/location.
Set the mandatory forecast parameters for that item/location (or set them at a higher merch/location/vendor level so that the item/location will inherit the parameter values).
A forecast item/location exists but no forecast sales (or some but not all forecast sales) have been saved.
There was not enough sales data to generate the requested sales forecast.
Forecast is slow. Forecasting is not optimized for the application server it is running on.
In the .config file, set the number of threads to 2 to 3 times the number of CPUs on the application server. Setting a lower number will decrease performance because there will be unused CPUs; setting a higher number will decrease performance because of context switch overhead. Set an optimal batch size. If the batch size is too small, memory resources will not be used efficiently and DB activity will increase; setting the batch size too large will cause a performance decrease because of locks in the DB and/or increased VM activity.
Application server is overwhelmed by the workload.
Balance the workload over different days and schedule accordingly.Scale up the server to add more CPUs and/or more memory.Scale out by adding more application servers and distribute the workload among them.
448 Scheduled Jobs
Ranking Group ImportNsb.AllocationReplenishment.RankingGroupImportProcess.exe imports externally-prepared location ranking groups into the Merchandising system from an XML or CSV file.
Opening tags - XML formatAt the beginning of the file
<?xml version="1.0" encoding="utf-8" ?> <RankingGroups>
Closing tags - XML formatAt the end of the file:
</RankingGroups>
RankingGroup Members (RankingGroups Level)
RankingGroupGrade Members (RankingGroupGrades Level)
Locations Members (RankingGroupGrade Level)
Example - csv Format&Ranking code,Hierarchy Group Code,Style code,Grade,Minimum,Maximum,Weight,Location CodeHG100005a,100005,,A,50,100,1.25,0040HG100005a,100005,,B,25,75,0.85,0041
Attribute name Type Description Mandatory
RankingGroupCode varchar(20) not null Code for the Ranking Group Mandatory; if neither MerchandiseCode nor StyleCode is defined, result is a generic ranking group.
MerchandiseCode integer null Code defining the merchandise level for which the ranking group is being created
Optional; used only when ranking group is prepared at the merchandise group level.
StyleCode decimal (12,0) null Style code Optional; used only when the ranking group is prepared at the style level
Attribute name Type Description Mandatory
Grade varchar (10) not null Grade in the ranking group Mandatory
Minimum integer null Minimum Optional; initially defaulted to 0
Maximum integer null Maximum Optional; initially defaulted to 0
Weight decimal (4,2) null factor to be applied for the locations in the grade
Optional; initially defaulted to 0
Attribute name Type Description Mandatory
LocationCode smallint not null Location Code Mandatory; multiple locations can be defined for each grade
Example - Tab-delimited 449
SC1000056,,1000056,A,5,10,1.5,0040GEN10000,,,C,,,,0042
Example - Tab-delimited&Ranking code Hierarchy Group CodeStyle codeGradeMinMaxWeightLocation CodeHG100005a 100005A501001.250040
HG100005a 100005B25750.850041
SC1000056 1000056A5101.50040GEN10000 C0042
Example - XML Format<?xml version="1.0" encoding="utf-8" ?> - <RankingGroups> - <RankingGroup RankingGroupCode="RG1">
<MerchandiseCode>10-4-37-2793-09</MerchandiseCode> <StyleCode /> - <RankingGroupGrades>
- <RankingGroupGrade Grade="RG1.A"> <Minimum>10</Minimum> <Maximum>50</Maximum> <Weight>6</Weight> - <Locations>
<Location Code="1001" /> <Location Code="1002" />
</Locations> </RankingGroupGrade> - <RankingGroupGrade Grade="RG1.B">
<Minimum>65</Minimum> <Maximum>160</Maximum> <Weight>.87</Weight> - <Locations>
<Location Code="1003" /> </Locations>
</RankingGroupGrade> - <RankingGroupGrade Grade="RG1.C">
<Minimum>120</Minimum> <Maximum>520</Maximum> <Weight>0.005</Weight> - <Locations>
<Location Code="2222" /> </Locations>
</RankingGroupGrade> </RankingGroupGrades>
</RankingGroup> </RankingGroups>
ErrorsErrors are logged to the Import status window.
450 Scheduled Jobs
Generate Store ShipmentsNsb.AllocationReplenishment.GenerateStoreShipmentsScheduledProcess.exe processes generate store shipments based on the details of the job you submit from Allocation and Replenishement. The associated config file for this executable is Nsb.AllocationReplenishment.GenerateStoreShipmentsScheduledProcess.exe.config. The configuration file indicates: the trace file name and where it can be found; where the foundation.config file and ServerObjectFactory.config file can be found; the database server and Foundation database server used to run the application.
Physical Inventory Scheduled JobsThe scheduled jobs for IM are: Import Queued Counts IMRD Submit
Import Queued CountsPIQueuedCountScheduledJob.exe processes an XML file to import counts that were submitted to an import queue through the Actions menu of Physical Inventory in Inventory Management. The associated config file for this executable is PIQueuedCountScheduledJob.exe.config. The configuration file indicates: the trace file name and where it can be found; where the foundation.config file and ServerObjectFactory.config file can be found; the database server and Foundation database server used to run the application.
If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run.
Config file switches
Switch Purpose of Switch Comments
PIMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
PIMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
PIErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set to ON (1), the system writes the error message defined in the code to the trace file. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
IMRD Submit 451
IMRD SubmitSubmitIMRDProcess.exe job allows the user to mass submit their IMRD transfer documents with a preliminary status as an alternative to manually submitting each IMRD document. Prior to running this job, the user must first select and schedule the range of IMRD Transfer documents from the Inventory Management Outbound Worklist. This job will only submit the IMRD transfer documents selected by the user. Refer to the Inventory Management User Guide for further details.
Enterprise Selling Scheduled jobsThe scheduled jobs for the Merchandising/Enterprise Selling interface are: Generate Refresh Files Send Inventory Movements Remote Host
Enterprise Selling Generate Refresh FilesNsb.EnterpriseSelling.GenerateRefreshFiles.exe job retrieves data from EDM & PROD, places them into Enterprise Selling data feed files, and sends them down to Enterprise Selling on a nightly basis.
This job should be scheduled to run after completion of the Sales Posting job and Warehouse Pick job (if applicable). It must not when Nsb.EnterpriseSelling.SendInventoryMovements.exe is running.
The following parameters stored in the parameter_system table of the Merchandising database are used by this job: installed_es_flag: indicates whether Merchandising interfaces with Enterprise Selling.
If set to False, this job cannot be run. es_location_group_level_id: indicates which level of the main location hierarchy will
be considered the grouping identifier for Enterprise Selling. Location hierarchy groups on this level will be sent to the outlet group refresh file that is generated by this job.
es_refresh_dest_directory: indicates the designated folder on the Enterprise Selling server to which the output file of this job will be exported.
The config file, Nsb.EnterpriseSelling.GenerateRefreshFiles.exe.config, contains the following:InProgressPath defines the path to the temporary directory in which the files are being generated prior to being sent to the ES server. By default, is set to C:\NSB Interface\ES Interface\In Progress. The directory specified must exist.BatchSize defines the number of records that should be read from Merchandising and sent to Enterprise Selling within each transaction. Defaults to 1000000. This value can be changed based on performance requirements. the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application. the client configuration elements of the Enterprise Selling web service.
452 Scheduled Jobs
Enterprise Selling Send Inventory MovementsNsb.EnterpriseSelling.SendInventoryMovements.exe job calls an Enterprise Selling web service to send down the inventory movements to Enterprise Selling. Once initiated, this job will publish the net effect of the inventory movements for each sku/location since last generation.
You schedule the frequency at which the inventory movements are sent to Enterprise Selling (i.e. every 5 minutes). Make sure that this job doesn't run when Nsb.EnterpriseSelling.GenerateRefreshFiles.exe is running.
The following parameters stored in the parameter_system table of the merchandising database are used by this job: installed_es_flag: indicates whether Merchandising interfaces with Enterprise Selling.
If set to False, this job can’t be run. last_ib_inventory_id: indicates the maximum ib_inventory_id at the time this job was
last run. This parameter is updated to the current maximum ib_inventory_id when this job is successfully completed.
last_ib_allocation_id: indicates the maximum ib_allocation_id at the time this job was last run. This parameter is updated to the current maximum ib_allocation_id when this job is successfully completed.
The following keys can be used for troubleshooting if you have difficulty connecting to the ES server:
The config file, called Nsb.EnterpriseSelling.SendInventoryMovements.exe.config, indicates: the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application. the client configuration elements of the Enterprise Selling web service.
Key Function Possible values
GenerateTextFile Indicates whether a log file containing all the inventory movements that were sent to Enterprise Selling via the Web service will be generated. The log file will be called InventoryMovements.txt and will be in the location specified by TextFilePath.
1 = Generate log file0 = Do not generate log file Defaults to 0.
TextFilePath The path where the log file InventoryMovements.txt will be generated when GenerateTextFile is set to 1. The directory must be created prior to running this job.
Defaults to C:\NSB Interface\ES Interface\In Progress. Should be changed before use.
WorkingOffline Indicates whether this job will call the Enterprise Selling web service for inventory movements.Must always be set to 0, otherwise inventory movements will not be sent to Enterprise Selling.
1 = Job will not call the web service0 = Job will call the web serviceDefaults to 0.
Config file switches 453
Config file switches
The Client configuration elements of Enterprise Selling service are stored in the system.serviceModel section of the config file, the following is an example of the system.serviceModel section that is configured for the web service that is available on server es_machine_name and port number 8090:<system.serviceModel> <bindings> <basicHttpBinding> <binding name="InventoryManagerSoapBinding" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00" allowCookies="false" bypassProxyOnLocal="false" hostNameComparisonMode="StrongWildcard" maxBufferSize="65536" maxBufferPoolSize="524288" maxReceivedMessageSize="65536" messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered" useDefaultWebProxy="true"> <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="16384" maxBytesPerRead="4096" maxNameTableCharCount="16384" /> <security mode="None"> <transport clientCredentialType="None" proxyCredentialType="None" realm="" /> <message clientCredentialType="UserName" algorithmSuite="Default" /> </security> </binding> </basicHttpBinding> </bindings> <client> <endpoint address="http://es_machine_name:8090/axis/services/InventoryManager" binding="basicHttpBinding" bindingConfiguration="InventoryManagerSoapBinding" contract="InventoryManagerProxy" name="InventoryManager" /> </client></system.serviceModel>
Switch Purpose of Switch Comments
ESMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
454 Scheduled Jobs
TroubleshootingPossible error messages are:
Enterprise Selling Remoting HostThe Enterprise Selling Remoting Host web service notifies Merchandising that a merchandise item is reserved for a new customer order or is un-reserved due to a cancelled customer order at a fulfillment location. The service can be called from Enterprise Selling or a third application on a remote machine to reserve/un-reserve a merchandise for a location in InfoBase.
The config file, Nsb.EnterpriseSelling.RemotingHost.exe.config, indicates: the name of the trace file and where it can be found; where the foundation.config and ServerObjectFactory.config files can be found; the database server and Foundation database server used to run the application. the configuration information that is used to host this web service.
Config file switches
The configuration information used to host this web service is found in the system.serviceModel section of the config file. The following is an example of the system.serviceModel section that is configured for the web service that is available on server me_machine_name and port number 8000:
<system.serviceModel>
<services> <service name="Nsb.EnterpriseSelling.Server.ReserveService"
behaviorConfiguration="ReserveServiceBehavior">
<host> <baseAddresses>
<add baseAddress="http://me_machine_name:8000/NSBEnterpriseSellingRemotingHost"/> </baseAddresses>
</host>
<!-- this endpoint is exposed at the base address provided by host: http://me_machine_name:8000/NSBEnterpriseSellingRemotingHost -->
<endpoint address="ReserveService"
Error Cause Solution
Parameter 'installed_es_flag' is set to false, cannot post inventory movement to Enterprise Selling.
The column installed_es_flag in table parameter_system in the Merchandising database is set to 0.
Disable this job if Merchandising is not interfacing with Enterprise Selling; if Merchandising is interfacing with Enterprise Selling and this job needs to be run, then set installed_es_flag in parameter_system to 1 in the Merchandising database.
Switch Purpose of Switch Comments
ESMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
Troubleshooting 455
binding="basicHttpBinding" bindingConfiguration="ReserveServiceBinding" contract="Nsb.EnterpriseSelling.Server.IReserveService" /> <!--endpoint address="ReserveService" binding="wsHttpBinding" contract="Nsb.EnterpriseSelling.Server.IReserveService" /--> <!-- the mex endpoint is explosed at http://me_machine_name:8000/NSBEnterpriseSellingRemotingHost/mex --> <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" /> </service> </services> <bindings> <basicHttpBinding> <binding name="ReserveServiceBinding"> <security mode="TransportCredentialOnly"> <transport clientCredentialType="Basic"/> </security> </binding> </basicHttpBinding> </bindings> <behaviors> <serviceBehaviors> <behavior name="ReserveServiceBehavior"> <serviceMetadata httpGetEnabled="true"/> <serviceDebug includeExceptionDetailInFaults="true"/> </behavior> </serviceBehaviors> </behaviors></system.serviceModel>
TroubleshootingPossible error messages are:
Error Cause Solution
Failed to authenticate user … for company …, cannot post Enterprise Selling Reserves to Merchandising.
The user who is calling this web service does not have access right to the merchandising database that she/he wants to update.
Ensure the user has access right to the Merchandising company that she/he needs to update.
The following invalid location codes have been provided: …
Invalid Merchandising location code have been provided when calling this web service.
Ensure valid location codes are provided when calling this web service
The following invalid sku ids have been provided: …
Invalid Merchandising sku ids have been provided when calling this web service.
Ensure valid SKU IDs are provided when calling this web service
456 Scheduled Jobs
EDM Scheduled JobsThe scheduled job for EDM is: Create Employee Import Files
Create Employee Import FilesNsb.EnterpriseData.EmployeeImportProcess.exe job gives a client the option of providing one employee import file (XML format) instead of the 3 separate import files usually required to load employees into Merchandising, POS and CRDM. This job will pick up the XML file and split it up into the 3 standard import files required by the applications. The files are then put into a designated folder as defined by the user (config parameter). Once the job is executed, the current import mechanism that is used to load employees into each application is still required to complete the process.The exe.config file contains the following keys:
The import files must be in xml format, and filenames must repect the following convention:
the file is always prefixed with the label EMPLOYEE, followed by the company number. The balance of the filename is at your discretion, but we recommend the date the file was generated. For example:
EMPLOYEE_01_20100513.xml
The import file will contain: Employee (mandatory) Employee address (optional, required only if employee has more than one address) Employee contact (options) Employee attributes (optional) Employee positions (optional, required only if employee has been assigned to more
than one position)
Optional fields should be included in the xml file only if a value is provided for them.
Sample xml file<?xml version="1.0" encoding="utf-8" ?><EmployeeImport xmlns="http://epicor.com/EmployeeImport.xsd"> <Employee ActionType="A" EmployeeNumber="23" EmployeeType="H"> <FirstName>Tim</FirstName> <LastName>Johnson</LastName>
Key Default Description
InputFolder C:\temp Folder into which the input file from the third party system should be placed.
PipelineInputFolder C:\temp\Pipeline Folder into which the generated Pipeline files will be placed.
CRDMInputfFolder C:\temp\CRDM Folder into which the generated CRDM files will be placed.
POSInputFolder C:\temp\POS Folder into which the generated POS files will be placed.
PipelineEnabled True Enable/disable generation of the Pipeline file.
CRDMEnabled True Enable/disable generation of the CRDM file.
POSEnabled True Enable/disable generation of the POS file.
Troubleshooting 457
<ActiveStatus>Y</ActiveStatus> <StatusCode>HIRE</StatusCode> <WorkSchedule>F</WorkSchedule> <DateHired>2010-01-23</DateHired> <UserName>tjohnson</UserName> <DomainName>AMERICAS</DomainName> <ServerName>alpine</ServerName> <PrimaryPositionCode>A</PrimaryPositionCode> <PrimaryLocationNumber>0001</PrimaryLocationNumber> <SSN>122312434</SSN> <DepartmentNumber>1</DepartmentNumber> <AddressType>MAIN</AddressType> <Address1>123 McGill Street</Address1> <CountryCode>CA</CountryCode> <ISPSecurityLevel>1</ISPSecurityLevel> <POSSecurityLevel>1</POSSecurityLevel> <Password>pos</Password> <Accountability>NONE</Accountability> </Employee> <Address ActionType="A" EmployeeNumber="23"> <AddressType>HOME</AddressType> <Address1>123 Elm Street</Address1> <Country>USA</Country> </Address> <Contact ActionType="A" EmployeeNumber="23">
<ContactType>F</ContactType> <Description1>Mobile</Description1> </Contact> <AttributeSet ActionType="A" EmployeeNumber="23"> <AttributeCode>ABC</AttributeCode> <AttributeSetCode>DEF</AttributeSetCode> </AttributeSet> <Position ActionType="A" EmployeeNumber="23"> <PositionCode>BUYER</PositionCode> <PrimaryPosition>N</PrimaryPosition> <LocationNumber>0001</LocationNumber> <EffectiveDate>2010-01-23</EffectiveDate> </Position>
</EmployeeImport>
TroubleshootingIf necessary, the following switches can be turned on in the config file to enable tracing and help with troubleshooting:
Switch Purpose of Switch Comments
EDMMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
458 Scheduled Jobs
Error Messages
General Scheduled JobsThe general scheduled jobs are: Merch Extension Queue Process Merchandising Export Financials to E9
Merch Extension Queue ProcessNsb.Merchandising.ExtensionQueueProcess.exe handles calling Foundation Extensions (for example, sending MSMQ messages) for all documents that get modified by the following jobs: ASN Import (IM Import Table to IM; Pipeline segment 19010) Price Change Import (PM Import to PM; Pipeline segment 34000) Price Change Issue (PM Internal - Issue Documents; Pipeline segment 4000) PO Cost & Style Cost Modify (scheduled job)
This job must be scheduled to run periodically (at least after any of above jobs have been executed). Applies only to clients sites who have been configured to use Foundation extensions.
The associated config file for this executable is Nsb.Merchandising.ExtensionQueueProcess.exe.config. The configuration file indicates: the trace file name and where it can be found; where the foundation.config file and ServerObjectFactory.config file can be found;
EDMMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
EDMErrors If this switch is enabled, errors encountered are written to the trace file.
If an error is encountered and this switch is set to ON (1), the system writes the error message defined in the code to the trace file. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
Switch Purpose of Switch Comments
Error Cause Solution
Error deserializing: <filename> The input file is not in the expected format, or the file cannot be read for some other reason
Verify that the file is in valid xml format and try again.
Pipeline input folder does not exist: <path>POS input folder does not exist: <path>CRDM input folder does not exist: <path>
The paths configured in the config file do not exist.
Make sure that the folder and the input file exist at the specified path and try the job again.
Config file switches 459
the database server and Foundation database server used to run the application.If necessary, the Switches section of this file can be modified for troubleshooting purposes. Open the file in any text editor and make the changes required, then either re-run the job by forcing it through the scheduler, or wait for the next scheduled run
Config file switches
TroubleshootingError messages are listed in the Job Scheduler error screen for this job.
Switch Purpose of Switch Comments
OrderMethods If this switch is enabled, an entry is added to the trace output file each time an internal method begins and ends.
Setting the switch to ON (1) can help pinpoint the method that caused the error, which will be the last method that started.
OrderMessages If this switch is enabled, a detailed entry is added to the trace file for frequent checkpoints in the application.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
Errors If this switch is enabled, errors encountered are written to the trace file.
Setting the switch to ON (1) can help determine the approximate location of the error within a method, which will generally be indicated by the last message entry. Although it will have an impact on performance, we recommend that this switch be ON for the first couple of months of operation; it can be turned off once the system is stable.
OrderPerformance If this switch is enabled, an entry is added for points in the application where the system expects a process to take a significant amount of time to run.
If the system tends to hang at a certain point, setting this switch to ON (1) may provide more details as to what process is failing.
Error Cause Solution
Cannot retrieve document number '{0}' for extension queue item id: {1}. stsCreatableItem.Retrieve failed.
The job fails to retrieve a document.
Verify that the document can be loaded by the Merchandising application. The document type can be found by querying the extension_queue table for the extension_queue_id indicated in the error message.If the document cannot be loaded in the Merchandising application (for example, if it does not exist), then this row can be removed from the extension_queue table.
460 Scheduled Jobs
Merchandising Export Financials to E9Nsb.Merchandising.Financials.exe job processes the GL export text files created from Stock Ledger (via Pipeline segment 28000) and the Invoice export text files created from Invoice Matching (via Pipeline segment 7000) and converts them to new XML files that adheres to E9 Financials import formats. Separate XML files for the GL export and Invoice exports are created. Additionally, the user has the option as defined in the EXE config file to further segregate the GL export XML files by GL company. The option to segregate the Invoice export files by GL company is NOT available in this release.
The job can not run more than 4 times an hour, 24 hours a day, so can be regularly scheduled to run every 15 minutes or at greater intervals. It CANNOT run more frequently.
The configuration file contains the following:
Note:If E9 does not require that XML files be split by GL company, the GLCompanies key must be included in the config file with an empty string: <add key="GLCompanies" value="" />
If E9 does require that Stock Ledger XML files be split by GL company, then the GLCompanies key must list all the GL Companies. Then, all the output paths must be defined for the generated XML files. In the following example, Merchandising is defined with two GL companies where the GL company numbers are 1 and 2:
Key Description
FilePathIMAT The path to the invoice text file created by IMAT.
FilePathGLFixed The path to the GL Posting file created by Stock Ledger.
FilePathGLComma The path to the GL Posting file created by Sales Audit.
FilePathIMATOutput The path to the XML file generated by this job for IMAT.
FilePathGLFixedOutput The path to the XML file generated by this job for the GL Posting file from Stock Ledger.
FilePathGLFixedOutputGLn The path to the Stock Ledger files generated by this job per GL company. The n specifies the company number. A path must be created for every company listed in the GLCompanies key, the path must be unique and it must not be shared with Sales Audit. One XML will be created per company in the designated folder. See Note.
FilePathGLCommaOutput The path to the XML file generated by this job for the GL Posting file from Sales Audit.
FilePathGLCommaOutputGLn
The path to the Sales Audit files generated by this job per GL company. The n specifies the company number. A path must be created for every company listed in the GLCompanies key, the path must be unique and it must not be shared with Stock Ledger. One XML will be created per company in the designated folder. See Note.
GLCompanies Lists all the GL company numbers.
MerchGLAccountLength The length of the Merch GL Account number. Defaults to 20, the max length of a Merch account.
SourceQueue The queue where E9 puts vendor information for Merchandising.
DestinationQueue The queue from which Merch picks up vendor information.
Troubleshooting Scheduled Jobs 461
<add key="GLCompanies" value="1,2"/><add key="FilePathGLFixedOutputGL1" value="C:\temp\GLFixedOutputGL1\" /><add key="FilePathGLFixedOutputGL2" value="C:\temp\GLFixedOutputGL2\" /><add key="FilePathGLCommaOutputGL1" value="C:\temp\GLCommaOutputGL1\" /><add key="FilePathGLCommaOutputGL2" value="C:\temp\GLCommaOutputGL2\" />
Troubleshooting Scheduled JobsThis section lists the basic errors that may be encountered when running any job scheduled through Server Manager as well as their cause and solutions. Errors specific to a particular job are covered in the section for that job. If an error message is generated that is not included in this document or any of the project-specific documents, contact Epicor Retail.
Error Message Cause Solution
Could not authenticate user. Username and/or password are invalid.
In the Server Manager, enter a valid username and password in the Job Info tab.
Server encountered an internal error. For more information, turn on customErrors in the server's .config file.
Ensure that the application’s config file and the config file of each service have the following entry before the </system.runtime.remoting> closing tag: // <customErrors mode="on" /> If required for detailed troubleshooting, this parameter can be turned off temporarily. However, if the value of the parameter is changed, the server must be rebooted.
The type initializer for "NsbSystem.Configuration.FoundationFactory" threw an exception.
The foundation.config file was not found.
Verify the path of foundation.config in the application .config file.
No such host is known. foundation.config has an invalid entry for one or more servers.
Ensure the URL is correct for all Class entries in the foundation.config file.
An error occurred during authentication: 'Error validating security data: invalid ApplicationID/CompanyID combination.'.
ObjectFactory.config file either invalid, or cannot be found.
Verify the location of the ObjectFactory.config file. Check that all entries contain valid data.
failed to create the type 'Nsb.*.*.*' from the assembly 'Nsb.*.* Version=x.x.x.x, Culture=neutral, PublicKeyToken=xxxxxxxxxxxxxxxx'
Assembly is either not signed or there is an incorrect version of the assembly.
Obtain the latest versions of all assemblies from Epicor Retail.
Error in the application. Unspecified error Look in the trace file for more detailed information. Contact Epicor.
462 Scheduled Jobs
Error CorrectionThe Job Scheduler, which is the service that hosts the PO import, contains error summaries. These summaries can be viewed from the Job Scheduler, after a job has completed. Once it is determined what the errors are, the original files can be edited, and the process can be run again.
Multiple POs can exist in one XML file; if one PO fails, the Importer will log the errors, and proceed with the rest of the POs in the file. To facilitate the recognition process for files with multiple POs, an ID attribute should be added to the PO node for each PO in the file, and a unique ID should be assigned for each PO. If the importer finds an ID tag and a PO fails, you will be able to easily identify which PO failed, and make any necessary adjustments. An example of this can be found in the samples included with this document. One suggestion is the use the PO Number as the ID field for each PO.As POs are processed, if at least one PO succeeds, a Completed folder will be created below the folder containing the xml document; the entire XML file will be added to this folder. If at least one PO fails, an Error folder will be created below the folder containing the xml document; the entire XML file will be added to this folder. The files in these two folders will be identical. Files in the Error folder should be corrected and re-processed. Once you have made the necessary corrections, save the corrected file to the original folder using the same file name as was used for the original process. The path for this folder is defined in the .config file. For example as: <add key="ImportFolder" value="C:\POM\POMImport"/>
In this case, the Error folder would be:
C:\POM\POMImport\ErrorThe Completed folder would be:
C:\POM\POMImport\Completed
Note: It is very important to ensure that all POs are still included in the corrected file, even the ones that completed, because the Import process flags each PO in the file, and attaches a sequence number to each PO. For example, if there are five POs in the file, and the fourth one fails but the rest succeed, when the file is re-processed, the Importer will look for the fourth PO in the file, and re-process it. The XML file name must also remain the same to ensure that only the failed POs are re-processed.
4 Planning Export Utility
The Planning Export Utility is designed to populate a couple of tables in the database in order to process History Transactions. It will help create planning elements for each table group and select or deselect the elements that will be or will not be exported to Planning.
464 Planning Export Utility
Getting Started1. Get the latest version of the Pipeline Export Utility from
\\Americas\share\dev\Releases\Merch\4.3\PipelineFramework.2. Launch the application and select the data source name for the MA database from
the drop down list.
Note: The DSN must be set up in Settings > Control Panel > Data Sources (ODBC).
3. Enter the appropriate user name and password; click OK.
Navigation 465
Navigation
What is this window?
Select from Table Groups to see corresponding elements once they have been addedClick the tabs to change views.Add, Edit, Delete buttons are used to add a new element/indicator or modify or delete the highlighted element/indicator.
Menu and Tool bar
466 Planning Export Utility
1. Save (Ctrl+S) - Saves from all tables to the database.
Note: Changes are not saved until this command is issued.
2. Print (Ctrl+P) - Not yet implemented3. Exit (Ctrl+X) - End application
Plan Export Levels viewThis view controls the levels that will be exported, based on Export Flag and Default Export Flag. You choose the levels to export by selecting them from the left pane and adding them to the right. The top panes are for Export Flag; these values are temporary and are replaced by the value in Default Export Flag after each export to Planning. The bottom panes are for Default Export Flag. These values are set once.
Use the >> and << buttons to add and remove selections.
Defining a new export levelYou can define a new export level directly in the database. However, if you are defining a non-standard export level, keep these things in mind: the plan_exp_level_id must be above 1000. the plan_exp_level_label must be unique if the period_indicator is set to None (`N'):
The additional_from_clause must contain: `, calendar_date cd'
For Oracle, the additional_where_clause must contain: AND cd.calendar_date = (SELECT TO_CHAR((SYSDATE),'dd-mon-yy') FROM dual)
AND merch_year_wk <= ( SELECT merch_year* 100 + merch_week FROM calendar_date
WHERE calendar_date = (SELECT TO_CHAR((SYSDATE),'dd-mon-yy') FROM dual) )
Plan Element View 467
AND merch_year_wk >= ( SELECT merch_year* 100 + merch_week FROM calendar_date WHERE calendar_date = (SELECT TO_CHAR((SYSDATE - 7),'dd-mon-yy') FROM dual))'
(SELECT TO_CHAR((SYSDATE - 7), 'dd-mon-yy') FROM dual)
This statement represents 7 days ago; if you wanted 10 days ago then the statement should be:
SELECT TO_CHAR((SYSDATE - 10), 'dd-mon-yy') FROM dual)
You can use either merch_year_wk or merch_year_pd based on your requirements.
For SQL, you must use the proper conversion. For example: convert(char(10), calendar_date, 120)convert(char(10), getdate(), 120)
Once you add any rows to plan_exp_level table, you must remember to add rows into plan_exp_table table. Check the table itself table, to see its relationship to plan_exp_level table.
Plan Element ViewThe right pane will be empty until new elements are added and saved. If standard elements already exist in the database, the display will be similar to what's shown below:
Adding a New
Element
This utility shows the SQL expression linked to a planning element and allows you to set the expression for elements you add. The expression can be added in either home or local currency, or in both. If you enter the expression in one currency, you can have the system
468 Planning Export Utility
create it in the other. A Planning parameter (EDM > PArameters >Planning > Multi-Jurisdiction > Planning currency type) determines what SQL expression is used when data are being exported.
1. On the Plan Element Definition tab, click Add New Element.
2. Enter: a valid Element Number from Planning a valid Element Name
3. Select: an OTB (Open To Buy) Element Name an OTB Operator Location or Chain Week or Period Version Code
4. Select the appropriate options: Export if this element is to be exported Beginning On Hand if beginning of period is to be used for data
Unit Type of the element: select Units, Retail or Cost
5. Choose Head Office or Local and build the sum statement by entering it directly or by using the Add Field, Add Expression and arithmetic buttons (+, -, /, *). Click Copy to Local or Copy to Head Office to have the system build the expression in the other currency.
Note: The Add Expression section is enabled or disabled according to the Table Group you select.Reset clears the text box and writes sum() in it.You can add a field by double-clicking it, or highlighting it and clicking Add Field.To add an expression to the sum statement, select a function from the function
Adding an Indicator to an existing element 469
list. The corresponding list of statuses will appear on the status list. Double-click the status or highlight it and click Add Expression.When you have finished entering the related data for this element, click Table Groups, select the Plan Element Level tab or click the menu to save and return to the Plan Element view.
6. The element is not saved to the database till you click Save on the menu or press Ctrl+S.
7. If you are not finished entering the data for this element but the view has changed, click Edit.
Adding an Indicator to an existing
element
From the Plan Element Definition window select the item for which you want to add an indicator, and click Add Indicator. The Add/Edit page appears showing the details of the selected item. You can add location and period. Each element can have more than one indicator of any combination with location and period (location/chain or week/period). All other fields are filled and disabled.
Editing an element
1. Click Edit Element on the Plan Element Definition window.2. Modify the necessary fields.
Note: Location and Period fields are disabled; to modify either one, click Edit Indicator.
3. When you have finished entering the related data for this element, click Table Groups, select the Plan Element Level tab or click the menu to save and return to the Plan Element view.
Note: The element is not saved to the database till you click Save on the menu or press Ctrl+S.
470 Planning Export Utility
Editing an Indicator
1. In the Plan Element Definition window, click Edit Indicator.
2. Modify Location and/or Period
3. Once you are done, click Table Groups, select the Plan Element Level tab or click the menu to save and return to the Plan Element Definition view.
Note: The element is not saved to the database till you click Save on the menu or press Ctrl+S.
Removing an element
1. Highlight the element to be deleted.
2. Click Remove Element. A message box will appear to confirm the removal.
Note: The element is not saved to the database till you click Save on the menu or press Ctrl+S.
Removing an Indicator
1. Highlight the indicator to be deleted.2. Click Remove Indicator. A message box will appear to confirm the removal.
Note: The element is not saved to the database till you click Save on the menu or press Ctrl+S.
Plan Element LevelSelect the Export Type by clicking any of the fields on the left pane.
Note: The middle and the right panes will be empty if you haven't created any elements on plan element view.
When you change views or change Export Types, changes will be temporarily saved; however, to permanently save you must select Save from the File menu or press Ctrl + S.
Plan Element Groups View 471
Plan Element Groups ViewSelect Element Groups by clicking any of the fields on the left pane.
Instructions for using this are the same as for Plan Element Levels view.
Click Add and Remove buttons to move elements to and from the Elements to be added and Elements already added lists.Whatever elements you select here will be saved in the database (plan_element_group_list table). If there are values in this table when you open the application, they will be displayed in the right hand pane when you select the element group they are associated with from the left hand pane.
About the Script 473
About the Script
Note: The following script is a template. You must edit it before running it. Information such as live date and the paths for the log files differ from one customer to another. Instructions on what to change are part of the scripts.Folder names in path information must be valid and exist on the Pipeline server. If these folders do not yet exist, you must create them.
These startup scripts are used to set parameters for: Beginning Inventory MerchantView Posting Allocation Export and Plan Import The Startup Data in MerchantView:
How the tables get populated
SQL Server Startup Script for Merchandising AnalyticsMA SQL STARTUP SCRIPT
/*-----------------------------
Before running this startup script, some of the following SQL statements will have to be modified with the correct values (Live Date, Company Id, the Paths for the log files, and parameters affecting Allocation and Planning interface).
The rest of the SQL statements can be run "as is". They will update the last dates in post_parameters and check that certain tables are not empty.
This startup script must be run twice. Run it first before the 'Core to MA' segment is run for the first time, and run it again after the 'Core to MA' segment is run.
On the first run, you will get errors when it tries to update post_parameter based on dates from the calendar tables. These are the table update commands in the section labeled 'Updates post_parameter last dates'. The errors occur because the calendar table is not populated. After the 'Core to MA' segment is run the first time, the calendar table is populated and the script will run error-free the second time.
-----------------------------*/
--IB TO MA --
-- Enter YYYYWW of Live Date
update post_parameter
set parameter_value = ***i.e. 200108
where parameter_id =308
474 Appendix: MA SQL Startup Script
go
--Enter Company Id (This is the Source Company Id from Merchandising)
update post_parameter
set parameter_value = ***i.e. 1
where parameter_id =125
go
/*-----------------------------
Enter Paths for all Log Files for Infobase to Merchandising Analytics Posting. Note that the paths and folders must exist on the Pipeline server. If the folders do not yet exist, you must create them.
-----------------------------*/
-- Sku log
update post_parameter
set parameter_value = *** i.e. for Sku 'D:\STSInterface\Infobase\MA\SkuLog'
where parameter_id =13
go
-- Style Color log
update post_parameter
set parameter_value = *** i.e. for Style
'D:\STSInterface\Infobase\MA\StyleClrLog'
where parameter_id =14
go
-- Style log
update post_parameter
set parameter_value = *** i.e. for StyleClr
'D:\STSInterface\Infobase\MA\StyleLog'
where parameter_id =15
go
-- Group log
update post_parameter
set parameter_value = *** i.e. for Group'D:\STSInterface\Infobase\MA\GroupLog'
where parameter_id =16
go
-- Init log
update post_parameter
set parameter_value = *** i.e. for Init 'D:\STSInterface\Infobase\MA\InitLog'
SQL Server Startup Script for Merchandising Analytics 475
where parameter_id =17
go
/*-----------------------------
Enter Paths for log files for Infobase to Beginning Inventory Posting
-----------------------------*/
-- Sku log
update post_parameter
set parameter_value = *** i.e. for Sku
'D:\STSInterface\Infobase\MA\BegInvSkuLog'
where parameter_id =304
go
-- Style log
update post_parameter
set parameter_value = *** i.e. for Style
'D:\STSInterface\Infobase\MA\BegInvStyleLog'
where parameter_id =305
go
-- Style color log
update post_parameter
set parameter_value = *** i.e. for StyleClr
'D:\STSInterface\Infobase\MA\BegInvStyleClrLog'
where parameter_id =306
go
-- Group log
update post_parameter
set parameter_value = *** i.e. for Group
'D:\STSInterface\Infobase\MA\BegInvGroupLog'
where parameter_id =307
go
/*-----------------------------
This applies for Fox and later versions only.
A New parameter called preSegmentsCheck has been added as a segment parameter to all the IB to MA segments. It prevents these segments from starting (executing) while EDM & PROD to MA & SL - Style Reclass segment is running. Please set the parameter value to the segment number of this Style Reclass segment.
-----------------------------*/
--MA Internal--
/*-----------------------------
476 Appendix: MA SQL Startup Script
Following are other log files that must be set for other Pipeline
Segments.
-----------------------------*/
-- Purge History log
update post_parameter
set parameter_value = *** i.e.
'D:\STSInterface\Infobase\MA\PurgeHistoryLog\purgehistorylog.dat'
where parameter_id = 90
go
-- Housekeeping log
update post_parameter
set parameter_value = *** i.e.
'D:\STSInterface\Infobase\MA\HousekeepingLog\housekeepinglog.dat'
where parameter_id = 91
go
-- Location/Comp log
update post_parameter
set parameter_value = *** i.e.
'D:\STSInterface\Infobase\MA\ComparativeStoresLog\compstoreslog.dat'
where parameter_id = 92
go
--Alternate Hierarchy Log
Update post_parameter
set parameter_value = *** i.e.
'D:\STSInterface\Infobase\MA\AlternateHierarchies\AlternateHStartup.dat'
where parameter_id = 299
go
--Alternate Hierarchy Batch Size
Update post_parameter
set parameter_value = *** i.e. 1000
where parameter_id = 264
go
--MA to Allocations--
--Updates for MA to Allocation indicating the hierarchy level id for plan level in Allocations. e.g. class or sub-type
SQL Server Startup Script for Merchandising Analytics 477
update post_parameter
set parameter_value = *** i.e. '3'
where parameter_id = 66
go
-- Indicate the hierarchy level id for category level in Allocations. e.g. dept or skin type.
update post_parameter
set parameter_value = *** i.e. '4'
where parameter_id = 67
go
--Enter destination file folder in which the Allocation Export files (size OH and In-Transit) will be created by Pipeline segment 11008
update post_parameter
set parameter_value = *** i.e. 'c:\stsinterface\trans'
where parameter_id = 68 --BEFORE Build 1.4.16.0 (Dragon) or 2.1.8.0 (Eagle)
the parameter_id is 167
go
--Indicate if need to include the records with zero quantity as part of the size
OH export to Allocation.
-- 0=No, 1=Yes
update post_parameter
set parameter_value = *** i.e. '1'
where parameter_id = 130 --BEFORE Build 1.4.16.0 (Dragon) or 2.1.8.0 (Eagle) the parameter_id is 162
go
-- Indicate if need to send style level data as part of the Allocation (Size OH and In Transit)
-- 0=No, 1=Yes
update post_parameter
set parameter_value = *** i.e. '1'
where parameter_id = 131 --BEFORE Build 1.4.16.0 (Dragon) or 2.1.8.0 (Eagle) the parameter_id is 163
go
-- Indicate if need to send style color level data to Allocation (Size OH and In Transit)
-- 0=No, 1=Yes
update post_parameter
set parameter_value = *** i.e. '1'
where parameter_id = 132 --BEFORE Build 1.4.16.0 (Dragon) or 2.1.8.0 (Eagle) the parameter_id is 164
478 Appendix: MA SQL Startup Script
go
-- Indicate if need to send group (level above style) to Allocation (Size OH and In Transit)
update post_parameter
set parameter_value = *** i.e. '1'
where parameter_id = 133 --BEFORE Build 1.4.16.0 (Dragon) or 2.1.8.0 (Eagle) the parameter_id is 165
go
--Batch size for Batch Lists.
--Used by segment 11008 MA to Allocation. Value needs to be tweaked based on Pipeline posting performance
update post_parameter
set parameter_value = *** i.e. '1000'
where parameter_id = 135
go
/*-----------------------------
Enter the inventory status IDs (i.e. available, unavailable in transit, etc...) to be included in the Size OH for Allocation export. Parameter is used by Pipeline segment 11008 MA to Allocation export. Note that the ID, not the code, must be entered as the parameter_value. The IDs can be selected from inventory_status table.
-----------------------------*/
update post_parameter
set parameter_value = *** i.e. '1,2,3'
where parameter_id = 136 -- --BEFORE Build 1.4.16.0 (Dragon) or 2.1.8.0 (Eagle) the parameter_id is 161
go
--Indicate if Price Point is defined in Allocation.
--0=No, 1=Yes.
--If yes then Price Point tables need to be setup further down in this script
update post_parameter
set parameter_value = *** i.e. '1'
where parameter_id = 140 -- --BEFORE Build 1.4.16.0 (Dragon) or 2.1.8.0 (Eagle) the parameter_id is 160
go
--Batch size for Num of Rows.
--Used by segment 11008 MA to Allocation. Value needs to be tweaked
SQL Server Startup Script for Merchandising Analytics 479
based on Pipeline posting performance
update post_parameter
set parameter_value = *** i.e. '3000'
where parameter_id = 166
go
--Right X characters for Department
update post_parameter
set parameter_value = *** i.e. 3
where parameter_id = 168
go
--Right X characters for Class
update post_parameter
set parameter_value = *** i.e. 7
where parameter_id = 169
go
--Delimiter to be stripped from the above Class/Dept code
update post_parameter
set parameter_value = *** i.e. '-'
where parameter_id = 170
go
--List of dept Codes (blank if every department is sent)
update post_parameter
set parameter_value = *** i.e. ''
where parameter_id = 171
go
/*-----------------------------
There are several tables that need to be populated with client specific data; these tables are described below with sample insert statements and sample data. Please make sure the values are valid for each client.
-----------------------------*/
--Allocation Price Point Table
--SQL Statement:
INSERT INTO allocation_price_point(price_status_id, allocation_price_point)
VALUES(<price_status_id>, <allocation_price_point>)
--Sample Data:
/*
480 Appendix: MA SQL Startup Script
Note: Price status ID is what is defined in price_status table in Merchandising, and allocation_price_point is what is defined in Allocations. This table is the link between price point in Allocations and price status in Merchandising. In Allocations, price point 1 is always Regular, price point 2 is always Markdown.
price_status_id allocation_price_point
11
22
32
42
52
62
*/
--MA to Planning or Core to Planning--
--Plan Element Group Table
--SQL Statement:
INSERT INTO plan_element_group(plan_element_group_id, plan_element_group_code,
plan_element_group_label)
VALUES(<plan_element_group_id>, <plan_element_group_code>,
<plan_element_group_label>)
--Sample Data
/*
Note the following two rows are standard for each client; therefore these rows will be inserted for you with the General Install:
plan_element_group_idplan_element_group_codeplan_element_group_label
1DDaily
2WWeekly
*/
--Plan Exp Table Table
--SQL Statement:
INSERT INTO plan_exp_table(plan_exp_table_id, plan_exp_table_name,
plan_exp_table_group_id, plan_exp_level_id, build_list_sql)
VALUES(<plan_exp_table_id>, <plan_exp_table_name>,
SQL Server Startup Script for Merchandising Analytics 481
<plan_exp_table_group_id>,
<plan_exp_level_id>, <build_list_sql>)
--Sample Data
/*
Note: there are rows inserted by the General Install which are standard for all clients. However, if you insert any rows into plan_exp_level table then you will need to add more rows into this table as well. The plan_exp_table_group_id and plan_exp_level_id are foreign keys from plan_exp_table_group and plan_exp_level tables respectively. All the plan_exp_table_id must be greater than 1000 as it is reserved for client specific rows. Following is sample only.
plan_exp_table_idplan_exp_table_nameplan_exp_table_group_idplan_exp_level_idbuild_list_sql
10001hist_group_loc_wk x12select distinct (hierarchy_group_id) from
hist_group_chn_wk order by hierarchy_group_id
*/
--Plan Version Table
--SQL Statement:
INSERT INTO plan_version(plan_version_id, plan_version_code, plan_version_label,
current_plan_flag)
VALUES(<plan_version_id>, <plan_version_code>, <plan_version_label>,
<current_plan_flag>)
--Sample Data
/*
Note: Following rows are already given to you by the General Install. For any additional plan versions you may use these samples as a guide.
plan_version_idplan_version_codeplan_version_labelcurrent_plan_flag
1CCurrent Worksheet1
4IInital0
*/
--MA to Planning or Core to Planning--
482 Appendix: MA SQL Startup Script
/*
Besides the above manual inserts, there are several other tables that needs to be populated by generating scripts with a user interface and running these scripts on the database, or directly thru a user interface. For example, for all the clients that are using the Julian calendar instead of the regular merch calendar, you must use a specific user interface called 'Julian calendar'.
You can find more information about this on the Merch website in requirements and developer docs.
For planning export (history transactions) most of the modifications are done by using a User Interface. The details of this can be found at developer docs in the Merch Website.
*/
--THE FOLLOWING STATEMENTS DO NOT NEED TO BE MODIFIED
-- Checks that the following tables are not empty. If they are empty, re-run Core to MA Segment.
select 'post_parameter table is empty'
where
0 = (select count (*) from post_parameter)
go
select 'component_xref table is empty'
where
0 = (select count (*) from component_xref)
go
select 'post_sql table is empty'
where
0 = (select count (*) from post_sql)
go
select 'calendar_date table is empty'
where
0 = (select count (*) from calendar_date)
go
select 'component_type table is empty'
where
0 = (select count (*) from component_type)
SQL Server Startup Script for Merchandising Analytics 483
go
select 'history_component table is empty'
where
0 = (select count (*) from history_component)
go
--Updates post_parameter last dates
1. --Last Week for all levels and initial max infobase date
update post_parameter
set parameter_value = (
select MAX(merch_year * 100 + merch_week)
from calendar_merch_week c, post_parameter p
where merch_year * 100 + merch_week < p.parameter_value
and p.parameter_id = 308)
where parameter_id in (1,4,7,10,23)
go
--Last Period for all levels
update post_parameter
set parameter_value = (
select MAX(merch_year *100 + merch_period)
from calendar_merch_week c, post_parameter p
where merch_year * 100 + merch_week < p.parameter_value
and p.parameter_id = 308)
where parameter_id in (2,5,8,11)
go
--Last Year for all levels
update post_parameter
set parameter_value = (
select MAX(merch_year)
from calendar_date c, post_parameter p
where merch_year * 100 + merch_week < p.parameter_value
and p.parameter_id = 308)
where parameter_id in (3,6,9,12)
go
User Documentation Feedback FormUse this form to send Epicor comments on documentation. Thank you for taking the time to help us improve our publications.
After completing the fields, click the Submit Form button (in the top-right corner) to send your comments to Epicor.
User Info (optional)
Documentation Info
Comment
Rating
Name:
Company:
Email address:
Can we contact you if we need further information? Yes No
Document name: Publication date (inside cover):
If you are commenting on specific text, include the location of the text (for example, a help topic title, a chapter and section title, a table number, or a page number):
Comments (including corrections and suggestions):
Please rate the document: Excellent Good Average Fair Poor
Did the document meet your needs? Yes No If not, fill in the Comments field above, describing your situation.