+ All Categories
Home > Documents > Sm 1000 Idi Reference Manual

Sm 1000 Idi Reference Manual

Date post: 03-Jan-2016
Category:
Upload: samuel-tan
View: 115 times
Download: 13 times
Share this document with a friend
Description:
SMIDI Document
Popular Tags:
108
Thermo Scientific SampleManager IDI SampleManager version 10.0 Reference Manual Revision A
Transcript
Page 1: Sm 1000 Idi Reference Manual

Thermo Scientific

SampleManager IDISampleManager version 10.0

Reference Manual

Revision A

Page 2: Sm 1000 Idi Reference Manual

© 2010 Thermo Fisher Scientific Inc. All rights reserved.

Thermo Fisher Scientific Inc. provides this document to its customers with a product purchase to use in the product operation. This document is copyright protected and any reproduction of the whole or any part of this document is strictly prohibited, except with the written authorization of Thermo Fisher Scientific Inc.

The contents of this document are subject to change without notice. All technical information in this document is for reference purposes only. System configurations and specifications in this document supersede all previous information received by the purchaser.

Thermo Fisher Scientific Inc. makes no representations that this document is complete, accurate or error-free and assumes no responsibility and will not be liable for any errors, omissions, damage or loss that might result from any use of this document, even if the information in the document is followed properly.

This document is not part of any sales contract between Thermo Fisher Scientific Inc. and a purchaser. This document shall in no way govern or modify any Terms and Conditions of Sale, which Terms and Conditions of Sale shall govern all conflicting information between the two documents.

All trademarks recognized.

Page 3: Sm 1000 Idi Reference Manual

Your Comments

Thermo Fisher Scientific is interested in receiving any comments you have regarding this manual.

Comments should be sent to:

[email protected]

Page 4: Sm 1000 Idi Reference Manual

Notes

Page 5: Sm 1000 Idi Reference Manual

Contents

1 Concepts......................................................................................................1 Introduction...........................................................................................................................................1 Elements of the System.........................................................................................................................2 Overview of System Operation.............................................................................................................3 Supported Features ...............................................................................................................................5

2 Connecting to SAP......................................................................................9 Introduction...........................................................................................................................................9 The SM-IDI System Table..................................................................................................................10

3 Downloading Work from SAP ..................................................................19 Introduction.........................................................................................................................................19 The Download Queue .........................................................................................................................20 The Download Process .......................................................................................................................21 Queries................................................................................................................................................22 Mapping Profiles.................................................................................................................................27 Maintaining Product Specifications in SampleManager .....................................................................33 Maintaining Phrases in SampleManager.............................................................................................34 Request Failure Management..............................................................................................................35 Link Failure Management...................................................................................................................36

4 Uploading Data to SAP .............................................................................37 Introduction.........................................................................................................................................37 Upload Queue .....................................................................................................................................37 Automatically Uploading Data ...........................................................................................................39 Manually Uploading Data...................................................................................................................39 Suspending Upload Operations...........................................................................................................39 Retests and Resamples........................................................................................................................40 Data Cleanup.......................................................................................................................................41

5 Usage Decisions .......................................................................................43 Introduction.........................................................................................................................................43 Usage Decision Information ...............................................................................................................43 Automatic Usage Decisions ................................................................................................................44 Manual Usage Decisions.....................................................................................................................44

6 Inspection Points ......................................................................................45 Introduction.........................................................................................................................................45 Points Queries .....................................................................................................................................46

7 System Management.................................................................................51 Introduction.........................................................................................................................................51 Logfiles ...............................................................................................................................................51 Background Processes ........................................................................................................................55

8 Configuration.............................................................................................63 Introduction.........................................................................................................................................63

i

Page 6: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Configuration Items ........................................................................................................................... 63 Objects ............................................................................................................................................... 73

9 Customizing SampleManager IDI ............................................................ 79 Introduction........................................................................................................................................ 79 Triggers .............................................................................................................................................. 79 Status Queue ...................................................................................................................................... 84

10 Glossary .................................................................................................... 87

Index ................................................................................................................ 99

ii

Page 7: Sm 1000 Idi Reference Manual

1 Concepts

Introduction This reference manual describes the use, management, configuration, and customization of the interface between SampleManager and SAP R/3. This interface is provided by the extended functionality module SampleManager IDI, which communicates with QM-IDI in SAP R/3's QM module.

In both SampleManager IDI and QM-IDI, the letters IDI stand for inspection data interface. This product is a means of exchanging inspection requirements and results between the two systems. The QM module sends SampleManager a request detailing what characteristics must be inspected to determine whether a quantity of material meets the required quality standards. SampleManager sends the results of those inspections back to QM. A usage decision for the material can be made in either system.

In addition, all the building blocks of the interface have been made available as a programmers tool kit. With systems as configurable as SampleManager and SAP R/3, the standard solution may not be suitable in all cases. Using this tool kit, parts of the interface can be customized to meet a wide range of requirements. The tool kit is suitable for use by competent VGL programmers.

1

Page 8: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Elements of the System SampleManager IDI allows communication between SampleManager and QM. Requests are made from QM and result data and usage decisions are returned from SampleManager. A suite of low-level functions make the necessary communication links to SAP R/3 (SAP) as shown below.

The low-level functions communicate via TCP/IP with the SM-IDI service. The SM-IDI service is part of SampleManager IDI but runs on Windows NT.

Figure 1.1: SampleManager IDI Architecture

The application is made up of two parts:

• Request manager controls the download of requests from QM. Work associated with QM inspection lots is interpreted by the process manager into job headers, samples, tests and results in SampleManager. The process manager also maintains product specifications and phrase tables in line with the details stored in QM. It also stores details of the original request so that the various data upload operations have all the information needed to communicate with QM.

• Upload manager controls the return of result values, statistical summaries of results, usage decisions and integration of SAP inspection points. In response to the appropriate request from QM, SampleManager organizes a regular sequence of inspections of a continuous process. In this case, each set of samples collected is known as an inspection point. Details of each set of samples collected and a usage decision for each inspection point may be uploaded. The upload functions are usually executed at well-defined points in the life cycle of SampleManager data.

2

Page 9: Sm 1000 Idi Reference Manual

Concepts

Overview of System Operation The purpose of SampleManager IDI is to download inspection requirements from the QM module in SAP. SampleManager IDI then returns the results of the inspections, and possibly a usage decision for the material being inspected. QM contains a dedicated interface called QM-IDI that allows the inspection requirements, results and usage decisions to be transferred between the two systems.

The inspection requirements arise from the passage of materials along the supply chain managed by the SAP logistics module as shown below.

Figure 1.2: The supply chain and its relationship to the logistics modules of SAP

Each of these modules can trigger the creation of an inspection lot in QM. This is done by identifying a quantity of material to be inspected and applying inspection operations to it from a predefined task list. In most cases, the task list is an inspection plan that identifies inspection operations and the characteristics of the material that are to be inspected in each inspection operation. If the material is being produced in a manufacturing operation, the task list may be a routing or master recipe associated with the production plan.

By default, QM assumes that inspections can be made under its sole control. People performing the inspection operations will enter results into QM’s result entry screens and perform any checks against specifications. Finally, a usage decision determining the materials suitability for use will be made in QM. In many cases, proper inspection requires the use of a laboratory and careful sample management. In these cases, the responsibility for the inspection can be delegated to a LIMS.

QM organizes the delegation of inspections by associating a work center with each inspection operation. A work center may represent a laboratory or even a particular bench within the laboratory. Equally, for a simple inspection that does not require a laboratory, it might identify a group of people in the manufacturing area who are responsible for making the inspection. Delegation occurs if the work center is associated with a subsystem. A subsystem is a database entity in SAP that represents a non-SAP system such as a LIMS.

When an inspection lot is created, QM checks to see whether any of the inspection operations are to be delegated to a subsystem. If so, QM writes brief details of each operation to be delegated into a special worklist table, ready for the subsystem to download.

3

Page 10: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Figure 1.3: Relationship of materials, inspection lots and the worklist

The worklist table is the point of access for a subsystem to download the details of the inspections required. Using the QM-IDI interface, SampleManager IDI can issue a query against the worklist. If there are any entries in the worklist that match the selection criteria in the query, QM-IDI will return the inspection request details to SampleManager IDI.

SampleManager IDI then interprets the inspection details into jobs, samples, tests and results in SampleManager. These are processed in SampleManager using the standard LIMS functionality. Once downloaded into SampleManager, the inspection operations and characteristics in QM are locked so that the results can only be supplied by SampleManager.

Once the result data is available, SampleManager IDI reports them to QM in the requested format, using the QM-IDI interface. SampleManager IDI may also be responsible for reporting whether the results are within specification. This is determined by comparison against specifications downloaded from SAP via QM-IDI, and using comparison techniques specified in the inspection request. SampleManager IDI maintains SampleManager multi-level product specification tables automatically so that the necessary specifications and comparison techniques are automatically used in SampleManager result entry and sample authorization functions.

4

Page 11: Sm 1000 Idi Reference Manual

Concepts

Figure 1.4: Interaction between QM, SampleManager IDI and SampleManager

Once all inspections are complete, a usage decision may be made in SampleManager. The usage decision dispositions the material represented by the inspection lot in QM. This involves the selection of a phrase representing the most suitable material disposition based on the result data measured in the laboratory. This selection is communicated to QM via QM-IDI. If some inspection operations are not delegated to the laboratory, or if the decision is best made based on information or experience outside the laboratory, the usage decision may be made in QM.

Once these stages are complete, the data in SampleManager may then be committed and archived as normal.

Supported Features The following list gives a brief description of the main features of SampleManager IDI. For a more comprehensive description, see the relevant chapters of this manual.

Feature Description Configurable client login to SAP.

All login information required to connect to SAP may be maintained in a SampleManager laboratory table. SampleManager IDI can use this data to connect to a dialog or background SAP account.

Scheduled download of inspection requests.

The download of inspection requests is driven by SampleManager laboratory table entries, known as queries. Queries define a repeat interval for the download. Each query may have its own selection criteria and configuration for downloading supplementary data. If required, the queries may download data from multiple SAP systems or multiple clients within a single system.

5

Page 12: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Interpretation of inspection request as jobs, samples, tests and results.

Since QM organizes inspection data differently to SampleManager, SampleManager IDI converts the downloaded information into normal active data entries.

Download of phrase data. Some of QM’s catalog data is needed by SampleManager to provide phrase tables for Option type results, and to make usage decisions for batches of material. This data can be downloaded manually, or during the download of inspection requests.

Download of product or material specifications.

The specifications for a material may be downloaded with the inspection request. SampleManager IDI can be configured to keep a permanent, read-only copy of these specification details in the multi-level product specification tables, or simply to keep a temporary copy for reference while the inspections are being performed.

Configurable mapping of inspection data into jobs and samples.

Some or all of the contextual data available in the inspection request may be useful in SampleManager. To make this available, selected data may be mapped onto sample and job fields. These fields are populated as the active data is logged in.

Merging tests requested by QM with those on a test schedule.

If more inspections are routinely performed than are required by QM, the set of tests derived from the inspection request may be merged with a test schedule to ensure that all necessary tests are assigned to samples.

Merging components requested by QM with those on an analysis or component list.

This feature is useful to enforce the recording of mandatory results that may not be requested explicitly by QM, e.g. the raw data for a calculated result.

Verifying that the Laboratory can meet the Inspection Requirements.

SampleManager IDI verifies that the data type of a requested component matches the corresponding SampleManager component. It also checks that the requested precision is not greater than the normal capability of the analysis, and that the units are compatible.

Allowing the creation of inspection points.

Inspection points may be created to represent the regular sampling of a continuous process. SampleManager IDI uses context specific data recorded at this time to describe each inspection point to QM.

Uploading of summarized or simple result values.

QM may request that individual values are uploaded from SampleManager, or a statistical summary of multiple readings that have been averaged. SampleManager IDI is capable of managing all kinds of result upload that may be requested.

Checking results against QM’s specifications.

As a result is entered in SampleManager, its value is checked against a specification. If the result is part of an inspection request from QM, the specification details downloaded from QM will be used to make this check.

Making a usage decision for an inspection lot.

When all inspections for an inspection lot have been completed in the laboratory, a SampleManager user may make a usage decision for the inspection lot. If suitably configured, this may cause automatic inventory posting within the SAP system.

Making a usage decision for an inspection point.

Each inspection point created by regularly sampling a continuous sample may have a usage decision associated with it. This usage decision may also be made by a SampleManager user.

Mapping profiles. You can specify the mapping between SAP and LIMS elements from the database without writing any VGL code.

6

Page 13: Sm 1000 Idi Reference Manual

Concepts

Failure management. During the start up of a new interface, it is common to have problems mapping the data elements, or processing the requests. Failure management allows problematic SAP lots to be skipped until the errors are corrected, and the request may be processed again.

Upload queue. Information that should be sent up to SAP may be queued in a persistent upload queue. This means that even if the link is broken the information will be sent as soon as the link is re- established.

Download of inspection characteristics.

QM inspection characteristics may used to automatically create analysis and component definitions within SampleManager. This helps reduce the amount of duplicate effort in setting up the static data.

7

Page 14: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Notes

8

Page 15: Sm 1000 Idi Reference Manual

2 Connecting to SAP

Introduction The SAP system maintains system and data security by only allowing access to authorized users. The principal technique for limiting access to the system is via a user account. SAP users must log in by supplying a valid user name and password.

Similarly, the connection from SampleManager to SAP via SampleManager IDI and QM-IDI requires a suitable account to be established in SAP. Then SampleManager IDI must supply the corresponding user name and password information whenever it wants to establish a connection.

SampleManager IDI has the additional problem of needing to specify the communications pathway from SampleManager to the SAP system. This will always require the details of which SAP system and client with which to communicate. Additionally, the SAP system may be connected via a gateway process. This process may not be running on the same system as you wish to connect to, so you must supply the location and identity of this process.

Finally, you will need to use a SM-IDI server process as a SampleManager gateway. This process will run on a platform compatible with the SAP system. You must supply the details of the location and identity of this process.

This information is contained in and managed by a laboratory table known as the SM-IDI server table.

9

