You are on page 1of 17

Data Manipulation

On-line Documentation
This is a printable version of Revision B of the on-line documentation for the Data Manipulation component.

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 1 of 17
Data Manipulation On-line Documentation

Copyright and Trademark Information


The products described in this document are copyrighted works of NCR Corporation.
NCR and APTRA are trademarks of NCR Corporation.
Windows NT is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other
countries.
All other trademarks are the property of their respective owners.
Disclaimer:
It is the policy of NCR Corporation to improve products as technology, components, software and firmware become
available. NCR therefore reserves the right to change specifications without prior notice.
All features, functions and operations described herein may not be marketed by NCR in all parts of the world. In some
instances, photographs are of equipment prototypes. Therefore, before using this document, consult with your NCR
representative or NCR office for information that is applicable and current.
© 2002, 2003, 2006
By NCR Corporation
Dayton, Ohio, USA
All Rights Reserved

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 2 of 17
Data Manipulation On-line Documentation

Revision Record
Revision Date Help Topic Description of Change
B, Issue 2 Jan 2006 Updated for Data Manipulation Release 02.01.06
All Added confidentiality statement
SupplyPoints Updated Problem Determination SupplyPoints
B, Issue 1 Nov 2003 All Updated for Data Manipulation Release 02.01.00
A Oct 2002 All New documentation for the Data Manipulation component
version 02.00.00

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 3 of 17
Data Manipulation On-line Documentation

Table of Contents
1. DATA MANIPULATION ..................................................................................................................................... 5
1.1 FUNCTIONAL OVERVIEW .................................................................................................................................... 5
1.2 USER GUIDE ....................................................................................................................................................... 5
1.2.1 Standard Data Record................................................................................................................................. 5
1.2.2 Standard Data Dictionary ........................................................................................................................... 5
1.2.3 Object Dictionary ....................................................................................................................................... 6
1.2.4 Troubleshooting.......................................................................................................................................... 6
1.3 REFERENCE ........................................................................................................................................................ 6
1.3.1 Standard Data Record Reference ................................................................................................................ 6
1.3.1.1 Standard Data Record Object Identification ............................................................................................................ 6
1.3.1.2 Standard Data Record Interfaces............................................................................................................................. 7
1.3.1.2.1 IDataRecord Interface..................................................................................................................................... 7
1.3.1.2.1.1 IDataRecord Properties............................................................................................................................ 7
1.3.1.2.1.1.1 RecordType Property..................................................................................................................... 7
1.3.1.2.1.2 IDataRecord Methods .............................................................................................................................. 7
1.3.1.2.1.2.1 GetFieldValue Method.................................................................................................................. 7
1.3.1.2.1.2.2 ListFields Method......................................................................................................................... 8
1.3.1.2.2 _StandardDataRecord Interface ...................................................................................................................... 8
1.3.1.2.2.1 _StandardDataRecord Properties.............................................................................................................. 8
1.3.1.2.2.1.1 RecordType Property..................................................................................................................... 8
1.3.1.2.2.2 _StandardDataRecord Methods................................................................................................................ 9
1.3.1.2.2.2.1 AddField Method .......................................................................................................................... 9
1.3.1.2.2.2.2 RemoveField Method .................................................................................................................... 9
1.3.2 Standard Data Dictionary Reference ......................................................................................................... 10
1.3.2.1 Standard Data Dictionary Object Identification ..................................................................................................... 10
1.3.2.2 Standard Data Dictionary Interfaces ..................................................................................................................... 10
1.3.2.2.1 IDataDictionary Interface ............................................................................................................................. 10
1.3.2.2.1.1 IDataDictionary Methods....................................................................................................................... 10
1.3.2.2.1.1.1 AddRecord Method ..................................................................................................................... 10
1.3.2.2.1.1.2 GetRecord Method...................................................................................................................... 11
1.3.2.2.1.1.3 RemoveRecord Method ............................................................................................................... 11
1.3.3 Object Dictionary Reference ..................................................................................................................... 11
1.3.3.1 Object Dictionary Object Identification ................................................................................................................ 12
1.3.3.2 Object Dictionary Interfaces................................................................................................................................. 12
1.3.3.2.1 IObjectDictionary Interface........................................................................................................................... 12
1.3.3.2.1.1 IObjectDictionary Methods .................................................................................................................... 12
1.3.3.2.1.1.1 Add Method................................................................................................................................ 12
1.3.3.2.1.1.2 AddAlias Method ........................................................................................................................ 13
1.3.3.2.1.1.3 ChangeDelGroup Method ........................................................................................................... 13
1.3.3.2.1.1.4 Find Method............................................................................................................................... 14
1.3.3.2.1.1.5 Remove Method .......................................................................................................................... 14
1.3.3.2.1.1.6 RemoveAlias Method .................................................................................................................. 15
1.3.3.2.1.1.7 RemoveDelGroup Method........................................................................................................... 15
1.3.4 Problem Determination............................................................................................................................. 15
1.3.4.1 SupplyPoints ....................................................................................................................................................... 16
2. INDEX................................................................................................................................................................. 17

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 4 of 17
Data Manipulation On-line Documentation

