API ~ API Table Codes

Sections in this article

API Table Codes

Setup values and information for the APIs and Night Job

AR_LTMAPOR

Description:

This API will only use K_PRODLTM records to calculate PO metrics with a birthdate up to X many days old, with the value for X found in TA_NUMBER1.

Enable:

If Flag 1 = 1, then you would like to only use K_PRODLTM records to calculate PO metrics with a birthdate up to X many days old

If Flag 1 = 0, then you would not only use K_PRODLTM records to calculate PO metrics

Structure:

Table Code Value: AR_LTMAPOR
Table Code Description 1: Analyze K_PRODLTM records up to this many days old
Table Code Description 2: Values is in number 1 field
Table Flag 1: 0
Table Number 1 (5.0): 7

Program Used In:

  • AR_LTMAPOR

BLOCKSLACK

If an error occurs in R6, an error will be sent to Slack for the developers to be aware and take action. This API will block Slack messages from being sent to K3S developers.

Enable:

If Flag 1 = 1, then you would like to block Slack messages

If Flag 1 = 0, then you would not like to block Slack messages

Structure:

Table Code Value: BLOCKSLACK Table Code Description 1: Block Slack message and user notification with Flag1=1 Table Code Description 2: Block Slack message but keep user notification with Flag2=1 Table Flag 1: 0

Program Used In:

  • AR_BLDTEXT

BYPASSUSERCHECK

Description:

Repuser is the user ID that exists on the IBM server. This table code, if turned on, will ensure the API that the user exists within the IBM server. If this table code is turned off, then it will bypass repuser and will allow the user to use R6 without a valid IBM user account.

Enable:

If Flag 1 = 1, then it will ensure the API that the user exists within the IBM server

If Flag 1 = 0, then it will bypass REPUSER validation on IBM server

Structure:

Table Code Value: BYPASSUSERCHECK
Table Code Description 1: Can the APIs bypass validating the REPUSER exists on the IBM server?
Table Code Description 2: Set Flag1 = 0 to require REPUSER validation on IBM server.
Table Code Description 3: Set Flag1 = 1 to bypass REPUSER validation on IBM server.
Table Flag 1: 1

Program Used In:

  • AR_ADDUSER
  • AR_APRORDR

BYPASS NOTOFY RECORD

Description:

Everytime reports are completed, it will write a record to inform the user. This table code will prevent this notification. It is not standard to have this turned on. However, it is only used if the customer is not using our standard of reports going to the IFS but instead routing reports to an out queue.

Enable:

If Flag 1 = 1, then you would like to prevent notifying the user when reports are completed

If Flag 1 = 0, then you would not like to prevent notifying the user when reports are completed

Structure:

Table Code Value: BYPASS NOT IFY RECORD
Table Code Description 1: Prevent writing notify record when reports are completed?
Table Code Description 2: Flag1 = 1 Yes prevent notify record
Table Flag 1: 0

Program Used In:

  • AR_DEAREPT
  • AR_FORREPT
  • AR_INVREPT
  • AR_OBSREPT
  • AR_ORCREPT
  • AR_OVRREPT
  • AR_PURREPT
  • AR_RNKREPT
  • AR_RPTCUSG
  • AR_SLBREPT
  • AR_SPLREPT
  • AR_SRVREPT
  • AR_SSIREPT
  • AR_TRNREPT
  • AR_UPEREPT

BYPASSPROD PERM_DEALS

Description:

This table code will check to see if the permanent deal APIs need to check that the product exists in K_PRODUCT in order to allow the API to run.

Enable:

If Flag 1 = 1, then the product ID does not have to exist in K_PRODUCT

If Flag 1 = 0, then the product ID must exist in K_PRODUCT

Structure:

Table Code Value: BYPASSUSERCHECK
Table Code Description 1: Does Prod ID have to exist in K_PRODUCT for permanent deal APIs?
Table Code Description 2: 0=Yes, Prod ID must exist in K_PRODUCT

Table Code Description 3: 1=No, Prod ID does NOT have to exist in K_PRODUCT
Table Flag 1: 1

Program Used In:

  • AR_ADPDEAL
  • AR_DLPDEAL
  • AR_UPPDEAL

DISABLETR

Obsolete

ERRORS

Obsolete API. No longer in use in R6.

HIDEARRIVE

Description:

This table code controls the ability to hide the PO arrival date on the PO approval and PO confirmation screens.

Enable:

If Flag 1 = 1, then you would like to hide the PO arrival date.

If Flag 1 = 0, then you would not like to hide the PO arrival date.