Page 16: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

The SM-IDI System Table The SM-IDI system table contains all the information required to sign on to your SAP system, the scheduled downtimes of the server, and configuration settings that may be specific to the server level.

SM-IDI system records are managed through the SM-IDI System Data Entry screen, which can be accessed using the SM-IDI/QM Servers submenu.

Figure 2.1: System Data Entry Screen

Field Description Identity An identity for the record.

10

Page 17: Sm 1000 Idi Reference Manual

Connecting to SAP

Group ID Enter the name of a SampleManager group to restrict access to the record to members of the group.

Description A free text description.

Subsystem ID The subsystem identifier used within SAP.

In the SAP QM module, any inspection operations which are to be managed by external software ('subsystems') are assigned to work centers that are linked to appropriate subsystem identities.

R/3 Destination A three character string which identifies the instance of SAP to connect to.

R/3 Client The client number of the SAP system

R/3 Username The username for signing on to your SAP system. There are two choices:

• Dialog – interactive user.

• CPIC – requires the sideinfo file in the gateway directory

R/3 Hostname The name of the computer that is running the SAP application.

R/3 System Number The 2 digit SAP system number.

R/3 Language The language that the interface using for SAP data. Enter a 1 character code for the required language option:

• E (English)

• D (Deutsch)

R/3 Gateway Host The name of the SAP CPU that is serving as the gateway host

R/3 Gateway Service The name of the service that is used with the specified R/3 System Number

R/3 Mode Select the mode that SampleManager IDI will use to login to SAP:

• R/3 if this is an interactive user (see R/3 username)

• R/2 if you are using CPIC account on SAP this also requires the SIDEINFO file in the SM-IDI gateway working directory when R/2 mode

R/3 Trace On or Off defines if the SAP library will output an error message file (in the SM-IDI gateway directory)

SM-IDI Host Identifies the computer where the SM-IDI service will run. If the nominated computer is identified in a local TCP/IP hosts table or by a name server on the network, the computers host name may be entered here. The IP address must be used. By default, this is the host name.

SM-IDI Service Identifies the name of the TCP/IP SM-IDI gateway service. If the nominated service is defined in a local TCP/IP services table, the service name may be entered. Normally, the service will be identified by the TCP/IP port number used to establish communication with the SM-IDI server process. By default, this value is prefixed with ‘smidi_’, which resolves to the port set up in the services.

11

Page 18: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

QM-IDI Structure This field defines the structure used by QM-IDI objects. This is dependent on the version of SAP. There are two possible settings:

• 1 if the SAP version is 4.6b

• 2 if the SAP version is 4.6c

QM-IDI DLL Version This field defines the version of the QM-IDI DLL. Enter 46b or 46c, as appropriate.

Modifiable? If this field is set to 'No', only a user with system-level authority can modify the record.

Setting the R/3 Mode The value assigned to the R/3 Mode field needs to be determined according to the configuration of the R/3 account which SampleManager IDI will use to log in as a client. This can be configured in SAP as a dialog account, such as those used by interactive users, or as a background account.

R/3 – Interactive Login

If a dialog account is used, the R/3 Mode should be set to R/3. All information needed to make the connection is supplied from this entry in the smidi system table. Although simpler to configure and use, this technique has the disadvantage that any user who knows the password of the account can also use it for interactive sessions. To minimize risks associated with this, the password to the account is encrypted within SampleManager.

12

Page 19: Sm 1000 Idi Reference Manual

Connecting to SAP

R/2 – Background Login

If a background account is required, the R/3 Mode should be set to R/2. This uses a CPIC connection technique. Some of the connection information is provided in a sideinfo table, which is a text file called sideinfo. The text file must be present in the current working directory of the process trying to make the connection. This can be either the SampleManager or the SM-IDI server process as appropriate. This can cause problems if more than one connection route to R/3 systems is required, since a different working directory must be used for each one. This makes it very difficult for a single SampleManager session to connect to multiple R/3 systems unless SM-IDI server processes are used.

The example sideinfo file below illustrates the settings that are required so that the QM-IDI application will be able to make use of these parameters when communicating with the SAP Server:

DEST=S6A

LU=sapdemo2.labsystems.com

TP=sapdp01

GWHOST=sapdemo2.labsystems.com

GWSERV=sapgw01

PROTOCOL=I

CPIC_TRACE=2

Each of these fields is described below:

Field Description DEST The R/3 destination, as entered in the SM-IDI System Data Entry Screen

LU The R/3 hostname, as entered in the SM-IDI System Data Entry Screen

TP This entry is not on the server LTE but it will be similar to the GWSERV (e.g. the last two numbers will match).

GWHOST The R/3 gateway host, as entered in the SM-IDI System Data Entry Screen

GWSERV The R/3 gateway service, as entered in the SM-IDI System Data Entry Screen

PROTOCOL This field must be set to I

CPIC_TRACE This field controls the level of debug information and can be set to an integer value of 0, 1 or 2.

13

Page 20: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Setting the SAP Account Password Clicking the Setup button on the SM-IDI System Data Entry Screen displays a menu which allows you to configure the password which SampleManager IDI will use to connect to SAP.

The options are:

Option Description Set Password Displays a standard change password dialog which allows you to change the

password once you have entered the existing password.

Figure 2.2: Set Password Dialog

Delete Password Deletes the current password for the SM-IDI Server record. The deletion will be carried out when the SM-IDI Server record is saved.

Note This option is only displayed for users with system level authority.

Change Password Allows you to set a new password without having to enter the current password.

Figure 2.3: Change Password Dialog

14

Page 21: Sm 1000 Idi Reference Manual

Connecting to SAP

Test Password SampleManager IDI will attempt to sign on to your SAP system using the settings you have entered, and will respond with a success or failure message.

Configuring Downtimes The Downtimes screen allows you to define periods during which the SampleManager IDI upload and download processes should be suspended. This screen can be accessed by clicking the Downtimes button on the SM-IDI System Data Entry Screen.

Figure 2.4: SMIDI_SYSTEM_DOWNTIMES Screen

Downtimes can be set in two ways:

• Date allows you to define a start and end date for a single event, e.g. a holiday period.

• Interval allows you to define a start and end time for a recurring event, e.g. a daily shutdown for maintenance.

If you are defining a downtime based on dates, the column entries should be set as follows:

Column Description Type Select 'Date' as the type of downtime period which you are defining.

Start downtime Enter the date and time when you want the downtime period to begin

End downtime Enter the date and time when you want the downtime period to end

Description Enter a description for the downtime

Order numb The order number defines the order in which the downtimes will be scheduled

Smidi system The identity of the SM-IDI system which the downtime will apply to

15

Page 22: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

If you are defining a downtime based on an interval, the column entries should be set as follows:

Column Description Type Select 'Interval' as the type of downtime period which you are defining.

Start downtime Enter the start point for the interval

End downtime Enter the end point for the interval

Description Enter a description for the downtime

Order numb The order number defines the order in which the downtimes will be scheduled

Smidi system The identity of the SM-IDI system which the downtime will apply to

Setting Server Configuration Items The SMIDI_Config Item screen allows you to display the configuration items which apply to the system. To display the screen, click the Config button on the SM-IDI System Data Entry Screen.

Note The settings in this screen will apply to all QM servers defined within SampleManager IDI. It is not possible to set different values for individual QM server records.

Figure 2.5: SMIDI Config Item Screen

Option Description Value The value of the configuration item

Identity The identity of the configuration item

Query This column should be blank as the configuration item is server-level, rather than query-level

16

Page 23: Sm 1000 Idi Reference Manual

Connecting to SAP

Server The identity of the system

Configuring the Units for the Data SAP normally identifies units with a simple three character string. The SM-IDI R3 Units screen allows you to define which SampleManager unit corresponds to each SAP unit identifier. To access the SM-IDI R3 Units screen, click the Units button on the SM-IDI System Data Entry Screen.

Figure 2.6: SM-IDI R3 Units Screen

Option Description Description Free text description of the unit

Ident The identifier of the unit within the SAP database

Id sm unit The identifier of the corresponding unit in the SampleManager database

Modif Controls whether the entry is modifiable by a user with less than system-level authority.

Modified b The user who last modified the entry

Modified on The date and time when the modification was made

Remov This boolean field can be used to temporarily disable the unit. Set to:

• Yes to enable the unit

• No to disable the unit

Smidi system The identity of the system record associated with the entry

17

Page 24: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Notes

18

Page 25: Sm 1000 Idi Reference Manual

3 Downloading Work from SAP

Introduction This section describes the activities of SampleManager IDI as it transfers details of inspections to be performed in SampleManager from the worklist in QM, and interprets them into job headers, samples, tests and results.

There is a great deal of flexibility in the way the inspection requirements can be represented, enabling QM to request inspections appropriate to the many different businesses and environments in which it may be used. This presents a great deal of complexity to SampleManager IDI, and one of the ways in which this can be managed is through the various configuration points in the download process. These are covered briefly in this chapter, and in more detail in the chapter on Configuration.

In most cases, a standard download processing pattern will occur. Here, each inspection lot encountered will be represented by a job header in SampleManager, and samples will be logged in for them as required by each inspection operation.

19

Page 26: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

The Download Queue The SampleManager IDI download queue contains all data which has been downloaded and which has not yet been uploaded back to SAP. This data is temporary – the system should be configured so that when the required results and usage decisions are uploaded, the corresponding request information in the download queue will be deleted.

To view the download queue, select the Download item in the SM-IDI cabinet of the SampleManager explorer. The queue is divided into two groups, based on the value of the Processed field.

Figure 3.1: Download Queue

The download queue records contain the following information:

Column Description Smidi system The smidi system record which was used to connect to QM-IDI

Smidi query The identity of the query

Sap lot The inspection lot number from SAP

Sap object The type of SAP data contained in the item. Possible entries are:

• SAP_QIWL – worklist entry

• SAP_OPS – inspection operation

• SAP_CHARS – inspection characteristic

• SAP_POINTS – inspection point

• SAP_PHRASE – a phrase entry

Order number An incrementing number which adds a unique value to the key of each record in a set

20

Page 27: Sm 1000 Idi Reference Manual

Downloading Work from SAP

Qmidi object The entry in this column defines the structure of the QM-IDI object from which the information was downloaded. This is dependent on the version of SAP. There are two possible settings:

• 1 if the SAP version is 4.6b

• 2 if the SAP version is 4.6c

Sap op no The SAP operation number. This information is only supplied for SAP_POINTS entries

Sap batch The batch number that the item is assigned to in SAP.

Sap status The status of the worklist entry within SAP:

• A – Inspection released

• B – Inspection completed

• C – Inspection discarded

• D – Inspection cancelled

Processed A boolean value which shows whether the entry has been processed by SampleManager IDI.

Retry count The number of retry attempts for the download

Error msg Any error message generated by the download

Log date The creation date of the logfile that recorded the download.

Subsystem The subsystem identifier from SAP

Message The information downloaded from SAP. This is in the form of a concatenated string, which will be interpreted by the processing routines.

The Download Process A typical download process consists of the following stages:

1. SampleManager IDI sends a query to QM-IDI, which examines its worklist for any matching items.

2. QM-IDI sends SampleManager IDI a list of the items it has found.

3. SampleManager IDI examines its failure table to check whether any of the listed items appear. If any items are included in the failure table, they are removed from the download list.

4. SampleManager IDI downloads the data in the modified list from the QM-IDI worklist and places it in the Download Queue with the Processed flag in each downloaded record set to 'N'. If any items fail to download correctly, they will be added to the failure table and the download will be repeated with that record skipped.

5. SampleManager IDI processes the data it has downloaded to create SampleManager jobs, samples, tests and results, with any supporting data, such as MLPs, that are required. The Processed flag for each processed record in the Download Queue is now set to 'Y'.

21

Page 28: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

6. When SampleManager IDI commits the new SampleManager data to the database, it simultaneously triggers a commit for the QM module worklist, which is updated to remove the successfully processed data.

Queries The SM-IDI Query Data Entry Screen allows you to construct a query which will:

• Download data from the QM-IDI worklist

• Process the downloaded data to create SampleManager data

To create a new query, select the SM-IDI/QM Queries/Add option.

Figure 3.2: SM-IDI Query Data Entry Screen

Option Description Query Server The smidi system which the query will be used for.

Query Id The identity of the query.

22

Page 29: Sm 1000 Idi Reference Manual

Downloading Work from SAP

Query Status The status of the worklist entry within SAP:

• A – Inspection released

• B – Inspection completed

• C – Inspection discarded

• D – Inspection cancelled

Group Id Enter the name of a SampleManager group to restrict access to the record to members of the group.

Modifiable? Controls whether the query is modifiable by a user with less than system-level authority.

Description A free text description of the query

Query Repeat Interval The interval after which the query will be resent to QM-IDI

Filter Library The VGL library which contains the filter routine to use

Filter Routine The name of the filter routine

Process Repeat Interval The interval after which the processing of downloaded data will be restarted

Process Library The VGL library which contains the process routine to use

Process Routine The name of the process routine

SM-IDI Mapping Profile The identity of the mapping profile which will be used to convert the downloaded data into SampleManager data.

Two Stage Download This field should be set to "Yes" for SampleManager 2002 R1 and any more recent versions.

When you have defined the query header, click the Criteria button to set the download selection criteria.

The Config button opens the SMIDI Config Item screen, which allows you to set configuration items that apply to the query. See Setting Server Configuration Items (page 16) for more details on this screen.

23

Page 30: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Setting the Download Selection Criteria The Set Download Selection Criteria screen allows you to:

• Refine the query by defining additional parameters

• Specify the maximum number of records which can be selected when the query is run

• Define which types of information will be downloaded from the QM module to SampleManager.

Figure 3.3: Set Download Selection Criteria Screen

24

Page 31: Sm 1000 Idi Reference Manual

Downloading Work from SAP

Option Description Lot number (from, to) The range of lot numbers to download.

Note The query will stop when it has downloaded the number of lots specified in the "Max. number of lots" field. When the query is next run, it will pick up at the point in the range where downloading stopped. Downloading with the query will cease when it has reached the lot number specified in the "to" field.