1. DATA MANIPULATION

1.1 Functional Overview


The Data Manipulation component (Data Manipulation) provides functionality to facilitate the storage and sharing of
data between components of an APTRA application. Data Manipulation consists of the following objects:
• Standard Data Record - Stores data type information to be used in the contexts of receipt printing and
journalling
• Standard Data Dictionary - Stores multiple data records and allows data records to be shared between
components (within the same process boundary)
• Object Dictionary - Allows object references to be shared between containers (for example, COM objects,
Web pages)
This on-line documentation for Data Manipulation is divided into two main sections:
• User Guide
This provides an introduction to using the component. It is particularly recommended for first-time users as it
provides a context for using many of the parameters.
• Reference
This provides a complete listing of the objects implemented by this component and other reference
information.

1.2 User Guide


The following topics are described in the User Guide:
• Standard Data Record - a general-purpose holder for a collection of data
• Standard Data Dictionary - a repository of DataRecord objects
• Object Dictionary - a general-purpose holder of instances of COM objects
• Troubleshooting - help with resolving problems

1.2.1 Standard Data Record


The Standard Data Record is an implementation of the DataRecord abstract class defined in the HICS Interfaces On-
line Documentation. It is a general-purpose holder for a collection of data (similar to a record in a relational database).
The Standard Data Record contains and is identified by its record type. It stores data organised in fields, which are
comprised of a field name and a field value. The data stored can be accessed by specifying the field name (for example,
'AccountNumber', 'TerminalID' and so on).
Any information stored in the Standard Data Record preserves its type (for example, if you enter an integer, an integer
is stored; if you enter a Long Int, a Long Int is stored).

1.2.2 Standard Data Dictionary


The Standard Data Dictionary is an implementation of the DataDictionary abstract class defined in the HICS Interfaces
On-line Documentation. The Standard Data Dictionary is a repository of DataRecord objects. It has simple search
capabilities that allow a data record to be searched for, based on its record type. For searching purposes, the data stored
in the Standard Data Dictionary is case-sensitive.
The Standard Data Dictionary can hold one record of a particular type at any time. Information stored in the Standard
Data Dictionary is stored in the form in which it is entered. Data stored in the Data Dictionary is not 'persistent', which
means it is lost if the DataDictionary object is destroyed.
The Standard Data Dictionary stores copies of the data records added to it, and returns copies of the data records it
contains. This means that if a data record is modified after it has been added to the Standard Data Dictionary, the
changes do not affect the data record stored in the dictionary. Similarly, if a data record retrieved from the Standard
Data Dictionary is modified, the changes do not affect the data record stored in the dictionary. The data record must be

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 5 of 17
Data Manipulation On-line Documentation
re-added to the Standard Data Dictionary after the modifications are made if the intention is to update the dictionary
with the modified data record.

