Package com.sgapi.config

Class APIConfigurationManager

  • public class APIConfigurationManager
extends java.lang.Object

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String getDateFormat​(int i)
      format.1.date
      The system date format used for outputting
      static boolean getImportFormulaOldLookupAllowed()
      import.formula.old.lookup.allowed
      Allows for the ability to lookup and schedule formula versions which are not the current by specifying the version in the job import
      static boolean getImportJobsPurgeBatchesOnReschedule()
      import.job.purgeBatchesReqOnReschedule
      Function used to clear down and recalculate the batches required if a job is rescheduled after it has already been started
      static boolean getImportOrderLineLookup()
      import.order.lineLookup
      Makes the system look for a unique LineID as the primary key for purchase or sales order lines.
      static int getImportPurchaseOrderDeliveryDateOffset()
      import.purchase.deliveryDate.offset
      A default offset number of days from a purchase order being acknowledged to it's delivery date being posted should delivery date not be specified
      static boolean getImportReturnIDOnly()  
      static int getImportSalesOverriddenStatus()
      import.sales.status
      The status a sales order should be imported with if it is not specified in the file
      static boolean getImportStockPurgeOnReceipt()
      import.stock.purgeOnReceipt
      When importing a stock file, purge all stock on receipt of that file.
      Only useful if sending the whole inventory import at once
      static int getImportValidationLevel()
      import.validationLevel
      The level of tolerance the system allows for objects which don't exist.
      static java.lang.Boolean getMarkExported()
      export.markExported
      Controls whether the system automatically marks records as exported once they are passed through the end point.
      static boolean getSchedulingAllowOverproduction()
      scheduling.overproduction.allowed
      Allows for production to breach allowed limits set by min/max against the formula.
      static java.lang.String getSchedulingJobNoFormat()
      scheduling.jobNo.format
      The format that the job number will take the form of when importing without a job number.
      Parameter 1 is the current date
      Parameter 2 is the number of jobs scheduled on that date
      Defaults to %1$tm%1$td%1$ty-|%2$04d|
      static java.lang.Integer getSchedulingMethodology()
      scheduling.methodology
      The method by which job scheduling should be performed.
      static int getSchedulingStatusMode()
      scheduling.status.mode
      Used to specify the status of a job should the status not be specified within the data
      static int getSystemDecimals()
      system.decimals
      The number of decimals to display for system outputs
      static java.lang.String getSystemUser()
      system.user
      Denotes the user which will be marked as performing the transactions which the API performs
      This should preferably be set to a unique user ID such as "API" or "Integration"
      static java.lang.String getTimeFormat​(int i)
      format.1.time
      The system time format used for outputting

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • APIConfigurationManager

        public APIConfigurationManager()

    • Method Detail

      • getSystemUser

        public static java.lang.String getSystemUser()
        system.user
        Denotes the user which will be marked as performing the transactions which the API performs
        This should preferably be set to a unique user ID such as "API" or "Integration"
        Returns:

      • getSchedulingStatusMode

        public static int getSchedulingStatusMode()
        scheduling.status.mode
        Used to specify the status of a job should the status not be specified within the data
        Returns:

      • getImportJobsPurgeBatchesOnReschedule

        public static boolean getImportJobsPurgeBatchesOnReschedule()
        import.job.purgeBatchesReqOnReschedule
        Function used to clear down and recalculate the batches required if a job is rescheduled after it has already been started
        Returns:

      • getSchedulingMethodology

        public static java.lang.Integer getSchedulingMethodology()
        scheduling.methodology
        The method by which job scheduling should be performed. The rules of scheduling must abide by the min,max and default/base size settings
        Seek additional documentation from SG with regards the different scheduling options
        0 - Attempt to create default sized batches with a remainder batch(s)
        1 - Attempt to make all batches equal in size
        2 - Attempt to create as many maximum sized batches as possible
        Returns:

      • getImportValidationLevel

        public static int getImportValidationLevel()
        import.validationLevel
        The level of tolerance the system allows for objects which don't exist.
        0 - If the inner object does not exist, proceed to add as a null entry
        1 - The inner object does not exist, cancel the import and return failure
        Returns:

      • getDateFormat

        public static java.lang.String getDateFormat​(int i)
        format.1.date
        The system date format used for outputting
        Parameters:
        i - You can specify as many formats as you like
        Returns:

      • getTimeFormat

        public static java.lang.String getTimeFormat​(int i)
        format.1.time
        The system time format used for outputting
        Parameters:
        i - You can specify as many formats as you like
        Returns:

      • getImportFormulaOldLookupAllowed

        public static boolean getImportFormulaOldLookupAllowed()
        import.formula.old.lookup.allowed
        Allows for the ability to lookup and schedule formula versions which are not the current by specifying the version in the job import
        Returns:

      • getSchedulingAllowOverproduction

        public static boolean getSchedulingAllowOverproduction()
        scheduling.overproduction.allowed
        Allows for production to breach allowed limits set by min/max against the formula. See SG documentation for more information on production schedule limits.
        Returns:

      • getImportOrderLineLookup

        public static boolean getImportOrderLineLookup()
        import.order.lineLookup
        Makes the system look for a unique LineID as the primary key for purchase or sales order lines.
        This provides the ability to have the same commodity listed on an order twice and be able to uniquely identify each order line.
        Returns:

      • getSystemDecimals

        public static int getSystemDecimals()
        system.decimals
        The number of decimals to display for system outputs
        Returns:

      • getImportStockPurgeOnReceipt

        public static boolean getImportStockPurgeOnReceipt()
        import.stock.purgeOnReceipt
        When importing a stock file, purge all stock on receipt of that file.
        Only useful if sending the whole inventory import at once
        Returns:

      • getSchedulingJobNoFormat

        public static java.lang.String getSchedulingJobNoFormat()
        scheduling.jobNo.format
        The format that the job number will take the form of when importing without a job number.
        Parameter 1 is the current date
        Parameter 2 is the number of jobs scheduled on that date
        Defaults to %1$tm%1$td%1$ty-|%2$04d|
        Returns:

      • getImportSalesOverriddenStatus

        public static int getImportSalesOverriddenStatus()
        import.sales.status
        The status a sales order should be imported with if it is not specified in the file
        Returns:

      • getImportPurchaseOrderDeliveryDateOffset

        public static int getImportPurchaseOrderDeliveryDateOffset()
        import.purchase.deliveryDate.offset
        A default offset number of days from a purchase order being acknowledged to it's delivery date being posted should delivery date not be specified
        Returns:

      • getMarkExported

        public static java.lang.Boolean getMarkExported()
        export.markExported
        Controls whether the system automatically marks records as exported once they are passed through the end point.
        For ensuring that data is transacted, this provides an ACK/NAK method of informing v% that a record has been received.
        A boolean value. 0 = Off. 1 = On.
        Defaults to 1.
        Returns:

      • getImportReturnIDOnly

        public static boolean getImportReturnIDOnly()