VerifyAndGetTimeSeries

Verify And Get Time Series

Minor Business Rule

Object Name: B3400710

Parent DLL: CMFG

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
This business function verifies that the Time Series (F3413) record exists and returns all field
values for the selected record in its output parameters. You can retrieve a record from F3413 using the
index.

1.2Setup Notes and Prerequisites

• The user passes to the business function the number of the index they want to use and the number of
key fields within that index that will be used.

List of Indexes:
1. ITM, MCU, QT, STRT

• The returned error message will display automatically on the message line and the appropriate field
(if any) will be highlighted. This can be suppressed by turning on the "Suppress Error Message" flag.
• Turn on the "Return Values" flag to have the business function return the field values of the
record.
• Set the "Call Type" flag to a "1" to have the business function verify that the record exists. Set
it to "2" to have the business function verify that the record does not exist (ie. it returns an error
if a record is found).

1.3Special Logic
None.

2.Technical Specifications
Fetch the Shop Floor Control Time Series Record corresponding to the index and keys entered by the
user.

If Fetch is Unsuccessful

If DS Call Type is equal to '1', return error messages.

Assign DS Error Message ID = '0002' (Record Invalid).

If DS Suppress Error Message is not equal to '1', SetGBRError where error message is '0002' ( Record
Invalid ) and the first field in the index is highlighted.

If Fetch is successful, return pointer and messages.

If DS Call Type is equal to '2', return error messages.

Assign DS Error Message ID = '2463'.
If DS Suppress Error Message is not equal to '1', SetGBRError where error message is '2463' and
the first field in the index is highlighted.

If DS Call Type is not equal to '2', return the Time Series information.

If DS CallType is not equal to '2' and DS Return Values Flag = '1', return the values into the
parameter data structure.

List of Indexes:
1.ITM, MCU, QT, STRT

Returns:
If Call Type is equal to '1' and the fetch fails, return Error Message ID '0002' (Record Invalid).
If Call Type is equal to '2' and the fetch is successful, return Error Message ID '2463'.
If Return Values is equal to '1', the fetch is successful, return the values of the record to the
input data structure.
For all other errors( i.e. Invalid Index / Keys Combination) return Error Message ID "3143"

^

Data Structure

D3400710 - Verify And Get Time Series

Parameter Name Data Item Data Type Req/Opt I/O/Both

cReturnValuesFlag EV01 char NONE NONE

^

cCallType EV01 char NONE NONE

An option that specifies the type of processing for an event.

cSuppressErrorMessage EV01 char NONE NONE

An option that specifies the type of processing for an event.

nIndex INT01 integer NONE NONE

Number of Days in Future to Query for Responses Due.

nKeys INT02 integer NONE NONE

Number of Days in the Past to Query for Quote Requests Received.

szErrorMessageID DTAI char NONE NONE

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

mnShortItemNumber ITM MATH_NUMERIC NONE NONE

An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item
numbers (see data item XRT) to accommodate substitute item numbers, replacements, bar codes, customer numbers, supplier numbers, and
so forth. The item numbers are as follows: o Item Number (short) - An eight-digit, computer-assigned item number o 2nd Item Number - The
25-digit, free-form, user defined alphanumeric item number o 3rd Item Number - Another 25-digit, free-form, user defined alphanumeric item
number

szBusinessUnit MCU char NONE 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.

szQuantityType QT char NONE NONE

This code is used to distinguish different quantities generated in the MPS/MRP system.

jdStartDate STRT JDEDATE NONE NONE

The start date for the order. You can enter this date manually, or have the system calculate it using a backscheduling routine. The routine
starts with the required date and offsets the total leadtime to calculate the appropriate start date.

mnQuantityAvailable TRQT MATH_NUMERIC NONE NONE

A value that represents the available quantity, which might consist of the on-hand balance minus commitments, reservations, and
backorders. You enter this value in the Branch/Plant Constants program (P41001).

Related Functions

None

Related Tables

F3413 MPS/MRP/DRP Summary File

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
cReturnValuesFlag	EV01	char	NONE	NONE
^
cCallType	EV01	char	NONE	NONE
An option that specifies the type of processing for an event.
cSuppressErrorMessage	EV01	char	NONE	NONE
An option that specifies the type of processing for an event.
nIndex	INT01	integer	NONE	NONE
Number of Days in Future to Query for Responses Due.
nKeys	INT02	integer	NONE	NONE
Number of Days in the Past to Query for Quote Requests Received.
szErrorMessageID	DTAI	char	NONE	NONE
A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.
mnShortItemNumber	ITM	MATH_NUMERIC	NONE	NONE
An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item numbers (see data item XRT) to accommodate substitute item numbers, replacements, bar codes, customer numbers, supplier numbers, and so forth. The item numbers are as follows: o Item Number (short) - An eight-digit, computer-assigned item number o 2nd Item Number - The 25-digit, free-form, user defined alphanumeric item number o 3rd Item Number - Another 25-digit, free-form, user defined alphanumeric item number
szBusinessUnit	MCU	char	NONE	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.
szQuantityType	QT	char	NONE	NONE
This code is used to distinguish different quantities generated in the MPS/MRP system.
jdStartDate	STRT	JDEDATE	NONE	NONE
The start date for the order. You can enter this date manually, or have the system calculate it using a backscheduling routine. The routine starts with the required date and offsets the total leadtime to calculate the appropriate start date.
mnQuantityAvailable	TRQT	MATH_NUMERIC	NONE	NONE
A value that represents the available quantity, which might consist of the on-hand balance minus commitments, reservations, and backorders. You enter this value in the Branch/Plant Constants program (P41001).