1.2.3 Object Dictionary


The Object Dictionary is an implementation of the ObjectDictionary abstract class defined in the HICS Interfaces On-
line Documentation. It is a general-purpose holder of instances of COM objects.
Instances of COM objects can be created and stored into the Object Dictionary for later use. It allows, for example,
objects to be created in one container and then shared in another container within the same process. In particular it
solves the problem of sharing the same object across different pages in a Web browser (one page can create the object,
configure it, and store it in the Object Dictionary, while other pages can retrieve and use it).
The Object Dictionary supports a hierarchy of a top-level dictionary and sub-dictionaries. This makes it easy to classify
objects of a certain COM type by placing all similar objects in a common sub-dictionary (for example, the top
dictionary can contain a sub-dictionary with transaction objects, another sub-dictionary with print services, another sub-
dictionary with utilities, and so forth). To facilitate this, two COM objects are provided: the Root Dictionary and the
Sub-Dictionary objects. Both objects are implementations of the ObjectDictionary abstract class. Sub-Dictionary
objects can only be used if contained in a Root Dictionary object.

1.2.4 Troubleshooting
Data Manipulation uses the Problem Determination component to assist users in determining the cause of software
problems. The component has predefined SupplyPoints that provide trace information.
If you have problems using this component, and you want to trace the operations the component is performing, you
should use Problem Determination Analysis component and start an investigation. For information on how to initiate
investigations, and guidelines on how to interpret the information collected see the Problem Determination On-line
Documentation.

1.3 Reference
The reference section provides information on the following topics:
• Standard Data Record Reference
• Standard Data Dictionary Reference
• Object Dictionary Reference
• Problem Determination

1.3.1 Standard Data Record Reference


The following topics are described in this section:
• Standard Data Record Object Identification
• Standard Data Record Interfaces

1.3.1.1 Standard Data Record Object Identification


The following table identifies the Standard Data Record object:
Key Value
Prog ID NCRaDataMan.StandardDataRecord
Type Library Filenames APTRADataMan.dll
Type Library Help String NCR APTRA Data Manipulation Objects Library 1.0
Type Library Name NCRaDataMan

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 6 of 17
Data Manipulation On-line Documentation

1.3.1.2 Standard Data Record Interfaces


The Standard Data Record supports the following COM interfaces:
• IDataRecord
• _StandardDataRecord

1.3.1.2.1 IDataRecord Interface


The IDataRecord interface is an architected interface, which must be supported by all implementations of the
DataRecord abstract class as defined in the HICS Interfaces On-line Documentation.
The IDataRecord interface supports the following:
• IDataRecord Properties
• IDataRecord Methods

1.3.1.2.1.1 IDataRecord Properties


The IDataRecord interface supports the following property:
• RecordType

1.3.1.2.1.1.1 RecordType Property


Type
BSTR
Access
Read-only
Description
This property identifies the record. All records of the same type have the same list of fields but each record can have
different field values.
Default value = "" (empty string)
Parameters
None
Exceptions
None

1.3.1.2.1.2 IDataRecord Methods


The IDataRecord interface supports the following methods:
• GetFieldValue
• ListFields

1.3.1.2.1.2.1 GetFieldValue Method


Signature
FieldValue = GetFieldValue (FieldName)
Description
Returns the value of the field specified. If the field does not exist, the type of VARIANT is VT_EMPTY.

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 7 of 17
Data Manipulation On-line Documentation

Parameters
Name [Direction] Type Description
FieldName [in] BSTR Name of the field whose value is requested.
Return Value
FieldValue, of type VARIANT. The value of the field specified as a VARIANT.
Exceptions
None

1.3.1.2.1.2.2 ListFields Method


Signature
FieldNames = ListFields ()
Description
This method returns an array of strings containing the names of all data fields currently held within this data record.
Parameters
None
Return Value
FieldNames, of type SAFEARRAY(BSTR). FieldNames is a SAFEARRAY of strings and contains the names of all
fields stored in the Standard Data Record.
Exceptions
None

