How to use the Batch Query on Logger website March of 2016

Transcription

1 How to use the Batch Query on Logger website March of 2016 About the Batch Query function The verification of GTIN, GLN and GCP data are in the focus of every GS1 MO worldwide. The system (including the mobile application and administration website) has already become a widely used tool for this purpose nowadays over 500 colleagues from 75 MOs use the solution in their everyday work. Nevertheless, the best practice for the verification of GTINs, GLNs or any other GS1 ID Keys in a large quantity is to cooperate with trading partners and to control their lists of thousands of GS1 ID Keys. Although this procedures could be difficult and tiresome without effective processes or an efficient tool. The Batch Query function offers an easy-to-use, fast and effective solution for the above mentioned processes. It realizes the verification and qualification through the GEPIR server of GS1 Hungary by standardized messages just like in the case of user requests initiated on the mobile application but offering the possibility of checking thousands of GTINs, GLNS, and GCPs in bulk. In order to use the Batch Query function of LFS system, you can upload/download Excel file of GS1 Identification (ID) keys via mylogger website or you can use Batch Query Web Service1 to upload ID keys. The goals of Batch Query are the following: o Verification of GS1 ID Keys in a high amount, even 10,000 or more, in the course of one user request. o Optimized, fast and ergonomic batch query function from which the statistics can be shown in a user-friendly way through different diagrams and graphs. Records are stored in the system and can be retrieved any time. 1 The Batch Query Web Service applies SOAP-based messaging technology. 1

2 How to use the Batch Query website After logging in on the website the Batch query function can be found on the top of the page in the Menu. The list of ID Keys can be uploaded on the Batch query page. Press the [Browse] button then select the Excel file which contains the ID Keys to be checked. File format: Please upload an Excel file with.xlsx extension (Excel spreadsheet created with Office 2007 or newer). Please note that the.xls format is not supported! File content: The uploaded Excel file must contain only one spreadsheet. The number of columns in the Excel uploaded is limited: GS1 ID Key + max. 4 columns). The number of rows is limited: in one column can be uploaded rows in case of uploading more columns is If you have a list that contains the requested ID Keys, but not the GLN of the company which uses that ID Key you can upload a spreadsheet in the following format: o The first column (column A) contains the name of the GS1 ID Key (e.g. GTIN, GLN, SSCC, GRAI etc.). This column must contain only one type of ID Key (specified in the first row). The following columns (2-4) can contain additional data relating to the GS1 ID key (manufacturer, product name etc). These data can also be seen in the outcome Excel, helping the processing. 2

3 If you have a list that contains not only the requested ID Keys (e.g. GTINs) but also the GLN of the company which uses that ID Key, then you can upload a spreadsheet in the following format: o Column A: in the header (1st row) the name of the GS1 ID Key (e.g. GTIN, GLN, SSCC, GRAI etc.), underneath the ID Keys (one key per cell). The column must contain only one type of ID Key (specified in the first row). o Column B: in the header (1st row): GLN, underneath the GLNs associated to the ID Key in the Column A (one GLN per cell). The following columns (2-4) can contain additional data relating to the GS1 ID key (manufacturer, product name etc). These data can also be seen in the outcome Excel, helping the processing. The selected file can be renamed. Fill in the field of Company name with the name of the company that provided the list (optional). After uploading the file (press [Upload] button), the system checks the file and data content format. As a result, the following information is shown on the page: o Total number of lines in the uploaded file o Number of ID Keys that are not in line with the GS1 Standards (e.g. invalid check digit, length or character set) Press [Download] to download the list of ID Keys with the result of format checking (the nonstandard ID Keys are marked in the originally uploaded file). Press [Run] to start the query through GEPIR. A progress bar shows the percentage of the processed ID Keys. The process continues on the server, therefore you can close the browser and turn back to this page later on. 3

4 When the query is finished, the result is shown in a table and the whole data set (the list of uploaded ID Keys with statuses, party information etc.) can be exported into Excel spreadsheet. Furthermore, if there are invalid numbers, by pressing the [Send report] button you can send a notification to the competent MO(s) to take the necessary next steps. After clicking on this button once, it becomes inactive showing that the report has already been sent. If there aren t any invalid numbers found during the checking, the [Send report] button is inactive. 4

5 Pressing the [Send report] button a Comment window will appear. Add a remark to the notification in order to help the receiver with the follow-up of reported numbers. 5

