Overview
The "Sales Order Loader Object" (SOAPI) is a Rootstock custom object used by both internal processing as well as a means to create various transactions either from an external source or from custom pages users may develop.
This object is also used to create transactions spawned from another transaction object, such as POLOADER, or from SYDATA itself (such as performing a SO Fulfillment, spawning another SYDATA to create the SO Invoice).
NOTE When creating a SOAPI record, if the 'Process Indicator' is not set, it will be added at a 'Ready' status. If 'Background Processing' is not used, as soon as the record is saved, a trigger will trigger the given transaction in real-time. If 'Background Processing' IS used, the record will not be processed until the PeriodicBatchProcessor cycles (see below).
Background Processing
When Asynchronous Processing (aka Background Processing) is set to TRUE, saving the record will spawn an SYDATA transaction that will process SOAPI records systematically in the order they were entered, and will prevent possible record locking and the possibility of records processing out of sequence. If real-time adding of orders is not necessary, then this is what is recommended.
Records may be processed in real-time or may be driven by a process called Rootstock Periodic Batch Processor, which runs in the background, processing transactions asynchronously.
NOTE The user that launches the PeriodicBatchProcessor is used as the 'Created-By" user on the resulting system transaction so must have the proper profile/permissions and licenses needed to execute the given transaction type.
Note on Lookup Fields
When using Data Loader, External ID fields are used to reference lookup fields, but Record ID can be substituted when using Apex Code to create records
Error Handling
SOAPI Load Errors
Basic validation is done prior to loading the record (e.g., Division can be derived, valid Work Order, valid Operation, valid User). Errors of this type occur within Data Loader or in the tool being used to load data from an external source and will be reported therein.
SOAPI Processing Errors
Go to SOAPI list view and make sure that you have columns for 'Processing Indicator', for 'Error Message', and for 'Last Modified Date'. Sort 'Last Modified Date' in descending order (latest first). Look for those where 'Processing Indicator' = "Processing Failure".
Several types of errors may occur when processing the records that successfully load.
Validation Failure: Additional validation is performed when processing a given record, such as attempting to book time and quantities with the same record entry. When this type of failure occurs, only the record in question fails, and not the entire load file, and the reason for the error is written to the Error Message field on the SOAPI record. Once the data is corrected in the source file, it can be resubmitted.
Processing Failure: Failures that occur during the processing of the record may occur, such as a data-related issue encountered. When this type of failure occurs, all records in the individual load file along with the reason for the error are written to the Error Message field on the SOAPI record. Go to SOAPI list view and make sure that you have columns for 'Error Message' and for 'Last Modified Date'. Sort 'Last Modified Date' in descending order (latest first). Look for those where 'Error Message' is not blank.
Review error messages for those that failed, then make necessary corrections. Once that is done, reset 'Processing Indicator' = "Ready" and Save record (merely correcting the data and saving will not trigger a retry). If corrections were adequate, you should then see the record process successfully, with a 'Processing Indicator' = "ProcessingComplete".
NOTE The CSV files attached to each API Mode article contain sample data that needs to be removed before populating with data from your org.
Supported Transactions
Transactions supported by SOAPI are listed below. Note that there are individual articles for each API Mode that define required and optional fields along with sample CSV "load" files which you may download, modify as necessary, and use.
-
Add Header
-
Add Line
-
Add Both
-
Change Line
-
Change Header
-
Change Both
-
Delete Line
-
Delete Header
-
Delete Both
SEE ALSO
Using Data Loader
About SYDATA ("System Transaction Object")
SOAPI - Add Header
SOAPI - Add Line
SOAPI - Add Header and Line
SOAPI - Change Header
SOAPI - Change Line
SOAPI - Change Both - Header and Line
SOAPI - Delete Header
SOAPI - Delete Line
SOAPI - Delete Header and Line
SYDATA - Process Async SOAPIs