1.3.1.2.2 _StandardDataRecord Interface


This interface contains the properties and methods necessary to set the RecordType property and add/remove fields
to/from the Standard Data Record. This is the default incoming interface of a Standard Data Record object.
The _StandardDataRecord interface supports the following:
• _StandardDataRecord Properties
• _StandardDataRecord Methods

1.3.1.2.2.1 _StandardDataRecord Properties


The _StandardDataRecord interface supports the following property:
• RecordType

1.3.1.2.2.1.1 RecordType Property


Type
BSTR
Access
Write-only
Description
This property identifies the record. All records of the same type have the same list of fields but each record can have
different field values.
Default value = "" (empty string)

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 8 of 17
Data Manipulation On-line Documentation
Parameters
None
Exceptions
None

1.3.1.2.2.2 _StandardDataRecord Methods


The _StandardDataRecord interface supports the following methods:
• AddField
• RemoveField

1.3.1.2.2.2.1 AddField Method


Signature
AddField ( FieldName, FieldValue )
Description
This method adds the FieldName and FieldValue parameters to the Standard Data Record. If another field with the same
FieldName is already present, the original FieldValue is overwritten.
There is no restriction on the number of fields that can be added to the Standard Data Record using this method.
Parameters
Name [Direction] Type Description
FieldName [in] BSTR Name of the field to be added to the data record
FieldValue [in] VARIANT* Value of the field specified as a VARIANT
Return Value
None
Exceptions
An exception is generated if the FieldName parameter is NULL or an empty string ("").

1.3.1.2.2.2.2 RemoveField Method


Signature
Existed = RemoveField (FieldName)
Description
This method removes the field identified by the FieldName parameter from the Standard Data Record.
Parameters
Name [Direction] Type Description
FieldName [in] BSTR Name of the field to be removed from the data record (case-sensitive)
Return Value
Existed, of type VARIANT_BOOL. Indicates whether the FieldName parameter specified existed or not:
• VARIANT_TRUE - An existing field has been removed.
• VARIANT_FALSE - There is no matching field to remove.
Exceptions
An exception is generated if the FieldName parameter is NULL or an empty string ("").

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 9 of 17
Data Manipulation On-line Documentation
1.3.2 Standard Data Dictionary Reference
The following topics are described in this section:
• Standard Data Dictionary Object Identification
• Standard Data Dictionary Interfaces

1.3.2.1 Standard Data Dictionary Object Identification


The following table identifies the Standard Data Dictionary object.
Key Value
Prog ID NCRaDataMan.StandardDataDictionary
Type Library Filenames APTRADataMan.dll
Type Library Help String NCR APTRA Data Manipulation Objects Library 1.0
Type Library Name NCRaDataMan

1.3.2.2 Standard Data Dictionary Interfaces


The Standard Data Dictionary supports the following interface:
• IDataDictionary

1.3.2.2.1 IDataDictionary Interface


This is an architected interface that must be supported by all implementations of the DataDictionary abstract class
defined in the HICS Interfaces On-line Documentation. This is the default incoming interface of a Standard Data
Dictionary object.
The IDataDictionary interface supports the following:
• IDataDictionary Methods

1.3.2.2.1.1 IDataDictionary Methods


The IDataDictionary interface supports the following methods:
• AddRecord
• GetRecord
• RemoveRecord

1.3.2.2.1.1.1 AddRecord Method


Signature
AddRecord (DataRecord)
Description
This method adds a copy of the given data record to the Standard Data Dictionary. If another data record with the same
record type already exists in the Standard Data Dictionary, the original data record is overwritten.
If a change is made to the contents of a data record after it has been added to the Standard Data Dictionary, this does not
alter the copy of the data record in the Standard Data Dictionary. The modified data record must be added again to
register this change.
Parameters
Name [Direction] Type Description
DataRecord [in] IDataRecord* The data record to be added
Return Value
None

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 10 of 17
Data Manipulation On-line Documentation
Exceptions
An exception is generated if the DataRecord parameter is a NULL pointer or if the RecordType property is NULL or
empty string ("").