Lot creation date (from, to) The from and to dates for the date the inspection lot was created. This pair of fields operates in the same manner as the "Lot number" fields described above.

Operation number (from, to)

The range of operation numbers to download. This pair of fields operates in the same manner as the "Lot number" fields described above.

Order number (from, to) The range of order numbers to download. This pair of fields operates in the same manner as the "Lot number" fields described above.

Max. number of lots The maximum number of lots that can be downloaded in one conversation with SAP. This field may be set to a value between 1 and 99.

Material number The SAP material Id.

Material document number The SAP material document number.

Operation sequence The operation sequence within SAP for the inspection.

Plant of operation The plant for the operation.

Work center The workcenter on an inspection plan or task list is what is linked to the QDR subsystem. It is what determines if the work in the SAP inspection will be done by the LIMS or an alternative system.

Plant of work center The plant to which the workcenter belongs.

Batch number The SAP batch number for this lot.

Inspection type The inspection type of the lots

Inspection origin The inspection origin of the lots

Vendor number The vendor number on the material for this lot.

Customer number The customer to which this inspection is expected to be sent.

Sort lots (Descending) This setting controls the sorting of the worklist on SAP prior to the selection criteria being applied.

• Ascending sorts lots into ascending order based on their creation date.

• Descending sorts lots into descending order based on their creation date.

Note If you set this field to descending, and enable the download of valuations, then the maximum number of lots will be coerced during the query run to 1.

25

Page 32: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Get purchasing info Select this check box to make the query select information related to the purchasing of the material being inspected and include it in the downloaded data.

Note If no purchasing information can be found, a warning may be generated.

Ignore optional requests The QM module can define inspection characteristics as either mandatory or optional. If this check box is selected, optional inspection characteristics will not be downloaded.

Once data has been downloaded and processed, SampleManager does not distinguish between optional and mandatory characteristics.

Download valuation details Select this check box to include details of the valuation technique for each characteristic in the downloaded data. This will include any tolerance limits defined for the characteristic.

If this check box is enabled, valuation can be performed within SampleManager and uploaded to the QM module.

Get vendor info Select this check box to make the query select information related to the vendor of the material being inspected and include it in the downloaded data.

Note If no vendor information can be found, a warning may be generated.

Get sales info Select this check box to make the query select information related to the sale of the material being inspected and include it in the downloaded data.

Note If no sale information can be found, a warning may be generated.

Get result phrases If this check box is selected SampleManager IDI will download any phrases associated with characteristics, so that they can be used for phrase results in SampleManager.

Note If the phrases used do not change frequently, the it will probably be more efficient to leave this check box blank and to use the SM-IDI/Background/QM-IDI/Download/Selected Sets/Phrases option to synchronize the phrase lists in SampleManager and the QM module.

Get usage decision phrases If this check box is selected SampleManager IDI will download any phrases associated with usage decisions, so that they can be used for usage decisions made in SampleManager.

Note If the phrases used do not change frequently, then it will probably be more efficient to leave this check box blank and to use the SM-IDI/Background/QM-IDI/Download/Selected Sets/Phrases option to synchronize the phrase lists in SampleManager and the QM module as necessary.

26

Page 33: Sm 1000 Idi Reference Manual

Downloading Work from SAP

Mapping Profiles Mapping profiles define how the data downloaded from SAP will be translated into SampleManager data.

To create a mapping profile, select the SM-IDI/Mapping/Add option.

Figure 3.4: SM-IDI Mapping Profile Screen

Option Description Identity The identity of the mapping profile

Group If a group identity is selected here, only members of the group will have access to the mapping profile

Description A description of the mapping profile

Modifiable If this field is set to No, only a user with system-level authority will be able to modify the mapping profile

The behavior of the mapping profile is defined in supplementary screens accessed by the following buttons:

• Setup – opens the Set Download Selection Criteria screen

• Optional – opens the Mapping Items screen for optional fields

• Mandatory – opens the Mapping Items screen for mandatory fields

27

Page 34: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Setting the Download Selection Criteria The Set Download Selection Criteria defines the rules for creating SampleManager static and dynamic data from the downloaded SAP data.

Figure 3.5: Set Download Selection Criteria Screen for Mapping Profile

Option Description Add SAP Results Controls whether ad-hoc results can be added to analyses if a suitable

component is not already present.

• Selected – an ad-hoc result will be added if there is an SAP characteristic which has no corresponding component in the analysis.

• Deselected – if the analysis does not have a component which corresponds to a characteristic, an error will be added to the download queue against the affected lot.

Add SAP Tests Controls whether tests can be added to the sample. This may apply to an existing sample which has been matched to a downloaded SAP lot.

• Selected – if the lot download from SAP includes an operation which does not have a corresponding test on the existing sample, a test will be added.

• Deselected – no additional tests will be added

28

Page 35: Sm 1000 Idi Reference Manual

Downloading Work from SAP

Assign Results Controls whether results will be assigned on the basis of the data from SAP, or whether the existing data will be uploaded without any additions.

• Selected – the LIMS data will be built from the downloaded SAP data, so any extra tests or results that are required will be added.

• Deselected – SampleManager IDI will upload the data from the located sample as it was logged into SampleManager, without adding any further tests or results.

Missing Tests Ok Controls whether a lot should be processed by SampleManager IDI when one or more of the characteristics associated with it does not correspond to an existing test in SampleManager.

• Selected – the lot will be processed and the missing characteristic will be ignored

• Deselected – the lot will remain in the download queue until a corresponding test has been created in SampleManager IDI

Force Sample Size Controls the number of test replicates created in SampleManager.

• Selected – the sample size from SAP is ignored and is set to 1, thus causing only one replicate of a test per characteristic.

• Deselected – the sample size from SAP is used to determine the number of replicate tests created in SampleManager. If no value is specified in SAP, one replicate test will be created in SampleManager.

Make MLPs Controls whether SampleManager IDI should create MLPs as required by the downloaded data.

• Selected – if a suitable MLP is not found, a new MLP, or a new version of an existing MLP, will be created

• Deselected – the lot will remain in the download queue until a suitable MLP is created by a user

MLP Copy LIMS only data Controls whether a new version of an existing MLP should contain details copied from the previous version.

• Selected – any information which has been added to the MLP in SampleManager (rather than being mapped from SAP data) will be copied to the new version.

• Deselected – the new version will contain only the information mapped from SAP.

Validate MLP Places Controls whether a new version of an MLP will be created if one or more components are set to use fewer decimal places than the SAP data specifies.

• Selected – a new version of the MLP will be created if a component in the existing version has lower precision than the SAP data requires.

• Deselected – the existing version of the MLP will be used

29

Page 36: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Validate MLP Types Controls whether a new version of an MLP will be created if one or more components are set to a different Type than the SAP data specifies.

• Selected – a new version of the MLP will be created if a component in the existing version has a different Type setting than the SAP data requires.

• Deselected – the existing version of the MLP will be used

Validate MLP Units Controls whether a new version of an MLP will be created if one or more components are set to a different Unit than the SAP data specifies.

• Selected – a new version of the MLP will be created if a component in the existing version has a different Unit setting than the SAP data requires.

• Deselected – the existing version of the MLP will be used

Validate MLP Phrase Controls whether a new version of an MLP will be created if one or more limits are set to a different Phrase than the SAP data specifies.

• Selected – a new version of the MLP will be created if a limit in the existing version has a different Phrase setting than the SAP data requires.

• Deselected – the existing version of the MLP will be used

Validate MLP Target Controls whether a new version of an MLP will be created if one or more components are set to a different Typical value than the SAP data specifies.

• Selected – a new version of the MLP will be created if a component in the existing version has a different Typical value than the SAP data requires.

• Deselected – the existing version of the MLP will be used

Validate Component Places

Controls whether a new version of an analysis will be created if one or more components are set to use fewer decimal places than the SAP data specifies.

• Selected – a new version of the analysis will be created if a component in the existing version has lower precision than the SAP data requires.

• Deselected – the existing version of the analysis will be used

Validate Component Units Controls whether a new version of an analysis will be created if one or more components are set to use different units than the SAP data specifies.

• Selected – a new version of the analysis will be created if a component in the existing version has different units than the SAP data requires.

• Deselected – the existing version of the analysis will be used

30

Page 37: Sm 1000 Idi Reference Manual

Downloading Work from SAP

Validate Component Phrase

Controls whether a new version of an analysis will be created if one or more components are set to use a different phrase than the SAP data specifies.

• Selected – a new version of the analysis will be created if a component in the existing version is set to use a different phrase than the SAP data requires.

• Deselected – the existing version of the analysis will be used

Component Limits by Plausible

Controls whether numeric components in analyses should have their upper and lower limits set to the plausible limit values downloaded from SAP.

• Selected – the limits will be set to the values downloaded from SAP

• Deselected – the limits will not be set

Analysis Copy Components

Controls whether components should be copied from the previous version of the analysis if they are not created from the SAP data.

• Selected – all components from the previous version will be copied to the new version, so any which were added manually within SampleManager will be included in the new version.

• Deselected – the components for the new version of the analysis will be created purely from the SAP data, so any components added manually to the previous version will not be included.

Analysis Copy Lists Controls whether component lists should be copied from the previous version of the analysis if they are not created from the SAP data.

• Selected – all component lists from the previous version will be copied to the new version, so any which were added manually within SampleManager will be included in the new version.

• Deselected – the component lists for the new version of the analysis will be created purely from the SAP data, so any component lists added manually to the previous version will not be included.

Boolean True Word The true word to use for a boolean component

Boolean False Word The false word to use for a boolean component

31

Page 38: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Defining Mapping Items The Optional and Mandatory Mapping Items screens can be opened by clicking the Optional button or the Mandatory button, as required. These screens define how fields from SAP will be mapped to fields in the SampleManager database.

Figure 3.6: Mapping Items Screen (Shown for Optional Mapping Items)

Option Description Table Name The name of the SampleManager table that the information will be stored in.

Field Name The name of the field that the information will be stored in.

Structure The QM-IDI object which contains the information

SAP Name The property of the QM-IDI object which contains the information.

Default Value The default value for the field, if no information has been downloaded from SAP

Library The SampleManager report which is required to process the information (optional).

Routine The routine which is required to process the information. The routine must be in the report specified in the Library field.

# Left The number of characters to extract as a substring from the left end of the string. This substring will be combined with any substring extracted via the # Right field.

For example, if the value of the whole field in the QM-IDI object was ABCDEFG, then if the # Left setting was 2 and the # Right setting was 1, the value used by SampleManager IDI would be ABG.

32

Page 39: Sm 1000 Idi Reference Manual

Downloading Work from SAP

# Right The number of characters to extract as a substring from the right end of the string. This substring will be combined with any substring extracted via the # Left field.

Update Defines whether the field value will be updated in SampleManager if the corresponding field is changed in SAP. There are two possible settings:

• If the field is set to * the value will be updated

• If the field is left blank, the value will not be updated

Maintaining Product Specifications in SampleManager There are two options for maintaining the MLPs which are used to check results for work downloaded from SAP:

• If the MLP limits do not change very often, you can create an MLP specification as normal, then assign it to samples via the mapping template.

• SampleManager IDI can be configured to maintain a set of MLPs, one for each material being tested. The valuation details (limits) for each characteristic can be downloaded as part of the request process. A new version of the appropriate MLP will be created each time the limits change.

Assigning the MLP through the Mapping Rule To assign an MLP through the mapping rule:

1. Deselect the Download valuation details checkbox on the Set Download Selection Criteria screen of the query.

2. Deselect the Make MLPs checkbox on the Set Download Selection Criteria screen of the mapping rule.

3. Enter the identity and version number of the required MLP as the Default value for the PRODUCT and PRODUCT_VERSION fields respectively in the Mapping Items screen of the mapping rule.

Automatically Creating and Maintaining MLPs To automatically maintain a set of MLPs which are synchronized with SAP:

1. Select the Download valuation details checkbox on the Set Download Selection Criteria screen of the query.

2. Select the Make MLPs checkbox on the Set Download Selection Criteria screen of the mapping rule.

3. Do not set a Default value for the PRODUCT and PRODUCT_VERSION fields respectively in the Mapping Items screen of the mapping rule.

33

Page 40: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Maintaining Phrases in SampleManager There are two options for maintaining the phrases for result entry and usage decisions:

• The phrases can be downloaded manually from SAP whenever they need to be updated.

• SM_IDI can be configured to download result entry and usage decision phrases from the QM module as part of the request data. The downloaded information can then be compared with the current version of the corresponding phrase entry list in SampleManager, allowing it to be updated automatically whenever necessary.

Downloading Phrases Manually To download phrases from SAP:

1. Deselect the Get result phrases and / or Get usage decision phrases checkboxes on the Set Download Selection Criteria screen of the query.

2. Select the SM-IDI/Background/QM-IDI/Download/Selected Sets/Phrases option. The Manual Phrase Download screen is displayed.

Figure 3.7: Manual Phrase Download Screen

3. Select the server which you want to use to connect to SAP in the System ID field.

4. Set the criteria for selecting the phrases in the remaining fields.

5. Click OK to start the download.

34

Page 41: Sm 1000 Idi Reference Manual

Downloading Work from SAP

Automatically Creating and Updating Phrases To automatically download result entry and usage decision phrases, select the Get result phrases and / or Get usage decision phrases checkboxes on the Set Download Selection Criteria screen of the query.

Note Downloading phrase data with every request will not have a significant impact on the amount of data downloaded or stored in requests. However, it will increase the amount of processing required for each request.

Request Failure Management If an attempt to process data selected from the worklist fails, e.g. because one or more of the required records is locked in SAP, the download will be repeated at a later time. The Retry Count value will be incremented each time a download attempt is made. The maximum number of retries for a download is defined by the configuration item PROCESS_RETRY_MAX (page 65).

If the maximum number of retries is reached without the data being successfully processed, then an error will be recorded in the Error msg column and attempts to download that item will cease.

Request failures can be viewed by opening the Download/No folder in the SMIDI cabinet of the Explorer. If the problem that caused a download to fail has been resolved, then the selected item can be removed from the folder by selected the Reset Download Queue option from the right mouse button pop-up menu. Once an item has been deleted from the download queue, SampleManager IDI will attempt to download it again the next time the appropriate query runs.

