Shoper 9 Customisation Guidelines

Transcription

1 Shoper 9 Customisation Guidelines

2 The information contained in this document is current as of the date of publication and subject to change. Because Tally must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Tally, and Tally cannot guarantee the accuracy of any information presented after the date of publication. The information provided herein is general, not according to individual circumstances, and is not intended to substitute for informed professional advice. This document is for informational purposes only. TALLY MAKES NO WARRANTIES, EXPRESS OR IMPLIED, IN THIS DOCUMENT AND SHALL NOT BE LIABLE FOR LOSS OR DAMAGE OF WHATEVER NATURE, ARISING OUT OF, OR IN CONNECTION WITH THE USE OF OR INABILITY TO USE THE CONTENT OF THIS PUBLICATION, AND/OR ANY CONDUCT UNDERTAKEN BY PLACING RELIANCE ON THE CONTENTS OF THIS PUBLICATION. Complying with all applicable copyright and other intellectual property laws is the responsibility of the user. All rights including copyrights, rights of translation, etc., are vested exclusively with TALLY SOLUTIONS PRIVATE LIMITED. No part of this document may be reproduced, translated, revised, stored in, or introduced into a retrieval system, or transmitted in any form, by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Tally Solutions Pvt. Ltd. Tally may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written licence agreement from Tally, the furnishing of this document does not give you any licence to these patents, trademarks, copyrights, or other intellectual property Tally Solutions Pvt. Ltd. All rights reserved. Tally, Tally 9, Tally9, Tally.ERP, Tally.ERP 9, Shoper, Shoper 9, Shoper POS, Shoper HO, Shoper 9 POS, Shoper 9 HO, TallyDeveloper, Tally Developer, Tally.Developer 9, Tally.NET, Tally Development Environment, Tally Extender, Tally Integrator, Tally Integrated Network, Tally Service Partner, TallyAcademy & Power of Simplicity are either registered trademarks or trademarks of Tally Solutions Pvt. Ltd. in India and/or other countries. All other trademarks are properties of their respective owners. Version: Shoper 9 Customisation Guidelines/1.1/July 2009

3 Contents Introduction 1. Generating Customised Reports 1.1 Approaches to Reporting Common Concepts 2.1 Retrieving Captions of Various Attributes Understanding the Analysis Code Design Void Indicator Summary Info for Reporting Procedures 3.1 How to use ShprFW01.DLL Retrieving Data/ Shoper DB Structure Appendix 4.1 GenLookup Table Class12Combo Table SubClass1Cat Table SubClass2Cat Table ItemMaster Table SizeCat Table StkTrnHdr Table StkTrnDtls Table SaleTrnHdr Table POSCashTrn Table StockTrnSummary Table IDTable IMTable i

4 Introduction Shoper is a popular retail solutions suite that has been in the market for almost two decades. Over this period it has undergone major enhancements and revisions to cater to the ever growing requirements and demands of the customer. As the retail scenario becomes more and more competitive, retail solutions also need to be dynamic, accomodative and flexible. Keeping this in mind, the suite allows customisations or add-ons to some extent, without modifying the base product. Customised add-ons are faster to develop and easy to deploy without disturbing the equilibrium. To harmonise with these dynamic solutions, various addon modules are under development. As a pilot for this initiative, the custom report generation module is ready for implementation. 1

5 1. Generating Customised Reports Reports such as Stock reports, Sales reports, Cash flow reports and Customer related reports play a major role in retail business and in understanding the business pattern. Thus, the facility of generating reports is critical for the success of any retail management software. Shoper has an inherent set of reports that would satisfy most of the requirements of a retail business. However, some users may have the need for an ad-hoc report due to the nature of their ecosystem or environment. To satisfy this need Shoper allows addition of custom reports with the help of an add-on component. Reports can be generated using the add-on module and deployed as per user requirements. This document explains how the add-on module can be used for generating reports. The document also covers the data storage concepts used in Shoper, various approaches to reporting, advantages and disadvantages of the possible data accesses methods in this context and data retrieval from the database. A few sample reports have been generated to demonstrate the functionality of this module. 1.1 Approaches to Reporting A Report can be generated either by direct retrieval from the Shoper standard tables or by using the Temporary Tables. However, almost all the Reports do require temporary tables. Direct from Shoper Table This method is useful for reports, for which data can be fetched using a single SQL statement. This can be done through the ADODB recordset. Advantages Less complex to generate reports as the data set is fetched using a single SQL statement Better performance in the case of simple reports Disadvantages The report generation is slow in the case of complex queries as the recordset processing is done row by row and is time consuming Improper usage of the Loc type of the recordset can lead to performance issues Using Temp Tables In order to avoid performance issues related to recordset processing and to generate complex reports, you can use intermediate tables called Temporary Tables (Temp Tables) for data processing. You can use either SQL server Temp tables or Program managed Temp tables. SQL Server Temp Tables The SQL server temp tables are of two types, namely, Local and Global. The local and global temporary tables differ only in their names, visibility and availability. 2