1.3.2.2.1.1.2 GetRecord Method


Signature
Record = GetRecord (RecordType)
Description
This method returns a copy of the data record matching the specified RecordType parameter (if one exists).
Parameters
Name [Direction] Type Description
RecordType [in] BSTR Identifier for the data record to return.
Return Value
Record, of type IDataRecord*. The data record whose record type matches that specified by the RecordType parameter.
If none exists within the Standard Data Dictionary, the value NULL is returned.
Exceptions
An exception is generated if the RecordType parameter is NULL or empty string ("").

1.3.2.2.1.1.3 RemoveRecord Method


Signature
Existed = RemoveRecord (RecordType)
Description
This method removes the data record matching the specified RecordType parameter from the Data Dictionary.
Parameters
Name [Direction] Type Description
RecordType [in] BSTR Identifier for the data record to be removed.
Return Value
Existed, of type VARIANT_BOOL. Indicates whether the record specified existed or not:
• VARIANT_TRUE - An existing record has been removed.
• VARIANT_FALSE - There was no record to remove.
Exceptions
An exception is generated if the RecordType parameter is NULL or empty string ("").

1.3.3 Object Dictionary Reference


The following topics are described in this section:
• Object Dictionary Object Identification
• Object Dictionary Interfaces

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 11 of 17
Data Manipulation On-line Documentation

1.3.3.1 Object Dictionary Object Identification


Root Dictionary Object
The following table identifies the Root Dictionary object.
Key Value
Prog ID NCRSS.ROOTDICTIONARY
Type Library Filenames MasterDictPj.dll
Type Library Help String NCR APTRA Data Manipulation Objects (Root Dictionary) Library 1.0
Type Library Name MasterDictPj 1.0 Type Library
Sub-Dictionary Object
The following table identifies the Sub-Dictionary object.
Key Value
Prog ID NCRSS.SUBDICTIONARY
Type Library Filenames SubDictPj.dll
Type Library Help String NCR APTRA Data Manipulation Objects (Sub Dictionary) Library 1.0
Type Library Name SubDictPj 1.0 Type Library

1.3.3.2 Object Dictionary Interfaces


The Object Dictionary supports the following COM interface:
• IObjectDictionary

1.3.3.2.1 IObjectDictionary Interface


This is an architected interface that must be supported by all implementations of the ObjectDictionary abstract class
defined in the HICS Interfaces On-line Documentation. This is the default incoming interface of the Root Dictionary
and Sub-Dictionary objects.
The IObjectDictionary interface supports the following:
• IObjectDictionary Methods

1.3.3.2.1.1 IObjectDictionary Methods


The IObjectDictionary interface supports the following methods:
• Add
• AddAlias
• ChangeDelGroup
• Find
• Remove
• RemoveAlias
• RemoveDelGroup

1.3.3.2.1.1.1 Add Method


Signature
Status = Add (Key, DeletionGroup, Object)
Description
This method adds the specified object to the dictionary. It associates the object with the given Key and DeletionGroup
parameters.

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 12 of 17
Data Manipulation On-line Documentation
Parameters
Name [Direction] Description
Type
Key [in] BSTR The key which identifies the entry in the dictionary. Must not be an empty string ("").
This value is case-sensitive.
DeletionGroup [in] BSTR This parameter is used to group a set of objects, which may all be removed in one single
operation (see the RemoveDelGroup method). May be an empty string ("").
Object [in] The COM object to be added to the dictionary.
IDispatch*
Return Value
Status, of type Short Integer. It always returns the value of 0 (success).
Exceptions
An exception is generated if the key is already in use or one of the input parameters is invalid.

1.3.3.2.1.1.2 AddAlias Method