35

Page 42: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Link Failure Management If networks or other critical elements of the system are disrupted for any length of time, the laboratory needs to be able to continue its quality inspections to avoid serious disruption to business activities.

SampleManager IDI facilitates this through the way it uses job and sample templates. During the download processing, templates are selected. These are used to create job headers and samples in SampleManager. Default values are copied from the templates into these new records. The prompt and copy flags in the template are also used. These drive the transfer of information from the QM-IDI data structures into the job header and samples.

For example, if the batch name field in the sample template has a prompt flag, SampleManager IDI will attempt to load an appropriate value from the information downloaded from QM into the sample batch name field.

The reason the prompt and copy flags are used to drive this process is that the same templates can be used interactively in the absence of the interface. The user will then be prompted for the batch name and can enter the information in the Sample Login screen. As long as all the information normally supplied from QM can be made available to the user, this part of the download process can be performed manually.

The assignment of tests is a little harder, though this can be facilitated by the use of test schedules either associated with the sample templates or held separately. These test schedules should contain the basic set of test methods normally required. This set can be supplemented manually as required. Clearly, SampleManager will not be informed of any variations to the normal set of tests required, such as those introduced by dynamic modification rules. However, a close approximation to the required set of inspections can be achieved.

When the QM-IDI system is available again, downloads will recommence. The download processing will find that the job headers and samples it was expecting to create already exist, so it will automatically use them. It will attempt to reconcile the set of assigned tests to those needed by the inspection, and will assign any tests that are missing. It will not, however, remove any extra tests that may have been assigned as “LIMS only” data on that sample. At this point, it will also update the MLPs with any new tolerance limits that will be encountered in the request.

Certain operations will fail if no contact can be established with QM-IDI. These include:

• Manual download of catalog data into phrase tables

• Upload of usage decisions for inspection lots

• Operations involving the creation of inspection points or their usage decisions.

Note No damage will occur if any of the above operations is attempted while the link is unavailable.

Samples associated with inspection points can be created during this time and the inspection points themselves created later. This process works the same way as the general case for manual sample login described above. If all information normally provided by QM-IDI is available to be entered into the sample records manually, the samples can be reconciled with their inspection points once the link is available.

36

Page 43: Sm 1000 Idi Reference Manual

4 Uploading Data to SAP

Introduction Once the download is complete, normal SampleManager operations are used to manage the samples and tests as laboratory work is performed. The only difference between work assigned via SampleManager IDI and manually logged in samples, is that there is extra data in job header and sample records to allow it to be linked with the request from QM-IDI that created it.

Once results are recorded for a test, the system may attempt to upload data back to the QM module. However, the request may have specified that many measurements are made across different test replicates, and these replicates are possibly spread across multiple partial samples.

The result upload process will always try to locate all relevant data for a requested characteristic, even if not all results are available yet. In some cases, this is because a statistical summary of individual measurements needs to be reported to QM. In other cases, it allows the system to verify that enough measurements have been made to satisfy the inspection requirements.

Upload Queue To view the upload queue, select the Upload item in the SM-IDI cabinet of the SampleManager explorer. By default, the Upload folder is grouped by retry count, smidi lot number and type of data.

Figure 4.1: Upload Queue

The upload queue records contain the following information:

Column Description Job name A pointer to the job header for the data. This is constructed from a set of

numeric identifiers downloaded from SAP.

Id numeric A pointer to the sample record in SampleManager.

Test number A pointer to the test record in SampleManager

Name A pointer to the result record in SampleManager

37

Page 44: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Status The status of the item in the queue. There are two possible status values:

• 1 (Waiting)

• 2 (Ignore)

Retry count The number of times SampleManager IDI has attempted to upload the data

Type The type of data

Date created The date when the upload queue record was created or updated.

Analysis id The identity of the analysis within SampleManager

Job status The status of the job

Sample status The status of the sample

Test status The status of the test

Result status The status of the result

Result text Text entered against the result

Result value The value entered for the result

Send result The value which will be uploaded for the result. This may be either the result text or the result value, depending on the setting of the configuration item SMIDI_UPLOAD_RESULT_VALUE.

Lims units The units used for the result in SampleManager.

Lims out of range The value of the out of range field for the result in SampleManager

Smidi system The identity of the system that the data should be uploaded to

Smidi lot The inspection lot number from SAP

Smidi operation The operation number from SAP

Smidi phys samp The physical sample number from SAP

Smidi part samp The partial sample number from SAP

Smidi start date The start date for the inspection from SAP

Sap entered by The person who entered the inspection in SAP

Sap result conf no. The result confirmation number from SAP

Sap result origin The result origin code from SAP

Sap code number The result code number from SAP

Sap code group The result code group from SAP

Sap documentation The documentation code from SAP

Sap doc required This boolean field indicates whether documentation is required in SAP

Sap serial no The serial number for the inspection in SAP

Sap serial required This boolean field indicates whether the serial number is required in SAP

Sap specification The identity of the specification record for the material in SAP

Sap valuation This boolean field indicates whether valuation is required in SAP

38

Page 45: Sm 1000 Idi Reference Manual

Uploading Data to SAP

Sap attribute This boolean field indicates whether attribution is required in SAP

Sap units The code number for the units used for the results in SAP

Sap places The number of decimal places used for the result in SAP

Sap result type The code for the result type in SAP

Sap subsys valuates This boolean field indicates whether SAP will accept a usage decision made within SampleManager

Sap valuate type The code for the type of valuation required in SAP

Sap need subsamps This boolean field indicates whether subsample information is required by SAP

Sap subsamp valtype The code for the type of valuation required for the subsamples in SAP

Sap inspect scope This boolean field indicates whether the inspection scope is required by SAP

Sap defect class This column is no longer used

Sap subsamp defect This column is no longer used

Qmidi object The version of the QMIDI object used

Error The text of any error message generated by a previous upload attempt.

Automatically Uploading Data You can configure SampleManager IDI to upload results, usage decisions and other data to SAP automatically. This is achieved by customizing the standard trigger reports supplied with SampleManager to call upload routines when dynamic data items are given a specified status.

Please see Customizing SampleManager IDI (page 79) for further details.

Manually Uploading Data Results, usage decisions and other data may be uploaded to SAP manually where necessary for testing, or for urgently required information.

To upload a single result from a result entry screen, select the result you require and click the button.

For further data upload options, see Upload Options (page 61).

Suspending Upload Operations To suspend upload operations, select the SM-IDI/Background/Shutdown/Upload Enable option. Alternatively, select Background/Shutdown/Upload Quiesce from the right mouse button pop-up menu of the Upload Queue folder in the Explorer.

39

Page 46: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Retests and Resamples Re-tests and re-samples cannot be requested via QM-IDI, so they are always managed exclusively within SampleManager.

Re-tests are assigned using the standard test assignment editor in SampleManager. Results are entered in the normal way, and then you will be ready to try to upload the results from the retest. What happens next will depend on the way in which the original request was structured. The inspection requirements from QM may have specified information about how many readings should be made. Along with the number of readings, another value is sent which can imply one of the following conditions:

• Exactly the required number of readings must be made.

• No more than the required number of readings must be made.

• At least the required number of readings must be made.

• The number of readings does not matter.

In the first two cases, if the specified number of readings have already been made and uploaded, any attempt to upload the new values will fail since SampleManager IDI will know that it has already satisfied the inspection requirement. To override this situation, a previously uploaded result must be marked as invalid. This can be done in two ways:

• Cancel the test to which the invalid result belongs.

• Reject the invalid result or results.

In the last two cases, there is no conflict caused by the appearance of another result, so it can be uploaded as normal.

A re-sample is created using the request re-sample function in SampleManager. This process is slightly more complex than assigning a re-test. This is because, in addition to the issues that exist for re-test, it is also necessary to ensure that the new sample is associated with the request that arrived from SampleManager IDI. The links to SampleManager IDI are made by recording the physical sample number, the partial sample number and the operation number in dedicated fields in the sample.

This can be done in several ways. The easiest way is to make use of existing functionality in SampleManager. A global configuration item RESAMP_TEMPL_ID determines which sample template is used to log in the new sample. If this is left blank, the required fields listed above, and all other contextual information that may have been copied from the data downloaded from QM, will be copied from the original sample into the new sample. This ensures that the link with the request is maintained.

However, other SampleManager requirements may require this configuration item to be set to a specific value. This means that this simple technique cannot be used. In this case, it is recommended that the mandatory fields that create this link be added to the template used for re-samples. This enables you to enter the required information at the time the re-sample is logged in.

Note The retest and resample functionality can be implemented in the manner described above, but this has not been fully validated as part of SampleManager IDI 2004 R2.

40

Page 47: Sm 1000 Idi Reference Manual

Uploading Data to SAP

Data Cleanup Once the usage decision is complete, the entries in the QM-IDI worklist corresponding to the selected inspection lot are no longer available for processing or use by any programs in SampleManager. SampleManager IDI cannot upload any more information for this inspection lot other than inspection characteristics that are flagged as long-term inspection characteristics.

The temporary request data stored by SampleManager IDI to facilitate these upload processes are also redundant after this point and should be deleted. However, since not all inspection lots will have a usage decision made in SampleManager, this data cleanup is usually deferred until the job header is committed. The cleanup library will clean out all the tables that were used by SampleManager when communicating between SampleManager and SAP for the inspection lot based upon the status of the job (inspection lot).

If you prefer, you can create a set of committed tables for the request data. However, the tables are likely to occupy a large amount of table space and may need frequent archiving. There are no standard routines that are included as part of SampleManager IDI for the long term archival nor committing of any SampleManager IDI tables. If you have such requirements at your site, this will require customized programming either by your internal resources or from your application vendor.

41

Page 48: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Notes

42

Page 49: Sm 1000 Idi Reference Manual

5 Usage Decisions

Introduction Once all inspections have been completed under the control of SampleManager and all results uploaded to QM, a usage decision (UD) can be made. If SAP is indicated in the downloaded request for the subsystem to allow usage decisions to be made, SampleManager IDI can be used for disposition of the material associated with the inspection lot.

The usage decision will normally be made when the job is authorized within SampleManager. The usage decision for a job is then placed on the upload queue, and uploaded via the QM-IDI background upload program.

Along with each entry in the downloaded catalog data for the usage decision is a flag that indicates whether an inventory posting should be made for the inspection lot following selection of this usage decision. If set, the inventory posting can be customized with trigger routines as part of processing the upload.

Usage Decision Information The information which configures and stores usage decisions for a lot is held in a series of fields in the job header and the SampleManager IDI upload queue.

Usage Decision Information Stored in the Job Header The job header table contains the following fields for usage decision information:

Field Description SAP_UD_ENABLED This field must be set to "X" to allow the usage decision to be made within

SampleManager and uploaded to SAP

SAP_UD_PHRASE The identity of the phrase which contains the possible usage decisions. The chosen phrase must match a selected set maintained in SAP.

SAP_UD_PLANT The identity of the SAP plant which owns the selected set corresponding to the usage decision phrase.

SAP_UD_CODE_GROUP The identity of the SAP code group which contains the selected set items.

Sap ud code The SAP usage decision code. This is one of the entries from the selected set.

Sap ud text Free form text, usually used by custom programming to provide further details for ABAP custom triggers.

Sap ud uploaded A Boolean field that determines if the UD has already been uploaded (updated by the upload process after a successful reply from SAP that the UD was carried out).

43

Page 50: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Usage Decision Information Stored in the Upload Queue The upload queue contains the following fields for usage decision information:

• Job name

• Type

• Status

• Retry count

See Upload Queue (page 37) for further details on these fields.

Automatic Usage Decisions SampleManager IDI can be customized so that users are automatically prompted for usage decisions that are then uploaded to SAP. See Customizing SampleManager IDI (page 79) for more details.

Manual Usage Decisions The Authorise Job screen allows you to fill in the job header fields used to store the usage decision.

Figure 5.1: Authorise Job Screen

When the job is authorized, the usage decision will be uploaded to SAP, provided SAP was configured to accept a usage decision from a subsystem for this inspection lot.

44

Page 51: Sm 1000 Idi Reference Manual

6 Inspection Points

Introduction Inspection points are used to make quality inspections of a continuous process on a regular basis under the umbrella of a single inspection lot in QM.

This is established by marking the relevant operation as involving an inspection grid, which governs the basic framework of sampling. The grid may be time based, quantity based, or based on some other independent factor. One or more characteristics can be associated with the operation and these may then be measured for each inspection point on the grid.

Each inspection point on the grid provides characteristic values that represent a quantity of material known as a partial lot. Partial lots with sufficiently similar characteristics can be combined into a batch.

The assignment of partial lot numbers and batch numbers may be performed by SampleManager IDI or within the SAP system. This is determined by information downloaded from QM-IDI. SampleManager IDI may also be used to make a usage decision for each inspection point in the grid.

45

Page 52: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Points Queries Points queries are created automatically when lots that are setup for inspections points are downloaded from SAP. There is no option for adding a points query manually.

To view or modify a points query, select the appropriate option from the SM-IDI/QM Points submenu. The SM-IDI Points Data Entry Screen is shown below:

Figure 6.1: SM-IDI Points Data Entry Screen

Field Description SM-IDI Server The SM-IDI server record used to connect to SAP

Inspection Lot The inspection lot that the points are associated with

Operation The operation number from SAP

Group ID Enter the name of a SampleManager group to restrict access to the record to members of the group.

Modifiable? If this field is set to 'No', only a user with system-level authority can modify the record.

Description Enter a free text description

46

Page 53: Sm 1000 Idi Reference Manual

Inspection Points

Repeat Interval Interval that determines how often this query will restart.

From Point # The last point obtained from SAP will always set this value so that the system will only process and download inspection points that have not already been synchronized with SAP

To Point # This is usually 999999 to denote the maximum number of inspection points that can be created for a single lot.

Process Library The name of the library which contains the routine that will process the points.

Process Routine The name of the routine that will process the points.

Mapping Profile The name of the mapping profile for processing the points.

Setting Configuration Items for a Points Query Click the Config button on the SM-IDI Points Data Entry Screen to set any configuration items required for the points query.

