CacheRetrieveError

Cache, Process Error

Minor Business Rule

Object Name: B3003301

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Cache, Retrieve Errors

This function retrieves records from cache which have been written by "Cache, Write Errors". It
fetches the first record in the cache, returns the values, then deletes that record.

While records remain in the cache, "Record Exists" will return 1. When the last record has been
retrieved and deleted, "Record Exists" will return 0.

Data Structure

D3003301 - Cache, Write Error

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnJobNumber	JOBS	MATH_NUMERIC	OPT	NONE
Job Number: JOBS Used to identify the cache CacheCodeError EV01 Error Checking: Check "Business Function Notes" for exact values Item Number: UITM Key Short item number. Business Unit: MMCU Key Business unit for the particular item. Data Item: VDT1 Key Name of the field in error. Field Value: FDVL Value intended for the data item field. Error ID: SHNO Key ID number of the error. Code: EV01 Purpose: An extra character field that may be used for text substitution in the error message. Records Exist: EV01 Purpose: When retrieving records from cache, this indicates if records still exist in cache. Use this value as the basis for terminating a While loop when retrieving all records in the cache. Return Value: 1 when records still exist in cache, 0 when no records exist in cache ^
cCacheCodeError	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szItemNumber	UITM	char	OPT	NONE
A number that the system assigns to an item. It can be in short, long, or third item number format.
szBusinessUnit	MCU	char	OPT	NONE
An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units for which you have no authority.
szDataItem	VDT1	char	OPT	NONE
Data Dictionary field name.
szFieldValue	FDVL	char	OPT	NONE
This contains the value of the field in error.
szErrorID	SHNO	char	OPT	NONE
A generic rates and message code (48/SN) that is assigned to a standard note, message, or general narrative explanation. You can use this code to add instructional information to a work order. You set up codes for this field on the Generic Message/Rate Types table (F00191).
cRecordsExist	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szCode	FTX	char	OPT	NONE
Video or report field text. For a VTX field (e.g. VTX001), this is the soft-coded description and will update the F0020 Vocabulary Overrides File. This field should be left blank when adding a new field unless you wish to override the Data Dictionary text.
szCallingApplication	ANM	char	OPT	NONE
This field is used to store the name of the application associated with a task. This application will provide a place for the user to enter specific information necessary to complete the setup task.

Related Functions

None

Related Tables

None

CacheWriteError

Cache, Process Error

Minor Business Rule

Object Name: B3003301

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Cache Write Error

This function can be used to write errors to cache.

It requires that a job number and the application name (where the job number was created) be passed
in to create the caches name.  This same job number and application name will then be required to
retrieve the errors from cache.

NOTE: The unique key for the cache is the Item Number, Business Unit, Data Item, and Error Code.  If
a record fails to add for any reason, it will return "er_failed".  However, cCacheCodeError will
return the following values:
0  Added Record Succesfully
1  Failed To Add Because Record With Same Key Already Exists
2  Failed To Add And No Similar Record Exists

For standard error reporting, UBE R30822 can then be called to print these errors from cache.

For special situations, "Cache, Retrieve Errors" can be used to read the errors written to cache by
this function.

^

Data Structure

D3003301 - Cache, Write Error

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnJobNumber	JOBS	MATH_NUMERIC	OPT	NONE
Job Number: JOBS Used to identify the cache CacheCodeError EV01 Error Checking: Check "Business Function Notes" for exact values Item Number: UITM Key Short item number. Business Unit: MMCU Key Business unit for the particular item. Data Item: VDT1 Key Name of the field in error. Field Value: FDVL Value intended for the data item field. Error ID: SHNO Key ID number of the error. Code: EV01 Purpose: An extra character field that may be used for text substitution in the error message. Records Exist: EV01 Purpose: When retrieving records from cache, this indicates if records still exist in cache. Use this value as the basis for terminating a While loop when retrieving all records in the cache. Return Value: 1 when records still exist in cache, 0 when no records exist in cache ^
cCacheCodeError	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szItemNumber	UITM	char	OPT	NONE
A number that the system assigns to an item. It can be in short, long, or third item number format.
szBusinessUnit	MCU	char	OPT	NONE
An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units for which you have no authority.
szDataItem	VDT1	char	OPT	NONE
Data Dictionary field name.
szFieldValue	FDVL	char	OPT	NONE
This contains the value of the field in error.
szErrorID	SHNO	char	OPT	NONE
A generic rates and message code (48/SN) that is assigned to a standard note, message, or general narrative explanation. You can use this code to add instructional information to a work order. You set up codes for this field on the Generic Message/Rate Types table (F00191).
cRecordsExist	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szCode	FTX	char	OPT	NONE
Video or report field text. For a VTX field (e.g. VTX001), this is the soft-coded description and will update the F0020 Vocabulary Overrides File. This field should be left blank when adding a new field unless you wish to override the Data Dictionary text.
szCallingApplication	ANM	char	OPT	NONE
This field is used to store the name of the application associated with a task. This application will provide a place for the user to enter specific information necessary to complete the setup task.

Related Functions

None

Related Tables

None

SubtituteErrorText

Cache, Process Error

Minor Business Rule

Object Name: B3003301

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

This function will perform text substitution.  It is only capable of substituting into one location.

Example:

Original Text:    The quick &1 fox jumped
Substitute Text:  brown
New Text:The quick brown fox jumped

It will substitute the "Substitute Text" parameter into the first "&X" that it finds.  Any "&X" after
the first one will be ignored.

Example:

Original Text:    The quick &1 fox &2
Substitute Text:  brown
New Text:The quick brown fox &2

If two strings need to be substituted, the function may be called twice.

Data Structure

D3003301A - Substitute Error Text

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szSubstituteText	FTX	char	REQ	INPUT
Video or report field text. For a VTX field (e.g. VTX001), this is the soft-coded description and will update the F0020 Vocabulary Overrides File. This field should be left blank when adding a new field unless you wish to override the Data Dictionary text.
szOriginalText	FTX	char	REQ	INPUT
Video or report field text. For a VTX field (e.g. VTX001), this is the soft-coded description and will update the F0020 Vocabulary Overrides File. This field should be left blank when adding a new field unless you wish to override the Data Dictionary text.
szNewText	FTX	char	REQ	OUTPUT
Video or report field text. For a VTX field (e.g. VTX001), this is the soft-coded description and will update the F0020 Vocabulary Overrides File. This field should be left blank when adding a new field unless you wish to override the Data Dictionary text.

Related Functions

None

Related Tables

None