Signature
Status = AddAlias (Key, Alias)
Description
This method assigns an alias to an object stored in the dictionary. If the operation succeeds, the alias can be used as a
key to find the object in the dictionary.
Parameters
Name [Direction] Description
Type
Key [in] BSTR The key that identifies the entry in the dictionary. Must not be an empty string (""). This value
is case-sensitive.
Alias [in] BSTR The alias for the object. Must not be an empty string ("").
Return Value
Status, of type Short Integer. It always returns the value of 0 (success).
Exceptions
An exception is generated if the object referred to by the Key parameter cannot be found in the Object Dictionary, one
of the input parameters is invalid or the alias is already in use.

1.3.3.2.1.1.3 ChangeDelGroup Method


Signature
Status = ChangeDelGroup (Key, DeletionGroup)
Description
This method modifies the DeletionGroup parameter value of the object identified by the Key parameter.
Parameters
Name [Direction] Description
Type
Key [in] BSTR The key that identifies the object in the dictionary. Must not be empty string (""). This
value is case-sensitive.
DeletionGroup [in] BSTR The deletion group to which the object should be assigned within the dictionary. May
be an empty string ("").

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 13 of 17
Data Manipulation On-line Documentation
Return Value
Status, of type Short Integer. It always returns the value of 0 (success).
Exceptions
An exception is generated if an object with the given Key parameter is not found in the Object Dictionary or if any of
the input parameters is invalid.

1.3.3.2.1.1.4 Find Method


Signature
Object = Find (Key)
Description
Returns the object stored in the Object Dictionary with the specified Key parameter.
Parameters
Name [Direction] Description
Type
Key [in] BSTR The key that identifies the entry in the dictionary. Must not be an empty string (""). This value
is case-sensitive.
Return Value
Object, of type IDispatch. Returns a pointer to the object stored in the Object Dictionary with the given Key parameter.
Returns NULL if an object with the given Key parameter is not found.
Exceptions
An exception is generated if the Key parameter is an empty string.

1.3.3.2.1.1.5 Remove Method


Signature
Status = Remove (Key)
Description
Removes the object stored with the specified Key parameter from the Object Dictionary. Any aliases of this object are
also removed.
• If the Key parameter refers to an entry which itself is a Dictionary, all objects in this Dictionary are removed,
along with the Dictionary itself.
• If the Key parameter refers to an alias, it removes the object from the Dictionary and all its aliases.
Parameters
Name [Direction] Description
Type
Key [in] BSTR The key of the object to be removed from the dictionary. Must not be an empty string (""). This
value is case-sensitive.
Return Value
Status, of type Short Integer. It always returns the value of 0 (success).
Exceptions
An exception is generated if an object assigned to the given Key parameter could not be found in the Dictionary or if the
Key parameter is an empty string.

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 14 of 17
Data Manipulation On-line Documentation
1.3.3.2.1.1.6 RemoveAlias Method
Signature
Status = RemoveAlias (Alias)
Description
This method removes an alias from the Object Dictionary. Only the alias is removed (not the object to which the alias
refers).
Parameters
Name [Direction] Description
Type
Alias [in] BSTR The alias for an object to be removed from the Object Dictionary. Must not be an empty string
(""). This value is case-sensitive.
Return Value
Status, of type Short Integer. It always returns the value of 0 (success).
Exceptions
An exception is generated if an object associated with the given Alias parameter cannot be found in the Object
Dictionary, or the Alias parameter is an empty string.

1.3.3.2.1.1.7 RemoveDelGroup Method


Signature
Status = RemoveDelGroup (DeletionGroup)
Description
This method removes all objects within the given DeletionGroup parameter from the Object Dictionary and (if
appropriate) from sub-dictionaries. If the DeletionGroup parameter is an empty string (""), all objects placed in the
dictionary with a 'deletion group' value of empty string are removed. Aliases of removed objects are also removed.
Parameters
Name [Direction] Description
Type
DeletionGroup [in] BSTR The deletion group to be deleted from the dictionary. This may be an empty string ("").
This value is case-sensitive.
Return Value
Status, of type Short Integer. It always returns the value of 0 (success).
Exceptions
None