See Setting Server Configuration Items (page 16) for more information about setting configuration items.

Setting User Prompt Values If your SAP system is set up to use the USER fields in the QAIPP structure for inspection points, click the Prompts button on the SM-IDI Points Data Entry Screen to define the behaviour of these fields within SampleManager IDI.

Figure 6.2: User Prompts Screen

Option Description Parameter The name of the user field in SAP

Caption The caption which you want to use for the field

Type The type of data that the field stores

Value The value of the field

Library The library which contains a routine that you wish to use to process the field information

Routine The name of the routine that you wish to use to process the field information

47

Page 54: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Setting Usage Decisions for Inspection Points Click the Usage button on the SM-IDI Points Data Entry Screen to set usage decisions for the points currently associated with the inspection lot.

Note Usage decisions entered in this screen will only be uploaded to SAP if SampleManager IDI and SAP are configured to allow usage decisions to be made within SampleManager.

Figure 6.3: SMIDI_INSPPOINT Screen (Usage)

Option Description Request key A pointer to the job header for the data. This is constructed from a set of

numeric identifiers downloaded from SAP.

Job Identity of the job the point is associated with.

Sample Numeric identifier of the sample the point is associated with.

Sap ud material no Material number for the inspection lot

Sap ud partial lot Partial lot number

Sap ud batch Batch number assigned in SAP

Sap ud code Usage decision code

Sap ud decision text Usage decision text

Sap ud quantity Inspection point quantity

Sap ud units Units for the inspection point quantity

Sap ud rework quantity Rework quantity

Sap ud scrap amount Scrap quantity

Sap ud scrap reason Scrap reason

Sap ud equipment no Equipment number

Sap ud functional loc Number of functional location

Sap ud operator Operator making the usage decision

Sap ud date Date of usage decision

48

Page 55: Sm 1000 Idi Reference Manual

Inspection Points

Sap ud cat plant Plant

Sap ud code group Code group

Sap ud selected set Selected set

Sap ud inspect type Inspection type

Creating Points within SampleManager Points can be created in either SAP or SampleManager. The data will be automatically synchronized between the two systems. The Create button on the SM-IDI Points Data Entry Screen displays a list of the points currently associated with the inspection lot. New points can be added by filling out the required fields in a new row.

Figure 6.4: SMIDI_INSPPOINT Screen

Option Description Request Key A unique identifier for the point, generated from several SAP identifiers.

Job The job that the point is associated with

Sample The sample that corresponds to the inspection point

Identification A textual identifier for the point, entered by the user

49

Page 56: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Notes

50

Page 57: Sm 1000 Idi Reference Manual

7 System Management

Introduction In most SampleManager IDI installations, the requirement for ongoing system management is minimal. It is limited to the periodic checking and deletion of log files.

This chapter describes the processes that may be running for SampleManager IDI and the log files produced by them.

Logfiles By default. SampleManager IDI logfiles are located in the VGSM/logfiles directory. They can be viewed in the logfiles folder of the SM-IDI cabinet in the SampleManager Explorer.

The right mouse button pop-up menu in this folder has the following options for managing logfiles, in addition to the standard menu options:

Option Description Display Logfile Display the currently selected logfile in a text window. If you select

multiple logfiles, they will be displayed in a series of separate windows, with a new window opening when the current one is closed.

Delete Logfile Delete the currently selected logfile(s).

Delete Logfile Record Delete the currently selected logfile records from the database, without deleting the corresponding logfiles.

Delete Logfile and Record Delete the currently selected logfile records and the corresponding logfiles.

SMIDI_QUERY_VIEW A SMIDI_QUERY_VIEW logfile records the query directed at the SAP QIWL queue and the conversion of the selected records into download queue table entries within SampleManager. These logfiles use the following naming convention:

smidi_get_lots_<query server>_<query id>_<start date>.log

Where:

• <query server> is the identity of the query server (from the query record)

• <query id> is the identity of the query (from the query record)

• <start date> is the date and time when the query was run, in the format MONdd_hh_mm_ss

51

Page 58: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

For example: smidi_get_lots_sisera01_siqueb01_Jun17_14_37_24.log

A new SMIDI_QUERY_VIEW logfile is created each time a query is run.

SMIDI_PROCESS_VIEW A SMIDI_PROCESS_VIEW logfile records the reading of the download queue and the conversion of a set of records for a single inspection lot into the required static and dynamic data within SampleManager. These logfiles use the following naming convention:

smidi_process_lot_<query server>_<query id>_<start date>.log

Where:

• <query server> is the identity of the query server (from the query record)

• <query id> is the identity of the query (from the query record)

• <start date> is the date and time when the process was run, in the format MONdd_hh_mm_ss

For example: smidi_process_lot_sisera01_siqueb01_Jun03_10_18_51.log

A new SMIDI_PROCESS_VIEW logfile is created for each inspection lot processed.

SMIDI_POINTS_VIEW A SMIDI_POINTS_VIEW logfile records the query directed at the SAP QIWL queue for new inspection points and the conversion of the selected records into download queue table entries within SampleManager. These logfiles use the following naming convention:

smidi_get_points_<query server>_<inspection lot>_<start date>.log

Where:

• <query server> is the identity of the query server (from the points query record)

• <inspection lot> is the identity of the inspection lot the points are associated with (from the points query record)

• <start date> is the date and time when the points query was run, in the format MONdd_hh_mm_ss

For example: smidi_get_points_sisera01_890000001784_Jun03_10_40_20.log

A new SMIDI_POINTS_VIEW logfile is created each time a points query is run.

52

Page 59: Sm 1000 Idi Reference Manual

System Management

SMIDI_PROCESS_POINT_VIEW A SMIDI_PROCESS_POINTS_VIEW logfile records the reading of the download queue and the conversion of a set of inspection points for a single inspection lot into the required static and dynamic data within SampleManager. These logfiles use the following naming convention:

smidi_process_point_<query server>_<inspection lot>_<start date>.log

Where:

• <query server> is the identity of the query server (from the points query record)

• <inspection lot> is the identity of the inspection lot the points are associated with (from the points query record)

• <start date> is the date and time when the process was run, in the format MONdd_hh_mm_ss

For example: smidi_process_point_sisera01_890000001784_Jun03_10_41_38.log

A new SMIDI_PROCESS_POINTS_VIEW logfile is created each time a set of points for an inspection lot is processed.

RESULT_send_result A RESULT_send_result logfile records the upload of a set of results for a single upload session. These logfiles use the following naming convention:

smidi_upload_send_result_<start date>.log

Where:

• <start date> is the date and time when the process was run, in the format MONdd_hh_mm_ss

For example: smidi_upload_send_result_Jun30_15_38_28.log

A new RESULT_send_result logfile is created each time an upload session is initiated.

POINT_send_point A POINT_send_point logfile records the upload of a set of inspection points for a single upload session. These logfiles use the following naming convention:

smidi_upload_send_point_<start date>.log

Where:

• <start date> is the date and time when the process was run, in the format MONdd_hh_mm_ss

For example: smidi_upload_send_point_Jun30_15_38_28.log

A new POINT_send_result logfile is created each time an upload session is initiated.

53

Page 60: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

LOT_UD_send_lot_ud A LOT_UD_send_lot_ud logfile records the upload of a set of lot usage decisions for a single upload session. These logfiles use the following naming convention:

smidi_upload_send_lot_ud_<start date>.log

Where:

• <start date> is the date and time when the process was run, in the format MONdd_hh_mm_ss

For example: smidi_upload_send_lot_ud_Jun03_09_40_09.log

A new LOT_UD_send_lot_ud logfile is created each time an upload session is initiated.

POINT_UD_send_point_ud A POINT_UD_send_point_ud logfile records the upload of a set of point usage decisions for a single upload session. These logfiles use the following naming convention:

smidi_upload_send_point_ud_<start date>.log

Where:

• <start date> is the date and time when the process was run, in the format MONdd_hh_mm_ss

For example: smidi_upload_send_point_ud_Jul17_14_56_54.log

A new POINT_UD_send_point_ud logfile is created each time an upload session is initiated.

Background Service Logfiles A background service logfile will be created if an error occurs when any of the background services is created, started or stopped. These logfiles use the following naming convention:

<service_name>_<date>_<time>.log

Where:

• <service_name> is the name of the background service

• <date> is the date when the error occurred

• <time> is the time when the error occurred

For example: TEST_G_LOT_Jul17_14_56_54.log

54

Page 61: Sm 1000 Idi Reference Manual

System Management

Background Processes The background processes for SampleManager IDI can be managed through the SM-IDI/Background menu.

The default installation of SampleManager IDI includes the following background service records:

Background Service Description G_LOT Downloads inspection lots from SAP

G_PTS Downloads inspection points from SAP

P_LOT Processes inspection lot data and creates corresponding SampleManager data

P_PTS Processes inspection point data and creates corresponding SampleManager data

U_LUD Uploads inspection lot usage decisions to SAP

U_PTS Uploads inspection points to SAP

U_PTUD Uploads inspection point usage decisions to SAP

U_RES Uploads results to SAP

55

Page 62: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Each background service record can be used to create a Windows background service. These services can be viewed in the Windows Services window. Each service is called instance_service. Where:

• instance is the value of the Instance field in the SampleManager IDI background service record

• service is the identity of the SampleManager IDI background service record

Figure 7.1: Services Console, Showing SampleManager IDI Services

56

Page 63: Sm 1000 Idi Reference Manual

System Management

When each service is started, two corresponding processes will start running. These can be viewed in the Windows Task Manager. The processes will be called:

• instance_service

• instance_service_process_id

Where:

• instance is the value of the Instance field in the SampleManager IDI background service record

• service is the identity of the SampleManager IDI background service record

• process_id is the value of the Process Id field in the SampleManager IDI background service record

Figure 7.2: Task Manager, Showing SampleManager IDI Processes

The VGL routine specified in the SampleManager IDI background service record is executed by the background user specified in the User Id field.

57

Page 64: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

SampleManager IDI Background Services Screen The SM-IDI Background screen can be accessed through the standard LTE options on the SM-IDI/Background submenu.

Figure 7.3: SampleManager IDI Background Services Screen

Option Description Active Boolean value which defines whether the service is active. Only active

services can be started using the options in the SM-IDI/Background/Services menu.

Create service Flag to indicate if the Service should be created when it is started. If this field is set to Yes, the Windows background service will be created when the record is saved.

58

Page 65: Sm 1000 Idi Reference Manual

System Management

Debug id Debug ID used for the log files, this is matched to the type of the process for the service:

• Download

• Upload

• Process

Description Free text description of the process

Instance SampleManager instance that the Service belongs to

Log loc Folder location of the log files to be generated by the background service

Max Retry User defined number to set the maximum number of retries for the process to attempt restarts if failures occur

Process Id Text identifier that is added to the name of the service to provide a unique identifier for one of the processes associated with the service. See Background Processes (page 55) for more information.

Restart mode Flag to indicate if the associated service is to be restarted if failure occurs

Running Flag to indicate if the service is running

Serv Templ Template service name for the Service template that is used to create each service dynamically

Smp Templ SampleManager smp.exe that is copied and used by the associated process to execute the Vgl code for the background service

Type Type of process that the service creates:

• Download

• Upload

• Process

User id SampleManager user id used by the service and associated process to log into the SampleManager server to execute the vgl code

Vgl library Vgl library called when the background service is executed

Vgl routine Vgl routine within the specified library that will be executed when the background service is started

59

Page 66: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Setting the Password

Click the Password button on the SampleManager IDI Background Services screen to display the Change Background User Password dialog. This allows you to change the password for the background process.

Figure 7.4: Change Background User Password Dialog

Enter and confirm your new password then click the OK button to save your changes.

Unregistering the Service

Click the Unregister button on the SampleManager IDI Background Services screen to unregister the service from the Windows console.

Note This will not remove the background service record from SampleManager IDI. Use the SM_IDI/Background/Remove menu option to remove the service record.

Checking the Status of Background Processes The SM-IDI/Background/Services/Background Status option displays a list of running server processes on the SampleManager Server.

Figure 7.5: SampleManager IDI Background Service Status Display

Click the Yes button to refresh the display, or the No button to close the screen.

60

Page 67: Sm 1000 Idi Reference Manual

System Management

Testing the Background Processes The options in the SM-IDI/Background/Test QM-IDI menu allow you to manually test the functionality that the background processes will utilize. They may also be used when debugging SampleManager IDI.

Note These options will only work if the SampleManager background process has been stopped and the SampleManager IDI background process is enabled.

Download Options

The SM-IDI/Background/Test QM-IDI/Download submenu contains the following options:

Option Description Lots Download inspection lots

Points Download inspection points

Selected Sets/Phrases Download catalog data

Process Options

The SM-IDI/Background/Test QM-IDI/Process submenu contains the following options:

Option Description Point Process inspection points in the download queue

Lot Process inspection lots in the download queue

Upload Options

The SM-IDI/Background/Test QM-IDI/Upload submenu contains the following options:

Option Description Results Upload results

Lot Usage Decision Upload inspection lot usage decisions

Point Usage Decision Upload inspection point usage decisions

Create Points If any samples corresponding to inspection points have been directly logged in to SampleManager, rather than being downloaded from SAP, this option will create the required inspection points in the SAP database.

61

Page 68: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Enabling and Disabling the Background Processes The SM-IDI/Background/Services submenu contains a series of options which allow you to start and stop the various background services.

Option Description Start All Services Start all active background services installed that are not currently running

Stop All Services Stop all currently running background services

Download/Start Download

Start all services that are of type Download and not already running

Download/Stop Download

Stop all running services of type Download

Process/Start Process Start all services that are of type Process and not already running

Process/Stop Process Stop all running services of type Process

Upload/Start Upload Start all services that are of type Upload and not already running

Upload/Stop Upload Stop all running services of type Upload

62

Page 69: Sm 1000 Idi Reference Manual

8 Configuration

Introduction This chapter describes the configuration items and objects which can be modified to configure SampleManager IDI to meet local requirements.

See Customizing SampleManager IDI (page 79) for a description of some of the methods for customizing SampleManager IDI further using specially written VGL reports and standard SampleManager triggers.