6 Content of the notification Below you will see the that is sent by the system to the relevant GS1 MO. The report handler will get the link to the list of reported invalid ID Keys. Subject: Logger for Staff Report invalid ID Keys Dear Staff Report Administrator, This is an automatically generated notification . Please do not reply to this . A list of GS1 ID Keys has been uploaded to Logger for Staff platform. After checking this list through GEPIR, the batch query service indicated that the GEPIR status of the following GS1 ID Keys are invalid. Please see the invalid keys belonging to your country on the following link: <direct link to the list of reported Id Keys Excel spreadsheet format> You received this list of GS1 ID Keys since the GCPs belong to your country. The list was uploaded by <user name> from <GS1 MO> using the following address: < address>. Uploader s comment: < - > Even if the list of ID Keys may not be enough to explore and identify the reason of their invalid status but you may contact the relevant GS1 MO or company who uploaded the original list and initiated the batch query. Should you need further information about or need assistance, please contact the Support at lfs_support@gs1hu.org. Kind regards, Team 6

7 for Staff How to use BQ webservice In order to use the Batch Query function of LFS system, you can upload/download Excel file of GS1 Identification (ID) keys via mylogger website or you can use Batch Query Web Service2 to upload ID keys. This section describes the latter solution. Service Characteristics Fig. 1 shows the whole process of a GS1 ID key upload and it also presents the web service operations (actions) related to the main phases of general data uploading and processing within Batch Query. To apply Batch Query web service, client partner should develop a web service client application based on the WSDL file3 of Batch Query web service. The web service client should implement seven operations: 1. GetQueryGroups to get previously uploaded data (groups). 2. GetSessions to get sessions related to a group. 3. ValidateQueryGroup to validate uploaded data based on GS1 Lib data source. 4. RunQueryGroup to upload and run query related to uploaded data in the Batch Query database based on information of GEPIR data source. 5. RunExistingQueryGroup to run query based on an existing group ID. 6. GetSessionProgress to get information about the state of processing session. 7. GetSessionResult to get information about the final state of processing session. Fig. 1. Batch Query process and related web service operations 2 The Batch Query Web Service applies SOAP-based messaging technology. 3 The WSDL file is available here: Document last update:

8 Details of Batch Query Web Service The seven mentioned operations of Batch Query web service should be implemented by the following way. Notes: The exact description of Batch Query web service is included in the WSDL file of service. To use operations, the valid authentication data (username/password) is the general preliminary input parameter. 1. GetQueryGroups: This operation is to get information about previously uploaded groups (lists of ID Keys). A list can be run more times without re-uploading data group and it can be run after a finished session as well. This operation returns: Company name Group ID Type of ID key including in the group Information about last session(s) if it already run other group data (see WSDL) 2. GetSessions: This operation is to get information about every session related to a data group. The input parameter is a group ID. This operation returns ID of a session Starting date/finish date of a session Count of valid/invalid GLN Count of valid/invalid ID key other session data (see WSDL) 3. ValidateQueryGroup: This operation is to get result about ID key format validation based on GS1 Lib data source. The input parameters are the ID key type as well as ID keys and optionally the GLN numbers related to each ID Key. This operation returns an OK or a format error type (e.g. CDVError ). 4. RunQueryGroup: This operation is to upload an ID Key list and run query in Batch Query database based on information GEPIR data source. The input parameters are Name of run Company name ID key type ID key with GLN number This operation returns a session ID. 5. RunExistingQueryGroup: This operation is similar to RunQueryGroup operation but the input parameter is only the group ID of a previously uploaded Query Group in this operation. The operation returns session ID as well. 8

9 6. GetSessionProgress: This operation is to get information about the state of a running session. The input parameter is a session ID as well as page number of session. Therefore you can query only a part of processed data. This operation returns the state of running session in percentage. 7. GetSessionResult: This operation is to get information about completed session. The input parameters are the same as in case of GetSessionProgress operation. This operation returns ID key ID key status (valid, invalid, faulted) GEPIR-based responses: return code related to an ID key, response key related to an ID key, GLN-specific response key related to an ID key GLN number 9

10 History of queries All the uploaded files (both via website and web service) and query results are stored on the server, therefore each user can see the history of queries previously initiated. Queries can be initiated for an uploaded file any time without re-uploading the list by pressing the [Run] button beside the file name. All the results related to the same file are listed under the filename. 10

11 Click on the icon to see all the queries related to the selected file. Should you need further information about or need assistance, please contact the GS1 Logger support at Kind regards, Team 11