Structure:

Table Code Value: HIDEARRIVE
Table Code Description 1: TSet Flag 1 = 1 to hide the PO Arrival date on PO approval screen
Table Flag 1: 0

K3S_110O ALTERNATE

Description:

When creating a PO approval we usually use program K3S_1100 to create it. For this table code, if set to 1 will then use a different program. This program is identified in description 3.

Enable:

If Flag 1 = 1, you would like to call an alternate program

If Flag 1 = 0, you would not like to call an alternate program

Structure:

Table Code Value: K3S_110O ALTERNATE
Table Code Description 1: The PO approval API AR_APRORDR will call an alternate to K3s_1100 when flag1 = 1
Table Code Description 2: This program is identified in description 3
Table Code Description 3: K3S_1106 Table Flag 1: 1

Program Used In:

  • AR_APRORDR

K_INTORDL UPDATES

Obsolete table code. No longer in use.

LISTORDER

Description:*

If a customer has put a modification in place turn LSEORDR will be used and all programs in the K3S_5MOD library will be called.

Enable:

If Flag 1 = 1, then a customer has had a modification put in place and so this table code must be turned on

If Flag 1 = 0, then a customer has no put a modification in place thus this table code will be turned off

Structure:

Table Code Value: LISTORDER
Table Code Description 1: Which API is used for the list order report?
Table Code Description 2: Flag1=0 use LSTORDR creates notification and PDF for download
Table Code Description 3: Flag1=1 use LSEORDR to email with program in K3S_5MOD
Table Flag 1: 0

Programs Used In:

  • AR_LSTORDR
  • AR_LSEORDR

MATH

Description:

This approach is to preserve consistency between the daily tasks and the EOD process, so the same results are provided without creating confusion in the Buyers Community.

Enable:

If Flag 1 = 0 then programs will use Eval

If Flag 0 = 1 then programs will use %DECH

Structure:

Table Code Value: MATH
Table Code Description 1: Do we want to use EVAL (Flag 1=0) or %DECH (Flag 1=1) for math
Table Flag 1: 0

Programs Used In

  • K3S_FX55BC
  • AR_CALORCY
  • K3S_CVRT23

NIT

Description:

This table code will set Description 2 to display the schedule for the K3S night job. This information will be displayed in two places, in the K3S Dashboard and in the R6 login screen.

Enable:

This table code will be used for informational purposes only.

Structure:

Table Code Value: NIT
Table Code Description 1: This description is for the Night Job schedule upon login
Table Code Description 2: Mon - Sun 7:00am EST
Table Flag 1: 0

Program Used In:

This table code will be used for informational purposes only.

ONEYEARFOR ARRIVEDATE

Description:

This table code will block PO approval when the arrival date in more than a year out.

Enable:

If Flag 1 = 1, then you would like to block PO approval with orders that have an arrival date that is over a year

If Flag 1 = 0, then you not would like to block PO approval with orders that have an arrival date that is over a year

Structure:

Table Code Value: ONEYEARFOR ARRIVEDATE
Table Code Description 1: Block PO approval when Flag1=1 and arrival date > 1 year out
Table Flag 1: 0

Program Used In:

  • AR_APRORDR

PORECORDS

Description:

This table code will grab POs from your ERP system and display the information in K3S.

Enable:

Set Flag 1 = 1 to create K_INTORDB, K_INTORDD, K_INTORDL for POs made outside of K3S

Set Flag 1 = 0 if you would not like the POs that have been generated within your ERP system to be generated into K3S

Structure:

Table Code Value: PORECORDS
Table Code Description 1: Identify POs not generated by K3S
Table Flag 1: 1

Program Used In:

  • AR_UPOAPOR

SALESJNL

Description:

Hides the sales journal button because the company does not have the K_INTDALY record set up to display data

Enable:

If Flag 1 = 1, then you would like to hide the sales journal button

If Flag 1 = 0, then you would not like to hide the sales journal button

Structure:

Table Code Value: SALESJNL
Table Code Description 1: Set Flag 1 = 1 to hide the Sales Journal button
Table Flag 1: 0

Program Used In:

Used in front-end development.

VER

Description:

This process will be done automatically. Will be displayed in the K3S dashboard, login page and on the banner on the bottom of the page.

Enable:

This table code will be used for informational purposes only.

Structure:

Table Code Value: VER
Table Code Description 1: This is the version of the APIs
Table Code Description 2: 04.15.20
Table Code Description 3: 02.20.20
Table Flag 1: 0

Program Used In:

  • AR_MONITOR