Configuration Items SampleManager IDI configuration items can be viewed in the Configuration folder of the SM-IDI cabinet in SampleManager Explorer. Alternatively, the SM-IDI Configuration Item Data Entry Screen can be opened by selecting the required option from SM-IDI/Configuration submenu.

Figure 8.1: SM-IDI Configuration Item Data Entry Screen

Option Description Description Free text description of the item.

63

Page 70: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Data Type The data type of the configuration item value.

Prompt Library If the Data Type is set to 'Routine', the name of the library which contains the routine.

Prompt Routine If the Data Type is set to 'Routine', the name of the routine.

Value The value of the configuration item.

Operator Modifiable If this field is set to 'No', only an operator with system-level authority will be able to modify the item.

Applicability The context of the configuration item. This field may be set to:

• System Configuration Items

• Server Configuration Items

• Query Configuration Items

VGL Libraries Used A list of the libraries which use the configuration item.

ERROR_OK_NUMBERS Description A list of the SAP error codes which should not be considered as serious. The

list is in CSV format.

Default Value 012,016,017,027,031,041,057,105,116,118,127,130,136,139,170,171,172,174,201,202,354,462,463

FETCH_DEBUG Description Sets the debug level for the Fetch process – this process sends queries to

SAP to download data from QIWL and populates the download_queue table in SampleManager

Default Value 0

Possible Values An integer from 0 – 10.

• 0 is the highest level of detail

• 10 the lowest level of detail

FETCH_SHUTDOWN Description Sets the default state for the background process which downloads data from

SAP

Default Value False

Possible Values • True – the background download process is disabled

• False – the background download process is running

64

Page 71: Sm 1000 Idi Reference Manual

Configuration

POINTS_DEBUG Description Sets the debug level for the points query

Default Value 0

Possible Values An integer from 0 – 10.

• 0 is the highest level of detail

• 10 the lowest level of detail

POINTS_INTERVAL Description Sets the default value for the Repeat Interval field of the Points Query

Default Value 0 00:00:05

POINTS_SHUTDOWN Description Sets the default state of the background process for inspection point queries

Default Value False

Possible Values • True – the process is disabled

• False – the process is running

PROCESS_DEBUG Description Sets the debug level for the processing of the download queue records into

LIMS data.

Default Value 0

Possible Values An integer from 0 – 10.

• 0 is the highest level of detail

• 10 the lowest level of detail

PROCESS_RETRY_MAX Description Integer for the number of times the system will attempt to process a

download_queue record before marking it as a failure

Default Value 10

65

Page 72: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

PROCESS_SHUTDOWN Description Sets the default state of the background process which translates records in

the download queue into LIMS data

Default Value False

Possible Values • True – the process is disabled

• False – the process is running

QM_DNL_MAIL Description Mail the default user in SAP if a problem occurs in Download

Default Value False

Possible Values • True – a mail will be sent

• False – no mail will be sent

QM_DUPL_PHRASETABLE Description Sets the default selected set identity to use if a phrase is downloaded from

SAP without a selected set id specified.

QM_RUPL_MAIL Description Mail the default user in SAP if a problem occurs in Upload

Default Value False

Possible Values • True – a mail will be sent

• False – no mail will be sent

QM_TOLERANCE_CALC Description The Limit Calculation to use for SAP Tolerance Limits

Default Value Library: $SMIDI_CONFIG_DB

Routine: config_prompt_limit_calc

QM_TOLERANCE_LEVEL Description The Level Identity to use for SAP Tolerance Limits

Default Value Library: $SMIDI_CONFIG_DB

Routine: config_prompt_level

Value: SAP_SPEC

66

Page 73: Sm 1000 Idi Reference Manual

Configuration

QM_UPL_CLOSE Description Defines whether a characteristic should be closed in SAP when its data is

uploaded from SampleManager IDI.

Possible Values • True – characteristic will be closed

• False – characteristic will not be closed

QM_UPL_COMMIT Description Defines whether data should be committed to SAP and SampleManager

databases when it is uploaded.

Possible Values • True – commit data

• False – do not commit data

Default Value True

QM_UPL_MULTIPLE Description Upload multiple results to SAP for one characteristic

Possible Values • True – upload multiple results

• False – do not upload multiple results

Default Value False

QM_UPL_UPDATE Description Defines whether data should be updated in SAP and SampleManager when it

is uploaded.

Possible Values • True – update

• False – do not update

Default Value True

QM_UPL_VALUATIONS Description Upload Valuation details from LIMS to SAP

Default Value True

Possible Values • True – Valuations can be made in SampleManager and uploaded to SAP

• False – Valuations must be made in SAP

67

Page 74: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

QM_USER1_CALC Description The Limit Calculation to use for SAP User1 Limits

Default Value Library: $SMIDI_CONFIG_DB

Routine: config_prompt_limit_calc

QM_USER1_LEVEL Description The Level Identity to use for SAP User1 Limits

Default Value Library: $SMIDI_CONFIG_DB

Routine: config_prompt_level

QM_USER2_CALC Description The Limit Calculation to use for SAP User1 Limits

Default Value Library: $SMIDI_CONFIG_DB

Routine: config_prompt_limit_calc

QM_USER2_LEVEL Description The Level Identity to use for SAP User2 Limits

Default Value Library: $SMIDI_CONFIG_DB

Routine: config_prompt_level

SAP_SPECIFICATION_ATTRIBUTE_OK Description List of acceptable words for the SAP Specification.

SAP_UPLOAD_STATUS_RESULTS Description The allowable SAP status values for a result in the upload queue. The value

consists of a string of the acceptable status letters, without spaces or separator characters.

Default Value AREM

SAP_UPLOAD_STATUS_TESTS Description The allowable SAP status values for a test in the upload queue. The value

consists of a string of the acceptable status letters, without spaces or separator characters.

Default Value ARCVP

68

Page 75: Sm 1000 Idi Reference Manual

Configuration

SMIDI_AUTO_UD_JOB_STATUSES Description During upload, this checks to see if there are no more results for this job to

upload. If so, a check is made of the job status against this list of job status letters. If the job is one of these statuses, the automatic usage decision routines are called. If the job is not one of these statuses, or the system is not setup to make UDs in LIMS, upload continues processing and does not call this routine.

SMIDI_AUTO_UPLOAD Description If this setting is True, then when data is downloaded, a check will be made

to see if any results need to be queued for upload.

Possible Values • True – check and upload

• False – do not upload

SMIDI_IGNORE_QUERY_FAILURE Description Defines whether a download failure will be ignored and further downloads

attempted.

Possible Values • True – failure ignored, download attempts will continue

• False – download will fail

SMIDI_JOB_CANCEL_MODE Description This configuration item is used when queries are used to download cancelled

lots from SAP. It determines how the cancellation of the job corresponding to the cancelled lot will propagate to associated samples, tests and results.

This item is used in combination with SMIDI_JOB_CANCEL_STATUS

Possible Values • ASSIGN – cancellation will not propagate to samples, tests and results

• CHANGE – all samples, tests and results associated with the job will be cancelled.

SMIDI_JOB_CANCEL_STATUS Description The list of status values a job can have when a cancelled lot is downloaded.

SMIDI_MAX_UPLOAD_DEFECT Description The maximum number of upload defect items which can be held in the

upload queue before an upload session is started.

Default Value 20

69

Page 76: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

SMIDI_MAX_UPLOAD_LOT_UD Description The maximum number of lot usage decision items which can be held in the

upload queue before an upload session is started.

Default Value 20

SMIDI_MAX_UPLOAD_POINT Description The maximum number of inspection point items which can be held in the

upload queue before an upload session is started.

Default Value 20

SMIDI_MAX_UPLOAD_POINT_UD Description The maximum number of inspection point usage decision items which can

be held in the upload queue before an upload session is started.

Default Value 20

SMIDI_MAX_UPLOAD_RESULT Description The maximum number of results which can be held in the upload queue

before an upload session is started.

Default Value 2000

SMIDI_ORACLE_TRACE Description Enables/disables the low level call to Oracle to create a trace file. The data

output from an Oracle trace can then be used to optimize indexes, or find problems in the application.

Default Value False

Possible Values • True – Oracle trace file creation enabled

• False – Oracle trace file creation disabled

SMIDI_PHRASE_PREFIX Description The prefix which will be used to identify phrases downloaded from SAP and

added to the SampleManager phrase table.

If the value is left blank then the R3_<nnnnnnnn> increment is used (as in older SMIDI versions), if it is not blank then the string is prefixed to the SAP Catalog ID and padded to the full length of the phrase identity field.

Default Value R_

70

Page 77: Sm 1000 Idi Reference Manual

Configuration

SMIDI_POINTS_1_AT_A_TIME Description Determines whether inspection points in a single inspection lot will be

downloaded singly, or in groups.

Default Value False

Possible Values • True – download points singly

• False – download all available points

SMIDI_UPLOAD_RESULT_VALUE Description Determines whether the result value or the result text will be uploaded to

SAP

Default Value False

Possible Values • True – uploads result.value

• False – uploads result.text

SMIDI_UPLOAD_RETRIES Description Maximum number of retries for a single upload that has a failure that is not

one of the ERROR_OK_NUMBERS

Default Value 50

SMIDI_UPLOAD_SLEEP Description The interval between upload attempts.

Default Value 0 00:00:30

SMIDI_UPLOAD_START_DATE Description Determines which field in SampleManager is used to supply the value for

the start date of inspection in the QM object.

Default Value SAMPLE.SAMPLED_DATE

SMIDI_UPLOAD_UNIT_CONVERT Description Determines whether SampleManager should convert the units used for a

result to the ones used by SAP during upload.

Default Value True

Possible Values • True – convert units

• False – do not convert units

71

Page 78: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

SMIDI_UPLOAD_VALUATES_A Description List of SAP result status letters that set the SAP valuation to A.

Default Value MAE

SMIDI_UPLOAD_VALUATES_R Description List of SAP result status letters that set the SAP valuation to R.

Default Value RX

STATUS_QUEUE_SHUTDOWN Description Sets the default state of the background process which services the

status_queue table.

Default Value False

Possible Values • True – the process is disabled

• False – the process is running

UPLOAD_COMPLETE_DELETE Description Determines whether items should be deleted from the upload queue when

they have been uploaded successfully.

Default Value False

Possible Values • True – delete item from upload queue

• False – set item status to ignore

UPLOAD_DEBUG Description Sets the debug level for the upload process

Default Value 0

Possible values An integer from 0 – 10.

• 0 is the highest level of detail

• 10 the lowest level of detail

UPLOAD_SHUTDOWN Description Enables the background process which uploads records to SAP

Default Value False

Possible Values • True – the process is disabled

• False – the process is running

72

Page 79: Sm 1000 Idi Reference Manual

Configuration

Objects QM-IDI objects are represented within SampleManager IDI as objects that have the same configurations. These objects are configured from database tables which hold the data that SAP currently holds on each SAP object. This simplifies the method of updating SampleManager IDI for different versions of SAP where the SAP objects change structure.

SampleManager IDI objects can be accessed through the SM-IDI/Objects submenu. The SAP Object Maintenance screen is shown below:

Figure 8.2: SAP Object Maintenance Screen

Option Description SAP Object The identity of the SAP object

SAP Version The SAP version number

Description A description of the object

Sum of field lengths The length of the string that will be downloaded from SAP for the object. This is the total of all the individual SAP length values set for the items listed on the SMIDI_STRUCTURE_ITEMS screen.

73

Page 80: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

SM-IDI Structure Items Click the Edit button on the SAP Object Maintenance screen to display the SM-IDI Structure Items for the object.

Figure 8.3: SM-IDI Structure Items Screen

Option Description Description A description of the item

Identity The identity of the object the item is associated with

Internal name The name SampleManager IDI uses for the item

Print This boolean field controls whether the item will be included in low level debug files

Sap length The length of the field in the string download from SAP

Sap name The name of the field which contains the item in SAP

Sap order The position of the field within the string downloaded from SAP. "1" is the first field, "2" the second and so on

Sap property This boolean field shows whether the field is an SAP-specific field (Y), or a user-defined field (N)

Sap version The SAP version number

74

Page 81: Sm 1000 Idi Reference Manual

Configuration

Standard Objects

GBI_JOB_LOGIN

This object is used when a job is logged in to SampleManager via SampleManager IDI. The GBI_JOB_LOGIN object could be customized to add additional fields to the job header.

GBI_LOGIN

This object is used to hold downloaded SAP data and check whether corresponding data exists in SampleManager. Existing data will be uploaded, while missing data will be logged in.

GBI_MAPPING

This object controls access to mapping profiles.

GBI_PHRASE_ENTRY

This object is used to hold catalogue data entries and to add them to SampleManager phrases when required.

GBI_PHRASE_HEADER

This object holds the catalogue data downloaded from SAP and is used to add SampleManager phrase headers when required.

GBI_PRODUCT_ENTRY

This object is used to hold the data from SAP which corresponds to an MLP product level. It is used to check whether the downloaded data matches the existing level and to update SampleManager as required.

GBI_PRODUCT_HEADER

This object is used to hold the data from SAP which corresponds to an MLP header. It is used to check whether the downloaded data matches the existing MLP and to update SampleManager as required.

GBI_SAMPLE_LOGIN

This sample login object is used to check whether the required samples, tests and results already exist in SampleManager. If the data does not exist, it will be created.

QAICA

QM-IDI object containing catalog data, which will be converted to phrase data in SampleManager.

75

Page 82: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

QAILS

QM-IDI object containing the selection criteria used to query the QM-IDI worklist.

QAIMR

Object which holds results to be uploaded to QM-IDI.

QAIMV

Object which holds characteristic data downloaded from QM-IDI.

QAIPP

Object which holds inspection point data.

QAISE

Object used to upload a single value to SAP.

QAISR

Object used to upload a summarized result value, e.g. an average.

QAIVC

Object used to hold SAP operations for download.

QAIVE

Object used to hold a usage decision for upload.

QEIFT

Data structure for transferring catalog types and texts. This object has the following fields:

• KATALOGART – Catalog type

• KATLOGTXT – Short Text

QIERR