6 Generating Customised Reports Local Temporary Tables Local temporary tables can be created from any connection in the database. Local temporary tables are connection specific tables, i.e., these tables can be accessed only from the connection where the tables are created. These tables are dropped automatically, when the connection from where the tables are created is closed. Syntax of the Local Temp table is given. CREATE TABLE #people ( id INT, name VARCHAR(32) ) Internally, local temporary tables are created and populated in the SQL server, tempdb database. If the temp tables are already present, the same can be checked and dropped as shown. IF OBJECT_ID('tempdb..#PEOPLE') IS NOT NULL BEGIN drop table #PEOPLE END The characteristics of Local Temp Tables are as follows: Local temporary tables are prefixed with a single # (hash) with their names (i.e., #table_name) Local temporary tables are accessible only in the current session. In other words, these tables are available only to the connection where they are created These tables are dropped automatically when the program closes its Database connection Advantages Multi-user scenarios are handled automatically. In the case of local temporary tables, you can create multiple copies of the same table from the same connection or different connections simultaneously. The program will automatically handle the existence and accessibility of the temp tables. Global Temporary Tables The global temporary tables can be created from any connection in the database. In contrast to local temporary tables, global temporary tables are not connection specific tables, i.e., these tables can be accessed from any connection irrespective of where the tables are created. These tables are dropped automatically when all the connections using the tables are closed. 3

7 Generating Customised Reports The Syntax of the Global Temp table is as shown. CREATE TABLE ##people ( id INT, name VARCHAR(32) ) Internally, global temporary tables are created and populated in the SQL server, tempdb database. You cannot create more than one global temporary table with the same name, i.e., the creation of a second global temporary table with the same name of an existing table, in any of the connections is not possible as long as the original table (the one which is created first) is existing. If the temporary tables are already present, the same can be checked and dropped as given. IF OBJECT_ID('tempdb..##PEOPLE') IS NOT NULL BEGIN drop table ##PEOPLE END The characteristics of Global Temp Tables are: Global temporary tables are prefixed with a ## (double hash) with their names (i.e., ##table_name). Global temporary tables are accessible in all connections. In other words, these tables are available to any connection till they exist. These tables are dropped automatically when all the connections that are using the tables are closed. Advantages It is easy to test/ debug the application as the temporary tables are accessible from any other database connection. Disadvantages Multi-user scenarios are handled programmatically, since you cannot create the same table from different connections simultaneously. It is advisable to use ## table for development, testing and debugging. 4

8 Generating Customised Reports Program Managed Temporary Tables The program managed temporary tables are standard SQL server tables. As the name suggests, functionalities like creating and dropping of temp tables, multi-user accessing are handled programmatically in the case of Program Managed Temp tables,. Handling Multi-user Access in Program Managed Temp Tables: 1. Creating a Temp Table by concatenating the UserId with the Temp Table name, e.g., Temp- SalesSuper In this method, a separate Temp Table is created for each user so that the temporary table created is dropped after the report is displayed. So the Temp Table will not remain in the database permanently. In this method, there is no need to use the UserId condition in each and every query. The same user cannot have more than one login simultaneously. Sample code for creating the Temp table TempSalesSuper is given. Here, the first step is to get the UserId from the command line argument using shprfw01.dll as shown. To create the Temp table, concatenate the Userid with the Temp table name as shown. 2. An alternative method for creating the Temporary Table involves the UserId field present in the Temp Table and checking the UserId condition in each query. The data has to be deleted from the Temp Table either at the beginning of the report generation process or after the report is displayed. Sample code for creating a temp table with UserId field is given. Insert with Userid (The Userid is taken from the command line) (struserid The variable that holds the userid) 5