1.3.4 Problem Determination


Data Manipulation uses the Problem Determination component to assist users in determining the cause of software
problems.
The component has predefined SupplyPoints that provide trace information that can be recorded to a log file using the
Problem Determination system.
Standard Data Dictionary
The supply point object for the Standard Data Dictionary is configured with the following parameters:
Field Description
Owner NCRaDataManipulation.StandardDataDict
Responsibility NCRScotland

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 15 of 17
Data Manipulation On-line Documentation
Standard Data Record
The supply point object for the Standard Data Record is configured with the following parameters:
Field Description
Owner NCRaDataManipulation.StandardDataRecord
Responsibility NCRScotland
Object Dictionary
The supply point object for the Object Dictionary is configured with the following parameters:
Field Description
Owner NCRaDataManipulation.ObjectDictionary
Responsibility NCRScotland

1.3.4.1 SupplyPoints
The component for the Standard Data Dictionary, Standard Data Record and Object Dictionary provides the following
SupplyPoints:
SupplyPointHelper Function When It Is Provided
InterfaceEntry Immediately after entering the public interface functions.
InterfaceExit Immediately before leaving the public interface functions.
ImplementationEntry Immediately after entering a private method.
ImplementationExit Immediately before leaving a private method.
EventFired Immediately before raising an event.
EventArrivedEntry Immediately after an event is received.
EventArrivedExit Immediately before the event handler terminates.
General At key points in the code to provide context information, primarily for use when
collecting traces in a live environment ('tracing always on' scenario).
GeneralDebug At key points in the code to provide extra debug information, primarily for use by
development and Professional Services organisations. To be used in the following
situations:
• Assigning a value to a property
• Retrieving the value of a property
• Querying a value to be used in an expression
Warning When non-critical, unexpected issues arrive.
Exception Immediately before an exception is raised.
The SupplyPoints can be queried with MINIMUM, NORMAL or MAXIMUM content:
Content Information Provided
MINIMUM The name of the method or event associated with the SupplyPoint.
Description associated with General and GeneralDebug SupplyPoints.
Description and extended information (for example, error codes) for Warning and
Exception SupplyPoints.
NORMAL Same as MINIMUM plus name and value of simple data type in and out
parameters of methods and events.
MAXIMUM Same as MINIMUM plus name and value of all in and out parameters of methods
and events.

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 16 of 17
Data Manipulation On-line Documentation

2. INDEX
_StandardDataRecord interface ................................. 8 ListFields method ......................................................8
Add method .............................................................12 Object Dictionary.................................................6, 11
AddAlias method .....................................................13 Object identification.............................................12
AddField method ...................................................... 9 Problem Determination ............................................15
AddRecord method ..................................................10 SupplyPoints........................................................16
ChangeDelGroup method.........................................13 RecordType property .............................................7, 8
Data dictionary.....................................................5, 10 Remove method.......................................................14
Data Manipulation .................................................... 5 RemoveAlias method...............................................15
Functional overview.............................................. 5 RemoveDelGroup method........................................15
Reference.............................................................. 6 RemoveField method .................................................9
User guide............................................................. 5 RemoveRecord method ............................................11
Data record ............................................................5, 6 Standard Data Dictionary .....................................5, 10
Find method.............................................................14 Object identification.............................................10
GetFieldValue method .............................................. 7 Standard Data Record ............................................5, 6
GetRecord method ...................................................11 Object identification...............................................6
IDataDictionary interface .........................................10 SupplyPoints for Problem Determination..................16
IDataRecord interface ............................................... 7 Troubleshooting.........................................................6
IObjectDictionary interface ......................................12

Confidential and proprietary information of NCR.


Unauthorised use, reproduction and/or distribution is strictly prohibited.
Page 17 of 17

You might also like