SAP error object used to report errors in upload, download or connection.

QIWLR

Object which contains the QM-IDI worklist data structure.

76

Page 83: Sm 1000 Idi Reference Manual

Configuration

QMIFE

This object is no longer used in this version of SampleManager IDI.

SMIDI_COMPONENT

The data structure used to verify the version of components in SampleManager.

SMIDI_DOWNLOAD

The data structure which acts as the "header" for the downloaded data.

SMIDI_LOGIN

The "header" object for the set of objects which check that downloaded SAP data matches the corresponding data in SampleManager.

SMIDI_QIRF

The data structure which contains RFC calls.

SMIDI_QUE2

The class used to invoke uploads.

SMIDI_RQST

This object checks whether data downloaded from SAP is already present in SampleManager.

SMIDI_SAMP

The class used to login samples.

SMIDI_TEST

The object that checks whether data is already in SampleManager.

SMIDI_UP_2

The class which contains upload functionality.

SMIDI_V2

The SampleManager IDI base class.

77

Page 84: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Notes

78

Page 85: Sm 1000 Idi Reference Manual

9 Customizing SampleManager IDI

Introduction This chapter describes some of the options available for customizing SampleManager IDI to meet the requirements of a specific operation.

Most of the customization is carried out via VGL reports. For more information about VGL, please see the Programmers Guide helpfile.

Triggers Status triggers are internal features in SampleManager that automatically execute VGL reports. This section describes the standard status triggers, and how to customize them.

Note Triggers are designed to implement user-defined events. No additional code for implementing functionality with triggers is supplied as part of SampleManager IDI.

Status changes, whether manual or automatic, can trigger a user-defined event. Different events can be defined within a VGL program for each status modification. Four programs that are distributed with SampleManager facilitate the use of this feature:

• $SAMPSTAT can be configured to contain instructions indicating the actions to be taken when there are changes to sample status.

• $JOBSTAT can be configured to contain instructions indicating the actions to be taken when there are changes to job status.

• $TESTSTAT can be configured to contain instructions indicating the actions to be taken when there are changes to test status.

• $RESLSTAT can be configured to contain instructions indicating the actions to be taken when there are changes to result status.

The distribution versions of the four programs do not in themselves trigger actions. They provide skeleton routines that you can modify as required. If you configure the code, and enable the trigger options in the user, group or system configuration, the trigger programs defined are executed when there is a status change.

79

Page 86: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Executing Triggers The following standard SampleManager commands will cause a change to at least one status value and will therefore cause one or more of the standard trigger programs to be executed:

• Result entry procedures, such as result entry by sample, result entry by test and result entry by spreadsheet, trigger $RESLSTAT when a result has a change made to its status. They also trigger this program if a result of status Modified (M) is changed. Although the status does not change, the fact that the result has been altered causes the trigger.

• Authorize sample triggers $SAMPSTAT. If the sample authorization causes authorization of associated tests or results, the relevant trigger programs will also be executed.

• Authorize job triggers $JOBSTAT. If the job authorization causes authorization of any samples, tests or results, the relevant trigger programs will also be executed.

When a program is triggered, it automatically knows the identity of the record which triggered it. For example, $SAMPSTAT can contain a VGL statement such as:

samp_id = SELECT SAMPLE.ID_NUMERIC

This will return the id of the sample whose status change triggered the program. The WHERE and ORDER ON clauses need not be specified.

Enabling Triggers The status triggers described in this section can be enabled or disabled by setting the value of the corresponding System configuration item.

$JOBSTAT Configuration Item JOB_TRIGGER_ENABLE

Routines SET_STATUS_A – triggered when status changes to authorised

SET_STATUS_V – triggered when status changes to available

SET_STATUS_C – triggered when status changes to completed

SET_STATUS_R – triggered when status changes to rejected

SET_STATUS_S – triggered when status changes to suspended

SET_STATUS_X – triggered when status changes to cancelled

80

Page 87: Sm 1000 Idi Reference Manual

Customizing SampleManager IDI

$SAMPSTAT Configuration Item SAMPLE_TRIGGER_ENABLE

Routines SET_STATUS_A – triggered when status changes to authorised

SET_STATUS_V – triggered when sample status is set to "available"

SET_STATUS_C – triggered when status changes to completed

SET_STATUS_R – triggered when status changes to rejected

SET_STATUS_S – triggered when status changes to suspended

SET_STATUS_X – triggered when status changes to cancelled

SET_STATUS_H – triggered when status changes to on hold

SET_STATUS_I – triggered when status changes to being inspected

SET_STATUS_U – triggered when status changes to unreceived

SET_STATUS_W – triggered when status changes to awaiting preparation

$TESTSTAT Configuration Item TEST_TRIGGER_ENABLE

Routines SET_STATUS_A – triggered when status changes to authorised

SET_STATUS_V – triggered when status changes to available

SET_STATUS_P – triggered when status changes to in progress

SET_STATUS_C – triggered when status changes to completed

SET_STATUS_R – triggered when status changes to rejected

SET_STATUS_S – triggered when status changes to suspended

SET_STATUS_X – triggered when status changes to cancelled

SET_STATUS_U – triggered when status changes to unavailable

SET_STATUS_W – triggered when status changes to awaiting preparation

$RESLSTAT Configuration Item RESULT_TRIGGER_ENABLE

Routines SET_STATUS_A – triggered when status changes to authorised

SET_STATUS_E – triggered when status changes to entered

SET_STATUS_M – triggered when status changes to modified

SET_STATUS_R – triggered when status changes to rejected

SET_STATUS_X – triggered when status changes to cancelled

81

Page 88: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Customizing a Trigger File A copy of the uncustomized $RESLSTAT.rpf file is shown below:

{*********************************************************************** * * Module Name : $RESLSTAT * * Purpose : SMP report for user defined code which is called when * the status of a sample is changed * * Document Ref. : SE/T/TVGL-WORK-REPORTS/1/3 * * Specification : * * Portability : Not Checked * * Re-entrant : * ***********************************************************************} ROUTINE set_status_a ENDROUTINE ROUTINE set_status_e ENDROUTINE ROUTINE set_status_m ENDROUTINE ROUTINE set_status_r ENDROUTINE ROUTINE set_status_u ENDROUTINE ROUTINE set_status_x ENDROUTINE

82

Page 89: Sm 1000 Idi Reference Manual

Customizing SampleManager IDI

Each status value has a corresponding routine, but in the uncustomized version of the file, the routines have no content. Each of the other trigger files follows the same format.

Note If you have installed SampleManager IDI as an additional module for an existing SampleManager system, one or more of the trigger files may have been altered to support other custom functionality. You must ensure that modifications made for SampleManager IDI do not disrupt the operation of existing custom code. We therefore recommend that all custom routines are added to a library that is specific to SampleManager IDI , such as $SMIDI_RESLSTAT and that the standard SampleManager trigger files are modified to call the required routines.

Add the custom code to the routine corresponding to the status change you need to trigger it. For example:

ROUTINE set_status_a CALL_ROUTINE "set_status_a" IN LIBRARY "$SMIDI_RESLSTAT" ENDROUTINE

The example shown above calls a routine in a different library to keep the $RESLSTAT report as concise as possible. An example of a possible routine triggered by the authorization of a result is shown below. It sends the result to the upload queue and hence to SAP.