9 Generating Customised Reports Update with Userid Delete with Userid Advantages The data verification and debugging will be easy since the program managed temp tables are persistent in nature. Disadvantages Multi-user accessibility is handled programmatically. Temp tables are dropped programmatically. The performance of database maintenance and backup operations will be affected, since the database size may increase in the case of program managed temp tables. General Guideline for using the temp tables effectively The data type and the length should be matched with corresponding Shoper tables Avoid using unnecessary columns while creating temp tables, i.e., use only the required columns Populate only the required/ filtered data to the temp table Consider using indexes Avoid multiple Update statements. Include columns as part of Insert statements It is advisable to use SQL server local temp tables (# table) Following is an example that shows how to avoid multiple Update statements while using temp tables. 6

10 Generating Customised Reports Sample code which uses two Update statements is shown below. The same code can be written using minimal Update statements as follows. If you are creating temporary table(s) in a transaction, you need to complete the transaction immediately as the create process will lock some system tables preventing others from executing the same query. In the case of SQL server temp tables (both # and ## tables), you need to ensure that there is enough free space in the drive where the SQL server Temporary Database is created. This is required because the SQL Temp tables (# and ## tables) are physically created in the SQL server Temporary Database and not in the Application Database. However, the Temporary Database will be removing the unwanted data as part of the SQL server stat process. 7

11 2. Common Concepts This section covers the basic concepts of Shoper design, which helps you create and manage your program efficiently. 2.1 Retrieving Captions of Various Attributes The Shoper captions are placed in the Sysparam table and are internally linked with a param code. The method used to retrieve the captions is the same in the case of both Shoper HO and Shoper POS. Please refer the appendix for more details. A sample code for fetching Classification1 and Classification2 captions from Sysparam table is shown. Here Shopercommon.ReturnSysParam retrieves captions (paramcode values) from the Sysparam table using shprfw01.dll. Here, the caption of Item Classification1 is Product. The recid of Product is 1 (Refer Sysparam table). Sample code to fetch the recid and the corresponding record from the Genlookup table is given. select recid,code,descr from genlookup where recid='1 8

12 Common Concepts Figure Understanding the Analysis Code Design Shoper supports item analysis codes. There are 32 item analysis codes placed in the Item Master table. You can enable or disable the item analysis codes during implementation as per the requirement,. The behaviour of these analysis codes are controlled by Sysparam. The list of values of the Analysis codes is stored in the Genlookup table. Please refer the appendix for more details. Sample code to retrieve the caption of Item Analysis Code1 is given. To retrieve captions, you need to check the availability of the corresponding Item Analysis Codes. Here, the caption of Item Analysis Code1 is Fibre. The recid of Fibre is 65 (refer Sysparam table). Sample code to fetch the recid and the corresponding record from the Genlookup table is given. 9

13 Common Concepts select recid,code,descr from genlookup where recid='65' Figure 2. In this manner you can fetch details of all the analysis codes for shoper POS and the Replication Database. 2.3 Void Indicator A Void Indicator plays an important role at the transaction retrieval time and is generally used to show whether the transaction has been cancelled or not. It is a Boolean field where the value 1 indicates a cancelled transaction, else not. In Shoper, the Void Indicator is displayed in two transaction tables, namely, stktrndtls field name (docentvoidind) and stktrnhdr field name (docvoidind). So while joining a query, the void indicator can be used to check if it is a sales or stock related report. 2.4 Summary Info for Reporting The Stocktrnsummary table has the Stockno wise summarised monthly details of all the transactions. Refer appendix for more details. The opening balance for the month will get updated as part of the month beginning process and the cumulative transaction info gets updated as part of the day end operations. In other words, the current day s transaction details will not get updated to the Stocktrnsummary table till the day end process is completed. Summary info of the HO is stored in IM and ID tables. Here, the IM table stores details like Showroom wise, Month wise, SKU wise Opening Stock Quantity and Value, whereas the ID table stores details like Showroom wise, Date wise and SKU wise Transaction Quantity and Value. 10

14 3. Procedures 3.1 How to use ShprFW01.DLL Creating a Standard EXE Project 1. Open Visual Basic 6.0 If Visual Basic 6.0 is installed on your system, you can open it from Windows Start menu. 2. Go to Programs > Microsoft Visual Studio 6.0 > Microsoft Visual Basic 6.0 The New Project dialog box opens. Figure Select Standard EXE and click Open The new Standard EXE project is opened. On the top right of the screen, you will see the Project Explorer window. 4. Click the View Code (the top left icon) 11

15 Procedures The Project Explorer window is as shown. Figure 4. The Code window is as shown. Figure 5. You are now ready to start a new project. Tips: Double click on the form and type in between the two lines (Private Sub Form_Load and End Sub). This code will be executed as soon as the program starts. Now, you need to refer the DLL. To refer the DLL, 12

16 Procedures Go to Project > References Figure 6. The References window opens and the available References are displayed. 5. Select the Shoper library that contains ShprFW01.Dll and then click OK to confirm 13

17 Procedures The References window is displayed. Figure 7. Here, the Shoper library selected is Shoper Customization Framework V Right-click in the Project Explorer window (displayed on the top right side of the screen) and Select Project1 Properties listed in the drop box Figure 8. 14

18 Procedures This will take you to Project Properties window. 7. In the Project Properties window, tab down to Startup Object field under the default tab General and select Sub Main from the dropdown list. The Project Properties window is as shown. Figure Select the tab Make in the Project Properties window. The Command Line Arguments and Conditional Compilation Arguments fields are to be entered in the respective fields. Sample Command Line Arguments and Conditional Compilation Arguments are given. Command Line Arguments Super, nothing, shopertest, Shopent5, shoper9888, C:\temp, sa, 0, SQLOLEDB, VSPSQL2K, TESTPC2, sa, c:\temp, c:\temp, c:\temp, 1111 The values passed from the given command line are: Connection string: Provider=SQLOLEDB; SERVER=TESTPC2; UID=sa; PWD=sa; DATA- BASE=shoper

19 Procedures Conditional Compilation Arguments SHOPERVERSION = 7 The Conditional Compilation Arguments should always be SHOPERVERSION = 7. The Project Properties window is displayed. 9. Click Ok Figure 10. Once you have completed these basic steps, open a bas module for the Sub main code. 10.Right-click in the Project Explorer window (displayed on the top right side of the screen) and go to Add > Module 16

20 Procedures The Project Explorer window is as shown. Figure 11. The Add Module window is as shown. Figure

21 Procedures 11.Click Open to open the Module Code window The Bas Module code is explained below with the corresponding database connection. 18

22 Procedures Adding Crystal Report to the Project 1. Right-click in the Project Explorer window (which is on the top right of the screen) and go to Add > Crystal Reports 8 Figure 13. The Seagate Crystal Report Gallery window is displayed. 2. Select the option As a Blank Report 19

23 Procedures Figure Click OK The Crystal Designer form opens a default Form (Form2) under the option Forms. Figure 15. The code window of Form2 (The default page of the Report Designer) is displayed as shown. 20

24 Procedures Figure 16. The command Dim Report As New CrystalReport1 needs to be commented, since there is Object for report in shprfw01.dll. So in Form2, Dim Report As New CrystalReport1 is not required. 21

25 Procedures The Form2 code after making the mentioned changes is as shown. Caution: When you run this program, you may encounter the following error. Reason: The Project Properties have changed when the Crystal Report is loaded. Solution: The Startup Object is loaded as Form2 and has to be changed to Sub Main. 22

26 Procedures Figure Go to the Crystal Designer and retain the first section (Report Header) as such 5. Insert the Page Header sections as shown 6. Right-click on Page Header [Section2] and select Insert Section Below 23

27 Procedures 7. Insert seven new sections Figure Rename the Section names to PageHdr1 to 6, i.e., HeaderName="PageHdr1" and so on till PageHdr6 24

28 Procedures Figure 19. Here, the six sections, i.e., PageHdr1 to PageHdr6 are for Report Header. The seventh section is for Report Name, Page No., Print Date and Shoper Date. 9. Insert a Text Object in each of the Page Header Sections (PageHdr1 to 6) as shown 25

29 Procedures Figure Rename each Text Object, i.e., PAGEHDR1Txt to PAGEHDR6Txt as shown 26

30 Procedures Figure Insert a new Text Object in the seventh section for Report Name 27

31 Procedures Figure 22. Here, Report Name is Class1, Class2, Subclass1, Subclass2 view. 12.Rename the following fields: Report Name RPTOPTN1Txt Report Options RPTOPTN2Txt Page No. (Caption) RPTPgNoDt1Txt, if required Page No. (Field) RPTPgNoDt1Fld, if required Print Date (Caption) RPTPgNoDt2Txt, if required Print Date (Field) RPTPgNoDt2Fld, if required Shoper Date (Caption) RPTPgNoDt3Txt, if required Shoper Date RPTPgNoDt4Txt, if required 28

32 Procedures The seventh section has used special fields and Text object. To refer special fields, go to Main Report in the Crystal Designer and click on Special Fields to display a drop box as shown Adding Database to Crystal Designer Figure Go to Main Report in the Crystal Designer 2. Right-click on Database Fields and select the option Add Database to Report from the drop box 29

33 Procedures The drop box is as shown. Figure 24. The Data Explorer window is as shown. Figure

34 Procedures 3. Click on the folder More Data Sources and select Active Data Object (ADO) as shown Figure

35 Procedures The Select Data Source window is as shown. Figure Select ADO and OLE DB and click Build The Data Link Properties window is displayed. 5. Click the tab Provider 32

36 Procedures 6. Select the option Microsoft OLE DB Provider for SQL Server from the list of OLE DB Provider (s) under the tab Provider 7. Click Next Figure 28. The Data Link Properties window is displayed as shown. 33

37 Procedures 8. Click the tab Connection Figure Enter information related to the Server and Database 34

38 Procedures The Data Link Properties window with information related to the Server and Database is displayed as shown. 10.Click Test Connection Figure 30. If the connection is successful, a message box is displayed as shown. 11.Click OK Figure

39 Procedures At times an authentication form is displayed as shown. Figure Enter the password of the Server and click OK The Data Explorer window is displayed as shown. 13.Click Add The Select Recordset window is displayed. Figure 33. Caution: The # Table is not displayed in the ADO connection. Solution: Create the Temp Table without # and store it in the database (which you are referring to) before designing it manually. 36

40 Procedures 14.Select the Temp Table in the Object field from the dropdown list The Select Recordset window is as shown. 15.Click OK Figure

41 Procedures The Data Explorer window is displayed as shown. 16.Click Close Figure

42 Procedures The Visual Linking Expert window is displayed as shown. 17.Click OK Figure 36. The list of database fields under Main Report in the Crystal Designer is displayed as shown. Figure

43 Procedures You can drag the database fields and place them in the Details section of the Crystal Designer. This allows you to design the required report. Inserting Group of Fields to the Crystal Designer 1. Go to Main Report in the Crystal Designer and Right click on Group Name Fields to display a drop box Figure Select the option Insert Group The Insert Group window opens. 3. Select the fields to be grouped under Group#1 40

44 Procedures These fields belong to the Temp Table. Figure Click OK To add more than one Group, repeat the steps from 1 to 4 5. Click Group Name Fields under Main Report to see the Group#1 Name created Figure

45 Procedures The Crystal Designer is displayed as shown. Figure 41. There are two sections in a Group, namely; Group Header and Group Footer. Usually, the details of a record form the Group Header part, while the Group Footer is used for the Subtotal. i. Avoid using unnecessary groupings that will make the report generation slow. ii. Suppress a Group Header or Group Footer, if not used. Same is applicable in the case of a Report Footer and Page Footer. iii. Unnecessary spaces in the Designer lead to an increase in paper consumption while printing. 42

46 Procedures Sample Program UI Design Figure

47 Procedures Bas Module code The above module will establish the database connection. 44

48 Procedures Remaining code 45

49 Procedures 46

50 Procedures Output Figure Retrieving Data/ Shoper DB Structure Joining Masters There are times when data from two or more tables have to be selected, to make your result complete. This requires the execution of the operation Join. The tables in a database can be related to each other through Keys. A primary key is a column with a unique value for each row. Each primary key value must be unique within the table. The purpose of using Join operation is to bind data together, across tables, without repeating all the data in every table. In Shoper, since all the transaction tables have primary keys, the maximum numbers of primary key wise Joins will make the query retrieval fast. You can apply conditions by using stockno in itemmaster, stktrndtls, stockmaster or stocktrnsummary. For example, you can specify: stktrndtls.stockno=itemmaster.stockno If joining with stktrndtls and stktrnhdr, then docnoprefix, docno, contrlno, docdt are of equal importance. Most of the time docdt is used in a WHERE condition. Also, a WHERE condition can take care of specific product wise or brand wise data while joining masters. Grouping Reports on the Basis of Item Master Fields Grouping allows you to organise the report fields. It gives the hierarchy of the item and its additional attributes. 47

51 Procedures Grouping in the designers can be: 1. Date wise (Bill wise Report) 2. Class1cd wise 3. Class2cd wise 4. Subclass1cd wise 5. Subclass2cd wise 6. Sizecd wise 7. Analysiscode1 wise 8. Analysiscode2 wise 9. Analysiscode3 wise 10.Analysiscode4 wise 11.Analysiscode5 wise 12.Transaction wise 13.Cashier wise 14.Salesmen wise 15.Customer wise (if customer related report) This does not mean that all the groupings mentioned above have to be used. This grouping can be defined, based on the requirement. Avoid using unnecessary groupings that will make the report generation slow. Suppress a Group Header or Group Footer, if not used. 48

52 Appendix 1. GenLookup Table As the table name hints, this table is used to store the Lookup values and some internal System Records. The Lookup values like Class1, Class2, all the Analysis Codes, Reason Codes, etc., and its descriptions are stored in this table. The Last Document Number is also stored in this table internally. Field Name DataType Length Nullable Description Recid int No Record Identifier Code. Predefined as part of the system design. Code varchar 128 No Code for the reocrd. Descr varchar 256 Yes Description of the record. Flag varchar 256 Yes Usage of this field varies based on the Recid. This is handled by program (Shoper) internally. Number int Generally, used to store the Last Document Numbers. Primary key: Recid + Code 49

53 Appendix 2. Class12Combo Table Class12combo is one of the important tables in Shoper and stores first two levels of item hierarchical data. This table contains the basic business rules and definitions used in the Item Master level. Shoper does not allow creation of any item related masters without having a valid entry in this table. Field Name DataType Length Nullable Description Class1Cd varchar 16 No Item Classification 1 Code. Defined in the Genlookup table. The description of this code will be available in the corresponding Genlookup record. Class2Cd varchar 16 No Item Classification 2 Code. Defined in the Genlookup table and Class12combo table. The description of this code will be available in the corresponding Genlookup record. Billable bit Yes This is a flag stating whether the items cataloged under this combination is billable or not. However, the Transaction module will check this flag at the Item Master level. SizeGroup varchar 16 Yes This field contains the details of the SizeGroup id of the Combo. The size details are stored in the sizecat table. RetailMarkUp Type in the percentage value that is calculated on cost price to get the MRP of the specified item. DealerMarkUp Type in the percentage value that is calculated on cost price to get the dealer price of the specified item. PrefVendorId varchar 16 Yes The default vendor who supplies the items. This field is not used in transactions. ProdTaxType varchar 16 Yes The Tax Code for the items defined under these classifications. However, the transactions use the Tax code defined in the Item Master. SuperClass1 varchar 16 Yes Item Super Classification 1 Code. Defined in the Genlookup table. The description of this code will be available in the corresponding Genlookup record. 50

54 Appendix Field Name DataType Length Nullable Description SuperClass2 varchar 16 Yes Item Super Classification 2 Code. Defined in the Genlookup table. The description of this code will be available in the corresponding Genlookup record. IsServiceCombo bit Yes This is a flag stating whether the items catalogued under this combination are service items or not. However, the Transaction modules will check this flag at the Item Master level. IsConsignmentItem bit Yes This is a flag stating whether the Items cataloged under this combination are consignment items or not. However, the Transaction modules will check this flag at the Item Master level. Primary key: Class1Cd + Class2Cd 51

55 Appendix 3. SubClass1Cat Table This table is used to store the third level of hierarchy in the item classification. Generally, the third level of hierarchal information is updated with Style/ Article details. Field Name DataType Length Nullable Description Class1Cd varchar 16 Yes Item Classification 1 Code. Defined in the GenLookup table and Class12combo table. The description of this code will be available in the corresponding General Lookup record. Class2Cd varchar 16 Yes Item Classification 2 Code. Defined in the GenLookup table and Class12combo table. The description of this code will be available in the corresponding General Lookup record. SubClass1Cd varchar Item Style Code. SubClass1Desc varchar Item Style Description. ProdTaxType Entries in the sales tax catalogue are listed for selection. RegularInd Whether the items are Regular items/ Non Regular items. Regular items are items which are repeated. They are also called as perennial items. Non Regular items are seasonal and are related to fashion. AnalCode1 varchar 16 Yes The user defined Item Analysis Code 1. The applicability, caption and Genlookup Recid of this attribute have to be defined in the Sysparam. The list of values with the description to be catalogued in the respective Genlookup record. AnalCode2 varchar 16 Yes The user defined Item Analysis Code 2. The applicability, caption and Genlookup Recid of this attribute have to be defined in the Sysparam. The list of values with the description to be catalogued in the respective Genlookup record. 52

56 Appendix Field Name DataType Length Nullable Description AnalCode3 varchar 16 Yes The user defined Item Analysis Code 3. AnalCode4 varchar 16 Yes The user defined Item Analysis Code 4. AnalCode5 varchar 16 Yes The user defined Item Analysis Code 5. AnalCode6 varchar 16 Yes The user defined Item Analysis Code 6. AnalCode7 varchar 16 Yes The user defined Item Analysis Code 7. AnalCode8 varchar 16 Yes The user defined Item Analysis Code 8. AnalCode9 varchar 16 Yes The user defined Item Analysis Code 9. 53

57 Appendix Field Name DataType Length Nullable Description AnalCode10 varchar 16 Yes The user defined Item Analysis Code 10. AnalCode11 varchar 16 Yes The user defined Item Analysis Code 11. AnalCode12 varchar 16 Yes The user defined Item Analysis Code 12. AnalCode13 varchar 16 Yes The user defined Item Analysis Code 13. AnalCode14 varchar 16 Yes The user defined Item Analysis Code 14. AnalCode15 varchar 16 Yes The user defined Item Analysis Code 15. AnalCode16 varchar 16 Yes The user defined Item Analysis Code

58 Appendix Field Name DataType Length Nullable Description AnalCode17 varchar 16 Yes The user defined Item Analysis Code 17. AnalCode18 varchar 16 Yes The user defined Item Analysis Code 18. AnalCode19 varchar 16 Yes The user defined Item Analysis Code 19. AnalCode20 varchar 16 Yes The user defined Item Analysis Code 20. AnalCode21 varchar 16 Yes The user defined Item Analysis Code 21. AnalCode22 varchar 16 Yes The user defined Item Analysis Code 22. AnalCode23 varchar 16 Yes The user defined Item Analysis Code

59 Appendix Field Name DataType Length Nullable Description AnalCode24 varchar 16 Yes The user defined Item Analysis Code 24. AnalCode25 varchar 16 Yes The user defined Item Analysis Code 25. AnalCode26 varchar 16 Yes The user defined Item Analysis Code 26. AnalCode27 varchar 16 Yes The user defined Item Analysis Code 27. AnalCode28 varchar 16 Yes The user defined Item Analysis Code 28. AnalCode29 varchar 16 Yes The user defined Item Analysis Code 29. AnalCode30 varchar 16 Yes The user defined Item Analysis Code

60 Appendix Field Name DataType Length Nullable Description AnalCode31 varchar 16 Yes The user defined Item Analysis Code 31. AnalCode32 varchar 16 Yes The user defined Item Analysis Code 32. Primary key: Class1Cd + Class2Cd + Subclass1Cd 4. SubClass2Cat Table This table is used to store the fourth level of hierarchy in the item classification. Generally, the fourth hierarchal information is updated with Shade/ Colour or item variant of the Subclass1 definition. Field Name DataType Length Nullable Description Class1Cd varchar 16 No Item Classification 1 Code. Defined in the GenLookup table and Class12combo table. The description of this code will be available in the corresponding General Lookup record. Class2Cd varchar 16 No Item Classification 2 Code. Defined in the GenLookup table and Class12combo table. The description of this code will be available in the corresponding General Lookup record. SubClass2Cd varchar 16 No The code of the Subclass 2 definition. SubClass2Desc varchar 50 The description of the Subclass 2 definition. Primary key: Class1Cd + Class2Cd + Subclass2Cd 57

61 Appendix 5. ItemMaster Table Item Master is one of the most important tables in Shoper architecture. This table stores details of the all item along with it classification and attributes. Field Name DataType Length Nullable Description StockNo varchar 32 No Unique number for each SKU. Auto generated or manual entry. Usually used in Barcode. BatchSrlNo varchar 16 No Intended to store Item Batch serial no. Not used currently. Updated as zero (0) by default. Class1Cd varchar 16 Yes Item Classification 1 Code. Defined in both Genlookup table and Class12combo table. The description of this code will be available in the corresponding Genlookup record. Class2Cd varchar 16 Yes Item Classification 2 Code. Defined in both Genlookup table and Class12combo table. The description of this code will be available in the corresponding Genlookup record. SubClass1Cd varchar 16 Yes Item Sub Classification 1 Code. The description is updated in the Subclass1Cat table. It used to store the Style/ Article Code of the item. SubClass2Cd varchar 16 Yes Item Sub Classification 2 Code. The description is updated in the Subclass2Cat table. It this field is used to store the Colour/ Shade. SizeCd varchar 16 Yes The size of the item. The applicable size of Classification 1 and Classification 2 are stored in the Sizecat table. LeastSalableQty money Yes The least saleable (possible to sell) quantity of the item. Quantity is accepted only in multiples of the value mentioned here. Retail_Price money Yes The retail price of the item. This can be updated using the Price Revision option. In retail sales transactions, this price is used as the default selling price. The retail price can be modified at the time of transaction, if the corresponding system parameter is configured. 58

62 Appendix Field Name DataType Length Nullable Description Dealer_Price money Yes The dealer price of the Item. This can be updated using the Price Revision option. In distributor invoice transactions, this price is used as the default selling price. The dealer price can be modified at the time of transaction, if the corresponding system parameter is configured. ProdTaxType varchar 16 Yes The Product Tax Code of the item. The tax details are updated in the SalesTaxCat table. SrcTaxType varchar 16 Yes The Source Tax Code of the item. This can be defined at the time of item master creation. This is updated as part of the Inward Transaction. IsInventoryItem bit Yes Whether the item is part of the inventory or not. Non inventory items are skipped from the Stock Reports. IsRPTaxInclusive bit Yes Whether the Sales Tax component is included in the transaction price or not. This is applicable for both retail sales and distributor invoice transactions. ItemDesc varchar 60 Yes The item description of each stock item. RegularInd varchar 2 Yes Whether the item is part of the Regular/ Core items or Non Regular/ Fashion items. This info is considered as one of the item attributes. ReordLvl real Yes The details of the reorder level of the item. Not used currently. EOQ real Yes The details of the economic order quantity of the item. Not used currently. MinOrdQty real Yes The details of the minimum order quantity of the item. Not used currently. 59

63 Appendix Field Name DataType Length Nullable Description LastPurchPrice money Yes The Last Purchase Price of the item. Updated as part of purchase transaction, though it can be entered at the time of item creation. CurrentCost money Yes The current cost of the item. Updated as part of purchase transaction, though it can be entered at the time of item creation. AnalCode1 varchar 16 Yes The user defined Item Analysis Code 1. AnalCode2 varchar 16 Yes The user defined Item Analysis Code 2. AnalCode3 varchar 16 Yes The user defined Item Analysis Code 3. AnalCode4 varchar 16 Yes The user defined Item Analysis Code 4. AnalCode5 varchar 16 Yes The user defined Item Analysis Code 5. 60

64 Appendix Field Name DataType Length Nullable Description AnalCode6 varchar 16 Yes The user defined Item Analysis Code 6. AnalCode7 varchar 16 Yes The user defined Item Analysis Code 7. AnalCode8 varchar 16 Yes The user defined Item Analysis Code 8. AnalCode9 varchar 16 Yes The user defined Item Analysis Code 9. AnalCode10 varchar 16 Yes The user defined Item Analysis Code 10. AnalCode11 varchar 16 Yes The user defined Item Analysis Code 11. AnalCode12 varchar 16 Yes The user defined Item Analysis Code

65 Appendix Field Name DataType Length Nullable Description AnalCode13 varchar 16 Yes The user defined Item Analysis Code 13. AnalCode14 varchar 16 Yes The user defined Item Analysis Code 14. AnalCode15 varchar 16 Yes The user defined Item Analysis Code 15. AnalCode16 varchar 16 Yes The user defined Item Analysis Code 16. AnalCode17 varchar 16 Yes The user defined Item Analysis Code 17. AnalCode18 varchar 16 Yes The user defined Item Analysis Code 18. AnalCode19 varchar 16 Yes The user defined Item Analysis Code

66 Appendix Field Name DataType Length Nullable Description AnalCode20 varchar 16 Yes The user defined Item Analysis Code 20. AnalCode21 varchar 16 Yes The user defined Item Analysis Code 21. AnalCode22 varchar 16 Yes The user defined Item Analysis Code 22. AnalCode23 varchar 16 Yes The user defined Item Analysis Code 23. AnalCode24 varchar 16 Yes The user defined Item Analysis Code 24. AnalCode25 varchar 16 Yes The user defined Item Analysis Code 25. AnalCode26 varchar 16 Yes The user defined Item Analysis Code

67 Appendix Field Name DataType Length Nullable Description AnalCode27 varchar 16 Yes The user defined Item Analysis Code 27. AnalCode28 varchar 16 Yes The user defined Item Analysis Code 28. AnalCode29 varchar 16 Yes The user defined Item Analysis Code 29. AnalCode30 varchar 16 Yes The user defined Item Analysis Code 30. AnalCode31 varchar 16 Yes The user defined Item Analysis Code 31. AnalCode32 varchar 16 Yes The user defined Item Analysis Code 32. MfgDate datetime Yes The manufacturing date of the item. You can configure the Item Master Entry to capture this information. ExpDate datetime Yes The expiry date of the item. You can configure the Item Master Entry to capture this information. 64

68 Appendix Field Name DataType Length Nullable Description ShelfLife int Yes The shelf life of the item (in days). You can configure the Item Master Entry to capture this information. ImagePresent bit Yes Whether an image of the item is available or not. IsBillable bit Yes Whether the item is billable or not. If it is set as false, then the item will not be allowed in the sales transactions. IsService bit Yes Whether the item is a service item or not. If it is set as true, then the item will be allowed to transact only in service billing. CCStockNo varchar 40 Yes To store the orginal stock number of the item. This value is stored for information and is not used in any operation. ImageID varchar 256 Yes The name of the item image file. The image is not stored as part of the database and it is stored as an external object. The path where the image file stored is controlled using a system parameter. IsConsignmentItem bit Yes Whether the item is a consigment item or not. FlgStockTake int Yes Whether the item is undergoing stock audit or not. If it is set as true, no transaction is permitted. Primary key: Stockno + Batchsrlno Indexes: i. Class1cd ii. Class2cd iii. Subclass1cd iv. Subclass2cd v. Sizecd 65

69 Appendix 6. SizeCat Table This table contains the fifth level of Item hierachy along with the first two levels. It also gives the information whether a particular size is in high demand or not, and the specifications along with the Size Group Id catalogued in Genlookup table. Field Name DataType Length Nullable Description Class1Cd Varchar 16 No Item Classification 1 Code. Defined in the Genlookup table. The description of this code will be available in the Corresponding general lookup record. Class2Cd Varchar 16 No Item Classification 2 Code. Defined in the Genlookup table and in the Class12combo table. The description of this code will be available in the corresponding general lookup record. SizeCd Varchar 16 No This is the fifth level of classification in the Item hierarchy. Generally, used to store the size/ variant details. IsPivotalSize Bit Yes This flag indicates whether the Size is a part of Pivotal Size or not. The term Pivotal Size refers to the size that is important/ common/ fast moving. SizeGroupId Varchar 16 Yes This is the Size Group code used in grouping applicable sizes. For example, in the Apparel industry, you can define different Size Groups for Shirts, Trouser, Suits, etc. SizeGroupSrlNo Int Yes This is the serial number for the sizes in the group. It would be better to use serial numbers rather than size codes for sorting the order of the sizes. Primary key: Class1Cd + Class2 Cd + SizeCd 66

70 Appendix 7. StkTrnHdr Table This is a Stock Transaction Table. This table is mainly used to update the header level information in transactions like BIlling, Inward, Outward, etc. (i.e Trn Net Value, Total Taxes, Total Discount, Total Addons, Total Dedcutions, Total Roundoff, Bill Level Promo related references, References between transactions, etc.) Field Name DataType Length Nullable Description TrnType int 4 No Unique Indentifier for each transaction type (i.e., Sales Billing, Sales Return, Void Sales, Outward, Inward, etc.) TrnCtrlNo int 4 No Unique number generated based on the Transaction Type DocNoPrefix varchar 8 No Document Prefix defined DocNo int 4 No Auto generated Document Number based on Document Prefix DocRsnCd varchar 16 No Transaction Reason Code. Applicable for Inward and Outward Transactions. DocDt datetime 8 No Transaction date DocTime datetime 8 No Transaction time DocStat varchar 4 No Not Applicable PackCountDoc int 4 No Not Applicable. Default value as zero PackCountPhy int 4 No Not Applicable. Default value as zero PartyType int 4 No Party type PartyId varchar 16 No Customer/ Supplier/ Chain Store Code based on the Transaction Type PartyStkDocNo varchar 32 No Party DC/ Invoice Number from Goods Inward PartyStkDocDt datetime 8 No Party DC/ Invoice Date from Goods Inward AccDocNo varchar 32 No Bill Level Remarks. Applicable only to Sales Transactions AccDocDt datetime 8 No Not Applicable 67

71 Appendix Field Name DataType Length Nullable Description TotDocValue money 8 No Total gross value of the document. TotDocDisc money 8 No Total Discounts (item level + Doc level Discount) TotDocTax money 8 No Total Taxes TotDocAddons money 8 No Total Addons = (TotDocEntBe- ftaxaddons+totdocentafttax- Addons) TotDocDedns money 8 No Total Deductions = (TotDocEntBefTaxDedns+TotDocEntAftTaxDedns) NetDocValue money 8 No Total Net Value of the document after considering discount, taxes, etc. FrwdRefTrnType int 4 No Forward Reference Transaction type of the document from Goods Inwards, Goods Outwards when document is voided or edited FrwdRefCtrlNo int 4 No Forward Reference Control Number of the document from Goods Inwards, Goods Outwards when document is voided or edited BkwdRefTrnType int 4 No Backward Reference Transaction type of the document from Goods Inwards, Goods Outwards when document is voided or edited BkwdRefCtrlNo int 4 No Backward Reference Control Number of the document from Goods Inwards, Goods Outwards when document is voided or edited DocVoidInd int 4 No Flag to indicate the transaction is voided/ cancelled. The void transactions will be updated as 1 BilllvlDiscId varchar 50 No Bill Level Discount Code if present. Used only in Sales Transactions 68

72 Appendix Field Name DataType Length Nullable Description VAUid varchar 32 No User Id DocRemarks varchar 128 No Document Remarks from Goods Inwards, Goods Outwards transactions TotalLineItems int 4 No Total number of line items ProdServInd varchar 1 No Whether it is product/ service bill. Applicable only to Sales Transactions TotDocPriceFactor money 8 No Document value after applying Price Factor. Applicable only to Sales Transactions TotDocEntBefTaxAddons money 8 No Total Addons before tax TotDocEntBefTaxDedns money 8 No Total Deductions before tax TotDocEntAftTaxAddons money 8 No Total Addons after tax TotDocEntAftTaxDedns money 8 No Total Deductions after tax PromoCode varchar 32 No Bill Level Promo code. Applicable only to sales transactions ReasonCodeForCancel varchar 50 No Reason for cancellation of bill or void bill. Applicable only to sales transactions GenDiscReason varchar 250 No Reason for Bill Level discount TotRndOffValue money 8 No Total Roundoff value TotDocAddonsTax money 8 No Total tax on Addons amount. Applicable only to sales transactions Primary key: TrnType + TrnCtrlNo 69

73 Appendix 8. StkTrnDtls Table This is a Stock Transaction Table. This table is mainly used to update item level information in transactions like BIlling, Inward, Outward, etc. It stores the values related to Item Level details (i.e., break up values of STKTNHDR Tables). It also stores stock number, item level rate, tax, dicount, appropriated Addons, Deductions, Round off and References between transctions. Field Name DataType Length Nullable Description TrnType int 4 No Unique indentifier for each transaction type (i.e., Sales Billing, Sales Return, Void Sales, Outward, Inward, etc.) TrnCtrlNo int 4 No Unique number generated based on the transaction type DocNoPrefix varchar 8 No Document Prefix defined DocNo int 4 No Auto generated Document Number based on the Document Prefix DocRsnCd varchar 16 No Reason Code from Goods Inward, Goods Outward DocDt datetime 8 No Transaction date EntSrlNo int 4 No Line Item Serial Number for the document StockNo varchar 32 No Stock number OrdDocType int 4 No Type of Order (1 = Purchase Order, 2 = Indent) - GIR OrdDocNoPrefix varchar 8 No Purchase Order Prefix/ Indent Prefix - GIR OrdDocNo int 4 No Purchase Order Number/ Indent Number - GIR OrdEntSrlNo int 4 No Purchase Order Entry Serial Number - GIR OrdEntSubSrlNo int 4 No Purchase Order Entry Sub Serial Number - GIR DocQty real 4 No Document Quantity appicable for Inward transactions PhyQtyIn real 4 No Quantity for Inbound Transactions PhyQtyOut real 4 No Quantity for Outbound Transactions 70

74 Appendix Field Name DataType Length Nullable Description StkUpdtRate money 8 No Cost price of an Item StkUpdtValueIn money 8 No Stock value for inbound transactions, i.e., Stkupdtrate * phyqtyin StkUpdtValueOut money 8 No Stock value for outbound transactions, i.e., Stkupdtrate * phyqtyout DocEntRate money 8 No Rate entered in the document DocEntValue money 8 No Entered Rate * Quantity DocEntTotDisc money 8 No Line Item Level Total Discount + Appropraited Bill Level Discount DocEntValAftDisc money 8 No Value after applying the Discount (i.e., DocEntValue - DocEntTot- Discount) DocEntTax money 8 No Total tax value for the Line Item DocEntAddons money 8 No Total Addons for the Line item (I,e., DocEntBefTaxAddons + DocEntAftTaxAddons) DocEntDedns money 8 No Total Deduction for the Line Item (I,e., DocEntBefTaxDedns + DocEntAftTaxDedns) DocEntNetValue money 8 No Total net value for the Line Item PhysQtyReturned real 4 No Returned quantity. (This field will get updated in Sales Return and Purchase Returns) DocEntBefTaxAddons money 8 No Addons before tax DocEntBefTaxDedns money 8 No Deductions before tax DocEntAftTaxAddons money 8 No Addons after tax DocEntAftTaxDedns money 8 No Deductions after tax DocEntDisc money 8 No Line Item level discount DocEntDiscId varchar 32 No Item level Promo code. Applicable only to Sales Transactions DocEntBillDisc money 8 No Total discount amount at document level 71