ROUTINE send_to_SAP DECLARE test, name, retval, resval test = SELECT RESULT.TEST_NUMBER name = SELECT RESULT.NAME resval = STRIP ( SELECT RESULT.TEXT ) retval = FALSE IF ( NOT BLANK ( resval ) ) THEN IF ( resval <> "~0.0" ) THEN { default results from download } CALL_ROUTINE "smidi_queue_result" IN LIBRARY "$SMIDI_LIB_UPLOAD" USING test, name RETURNING retval ENDIF ENDIF { if no result then don't queue } RETURN ( retval ) ENDROUTINE { end send_to_SAP }

smidi_queue_result

The smidi_queue_result routine is located in the $SMIDI_LIB_UPLOAD library. It can be used to send a selected result to the upload queue. It has two parameters:

• The numeric identifier of the test

• The name of the result

The routine will return True if the result is successfully added to the upload queue, or False if the attempt to update the queue fails.

83

Page 90: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Status Queue When items are sent to the upload queue, SampleManager IDI will attempt to upload them to SAP immediately. If your system requires a delay between the status trigger and the upload attempt, then rather than sending items directly to the upload queue, a pointer to the items can be stored in the status queue. You can then create custom code to examine the status queue at regular intervals, checking whether the required conditions have been met. Once the conditions are satisfied the data can be sent to the upload queue and uploaded to SAP.

The status queue table contains the following fields:

Options Description Identity A unique identity for the item. This is created by the code which places the

item in the queue

Status The status code for the item

Type The type of record is indicated by a single character. The standard characters are:

• J – job

• S – sample

• T – test

• R – result

The three columns in the table are combined to create a unique pointer which can be used to identify the queued data.

Sending a Result to the Status Queue An example of a routine which sends results to the status queue is shown below:

ROUTINE status_queue_trigger ( VALUE status ) DECLARE table_id table_id = "R" a_test = SELECT RESULT.TEST_NUMBER a_name = SELECT RESULT.NAME a_rec = a_test:a_name CALL_ROUTINE "update_status_table" IN LIBRARY "$smidi_user" USING a_rec, table_id, status RETURNING status IF ! status THEN FLASH_MESSAGE ( "Error updating status queue for result ":a_rec, TRUE ) ENDIF ENDROUTINE { status_queue_trigger }

84

Page 91: Sm 1000 Idi Reference Manual

Customizing SampleManager IDI

update_status_table The update_status_table routine is located in the $smidi_user library. It populates the status queue table with a key which points to the combination of the selected record and a specific status value. The routine has the following parameters:

• The identity of the selected item

• The type of item represented by a character, where J=job, S=sample, T=test and R=result

• The character code for the item status

The routine will return True if the status queue is successfully updated, or False if the attempt to update the queue fails.

85

Page 92: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Notes

86

Page 93: Sm 1000 Idi Reference Manual

10 Glossary

Analysis

SampleManager

An analysis is a procedure which is performed on a sample, to obtain one or more measurements or observations. Each measurement or observation to be made is defined as a component of the analysis.

When an analysis is applied to a sample, the unique combination of the analysis and the sample is called a test. The measurement or observation made for each component is entered as a result.

Component

SampleManager

Every measurement taken during the analysis is defined as a separate component. Each component has a unique name and a series of properties which can be defined including:

• Type of result expected e.g. a number, predefined phrase, date or boolean value

• Units

• Maximum and minimum allowed values

• Practical quantification limits (PQLs)

Inspection Characteristic

QM Module

A characteristic of the material being inspected, on which the quality assessment is based.

For example:

• pH

• Water content

• Odor

A characteristic is not necessarily equivalent to a result in SampleManager. For example, if the water content of a sample is determined by loss on drying, then SampleManager may have at least three results: the mass before drying, the mass after drying and the calculated water content result. SampleManager IDI must be configured to translate the inspection characteristic requested by the QM module into the tests and results required to measure it in SampleManager.

87

Page 94: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Inspection Lot

QM Module

A specific quantity of material for which a quality inspection has been requested.

For example:

• A new delivery of raw material for a production process, which must be checked before use in manufacturing

• A new batch of product which needs to pass the quality assurance tests before being cleared for sale

Inspection Operation

QM Module

The activities to be carried out with specific equipment in a given location to determine one or more characteristics of an inspection lot. This may be a simple activity, such as a visual inspection by authorized personnel, or a complex procedure requiring specialist analytical equipment.

For example:

• pH test

• Moisture content

• Color check

Inspection Plan

QM Module

A "template" for Inspection Lots. An inspection plan defines the operations to be carried out for a quality inspection on a material, including the characteristics which are to be investigated.

Figure 10.1: Inspection Plan

88

Page 95: Sm 1000 Idi Reference Manual

Glossary

Inspection Points

QM Module

Inspection points are requests to carry out inspection of material from a production process at regular intervals.

The interval may be based on:

• Time, e.g. once per day

• Quantity, e.g. every 10th barrel

• Other factors, e.g. each time a consumable part is changed.

Job

SampleManager

Jobs are used to group together a set of related samples so that they can be processed together. The job can be used to generate preparation and analysis worksheets for the samples as a group. This facilitates processing, result entry and reporting.

Multi Level Product Specification (MLP)

SampleManager

Multi level product specifications provide a method of checking results against expected values. An MLP specification consists of components, levels and limits:

• Components are drawn from one or more analyses.

• Levels are lists of actions, which can include displaying messages and generating reports. Levels can be applied in any combination to any MLP specification.

• Limits are the permitted range of values at a given level for each component. If a result is outside the limits then the instructions contained in the level will be carried out.

Partial Sample

QM Module

A partial sample is an aliquot of a primary, pooled or reserve sample which is required for use in a specific test. For example, a 400g pooled sample may be split into one 200g and two 100g partial samples for testing.

89

Page 96: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Pooled Sample

QM Module

A pooled sample is one which is made by combining two or more primary samples from a single physical sample.

For example, if a production line produces tins of beans, four tins may be removed from each batch for QC testing. The contents of each individual tin will be a primary sample, i.e. a discreet unit. The contents of all four tins will be the physical sample, i.e. all the material taken from that batch for QC purposes. The contents of three of the tins may then be combined to create a pooled sample for QC tests which require more material than can be obtained from a single tin.

See Physical Sample (page 91) for more details.

90

Page 97: Sm 1000 Idi Reference Manual

Glossary

Physical Sample

QM Module

A physical sample is used to group all the QA samples taken from a single inspection lot at a given time. All the types of sample which are grouped within the physical sample are assumed to have the same characteristics.

A physical sample may be made up of any combination of the following types of sample:

• Primary samples

• Pooled samples

• Reserve samples

Figure 10.2: Sample Types in the QM Module

In the example shown above, four boxes of product are taken for the QA inspection. Hence there are four primary samples. The primary samples are then used as follows:

• 1 primary sample is sent direct to an inspection operation

• 2 primary samples are combined to create a single pooled sample, which is then used for an inspection operation

• 1 primary sample is placed in storage in case repeat tests are required, becoming a reserve sample.

91

Page 98: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Primary Sample

QM Module

A physical amount drawn directly from the stock of a material or batch. One primary sample is created for each discreet quantity taken, e.g. each package or sampling container full.

For example, if a production line produces tins of beans, then the contents of each tin removed for QC testing of the contents would be one primary sample.

See Physical Sample (page 91) for more details.

QAICA

QM-IDI

The data structure used for transferring inspection catalog data.

QAILS

QM-IDI

The data structure used by a subsystem to request inspection lots from the QM module.

QAIMR

QM-IDI

The data structure used for adding result data to a characteristic in the QM module.

QAIMV

QM-IDI

The data structure used for transferring specification information for inspection characteristics.

QAIPP

QM-IDI

The data structure used for transferring inspection point results.

QAISE

QM-IDI

The data structure used for adding a single result to the QM module.

92

Page 99: Sm 1000 Idi Reference Manual

Glossary

QAISR

QM-IDI

The data structure used to add the results for a sample to the QM module.

QAIVC

QM-IDI

The data structure used to send a list of operation and inspection lot data, taken from a specific worklist, to a subsystem.

QAIVE

QM-IDI

The data structure used to add a usage decision for an inspection lot to the QM module.

QIERR

QM-IDI

The data structure used for transferring error messages.

QIWLR

QM-IDI

The data structure used for the worklist of operations to be processed.

QM

The QM (quality management) module of SAP R/3.

QM-IDI

A dedicated interface within the SAP QM module, which allows inspection requirements, results and usage decisions to be transferred between the QM module and SampleManager IDI.

QMIFE

QM-IDI

The data structure used for transferring defect items.

93

Page 100: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Request Manager

One part of the SampleManager IDI module.

Request manager controls the download of requests from QM. Work associated with QM inspection lots is interpreted by the process manager into the following SampleManager data:

• Jobs

• Samples

• Tests

• Results

The process manager stores details of the original request so that the various data upload operations have all the information needed to communicate with QM. It also maintains product specifications and phrase tables in line with the details stored in QM.

Figure 10.3: A Typical Request Manager Operation

Reserve Sample

QM Module

A reserve sample is formed from one or more primary samples, which are placed in storage without testing, when the inspection is carried out. The material in a reserve sample is held in case repeat or additional tests are required at a later date.

See Physical Sample (page 91) for more details.

Result

SampleManager

A result in SampleManager is a single piece of information obtained when a sample undergoes an analytical procedure. Each component of an analysis will have a separate result. The type of result expected is defined in the component record.

94

Page 101: Sm 1000 Idi Reference Manual

Glossary

Sample

SampleManager

A sample is an item which has been sent to the laboratory for testing. In the SampleManager database the information associated with a sample is organized as follows:

Figure 10.4: Sample Data Structure within SampleManager

Samples in SampleManager are dynamic data. This means that they have a distinct lifecycle. A sample will be recorded in the database, tested, have results entered for tests, authorised and then stored for future reference.

95

Page 102: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

SampleManager IDI (SM IDI)

SampleManager Inspection Data Interface

The SampleManager IDI extented functionality module for SampleManager provides an interface between the SampleManager LIMS system and the SAP R/3 QM module. The QM module handles quality management for SAP R/3. SampleManager IDI receives requests for quality inspections from the QM module and translates these into the required SampleManager data. When results have been obtained, SampleManager IDI can then send appropriate data back to the QM module.

Figure 10.5: Interaction between QM, SampleManager IDI and SampleManager

Test

SampleManager

A test in SampleManager is an analysis which has been assigned to a specific sample. The analysis may have a preparation stage. Each measurement to be carried out as part of the analysis is defined as a separate component. Each component has a single result – which is used to store the measurement obtained.

96

Page 103: Sm 1000 Idi Reference Manual

Glossary

Upload Manager

One part of the SampleManager IDI module.

Upload manager controls the return of result values, statistical summaries of results, usage decisions and integration of SAP inspection points. In response to the appropriate request from QM, SampleManager organizes a regular sequence of inspections of a continuous process. In this case, each set of samples collected is known as an inspection point. Details of each set of samples collected and a usage decision for each inspection point may be uploaded. The upload functions are usually executed at well-defined points in the life cycle of SampleManager data.

Figure 10.6: A Typical Upload Manager Workflow

Usage Decision

The conclusion produced by the inspection process, as to the most suitable use for the inspected material.

Usage decisions are made by selecting from a predefined phrase list, and may be entered in either SampleManager IDI or the QM module.

VGL

The custom reporting language for SampleManager.

97

Page 104: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Work Center

QM Module

A place in which inspection operations are carried out. A work center may be associated with a subsystem (a non-SAP software system), such as a LIMS. If a work center is associated with a subsystem, any inspection operations for that work center will be placed in the worklist.

SampleManager IDI will query the QM module at regular intervals and download any new inspections in the worklist which are to be carried out by a subsystem configured within SampleManager IDI.

Figure 10.7: Work Centers, Subsystems and Worklist

Worklist

QM Module

A table containing inspection operations which are associated with subsystems. SampleManager IDI will download requests from the worklist if they are associated with a subsystem identity it has been configured to connect with.

See Work Center (page 98) for further details.

98

Page 105: Sm 1000 Idi Reference Manual

Index

C Configuration Items, 63

ERROR_OK_NUMBERS, 64 FETCH_DEBUG, 64 FETCH_SHUTDOWN, 64 POINTS_DEBUG, 65 POINTS_INTERVAL, 65 POINTS_SHUTDOWN, 65 PROCESS_DEBUG, 65 PROCESS_RETRY_MAX, 65 PROCESS_SHUTDOWN, 66 QM_DNL_MAIL, 66 QM_DUPL_PHRASETABLE, 66 QM_RUPL_MAIL, 66 QM_TOLERANCE_CALC, 66 QM_TOLERANCE_LEVEL, 66 QM_UPL_CLOSE, 67 QM_UPL_COMMIT, 67 QM_UPL_UPDATE, 67 QM_UPL_VALUATIONS, 67 QM_USER1_CALC, 68 QM_USER1_LEVEL, 68 QM_USER2_CALC, 68 QM_USER2_LEVEL, 68 SAP_SPECIFICATION_ATTRIBUTE_OK, 68 SAP_UPLOAD_STATUS_RESULTS, 68 SAP_UPLOAD_STATUS_TESTS, 68 Server Configuration Items, 16 SMIDI_AUTO_UD_JOB_STATUSES, 69 SMIDI_AUTO_UPLOAD, 69 SMIDI_IGNORE_QUERY_FAILURE, 69 SMIDI_JOB_CANCEL_MODE, 69 SMIDI_JOB_CANCEL_STATUS, 69 SMIDI_MAX_UPLOAD_DEFECT, 69 SMIDI_MAX_UPLOAD_LOT_UD, 70 SMIDI_MAX_UPLOAD_POINT, 70 SMIDI_MAX_UPLOAD_POINT_UD, 70 SMIDI_MAX_UPLOAD_RESULT, 70 SMIDI_ORACLE_TRACE, 70 SMIDI_PHRASE_PREFIX, 70 SMIDI_POINTS_1_AT_A_TIME, 71 SMIDI_UPLOAD_RESULT_VALUE, 71 SMIDI_UPLOAD_RETRIES, 71 SMIDI_UPLOAD_SLEEP, 71 SMIDI_UPLOAD_START_DATE, 71

SMIDI_UPLOAD_UNIT_CONVERT, 71 SMIDI_UPLOAD_VALUATES_A, 72 SMIDI_UPLOAD_VALUATES_R, 72 STATUS_QUEUE_SHUTDOWN, 72 UPLOAD_COMPLETE_DELETE, 72 UPLOAD_DEBUG, 72 UPLOAD_SHUTDOWN, 72

Connection Status, 60

D Download Process, 21 Download Queue, 20 Download Selection Criteria, 24 Downtimes, 15

E ERROR_OK_NUMBERS, 64

F Failure Management, 35, 36 FETCH_DEBUG, 64 FETCH_SHUTDOWN, 64

G GBI_JOB_LOGIN, 75 GBI_LOGIN, 75 GBI_MAPPING, 75 GBI_PHRASE_ENTRY, 75 GBI_PHRASE_HEADER, 75 GBI_PRODUCT_ENTRY, 75 GBI_PRODUCT_HEADER, 75 GBI_SAMPLE_LOGIN, 75

I Inspection Points, 45

Creating Inspection Points, 49 Usage Decisions, 48

L Link Failure, 36 Logfiles, 51

LOT_UD_send_lot_ud, 54 POINT_send_point, 53 POINT_UD_send_point_ud, 54 RESULT_send_result, 53 SMIDI_POINTS_VIEW, 52

99

Page 106: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

SMIDI_PROCESS_POINT_VIEW, 53 SMIDI_PROCESS_VIEW, 52 SMIDI_QUERY_VIEW, 51

LOT_UD_send_lot_ud, 54

M Mapping Items, 32 Mapping Profiles, 27

Download Selection Criteria, 28 Mapping Items, 32

MLPs, 33 Multi-Level Product Specifications, 33

O Objects, 73

GBI_JOB_LOGIN, 75 GBI_LOGIN, 75 GBI_MAPPING, 75 GBI_PHRASE_ENTRY, 75 GBI_PHRASE_HEADER, 75 GBI_PRODUCT_ENTRY, 75 GBI_PRODUCT_HEADER, 75 GBI_SAMPLE_LOGIN, 75 QAICA, 75 QAILS, 76 QAIMR, 76 QAIMV, 76 QAIPP, 76 QAISE, 76 QAISR, 76 QAIVC, 76 QAIVE, 76 QEIFT, 76 QIERR, 76 QIWLR, 76 QMIFE, 77 SMIDI_COMPONENT, 77 SMIDI_DOWNLOAD, 77 SMIDI_LOGIN, 77 SMIDI_QIRF, 77 SMIDI_QUE2, 77 SMIDI_RQST, 77 SMIDI_SAMP, 77 SMIDI_TEST, 77 SMIDI_UP_2, 77 SMIDI_V2, 77

P Password, 14 Phrases, 34 POINT_send_point, 53 POINT_UD_send_point_ud, 54 Points Queries, 46

POINTS_DEBUG, 65 POINTS_INTERVAL, 65 POINTS_SHUTDOWN, 65 PROCESS_DEBUG, 65 PROCESS_RETRY_MAX, 65 PROCESS_SHUTDOWN, 66 Product Specifications, 33

Q QAICA, 75 QAILS, 76 QAIMR, 76 QAIMV, 76 QAIPP, 76 QAISE, 76 QAISR, 76 QAIVC, 76 QAIVE, 76 QEIFT, 76 QIERR, 76 QIWLR, 76 QM_DNL_MAIL, 66 QM_DUPL_PHRASETABLE, 66 QM_RUPL_MAIL, 66 QM_TOLERANCE_CALC, 66 QM_TOLERANCE_LEVEL, 66 QM_UPL_CLOSE, 67 QM_UPL_COMMIT, 67 QM_UPL_UPDATE, 67 QM_UPL_VALUATIONS, 67 QM_USER1_CALC, 68 QM_USER1_LEVEL, 68 QM_USER2_CALC, 68 QM_USER2_LEVEL, 68 QMIFE, 77 Queries, 22

Download Selection Criteria, 24 Points Queries, 46

R R/3 Mode, 12 Request Failure, 35 Resamples, 40 RESULT_send_result, 53 Retests, 40

S SAP Password, 14 SAP_SPECIFICATION_ATTRIBUTE_OK, 68 SAP_UPLOAD_STATUS_RESULTS, 68 SAP_UPLOAD_STATUS_TESTS, 68 SM-IDI Server Table, 10

100

Page 107: Sm 1000 Idi Reference Manual

Index

SMIDI_AUTO_UD_JOB_STATUSES, 69 SMIDI_AUTO_UPLOAD, 69 SMIDI_COMPONENT, 77 SMIDI_DOWNLOAD, 77 SMIDI_IGNORE_QUERY_FAILURE, 69 SMIDI_JOB_CANCEL_MODE, 69 SMIDI_JOB_CANCEL_STATUS, 69 SMIDI_LOGIN, 77 SMIDI_MAX_UPLOAD_DEFECT, 69 SMIDI_MAX_UPLOAD_LOT_UD, 70 SMIDI_MAX_UPLOAD_POINT, 70 SMIDI_MAX_UPLOAD_POINT_UD, 70 SMIDI_MAX_UPLOAD_RESULT, 70 SMIDI_ORACLE_TRACE, 70 SMIDI_PHRASE_PREFIX, 70 SMIDI_POINTS_1_AT_A_TIME, 71 SMIDI_POINTS_VIEW, 52 SMIDI_PROCESS_POINT_VIEW, 53 SMIDI_PROCESS_VIEW, 52 SMIDI_QIRF, 77 SMIDI_QUE2, 77 SMIDI_QUERY_VIEW, 51 SMIDI_RQST, 77 SMIDI_SAMP, 77 SMIDI_TEST, 77 SMIDI_UP_2, 77 SMIDI_UPLOAD_RESULT_VALUE, 71 SMIDI_UPLOAD_RETRIES, 71 SMIDI_UPLOAD_SLEEP, 71 SMIDI_UPLOAD_START_DATE, 71 SMIDI_UPLOAD_UNIT_CONVERT, 71 SMIDI_UPLOAD_VALUATES_A, 72 SMIDI_UPLOAD_VALUATES_R, 72 SMIDI_V2, 77 Specifications, 33 STATUS_QUEUE_SHUTDOWN, 72

U Units, 17 Upload, 37

Automatic Upload, 39 Data Cleanup, 41 Manual Upload, 39 Suspending Upload, 39 Upload Queue, 37

Upload Queue, 37 UPLOAD_COMPLETE_DELETE, 72 UPLOAD_DEBUG, 72 UPLOAD_SHUTDOWN, 72 Usage Decisions, 43

Automatic Usage Decisions, 44 Manual Usage Decisions, 44 Usage Decisions, 48

101

Page 108: Sm 1000 Idi Reference Manual

SampleManager IDI Reference Manual

Notes

102


Recommended