Epicor 9.05 Business Object Reference Guide 9.05.605
Disclaimer This document is for informational purposes only and is subject to change without notice. This document and its contents, including the viewpoints, dates and functional content expressed herein are believed to be accurate as of its date of publication. However, Epicor Software Corporation makes no guarantee, representations or warranties with regard to the enclosed information and specifically disclaims any applicable implied warranties, such as fitness for a particular purpose, merchantability, satisfactory quality or reasonable skill and care. As each user of Epicor software is likely to be unique in their requirements in the use of such software and their business processes, users of this document are always advised to discuss the content of this document with their Epicor account manager. All information contained herein is subject to change without notice and changes to this document since printing and other important information about the software product are made or published in release notes, and you are urged to obtain the current release notes for the software product. We welcome user comments and reserve the right to revise this publication and/or make improvements or changes to the products or programs described in this publication at any time, without notice. The usage of any Epicor software shall be pursuant to an Epicor end user license agreement and the performance of any consulting services by Epicor personnel shall be pursuant to Epicor's standard services terms and conditions. Usage of the solution(s) described in this document with other Epicor software or third party products may require the purchase of licenses for such other products. Where any software is expressed to be compliant with local laws or requirements in this document, such compliance is not a warranty and is based solely on Epicor's current understanding of such laws and requirements. All laws and requirements are subject to varying interpretations as well as to change and accordingly Epicor cannot guarantee that the software will be compliant and up to date with such changes. All statements of platform and product compatibility in this document shall be considered individually in relation to the products referred to in the relevant statement, i.e., where any Epicor software is stated to be compatible with one product and also stated to be compatible with another product, it should not be interpreted that such Epicor software is compatible with both of the products running at the same time on the same platform or environment. Additionally platform or product compatibility may require the application of Epicor or third-party updates, patches and/or service packs and Epicor has no responsibility for compatibility issues which may be caused by updates, patches and/or service packs released by third parties after the date of publication of this document. Epicor® is a registered trademark and/or trademark of Epicor Software Corporation in the United States, certain other countries and/or the EU. All other trademarks mentioned are the property of their respective owners. Copyright © Epicor Software Corporation 2011. All rights reserved. No part of this publication may be reproduced in any form without the prior written consent of Epicor Software Corporation.
9.05.605 Revision: May 23, 2011 12:38 p.m. Total pages: 2403 sys.ditaval
Business Object Reference Guide
Purpose The Business Objects Methods Reference Guide documents all business objects in the Epicor application. Use this reference guide to review the methods used by each business object. Leverage this guide when you are configuring or developing applications that require some interaction with business object methods. For example, use this guide when you are setting up WCF services to perform business tasks. Review this guide to locate the specific business object methods you need to link to the WCF services. This reference guide divides the business objects into four alphabetical sections: • A-E • F-L • M-R • S-Z Within each section, the business objects are organized in alphabetical order. The Epicor application contains 797 business objects and a total of 11737 public methods.
Epicor 9.05 | 9.05.605
3
A-E
Business Object Reference Guide
Part I: A-E Chapter 1: A AbcCode Epicor.Mfg.BO.AbcCode: This business object contains 7 methods.
GetNewAbcCode Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
4
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AccountBudget Epicor.Mfg.BO.AccountBudget: This business object contains 12 methods.
GetNewGLBudgetHd Inserts a new row in the DataSet with defaults populated.
GetNewGLBudgetDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
5
A-E
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeDtlBudgetAmt This method updates the DispTotalBudgetAmt and the BudgetAmt of the GLBudgetHd when the GLBudgetDtl.BudgetAmt changes.
6
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description G/L Account Budget Data Set
ChangePerCodeOrAmount This method updates the DispTotalBudgetAmt when the BudgetPerCode or BudgetAmt changes. Parameters Name
Type
ds
Description G/L Account Budget Data Set
CopyBudget This method copies the entire Budget from a valid fiscal year to a new Fiscal Year. Parameters Name
Type
Description
bookToCopy
String
The book budget to copy.
fromFiscalYear
Int32
The Fiscal Year of the Budget to copy.
fromFiscalYearSuffix
String
The Fiscal Year Suffix of the Budget to copy.
sourceBudgetActual
String
Radio set for budget (B) or actuals (A).
adjustmentPct
Decimal
The Adjustment Percentage by which to adjust the numbers for the Target Fiscal Year. If 0 then budget will be copied as is.
toFiscalYear
Int32
The Target Fiscal Year for the new budget.
toFiscalYearSuffix
String
The Target Fiscal Year Suffix for the new budget.
Returns G/L Account Budget Data Set
ACTType Epicor.Mfg.BO.ACTType: This business object contains 72 methods.
GetNewACTType Inserts a new row in the DataSet with defaults populated.
GetNewACTRevision Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
7
A-E
Business Object Reference Guide
GetNewABTDocLine Inserts a new row in the DataSet with defaults populated.
GetNewABTAmount Inserts a new row in the DataSet with defaults populated.
GetNewABTPostEntity Inserts a new row in the DataSet with defaults populated.
GetNewABTPostCode Inserts a new row in the DataSet with defaults populated.
GetNewABTQuery Inserts a new row in the DataSet with defaults populated.
GetNewABTQParam Inserts a new row in the DataSet with defaults populated.
GetNewACTBook Inserts a new row in the DataSet with defaults populated.
GetNewBookingRule Inserts a new row in the DataSet with defaults populated.
GetNewBROperation Inserts a new row in the DataSet with defaults populated.
GetNewBRFunction Inserts a new row in the DataSet with defaults populated.
GetNewBookVar Inserts a new row in the DataSet with defaults populated.
GetNewBRFuncArgs Inserts a new row in the DataSet with defaults populated.
GetNewBRFuncOperation Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
8
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ABTBookGetNew Add book to book list.
Epicor 9.05 | 9.05.605
9
A-E
Business Object Reference Guide
Parameters Name
Type
Description
actTypeUID
Int32
aCTTypeUID
actRevisionUID
Int32
actRevisionUID
bookID
String
Book ID
ds
actTypeDataSet
ABTDocLineGetNew Create new BR Operation. Parameters Name
Type
Description
actTypeUID
Int32
aCTTypeUID
actRevisionUID
Int32
actRevisionUID
parentAbtDocLineUID
Int32
Parent ABTDocLineUID
ds
actTypeDataSet
ABTPostCodeGetNew Create new ABTPostcode. Parameters Name
Type
Description
actTypeUID
Int32
actTypeUID
actRevisionUID
Int32
actRevisionUID
abtDocLineUID
Int32
abtDocLineUID
abtPostEntityUID
Int32
abtPostEntityUID
developMode
Boolean
Developer Mode
ds
actTypeDataSet
DeleteACTBook Parameters
10
Name
Type
Description
aCTTypeUID
Int32
aCTTypeUID
aCTRevisionUID
Int32
aCTRevisionUID
bookID
String
bookID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
BookingRuleGetNew Create new Booking Rule. Parameters Name
Type
Description
actTypeUID
Int32
aCTTypeUID
actRevisionUID
Int32
actRevisionUID
bookID
String
bookID
isPost
Boolean
Is Post Rule
ds
actTypeDataSet
BookVariableGetNew Create new variable of type of type book, function, rule. Parameters Name
Type
Description
actTypeUID
Int32
aCTTypeUID
actRevisionUID
Int32
actRevisionUID
bookID
String
bookID
vType
String
vType
vUID
Int32
vUID
ds
actTypeDataSet
BRFuncOperationGetNew Create new BR Operation. Parameters Name
Type
Description
actTypeUID
Int32
aCTTypeUID
actRevisionUID
Int32
actRevisionUID
functionUID
Int32
functionUID
operationUID
Int32
operationUID
chldSequenceNumber
Int32
childSequenceNumber
ds
Epicor 9.05 | 9.05.605
actTypeDataSet
11
A-E
Business Object Reference Guide
BROperationGetNew Create new BR Operation. Parameters Name
Type
Description
actTypeUID
Int32
aCTTypeUID
actRevisionUID
Int32
actRevisionUID
bookID
String
bookID
ruleUID
Int32
ruleUID
operationUID
Int32
operationUID
chldSequenceNumber
Int32
childSequenceNumber
ds
actTypeDataSet
ChangeACTTypeSigleActive Change ACT Type Single Active Mode. Parameters Name
Type
Description
iACTTypeUID
Int32
iACTTypeUID
lSingleMode
Boolean
SingleMode
ds
actTypeDataSet
ChangeBAQ Refresh parameter list after BAQ change. Parameters Name
Type
Description
actTypeUID
Int32
actTypeUID
actRevisionUID
Int32
actRevisionUID
abtDocLineUID
Int32
abtDocLineUID
abtQueryUID
Int32
abtQueryUID
baqName
String
baqName
ds
12
actTypeDataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangeRevisionStatusMode Change Revision Status or Mode. Parameters Name
Type
Description
companyName
String
CompanyName
iACTTypeUID
Int32
iACTTypeUID
iACTRevisionUID
Int32
iACTRevisionUID
cStatus
String
Status
lSingleMode
Boolean
SingleMode
lNeedRefresh
Boolean@
NeedRefresh
ds
actTypeDataSet
CheckBAQExists Checks if BAQ exists. Parameters Name
Type
Description
baqid
String
baqid
isexisted
Boolean@
isexisted
CopyListOfFunctions Copy defined function list Parameters Name
Type
Description
listOfFuncUID
String
listOfFuncUID
destinationACTTypeUID
Int32
identifier of destination ActType
destinationRevisionUID
Int32
identifier of destionation revision
destinationBookUID
String
identifier of destination book
CopyListOfRules Copy defined booking rule list
Epicor 9.05 | 9.05.605
13
A-E
Business Object Reference Guide
Parameters Name
Type
Description
listOfRuleUID
String
listOfRuleUID
destinationACTTypeUID
Int32
identifier of destination ActType
destinationRevisionUID
Int32
identifier of destionation revision
destinationBookUID
String
identifier of destination book
CopyFunction Copies defined function to another Revision, book etc. Parameters Name
Type
Description
sourceFunctionUID
Int32
identifier of function will be copied
destinationACTTypeUID
Int32
identifier of destination ActType
destinationRevisionUID
Int32
identifier of destionation revision
destinationBookUID
String
identifier of destination book
createdFuncUID
Int32@
createdFuncUID
CopyOperation Copies defined operation. Parameters
14
Name
Type
Description
aCTTypeUID
Int32
ACTTypeUID
aCTRevisionUID
Int32
ACTRevisionUID
bookID
String
bookID
ruleUID
Int32
RuleUID
functionUID
Int32
FunctionUID
operationUID
Int32
OperationUID
destACTRevisionUID
Int32
ACTRevisionUID destination
destBookID
String
destBookID
destRuleUID
Int32
RuleUID destination
destFunctionUID
Int32
FunctionUID destination
destOperationUID
Int32
identifier of destination operation
bMulti
Boolean
Multi Copy
bMove
Boolean
Move
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
ds
Description actTypeDataSet
CopyRule Copy rule with their operations Parameters Name
Type
Description
sourceRuleUID
Int32
identifier of rule will be copied
destinationACTTypeUID
Int32
identifier of destination ActType
destinationRevisionUID
Int32
identifier of destionation revision
destinationBookUID
String
identifier of destination book
newRuleUID
Int32@
newRuleUID
CustomUpdate Custom Update Database Parameters Name
Type
Description
ds
A/R invoice data set.
DeleteOpItems Delete single Operation or with child operations Parameters Name
Type
Description
aCTTypeUID
Int32
ACTTypeUID
aCTRevisionUID
Int32
ACTRevisionUID
bookID
String
bookID
ruleUID
Int32
RuleUID
functionUID
Int32
FunctionUID
operationUID
Int32
OperationUID
bMulti
Boolean
Multi Delete
ds
Epicor 9.05 | 9.05.605
actTypeDataSet
15
A-E
Business Object Reference Guide
DeleteRevisionByName Delete revision by Revision Code. Parameters Name
Type
Description
acttypeUID
Int32
ACTType ACTTypeUID
revisionCode
String
ACTRevision Revision Code
compList
String
Companies List
DeleteRevsBeforeImport Delete all previous revisions for spec. transaction types. Parameters Name
Type
Description
typeName
String
ACTType Display Name
compList
String
Companies List
ExportToXML Export revision to XML format Parameters Name
Type
Description
strRevisionList
String
strRevisionList
strXML
String@
strXML
aCTTypeUID
Int32
aCTTypeUID
FillBAQDescription Check BAQ Name. Parameters Name ds
16
Type
Description actTypeDataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GenerateTemplate Parameters Name
Type
Description
companyName
String
Company Name
aCTTypeUID
Int32
aCTTypeUID
aCTRevisionUID
Int32
aCTRevisionUID
singleActive
Boolean
singleActive
errorText
String@
errorText
Returns all revisions for Export Form Returns Returns the result dataset
GetAllCOAByCode Returns all COA with Segments Parameters Name
Type
Description
coaCode
String
coaCode
Returns Returns the result dataset
GetBookVarOwnerID Get list of book variable owner id's. If owner is function or rule the list will include names and id's. Parameters Name
Type
Description
actTypeUID
Int32
aCTTypeUID
actRevisionUID
Int32
actRevisionUID
bookID
String
bookID
ownerType
String
ownerType
strList
String@
strList
GetBookVarOwnerTypes Get list of bookVar owners - Global, Book, Rule, Function.
Epicor 9.05 | 9.05.605
17
A-E
Business Object Reference Guide
Returns strList
GetBRContainerRows Get list of fields. Parameters Name
Type
Description
tag
String
tag
bookID
String
bookID
actTypeUID
Int32
actTypeUID
actRevisionUID
Int32
actRevisionUID
Returns Returns the result dataset
GetCurrentVersion Get ACTType ID by Name. Parameters Name
Type
Description
actTypeName
String
ACT Type Name
abtVer
String@
ABT version
GetCustomContextMenuXml Returns context menu items as xml for rules constructor. Parameters Name
Type
Description
actTypeID
Int32
ACTTypeUID
actRevisionUID
Int32
ACTRevisionUID
bookID
String
BookID
ruleID
Int32
RuleUID
functionID
Int32
FunctionUID
sXML
String@
XML
GetEntityForBookingRule Get a value of Entity for a Booking Rule in table PatchFld.
18
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
actTypeID
Int32
ACTTypeUID
actRevisionUID
Int32
ACTRevisionUID
bookID
String
BookID
ruleID
Int32
RuleUID
brEntity
String@
brEntity
Name
Type
Description
companyName
String
CompanyName
actTypeName
String
ACT Type Name
actTypeID
Int32@
ACT Type UID
GetFlowList Get list of flow statements. Returns strList
GetIDByName Get ACTType ID by Name. Parameters
GetOperatorList Get list of operators. Returns strList
GetPostCodeTypes Get list of possible post code types. Returns strTypes
GetRevisionIDByName Get ACTRevision ID by Name.
Epicor 9.05 | 9.05.605
19
A-E
Business Object Reference Guide
Parameters Name
Type
Description
companyName
String
Company Name
actRevisionCode
String
ACT Revision Code
actTypeID
Int32
ACTTypeID
actRevisionID
Int32@
ACTRevisionID
GetStatusList Get list of revision statuses. Returns strList
GetSummarizeList Get list of summarize options. Returns strList
GetTrCurrencyList Transactional currency options. Returns strList
GetVarTypes Get list of possible types. Returns arTypes
GetWarningRevisionStatus Return warning if status is changing. Parameters
20
Name
Type
Description
iACTTypeUID
Int32
iACTTypeUID
iACTRevisionUID
Int32
iACTRevisionUID
cStatus
String
Status
lSingleMode
Boolean
SingleMode
cWarning
String@
cWarning
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ImportFromXML Import revision to XML format Parameters Name
Type
Description
typeName
String
ACTType Display Name
cRevisionList
String
Revisions List
cXML
String
XML Document as string
isACTType
Boolean
isACTType
compList
String
Companies List
bookMap
String
Books Map as List
errorMess
String@
Text message with error description
IsVarInUse Checks if a variable (book, function, rule) is used. Parameters Name
Type
Description
acttypeuid
Int32
acttypeuid
actrevisionuid
Int32
actrevisionuid
bookid
String
bookid
bookvaruid
Int32
bookvaruid
errorreturn
Boolean
errorreturn
isinuse
Boolean@
isinuse
LoadBooks LoadBooks Parameters Name
Type
Description
aCTRevisionUID
Int32
ACTRevisionUID
OnChangeBVRuleAction This method should be called when action of validation rule is changed.
Epicor 9.05 | 9.05.605
21
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
ACT Type data set
OnChangeOfACTRevisionEffFromDate This method should be called before the revision effective date has been updated. Parameters Name
Type
Description
aCTRevisionUID
Int32
ACTRevisionUID
newEffFromDate
Nullable{System.DateTime}
Proposed Effective Date
ds
ACT Type data set
PostCodeSourceRefresh refresh datasource of post codes. Parameters Name
Type
Description
ds
actTypeDataSet
RefreshBookList Refresh Books list Parameters Name
Type
Description
aCTRevisionUID
Int32
ACTRevisionUID
RevisionCopyFrom Create copy of Revision. Parameters Name
Type
Description
revisionCopyFromUID
Int32
RevisionCopyFromUID
isDocOnly
Boolean
isDocOnly
ds
22
actTypeDataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateBookingRulePostingEntity Update a value of Entity for a Booking Rule in table PatchFld. Parameters Name
Type
Description
actTypeID
Int32
ACTTypeUID
actRevisionUID
Int32
ACTRevisionUID
bookID
String
BookID
ruleID
Int32
RuleUID
entity
String
Entity
AddPartWhse Epicor.Mfg.BO.AddPartWhse: This business object contains 2 methods.
CreatePartWhse Creates a PartWhse record. Parameters Name
Type
Description
partNum
String
Part number.
plant
String
Plant.
wareHseCode
String
Warhouse code.
GetWareHseList Get a list of warehouses where the part does not exist. Parameters Name
Type
Description
partNum
String
Part number for the search.
plant
String
Plant for the search.
Returns Epicor.Mfg.BO.AddPartWhseDataSet
Epicor 9.05 | 9.05.605
23
A-E
Business Object Reference Guide
AdminCompany Epicor.Mfg.BO.AdminCompany: This business object contains 17 methods.
GetNewAdminCompany Inserts a new row in the DataSet with defaults populated. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
24
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AddCompany This method adds a new Company. Parameters Name
Type
Description
companyId
String
Id for the new Company
companyName
String
Name for the new Company
serialNumber
Decimal
Serial number to be assigned for the new Company
currencyCode
String
The base currency code for the new Company
decimalsGeneral
Int32
General Decimals for the base currency code for the new Company
decimalsCost
Int32
Unit Cost Decimals for the base currency code for the new Company
decimalsPrice
Int32
Unit Prices Decimals for the base currency code for the new Company
countryCode
String
The Country code to use for Country Specific Functionality.
countryGroupCode
String
The Country Group code to use for Country Specific Functionality.
AssignSerialNumber This method updates the serial number for a Company. Parameters Name
Type
Description
companyId
String
Id for the Company
serialNumber
Decimal
Serial number to be assigned for the Company
ChangeCGCCodes This method updates the CGC codes for a Company.
Epicor 9.05 | 9.05.605
25
A-E
Business Object Reference Guide
Parameters Name
Type
Description
companyId
String
Id for the Company
countryCode
String
New country code for the Company
countryGroupCode
String
New country group code for the Company
ChangeCompanyName This method updates the name for a Company. Parameters Name
Type
Description
companyId
String
Id for the Company
companyName
String
New name for the Company
DeleteByCompanyId This method deletes the Company with the specified id and and all of the associated data for the company. Parameters Name
Type
Description
companyId
String
Id for Company to be deleted
DeleteBySysRowId This method deletes the Company with the specified id and and all of the associated data for the company. Parameters Name
Type
Description
sysRowId
String
SysRowId for Company to be deleted
GetByCompanyId This method retrieves details of the Company with the specified id. Parameters
26
Name
Type
Description
companyId
String
CompanyId for Company to be retrieved
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetBySerialNumber This method retrieves details of the Company with the specified serial number. Parameters Name
Type
Description
serialNumber
Decimal
The serial number for Company to be retrieved
GetBySysRowId This method retrieves details of the Company with the specified id. Parameters Name
Type
Description
sysRowId
String
SysRowId for Company to be retrieved
Returns a list of all companies.
AdminLicensing Epicor.Mfg.BO.AdminLicensing: This business object contains 16 methods.
GetNewAdminSerialNumber Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
27
A-E
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeProductName This method updates the product name for a license. Parameters Name
Type
Description
serialNumber
Decimal
Serial number for the license
productName
String
New product name for the license
DeleteLicense This method deletes the License with the specified serial number.
28
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
serialNumber
Decimal
Serial number of license to be deleted
EnableCGC This method enables a licensed country group/country. Parameters Name
Type
Description
ds
Dataset containg serial number and country group/countries that need to be enabled.
EnableModule This method enables a licensed feature/module. Parameters Name
Type
Description
ds
Dataset containg serial number and modules that need to be enabled.
GetBySysRowId This method retrieves details of the License with the specified id. Parameters Name
Type
Description
sysRowId
String
SysRowId for License to be retrieved
GetCSFLicenseList Returns a list of all csf codes for a license. Parameters Name
Type
Description
serialNumber
Decimal
Serial number of license.
Returns a list of all licenses. Returns a list of all usable licenses.
Epicor 9.05 | 9.05.605
29
A-E
Business Object Reference Guide
ImportLicense This method imports a new License. Parameters Name
Type
Description
licenseInfo
String
Serial number and codes of license to be imported.
AdminSession Epicor.Mfg.BO.AdminSession: This business object contains 11 methods.
GetNewAdminSession Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
30
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DeleteBySessionId This method deletes the session with the specified SessionId Parameters Name
Type
Description
sessionId
String
SessionId for session to be deleted
DeleteBySysRowId This method deletes the session with the specified SysRowId Parameters Name
Type
Description
sysRowId
String
SysRowId for session to be deleted
Returns the current session. Returns a list of all users sessions.
AgingRptFmt Epicor.Mfg.BO.AgingRptFmt: This business object contains 7 methods.
GetNewAgingRptFmt Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
31
A-E
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
32
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
AlcBatchSchedSearch Epicor.Mfg.BO.AlcBatchSchedSearch: This business object contains 7 methods.
GetNewAlcBatchSched Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
33
A-E
Business Object Reference Guide
Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AlcHed Epicor.Mfg.BO.AlcHed: This business object contains 51 methods.
GetNewAlcHed Inserts a new row in the DataSet with defaults populated.
GetNewAlcAcct Inserts a new row in the DataSet with defaults populated.
GetNewAlcAcctCat Inserts a new row in the DataSet with defaults populated.
GetNewAlcJrnCd Inserts a new row in the DataSet with defaults populated.
GetNewAlcParams Inserts a new row in the DataSet with defaults populated.
GetNewAlcNFSrc Inserts a new row in the DataSet with defaults populated.
GetNewAlcParamsBAQ Inserts a new row in the DataSet with defaults populated.
GetNewAlcRange Inserts a new row in the DataSet with defaults populated.
GetNewAlcTarget Inserts a new row in the DataSet with defaults populated.
34
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
35
A-E
Business Object Reference Guide
ChangeAllocOption Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeAllocationType Parameters Name
Type
Description
ipProposedAllocType
Int32
proposed allocation type
ds
GL Allocations Data Set
ChangeBAQEntryType Parameters Name
Type
ds
Description GL Allocations Data Set
ChangeLookupEntryType Parameters Name
Type
ds
Description GL Allocations Data Set
CheckArgument Validate Argument1 and Argument2 values and return the values in the rigth format. Parameters
36
Name
Type
Description
ipAllocID
String
ipAllocID of selected record
ipArgument1
String
Argument1 to validate
ipArgument2
String
Argument2 to validate
opArgument1
String@
Returns Argument1 with special format
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
opArgument2
String@
Returns Argument1 with special format
CheckBAQExportID Validate BAQ Export ID Parameters Name
Type
Description
ipBAQExportID
String
BAQ proposed value
ds
GL Allocations Data Set
CheckBAQParameter Parameters Name
Type
Description
ipBAQExportID
String
ipBAQExportID">BAQ to validate the parameter
ipFieldName
String
Field to validate
CheckBAQParameterValue Parameters Name
Type
Description
ipBAQExportID
String
ipBAQExportID">BAQ to validate the parameter
ipFieldName
String
Field to validate
ipValue
String
query field value to validate
CheckBook Validate the selected book is valid and of type standard Parameters Name
Type
Description
ipBookID
String
GL Book ID
ds
Epicor 9.05 | 9.05.605
GL Allocations Data Set
37
A-E
Business Object Reference Guide
CheckCanAddNewTarget Parameters Name
Type
Description
ipAllocID
String
Allocation Code
CheckCategory Validate Category Parameters Name
Type
Description
ipCategoryID
String
Category ID to validate
ds
GL Allocations Data Set
CheckForDuplicateAccount Parameters Name
Type
Description
ipGLAccount
String
proposed GL Account
ipParamNbr
Int32
parameter nbr
ipAllocID
String
allocation id
CheckJournalCode Validate Journal Code Parameters Name
Type
Description
ipJournalCode
String
Journal Code to validate
ds
GL Allocations Data Set
CheckMinMax Validate Min and max values Parameters
38
Name
Type
Description
ipMinRange
String
Minimum range to validate
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipMaxRange
String
Maximum range to validate
ipCOACode
String
COA Code
ipSegmentNbr
Int32
Segment Number to validate
CheckParamName Validate parameter name is not a valid math operator. Parameters Name
Type
Description
ipParamName
String
Proposed parameter name
CheckParamOption Parameters Name
Type
Description
ipParamOpt
Int32
parameter option
ds
GL Allocations Data Set
CheckParamOptionBAQ Parameters Name
Type
Description
ipParamOpt
Int32
parameter option
ds
GL Allocations Data Set
CheckParamSegment Parameters Name
Type
Description
ipParamSegmentNbr
Int32
parameter option
ipParamType
String
either NonFin or BAQ
ds
Epicor 9.05 | 9.05.605
GL Allocations Data Set
39
A-E
Business Object Reference Guide
CheckPercentageToAllocate Parameters Name
Type
Description
ipAllocID
String
Allocation Code
ipProposedPercentage
Decimal
percent to allocate
opWarnMsg
String@
warning message
CheckPriorTgtStamp Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckSegmentNbr This method is to be used in place of GetNewAlcRange. This method Validates there are still COA Segments available. Parameters Name
Type
Description
ipAllocID
String
Allocation ID
ipParamNbr
Int32
Parameter Number
ipSegmentNbr
Int32
Proposed Segment Number
CheckSyntax Check Syntax for formula field. Parameters
40
Name
Type
Description
ipAllocID
String
AllocID of selected record
ipFormula
String
Formula to validate
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CheckTgtStamp Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckTier Parameters Name
Type
Description
ipTier
Int32
proposed tier
ds
GL Allocations Data Set
CheckTotalPercent Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CreateAlcLookupRecords Create Source Fields Records for the selected MapUID Parameters Name
Type
Description
ds
GL Allocations Data Set
GetLinkList Returns a List of valid values for the cmbLinkUID Combo-box Parameters Name
Type
Description
ipMapUID
Int32
Map Unique ID
Epicor 9.05 | 9.05.605
41
A-E
Business Object Reference Guide
Name
Type
Description
ipSrcSeqNbr
Int32
Src Sequence Number
ipWhereClause
String
Where Clause
opLinkList
String@
Returns Link List
GetNewAlcNFSrc1 This method is to be used in place of GetNewAlcNFSrc. This method Validates that only one AlcNFSrc record is created for each AlcParam record created. Parameters Name
Type
Description
ipAllocID
String
Allocation ID
ipParamNbr
Int32
Parameter Number
ds
GL Allocations Data Set
GetNewAlcRange1 This method is to be used in place of GetNewAlcRange. This method Validates there are still COA Segments available. Parameters Name
Type
Description
ipAllocID
String
Allocation ID
ipParamNbr
Int32
Parameter Number
ipCOACode
String
COA Code
ds
GL Allocations Data Set
GetOperatorsList Return a list of valid operators in a format ready to be use on a combo-box Parameters Name
Type
Description
opOperatorsList
String@
Return List of operators Menu Items
GetOperatorsMenuList Return a list of valid operators in a format ready to be use on the context Menu (i.e +'Operators~-'Operators~*'Operators~/'Operators~('Operators~)'Operators
42
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
opMenuItem
String@
Return List of operators Menu Items
GetParamMenuList Return a list of available parameters in a format ready to be use on the context Menu Parameters Name
Type
Description
ipAllocID
String
Allocation ID
opMenuItem
String@
Return List of parameters Menu Items
RefreshAllocationTotals Parameters Name
Type
Description
ds
GL Allocations Data Set
UpdAlcLookup Updates AlcLookup set Records for an already existent AlcLookup set. Parameters Name
Type
Description
ipMapUID
Int32
MapUID
ipSrcSeqNbr
Int32
Source Sequence Number
ds
GL Allocations Data Set
UpdateAcctBalAcct Updates Account Balance Account. Parameters Name
Type
Description
ipUseTgtAcct
Boolean
Use Target Account field value
ds
Epicor 9.05 | 9.05.605
GL Allocations Data Set
43
A-E
Business Object Reference Guide
ValidatePercentTotals Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AlcHedTgtStampSearch Epicor.Mfg.BO.AlcHedTgtStampSearch: This business object contains 7 methods.
GetNewAlcHedTgtStampSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
44
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AlcHistory Epicor.Mfg.BO.AlcHistory: This business object contains 23 methods.
GetNewAlcHist Inserts a new row in the DataSet with defaults populated.
GetNewAlcHistAcct Inserts a new row in the DataSet with defaults populated.
GetNewAlcHistActCat Inserts a new row in the DataSet with defaults populated.
GetNewAlcHistDtl Inserts a new row in the DataSet with defaults populated.
GetNewAlcHistResParams Inserts a new row in the DataSet with defaults populated.
GetNewAlcHistJrnCd Inserts a new row in the DataSet with defaults populated.
GetNewAlcHistParams Inserts a new row in the DataSet with defaults populated.
GetNewAlcHistParamsBAQ Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
45
A-E
Business Object Reference Guide
GetNewAlcHistNFSrc Inserts a new row in the DataSet with defaults populated.
GetNewPAlcHistAcct Inserts a new row in the DataSet with defaults populated.
GetNewPAlcHistActCat Inserts a new row in the DataSet with defaults populated.
GetNewPAlcHistJrnCd Inserts a new row in the DataSet with defaults populated.
GetNewPAlcHistRange Inserts a new row in the DataSet with defaults populated.
GetNewAlcHistRange Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
46
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListByBatchID One AlcHist record for each BatchID. Call normal GetList method. Parameters Name
Type
Description
whereClause
String
Whereclause.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The Allocation History List data set This method creates a new AlcHistoryFilter record. Returns The Allocation History Filter data set
OnChangeBookID This method is called when the BookID is changed.
Epicor 9.05 | 9.05.605
47
A-E
Business Object Reference Guide
Parameters Name
Type
Description
cInBookID
String
Proposed BookID
iOutFiscalYear
Int32@
Fiscal Year
cOutFiscalYearSuffix
String@
Fiscal Year Suffix
iOutStartPeriod
Int32@
Start Period
iOutEndPeriod
Int32@
End Period
AlertGroup Epicor.Mfg.BO.AlertGroup: This business object contains 7 methods.
GetNewAlertGroup Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
48
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AlertLog Epicor.Mfg.BO.AlertLog: This business object contains 9 methods.
GetNewAlertLog Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
49
A-E
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process. This method deletes all alert logs for current company.
Resend This method resends specified alert log row. Parameters Name
Type
Description
alertLogRowid
String
The RowIdent of the record of which Resend
ds
AllocBatch Epicor.Mfg.BO.AllocBatch: This business object contains 21 methods.
GetNewAlcBatch Inserts a new row in the DataSet with defaults populated.
GetNewAlcBatchCD Inserts a new row in the DataSet with defaults populated.
50
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetNewAlcBatchSched Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
51
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DeleteSchedule This method deletes AlcBatchSched records given a fiscal year. Parameters Name
Type
ds cOutMessage
Description The generate schedule parameters data set
String@
Output message
Returns The Allocation Batch data set
GenerateSchedule This method creates AlcBatchSched records given a fiscal year. Parameters Name
Type
ds cOutMessage
Description The generate schedule parameters data set
String@
Output message
Returns The Allocation Batch data set
GetAlcBatchSchedDel This method returns the AlcBatchSchedGen dataset. Parameters Name
Type
Description
inBatchID
String
The AlcBatch BatchID
Returns The Generate Schedule data set
GetAlcBatchSchedGen This method returns the AlcBatchSchedGen dataset.
52
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
inBatchID
String
The AlcBatch BatchID
Returns The Generate Schedule data set
OnChangeAllocID Method to call when changing the AlcBatchCD.AllocID field. Parameters Name
Type
Description
proposedAllocID
String
The proposed Allocation ID
ds
The Allocation Batch data set
OnChangeApplyDate Method to call when changing the AlcBatchSched.ApplyDate field. Parameters Name
Type
Description
proposedApplyDate
Nullable{System.DateTime}
Proposed Apply Date
ds
The Allocation Batch data set
OnChangeBookID Method to call when changing the AlcBatch.BookID field. Parameters Name
Type
Description
proposedBookID
String
The proposed book
ds
The Allocation Batch data set
OnChangeReverse Parameters Name
Type
Description
ipBatchID
String
Allocation Batch ID to schedule all periods
ipReverseFlag
Boolean
reverse flag
Epicor 9.05 | 9.05.605
53
A-E
Business Object Reference Guide
Returns The Allocation Batch data set
OnChangeSchedDate Method to call when changing the AlcBatchSched.SchedDate field. Parameters Name
Type
Description
proposedApplyDate
Nullable{System.DateTime}
Proposed Schedule Date
ds
The Allocation Batch data set
OnChangeScheduled Method to call when changing the AlcBatchSched.scheduled field. Parameters Name
Type
Description
ipScheduled
Boolean
Proposed Scheduled
ds
The Allocation Batch data set
OnChangeStatus Method to call when changing the AlcBatchSched.SchedDate field. Parameters Name
Type
Description
proposedStatus
Int32
Proposed Schedule Date
ScheduleAllPeriods Parameters Name
Type
Description
ipBatchID
String
Allocation Batch ID to schedule all periods
Returns The Allocation Batch data set
54
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
AlternatePart Epicor.Mfg.BO.AlternatePart: This business object contains 9 methods.
GetNewPartSubs Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
55
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListAlternateParts This method returns a list Alternate part with some calculated columns added. Parameters Name
Type
Description
whereClause
String
The criteria
custNum
Int32
Filter by this CustNum
shipToNum
String
Ship To Num
orderDate
Nullable{System.DateTime}
Order Date
currencyCode
String
Currency Code
sellingQuantity
Decimal
Selling Qty
sellingUOM
String
Selling Unit of Measure
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns The list of OrderRel
GetListAlternatePartsForSO This method returns a list Alternate part with some calculated columns added. Parameters
56
Name
Type
Description
whereClause
String
The criteria
custNum
Int32
Filter by this CustNum
shipToNum
String
Ship To Num
orderDate
Nullable{System.DateTime}
Order Date
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
currencyCode
String
Currency Code
sellingQuantity
Decimal
Selling Qty
sellingUOM
String
Selling Unit of Measure
Returns The list of OrderRel
AnalysisCode Epicor.Mfg.BO.AnalysisCode: This business object contains 8 methods.
GetNewAnalysisCd Inserts a new row in the DataSet with defaults populated.
GetNewAnalysisCdAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
57
A-E
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Annotation Epicor.Mfg.BO.Annotation: This business object contains 9 methods.
GetNewAnnotation Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
58
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeofAnnotationType Validate the Annotation Type change is valid. Parameters Name
Type
Description
annotationType
String
The proposed annotation type.
helpPageRef
String
Part of the key.
langNameID
String
Part of the key.
origAnnotationType
String
The original annotation type
ds
The Annotation data set
OnChangeofCreatedBy Validate the CreatedBy change is valid.
Epicor 9.05 | 9.05.605
59
A-E
Business Object Reference Guide
Parameters Name
Type
Description
createdBy
String
The CreatedBy to change to.
helpPageRef
String
Part of the key.
langNameID
String
Part of the key.
annotationType
String
Part of the key.
ds
The Annotation data set
APAdjustment Epicor.Mfg.BO.APAdjustment: This business object contains 15 methods.
GetNewAPInvHedAdj Inserts a new row in the DataSet with defaults populated.
GetNewAPTran Inserts a new row in the DataSet with defaults populated.
GetNewAPTranTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
60
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeAdjAmount This method updates the APTran amounts when the adjustment amount changes or the currency switch toggles. Parameters Name
Type
Description
ipTranAmtType
String
Indicate which of the transaction amount is changed. Valid values are: 'B' for Base Tran Amount and 'D' for Doc Tran Amount
proposedTranAmt
Decimal
The proposed Display Transaction Amount
ipRateGroupCode
String
rate group code for adjustment
Epicor 9.05 | 9.05.605
61
A-E
Business Object Reference Guide
Name
Type
ds
Description The A/P Adjustment Entry data set
ChangeIncomeTaxCode Performs required logic when APTran.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
APAdjustment data set
ChangeRateGroup Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeTranDate This method updates the APTran fiscal period and year when the transaction date changes. Parameters Name
Type
ds
Description The A/P Adjustment Entry data set
CheckGLInterface Call this method once to validate the G/L Interface. This method checks for GLSyst availability and if G/L is interfaced with A/P. If A/P is not interfaced with G/L then user should be asked if okay to continue without posting to G/L. This method will return a Message for the user if not interfaced else the Message is blank. If the user do not wish to continue then exit this object. This method also returns a logical flag to indicate if Posting to G/L. This value should be passed on to each new A/P Adjustment (APTran) record to process. Parameters
62
Name
Type
Description
opMessage
String@
The Message to ask the user if A/P is not interfaced with G/L.
opPostToGL
Boolean@
Indicates if the A/P Adjustment will be Posted to G/L.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
APAgingTracker Epicor.Mfg.BO.APAgingTracker: This business object contains 1 methods.
GenerateTracker This method should be called to populate the dataset for the AR Aging Tracker. Parameters Name
Type
Description
supplierID
String
Supplier ID.
Returns Epicor.Mfg.BO.APAgingTrackerDataSet
APAlcHed Epicor.Mfg.BO.APAlcHed: This business object contains 10 methods.
GetNewAPAlcHed Inserts a new row in the DataSet with defaults populated.
GetNewAPAlcDtl Inserts a new row in the DataSet with defaults populated.
GetNewAPAlcDtlTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
63
A-E
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckAPAllocDetail Call this method to check that the A/P Allocation header has at least one A/P Allocation detail before allowing the user to leave the header record. If user does not want to create an allocation detail, the A/P Allocation header needs to be deleted. Parameters
64
Name
Type
Description
cAllocID
String
Allocation ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
APBankFileImport Epicor.Mfg.BO.APBankFileImport: This business object contains 18 methods.
GetNewIMAPChkGrp Inserts a new row in the DataSet with defaults populated.
GetNewIMAPChkGrpAttch Inserts a new row in the DataSet with defaults populated.
GetNewIMCheckHed Inserts a new row in the DataSet with defaults populated.
GetNewIMAPTran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
65
A-E
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeGrpBankAcctID Method to call when changing the bank account. Parameters Name
Type
Description
proposedBankAcctID
String
The proposed bank account id
ds
The AP Bank File Import data set
ChangeMatchFlag Validate entered record number - user matches payments Parameters Name
Type
Description
matchFlag
Boolean
Record number entered/proposed
pcGroupID
String
Group ID of the paymnet
ds
The AP Bank File Import data set
ChangeRecordNum Validate entered record number - user matches payments Parameters Name ds
66
Type
Description The AP Bank File Import data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
recordNumber
Int32
Record number entered/proposed
pcGroupID
String
Group ID of the paymnet
GetBankFileImportParam Returns record in BankFileImportParam dataset Parameters Name
Type
Description
cGroupID
String
The Payment Group ID
Returns
ImportBankFile Imports a bank file Parameters Name
Type
Description
ds Returns The AP Bank File Import data set
MatchPayments Method Match imported file records to unmatched payments of Proposed Payment Groups Parameters Name
Type
Description
pcGroupID
String
Group ID of the paymnet
Returns The AP Bank File Import data set
OnEnterGroupID Method Match imported file records to unmatched payments of Proposed Payment Groups Parameters Name
Type
Description
groupID
String
Group ID of the paymnet
ds
Epicor 9.05 | 9.05.605
The AP Bank File Import data set
67
A-E
Business Object Reference Guide
ProcessPayments Method Match imported file records to unmatched payments of Proposed Payment Groups Parameters Name
Type
Description
pcGroupID
String
Group ID of the paymnet
opMsg
String@
Message to the user
ds
The AP Bank File Import data set
APChkGrp Epicor.Mfg.BO.APChkGrp: This business object contains 16 methods.
GetNewAPChkGrp Inserts a new row in the DataSet with defaults populated.
GetNewAPChkGrpAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
68
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process. This method exists soley for the purpose of allowing security for processing payments to be defined
DeleteZeroAmtTaxRec This method deletes TaxDtl records which have zero amounts Since Payments TAx logic calculates tax conditionally only for the first tax line the invoice could have multiple zero tax records. Parameters Name
Type
Description
postGroupID
String
The Group ID of the Group to post
GetDisplayTotals Call this method when the display currency changed Parameters Name
Type
Description
pCurrencyCode
String
The display currency.
ds
Epicor 9.05 | 9.05.605
Returns Epicor.Mfg.BO.APChkGrpDataSet
69
A-E
Business Object Reference Guide
LockGroup This procedure is GetById + Lock the Group. This procedure can be run instead of GetById if you want to lock along with doing a GetByID. If the lock is acquired successfully, plSuccess is returned as true. Parameters Name
Type
Description
pcGroupID
String
The Group ID selected by the user.
plSuccess
Boolean@
Returns a True or False value. True means successfully locked the Group
Returns Returns Epicor.Mfg.BO.APChkGrpDataSet
OnChangeBankAcctID Call this method when the user changes the Bank Account. Parameters Name
Type
Description
pcBankAcctID
String
The proposed value of BankAcctID.
ds
Returns Epicor.Mfg.BO.APChkGrpDataSet
OnChangePayMethod Call this method when the user changes the PayMethod. Parameters Name
Type
Description
vPMUID
Int32
The proposed value of PMUID.
ds
Returns Epicor.Mfg.BO.APChkGrpDataSet
PrePostGrp Method to call before posting invoices for a specific group.. This method will check if there are records with zero tax amounts and return message text asking the user if they would like to continue with posting or delete these tax records. Parameters
70
Name
Type
Description
postGroupID
String
The Group ID of the Group to post
taxRecMessage
String@
Contains text of the message to present to the user if zero amount tax line exist.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UnLockGroup Unlock the group. The user who locked the group can only unlock it. Parameters Name
Type
Description
pcGroupID
String
The Group ID selected by the user.
plSuccess
Boolean@
Returns a True or False value. True means successfully locked the Group
APInvDtlSearch Epicor.Mfg.BO.APInvDtlSearch: This business object contains 7 methods.
GetNewAPInvDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
71
A-E
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
APInvGrp Epicor.Mfg.BO.APInvGrp: This business object contains 10 methods.
GetNewAPInvGrp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
72
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeofApplyDate This method should be called to validate the new apply date entered by the user. Parameters Name
Type
Description
groupID
String
Group ID.
newApplyDate
Nullable{System.DateTime}
New Apply Date.
ds
AP Invoice Entry data set.
PrePostGroupInvoices Method to call before posting invoices for a specific group. If the G/L module is installed, this method will determine if A/P is interfaced with G/L. If it is not, text of a question is returned indicating this and asking if it is ok to continue. This question should be presented to the user in yes/no format. If the user replies no, the PostGroupInvoices method should not be called. This method can also throw exceptions if certain configuration
Epicor 9.05 | 9.05.605
73
A-E
Business Object Reference Guide
records do not exist. This method will also check if variances exist on the header or lines and return message text asking the user if they would like to continue nor not with posting. Parameters Name
Type
Description
postGroupID
String
The Group ID of the Group to post
returnMessage
String@
Contains text of the message to present to the user.
varianceMessage
String@
Contains text of the message to present to the user if variances exist.
UnlockGroup Method to call to unlock a group record. This method should be called whenever the group no longer needs to be locked. The group no longer needs to be locked when the invoice object is closed, or when a different group is selected. Parameters Name
Type
Description
inGroupID
String
The group id of the group record to unlock
APInvMscSearch Epicor.Mfg.BO.APInvMscSearch: This business object contains 6 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
74
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
APInvoice Epicor.Mfg.BO.APInvoice: This business object contains 139 methods.
GetNewAPInvHed Inserts a new row in the DataSet with defaults populated.
GetNewAPInvHedAttch Inserts a new row in the DataSet with defaults populated.
GetNewAPIHAPInvExp Inserts a new row in the DataSet with defaults populated.
GetNewAPIHAPInvExpTGLC Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
75
A-E
Business Object Reference Guide
GetNewAPIHAPInvMsc Inserts a new row in the DataSet with defaults populated.
GetNewRcvMisc Inserts a new row in the DataSet with defaults populated.
GetNewAPInvDtl Inserts a new row in the DataSet with defaults populated.
GetNewAPInvDtlAttch Inserts a new row in the DataSet with defaults populated.
GetNewAPInvExp Inserts a new row in the DataSet with defaults populated.
GetNewAPInvExpTGLC Inserts a new row in the DataSet with defaults populated.
GetNewGlbAPIETGLC Inserts a new row in the DataSet with defaults populated.
GetNewAPInvJob Inserts a new row in the DataSet with defaults populated.
GetNewAPInvMsc Inserts a new row in the DataSet with defaults populated.
GetNewAPInvPB Inserts a new row in the DataSet with defaults populated.
GetNewAPInvTax Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
76
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field.
Epicor 9.05 | 9.05.605
77
A-E
Business Object Reference Guide
Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GenerateRebateInv This method create the invoices for the rebates selected.
78
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
invoiceType
String
Type of invoice, AP or AR
groupID
String
Invoice Group to generate the invoices in
opMsg
String@
tax connect message
ds
List of rebates available for invoicing
GetRebateInvList This method returns a list of rebates available for invoicing. Parameters Name
Type
Description
invoiceType
String
Type of invoice, AP or AR
Returns List of rebates available for invoicing
AddPOMiscChrgToInvoiceHead Method to call when adding a po miscellaneous charge to an ap invoice line. Parameters Name
Type
Description
invHedVendorNum
Int32
The vendor number of the invoice line to add the charge to
invHedInvoiceNum
String
The invoice number of the invoice line to add the charge to
poMiscMiscCode
String
The miscellaneous code on the po misc charge record to create the invoice miscellaneous charge from.
ds
The APInvoice data set
AddPOMiscChrgToInvoiceLine Method to call when adding a po miscellaneous charge to an ap invoice line. Parameters Name
Type
Description
invDtlVendorNum
Int32
The vendor number of the invoice line to add the charge to
invDtlInvoiceNum
String
The invoice number of the invoice line to add the charge to
invDtlInvoiceLine
Int32
The line number of the invoice line to add the charge to
Epicor 9.05 | 9.05.605
79
A-E
Business Object Reference Guide
Name
Type
Description
poMiscPOLine
Int32
The po line of the po misc charge record
poMiscSeqNum
Int32
The SeqNum of the po misc charge record
ds
The APInvoice data set
AllocateLateCost Method to allocate late cost. Parameters Name
Type
Description
ds
ChangeAdjustmentValue Method to call when changing the adjustment value on the invoice detail. It is used only for correction invoice in adjustment line. Parameters Name
Type
Description
proposedValue
Decimal
The proposed adjustment value
ds
The APInvoice data set
ChangeAdvancePayAmt Method to call when changing the advance pay amount on the invoice detail. Updates APInvDtl with default values based on the new pay amount. Parameters Name
Type
Description
proposedAdvancePayAmt
Decimal
The proposed advance payment amount
ds
The APInvoice data set
ChangeAssemblySeq Method to call when changing the assembly sequence on the job miscellaneous charge. Validates the assembly sequence and updates APInvJob with values from the new assembly sequence. Parameters
80
Name
Type
Description
proposedAssemblySeq
Int32
The proposed assembly sequence
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
A-E
Type
ds
Description The APInvoice data set
ChangeCostPerCode Method to call when changing the cost per code on the invoice detail. Updates APInvDtl with default values based on the new code. Parameters Name
Type
Description
proposedCostPerCode
String
The proposed cost per code
ds
The APInvoice data set
ChangeCurrency Method to call when changing the currency on the invoice. Validates the currency code and updates APInvHed with default values based on the currency. Parameters Name
Type
Description
proposedCurrencyCode
String
The proposed currency code
ds
The APInvoice data set
ChangeCurrencyMaster Method to call when changing the currency on the invoice. Validates the currency code and updates APInvHed with default values based on the currency. Parameters Name
Type
Description
proposedCurrencyCode
String
The proposed currency code
vRateGrpCode
String
Currency Rate Group selected for the APInvoice
vExchangeRate
Decimal@
Current exchange rate between the APInvoice currency and the Ref Currency
vXRateLabel
String@
Label for the Exchange Rate field
ds
The APInvoice data set
ChangeExtCompanyID This method resets the regular Expense and Multi-Company G/L Accounts and the Reference Codes when the External Company ID changes. This should only be called when updating APInvExp and not the APIHAPInvExp.
Epicor 9.05 | 9.05.605
81
A-E
Business Object Reference Guide
Parameters Name
Type
Description
proposedExtCompID
String
The proposed External Company ID
ds
The AP Invoice data set
ChangeExtCost Method to call when changing the ext cost on the invoice detail. Validates the ext cost and updates APInvDtl with default values based on the new cost. Parameters Name
Type
Description
proposedExtCost
Decimal
The proposed ext cost
ds
The APInvoice data set
ChangeFixedAmount Method to call when changing the fixed amount on a tax record. Updates APInvTax tax amounts based on the new fixed amount. Parameters Name
Type
Description
proposedFixedAmt
Decimal
The proposed fixed amount
ds
The APInvoice data set
ChangeGUITaxBasisAmt Method to call when changing the Tax Basis Amount - Taiwan Localization on an invoice record. Updates APInvHed amounts based on the new invoice vendor amount. Parameters Name
Type
Description
proposedGUITaxBasisAmt
Decimal
The proposed tax amount
ds
The APInvoice data set
ChangeIncomeTaxCode Performs required logic when APInvDtl.IncomeTaxCode is modified.
82
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
APInvoice data set
ChangeInvoiceDate Method to call when changing the invoice date on the invoice. Updates APInvHed with default values based on the new date. Parameters Name
Type
Description
proposedInvoiceDate
Nullable{System.DateTime}
The proposed invoice date
ds
The APInvoice data set
ChangeInvoiceRef Method to call when changing the invoice reference on the debit memo. Validates the invoice reference number id and updates APInvHed with values from the new invoice reference. Parameters Name
Type
Description
proposedInvoiceRef
String
The proposed invoice reference number
ds
The APInvoice data set
ChangeInvoiceVendorAmt Method to call when changing the invoice vendor amount on an invoice record. Updates APInvHed amounts based on the new invoice vendor amount. Parameters Name
Type
Description
proposedInvoiceVendorAmt
Decimal
The proposed tax amount
ds
The APInvoice data set
ChangeJobMiscCode Parameters Name
Type
Description
proposedJobMisc
String
The proposed job misc code
Epicor 9.05 | 9.05.605
83
A-E
Business Object Reference Guide
Name
Type
ds
Description The APInvoice data set
ChangeJobMiscProject Method to call when changing the projectID. Updates APInvJob Parameters Name
Type
Description
propProject
String
The proposed project
ds
The APInvoice data set
ChangeJobNum Method to call when changing the job number on the job miscellaneous charge. Validates the job number and updates APInvJob with values from the new job. Parameters Name
Type
Description
proposedJobNum
String
The proposed job number
ds
The APInvoice data set
ChangeLineDiscAmt Method to call when changing the discount amount on the invoice detail. Updates APInvDtl with default values based on the new discount amount. Parameters Name
Type
Description
proposedLineDiscAmt
Decimal
The proposed discount amount
ds
The APInvoice data set
ChangeLOCID Method to call when changing the LOC ID on the invoice. Validates the LOC ID and updates APInvHed with default values based on the new code. Parameters
84
Name
Type
Description
proposedLOCID
String
The proposed LOC ID
outMsg
String@
Output message
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
outTermsDiff
String@
indicates if the loc terms are different from the AP Invoice
outLocTerms
String@
LOC Terms
ds
The APInvoice data set
ChangeLOCIDInvPosted Method to call when changing the LOC ID on Posted AP Invoice Maintenance EXCLUSIVE. Validates the proposed LOC ID vs Vendor and Currency, then updates APInvHed with default values based on the new code. Parameters Name
Type
Description
proposedLOCID
String
The proposed LOC ID
ds
The APInvoice data set
ChangeLockRate Method to call when changing the lock rate flag on the invoice. Updates APInvHed.EnableExchangeRate field. Parameters Name
Type
ds
Description The APInvoice data set
ChangeManualTaxCalculation Method to call when changing the manual tax calculation value on a tax record. Updates APInvTax tax amounts based on the new value of the flag. Parameters Name
Type
ds
Description The APInvoice data set
ChangeMiscAmt Method to call when changing the miscellanous amount on a miscellaneous charge. This method can be called for both the APInvMsc table and APIHAPInvMsc table. Updates the respective miscellanous charge table with default values based on the new amount. Parameters Name
Type
Description
proposedMiscAmt
Decimal
The proposed miscellanous amount
Epicor 9.05 | 9.05.605
85
A-E
Business Object Reference Guide
Name
Type
Description
tableName
String
The table the charge is for. Values are "APInvMsc" or "APIHAPInvMsc"
ds
The APInvoice data set
ChangeMiscCode Method to call when changing the miscellanous code on a miscellaneous charge. This method can be called for both the APInvMsc table and APIHAPInvMsc table. Validates the code and updates the respective miscellanous charge table with default values based on the new code. Parameters Name
Type
Description
proposedMiscCode
String
The proposed miscellanous code
tableName
String
The table the charge is for. Values are "APInvMsc" or "APIHAPInvMsc"
ds
The APInvoice data set
ChangeMiscLCFlag Method to call when changing the LCFLag on a miscellaneous charge. This method can be called for both the APInvMsc table and APIHAPInvMsc table. Validates the code if can be flagged as Landed Cost Charge. Parameters Name
Type
Description
ipLCFlag
Boolean
The proposed Landed Cost Flag
tableName
String
The table the charge is for. Values are "APInvMsc" or "APIHAPInvMsc"
ds
The APInvoice data set
ChangeMiscPercent This method recalculates Misc Charges Amounts when Percentage was changed. Parameters Name
Type
Description
proposedPrcnt
Decimal
new Percentage value
tableName
String
name of table being passed in
ds
86
Returns the updated dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangeMtlSeq Method to call when changing the material sequence on the job miscellaneous charge. Validates the material sequence and updates APInvJob with values from the new material sequence. Parameters Name
Type
Description
proposedMtlSeq
Int32
The proposed material sequence
ds
The APInvoice data set
ChangeMultiCompany This method resets the External Company ID, regular and Multi-Company G/L Accounts and the Reference Codes when the Multi-Company flag changes. Parameters Name
Type
Description
proposedMulti
Boolean
The proposed Multi-Company flag
ds
The AP Invoice data set
ChangeOverrideRevCharge Method to call when changing the override reverse charge. If override flag is unchecked then default the original value of RevChargeMethod back. Parameters Name
Type
Description
proposedOverrideRC
Boolean
The proposed Override Reverse Charge
ds
The APInvoice data set
ChangePartNum Method to call when changing the part number on a detail record. Updates APInvDtl with defaults from the part. Parameters Name
Type
Description
proposedPartNum
String
The proposed part number
ds
Epicor 9.05 | 9.05.605
The APInvoice data set
87
A-E
Business Object Reference Guide
ChangePaymentAmount Method to call when changing the payment amount on the payment schedule for the invoice header. Validates the payment amount and updates APInvPaySched with default values based on the payment amount. Parameters Name
Type
Description
proposedPaymentAmount
Decimal
The proposed payment amount
apInvVendorNum
Int32
The vendor number on the invoice
apInvInvoiceNum
String
The invoice number
paySchedPaySchedSeqNum
Int32
The payment schedule sequence number
ds
Returns
ChangePBDtlValue Parameters Name
Type
Description
proposedInvDtlValue
Decimal
The proposed value
ds
The APInvoice data set
ChangePBMtlCharge Parameters Name
Type
Description
proposedMtlChrg
Decimal
The proposed value
ds
The APInvoice data set
ChangePhaseID Method to call when changing the phase on a detail record. Updates APInvJob with defaults from the part. Parameters Name
Type
Description
propPhase
String
The proposed phase number
ds
88
The APInvoice data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangePMUID Method to call when changing the Payment Method. Parameters Name
Type
Description
ds
The APInvoice data set
ChangePMUIDMaster Method to call when changing the Payment Method. Parameters Name
Type
Description
ipPaymentMethod
Int32
Payment Method ID
ds
The APInvoice data set
ChangePOLine Method to call when changing the po line on a detail record. Validates the po line and updates APInvDtl with defaults from the purchase order line. Parameters Name
Type
Description
proposedPOLine
Int32
The proposed po line
ds
The APInvoice data set
ChangePONum Method to call when changing the po number on a detail record. Validates the po number and updates APInvDtl with defaults from the purchase order. Parameters Name
Type
Description
proposedPONum
Int32
The proposed po number
ds
The APInvoice data set
ChangePORelNum Method to call when changing the po release number on a detail record. Validates the po release number and updates APInvDtl with defaults from the purchase order release.
Epicor 9.05 | 9.05.605
89
A-E
Business Object Reference Guide
Parameters Name
Type
Description
proposedPORelNum
Int32
The proposed po release number
ds
The APInvoice data set
ChangePrePayment Method to call when changing the number of a prepayment invoice on the invoice header. Parameters Name
Type
Description
prepaymentNum
String
The number of prepayment invoce
ds
The APInvoice data set
ChangePrePaymentAmt Method to call when changing the prepayment amount. Parameters Name
Type
Description
prepaymentAmount
Decimal
The proposed prepayment amount
ds
The APInvoice data set
ChangeRateCode Method to call when changing the tax percent on a tax record. Updates APInvTax tax amounts based on the new tax percent. Parameters Name
Type
Description
ds
The APInvoice data set
ChangeRateCodeMaster Method to call when changing the rate code on a tax record. Validates the rate and tax code Parameters Name
Type
Description
proposedRateCode
String
The proposed rate code
ds
90
The APInvoice data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangeRefPONum Method to call when changing the po number reference on the invoice. Validates the po number reference and updates APInvHed with default values based on the po number. Parameters Name
Type
Description
proposedRefPONum
Int32
The proposed po number reference
ds
The APInvoice data set
ChangeReportableAmt Method to call when changing the taxable amount on a tax record. Updates APInvTax tax amounts based on the new taxable amount. Parameters Name
Type
Description
proposedReportableAmt
Decimal
The proposed reportable amount
ds
The APInvoice data set
ChangeRevChargeMethod Method to call when changing the reverse charge method. If override flag is true then check if the proposed method is valid. Parameters Name
Type
Description
proposedRevChrgMethod
String
The proposed Reverse Charge Method
ds
The APInvoice data set
ChangeTaxableAmt Method to call when changing the taxable amount on a tax record. Updates APInvTax tax amounts based on the new taxable amount. Parameters Name
Type
Description
proposedTaxableAmt
Decimal
The proposed taxable amount
ds
Epicor 9.05 | 9.05.605
The APInvoice data set
91
A-E
Business Object Reference Guide
ChangeTaxAmt Method to call when changing the fixed tax amount on a tax record. Updates APInvTax tax amounts based on the new tax amount. Parameters Name
Type
Description
proposedTaxAmt
Decimal
The proposed tax amount
ds
The APInvoice data set
ChangeTaxCatID Method to call when changing the Tax Category ID Parameters Name
Type
Description
ipTaxCatID
String
The proposed Tax Category ID
ds
The APInvoice data set
ChangeTaxCode Method to call when changing the tax code on a tax record. Validates the tax code and updates APInvTax tax amounts based on the new tax code. Parameters Name
Type
Description
proposedTaxCode
String
The proposed tax code
ds
The APInvoice data set
ChangeTaxDeductable Method to call when changing the tax deductable on a tax record. Updates APInvTax tax amounts based on the new tax percent. Parameters Name
Type
Description
proposedTaxDeductable
Decimal
The proposed tax deductable
ds
The APInvoice data set
ChangeTaxLock Method to call when changing the lock rate flag on the invoice. Updates APInvHed.EnableTaxExRate field.
92
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
The APInvoice data set
ChangeTaxPercent Method to call when changing the tax percent on a tax record. Updates APInvTax tax amounts based on the new tax percent. Parameters Name
Type
Description
proposedTaxPercent
Decimal
The proposed tax percent
ds
The APInvoice data set
ChangeTermsCode Method to call when changing the terms code on the invoice. Validates the terms code and updates APInvHed with default values based on the new code. Parameters Name
Type
Description
proposedTermsCode
String
The proposed terms code
ds
The APInvoice data set
ChangeUnitCost Method to call when changing the unit cost on the invoice detail. Updates APInvDtl with default values based on the new unit cost. Parameters Name
Type
Description
proposedUnitCost
Decimal
The proposed unit cost
ds
The APInvoice data set
ChangeVendorID Method to call when changing the vendor id on the invoice. Validates the vendor id and updates APInvHed with values from the new vendor.
Epicor 9.05 | 9.05.605
93
A-E
Business Object Reference Guide
Parameters Name
Type
Description
proposedVendorID
String
The proposed vendor id
ds
The APInvoice data set
ChangeVendorQty Method to call when changing the vendor quantity on the invoice detail. Updates APInvDtl with default values based on the new quantity. Parameters Name
Type
Description
proposedVendorQty
Decimal
The proposed vendor quantity
ds
The APInvoice data set
CheckBankRef Before updating the APInvHed record, CheckBankRef will be called to check if the bank reference conforms to format standards. If not, the user will be presented with a warning message and allowed to continue with the save. At this time this method is specific to Finland/Sweden localization Parameters Name
Type
ds opMessage
Description The APInvoice data set
String@
The Message to ask the user if the changes for the linked AP Invoice are okay.
CheckCPayBeforeUpdate Before updating the APInvHed record, CheckCPayBeforeUpdate will have to be called. The CheckCPayBeforeUpdate method will pass back opMessage. - If opMessage is not equal to null then a Yes/No question will have to be asked to the user displaying the message in opMessage. - If the user answers "Yes", then call the Update method to continue else stop update. Parameters Name
Type
ds opMessage
Description The APInvoice data set
String@
The Message to ask the user if the changes for the linked AP Invoice are okay.
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth.
94
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
keyValue
String
VendorNum
keyValue2
String
InvoiceNum
CheckLegalNumsDisplay Method for retrieving logical variable which shows is it neccessary to generate legal numbers for Debit Memos. Parameters Name
Type
Description
cGroupID
String
The group id
lEnabled
Boolean@
The logical variable which shows is it neccessary to generate legal numbers
CheckLineSubTotal Parameters Name
Type
Description
ipVendNum
Int32
The group id
ipInvNum
String
The group id
ipInvLine
Int32
The group id
ipRoleCd
String
The group id
ipProposedValue
Decimal
The group id
CheckPaymentMethod Check for the correct Payment Method assigned. Parameters Name
Type
Description
ipPaymentMethod
Int32
Payment Method ID
ds
APInvoice dataset
CheckRateGrpCode Update APInvoice Detail information when the RateGrp is changed.
Epicor 9.05 | 9.05.605
95
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipRateGrpCode
String
Currency Rate Group Code
ds
APInvoice dataset
CheckRevChrgBeforeUpdate Before updating the APInvDtl record, CheckRevChrgBeforeUpdate will have to be called. The CheckRevChrgBeforeUpdate method will pass back opMessage. - If opMessage is not equal to null then a Yes/No question will have to be asked to the user displaying the message in opMessage. - If the user answers "Yes", then call the Update method to continue else stop update. Parameters Name
Type
Description
ds opMessage
The APInvoice data set String@
The Message to ask the user if the changes to reverse charge method is okay.
CheckTaxRateGrpCode Update APInvoice Detail information when the TaxRateGrp is changed. Parameters Name
Type
Description
ipRateGrpCode
String
Currency Rate Group Code
ds
APInvoice dataset
CreateCorrectionInvoice Creates a correction invoice from a another invoice. Parameters
96
Name
Type
Description
groupID
String
Current group for new invoice
sourceInvoiceNum
String
Invoice num which should be corrected
sourceVendorNum
Int32
Invoice vendor num
newInvoiceNum
String
Invoice num provided by user
newInvoiceDate
Nullable{System.DateTime} Date of new invoice
newDocType
String
Document Type for the new invoice
grpTotalInvAmt
Decimal@
return new TotalInvAmt to update APInvGrp in UI
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
lEnableGenLegalNum
Boolean@
flag for UI to determine whether Generate Legal Numbers option is available
CreateJobMtl Parameters Name
Type
Description
ds
The APInvoice data set
DeleteMaster Parameters Name
Type
Description
cGroupID
String
current APInvGrp GroupID
keyValue
String
VendorNum
keyValue2
String
InvoiceNum
grpTotalInvAmt
Decimal@
return new TotalInvAmt to update APInvGrp in UI
lEnableGenLegalNum
Boolean@
flag for UI to determine whether Generate Legal Numbers option is available
ds
DeselectSelectedRcptLines Method to call to deselected selected lines. This method will run through each APSelectedRcptLines where the DeselectLine flag is true and remove it from the APSelectedRcptLines table. Also, if the APUninvoicedReceipts record for the receipt line being delesected is currently in the dataset, it will add the line back to the APUninvoicedRcptLines table. Parameters Name
Type
Description
ds Returns
GetAPInvPaySched Method to call to retrieve the invoice header payment schedule in table form in order to update dates and/or amounts for the payment schedule.
Epicor 9.05 | 9.05.605
97
A-E
Business Object Reference Guide
Parameters Name
Type
Description
inVendorNum
Int32
The vendor number on the invoice
inInvoiceNum
String
The invoice number
Returns
GetAPInvPOMisc Method to call to retrieve the POMisc records that can be added to an AP Invoice Header or an AP Invoice Line. This method will create the available po misc charges for the invoice and all lines of the invoice. Parameters Name
Type
Description
inVendorNum
Int32
The vendor number on the invoice.
inInvoiceNum
String
The invoice number.
Returns
GetAPUninvoicedReceipts Method to call to get uninvoiced receipts for Receipt billing. Parameters Name
Type
Description
inVendorNum
Int32
The APInvHed Vendor Number
inInvoiceNum
String
The APInvHed Invoice Number
inPONum
Int32
The PO Number to retrieve uninvoiced receipts for. May be blank.
ds
GetDMRCorrInvRequests Method to call to get DMR Correction Invoice Requests. Parameters Name
Type
Description
addToGroupID
String
The group id to add the invoices to
returnMsg
String@
Text of a message to inform the user of how many invoices were created. Informational only.
ds
98
The APInvoice data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetDMRDebitMemos Method to call to get DMR Debit Memos for invoicing. Parameters Name
Type
Description
addToGroupID
String
The group id to add the invoices to
returnMsg
String@
Text of a message to inform the user of how many invoices were created. Informational only.
grpTotalInvAmt
Decimal@
return new TotalInvAmt to update APInvGrp in UI
lEnableGenLegalNum
Boolean@
flag for UI to determine whether Generate Legal Numbers option is available
ds
The APInvoice data set
GetLegalNumforDebitMemo Method for generating legal numbers for generated Debit Memo. Parameters Name
Type
Description
cGroupID
String
The group id
GetNewAPInvDtlAdvance Method to call when adding a new Advance Billing line AP Invoice Detail record Parameters Name
Type
ds
Description The APInvoice data set
iVendorNum
Int32
The vendor number of the invoice
cInvoiceNum
String
The invoice number of the invoice
GetNewAPInvDtlAsset Method to call when adding a new Asset line AP Invoice Detail record Parameters Name
Type
ds iVendorNum
Epicor 9.05 | 9.05.605
Description The APInvoice data set
Int32
The vendor number of the invoice
99
A-E
Business Object Reference Guide
Name
Type
Description
cInvoiceNum
String
The invoice number of the invoice
GetNewAPInvDtlDMRCredit Method to call when adding a new DMR Credit line AP Invoice Detail record Parameters Name
Type
ds
Description The APInvoice data set
iVendorNum
Int32
The vendor number of the invoice
cInvoiceNum
String
The invoice number of the invoice
iDMRNum
Int32
The DMR Num that we are creating a line for.
iDMRActionNum
Int32
The DMR ActionNum that we are creating a line for.
GetNewAPInvDtlJobMiscellaneous Method to call when adding a new Job Miscellaneous line AP Invoice Detail record Parameters Name
Type
ds
Description The APInvoice data set
iVendorNum
Int32
The vendor number of the invoice
cInvoiceNum
String
The invoice number of the invoice
GetNewAPInvDtlMiscellaneous Method to call when adding a new Miscellaneous line AP Invoice Detail record Parameters Name
Type
ds
Description The APInvoice data set
iVendorNum
Int32
The vendor number of the invoice
cInvoiceNum
String
The invoice number of the invoice
GetNewAPInvDtlUnreceived Method to call when adding a new Unreceived Billing line AP Invoice Detail record
100
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The APInvoice data set
iVendorNum
Int32
The vendor number of the invoice
cInvoiceNum
String
The invoice number of the invoice
GetNewAPInvHedDebitMemo Method to call when adding a new Debit Memo AP Invoice record Parameters Name
Type
ds cGroupID
Description The APInvoice data set
String
The group id to add the invoice to
GetNewAPInvHedInvoice Method to call when adding a new Debit Memo AP Invoice record Parameters Name
Type
ds cGroupID
Description The APInvoice data set
String
The group id to add the invoice to
GetNewHdrCharge Method to call when adding a new Header/Late Cost charge Parameters Name
Type
ds
Description The APInvoice data set
iVendorNum
Int32
The vendor number of the invoice
cInvoiceNum
String
The invoice number of the invoice
lcFlag
Boolean
true if late cost should be added
GetPercentFixedAmt Remarks • QTableName - MANDATORY - Name of table to find
Epicor 9.05 | 9.05.605
101
A-E
Business Object Reference Guide
• QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetValueExchageRate This method returns the Exchange Rate information for the selected Currency. The system may not have an exchange rate between the APInvoice and Base so it may use an middle Currency so that it will go APInvoice Currency -> Ref Currency -> Base Currency Parameters Name
Type
Description
vCurrencyCode
String
Currency selected for the APInvoice
vRateGrpCode
String
Currency Rate Group selected for the APInvoice
vExchangeRate
Decimal@
Current exchange rate between the APInvoice currency and the Ref Currency
vXRateLabel
String@
Label for the Exchange Rate field
ds
The APInvoice data set
GLAllocation Method to call when peforming G/L allocation. This method uses the AllocationID and AllocationAmount fields from APInvDtl to create the allocation records. After this method runs, the APInvDtl and APInvExp records will be passed back. It is expected that the AllocationID and AllocationAmount fields will be entered separately from the other APInvDtl fields since the fields are used only for this method and are not written to the APInvDtl database table. Parameters Name
Type
Description
ds
The APInvoice data set
InvoiceSelectedLines Method to call to invoice the selected receipt lines. This method will run through each APSelectedRcptLines and create an APInvDtl record. After this method is called, the GetRows method should be called to get the invoice lines that were created. Parameters Name
Type
Description
ds
102
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns
MatchLoggedInvoice Method that creates/update AP Invoice from a existent Logged Invoice (LogAPInv) Parameters Name
Type
ds cGroupID
Description The LogAPInv data set
String
ds1
The group id to add the invoice to. The APInvoice data set
OnChangeofApplyDate This method should be called to validate the new apply date entered by the user. Parameters Name
Type
Description
vendorNum
Int32
Vendor Number.
invoiceNum
String
Invoice Number.
recalcAmts
String
Recalculate Amounts String.
newApplyDate
Nullable{System.DateTime}
New Apply Date.
ds
AP Invoice Entry data set.
OnChangeofTaxRateDate This method should be called to validate the new tax rate date entered by the user. Parameters Name
Type
Description
vendorNum
Int32
Vendor Number.
invoiceNum
String
Invoice Number.
newTaxDate
Nullable{System.DateTime}
New Tax Date.
ds
AP Invoice Entry data set.
OnChangeofTransApplyDate This method should be called to validate the new apply date entered by the user for transferred invoice.
Epicor 9.05 | 9.05.605
103
A-E
Business Object Reference Guide
Parameters Name
Type
Description
vendorNum
Int32
Vendor Number.
invoiceNum
String
Invoice Number.
newTransApplyDate
Nullable{System.DateTime}
New Apply Date for Transferred Invoice.
ds
AP Invoice Entry data set.
OnChangeTranDocTypeID Sets default values when the TranDocTypeID changes Parameters Name
Type
Description
ipTranDocTypeID
String
TranDocTypeID supplied
ds
OnChangeVendBankID Call this method when the user enters the ttApInv.BankID Parameters Name
Type
Description
pcVendBankID
String
Vendor Bank ID
ds
OnLCFlagOfLineMiscChargeChange Verifies if a Miscellaneous Charge can be marked as Landed Cost. Parameters Name
Type
Description
ipMiscCode
String
The Purchase Miscellaneous ID
ipLCFlag
Boolean
The Landed Cost Flag (true/false)
OnShipmentIDChange Verifies if a Shipment ID (ContainerHeader.ContainerID) is valid.
104
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipShipmentID
Int32
The Shipment ID (ContainerHeader.ContainerID)
ds
AP Invoice Entry data set.
PreUpdate This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
Boolean@
Indicates if the legal number requires user input
ds requiresUserInput
SelectUninvoicedRcptLines Method to call to selected uninvoiced lines. This method will run through each APUninvoicedRcptLines where the SelectLine flag is true, move the record to the APSelectedRcptLines table and remove it from the APUninvoicedRcptLines table. This method can also be called for the SelectAll functionality. In that case all APUninvoicedRcptLines must have the SelectLine flag set to true before calling the method. Parameters Name
Type
Description
inVendorNum
Int32
The Vendor Number of the receipt the uninvoiced lines are assigned to.
inPurPoint
String
The PurPoint of the receipt the uninvoiced lines are assigned to.
inPONum
Int32
The PO Number of the receipt the uninvoiced lines are assigned to.
inPackSlip
String
The Pack Slip of the receipt the uninvoiced lines are assigned to.
inDropShip
Boolean
The Drop Ship value.
ds
Epicor 9.05 | 9.05.605
105
A-E
Business Object Reference Guide
Returns
SetReadyToCalc Parameters Name
Type
Description
ipGroupID
String
ipGroupID
ipInvoiceNum
String
ipInvoiceNum
ipVendorNum
Int32
ipVendorNum
ipCalcAll
Boolean
ipCalcAll
ds
APInvoice dataset
SubCDataBtnClicked Parameters Name
Type
Description
ipVendorNum
Int32
Vendor Num
ipInvoiceNum
String
Invoice Num
ipInvoiceLine
Int32
Invoice Line
ds
APInvoice dataset
TransferInvoiceToGroup Method to call when transfering an invoice to a different group. Parameters Name
Type
Description
transferToGroupID
String
The group id to transfer the invoice to
xferInvVendorNum
Int32
The vendor number on the invoice to transfer
xferInvInvoiceNum
String
The invoice number of the invoice to transfer
cGroupID
String
current APInvGrp GroupID
grpTotalInvAmt
Decimal@
return new TotalInvAmt to update APInvGrp in UI
lEnableGenLegalNum
Boolean@
flag for UI to determine whether Generate Legal Numbers option is available
UpdAPInvoiceMatched Updates an AP Invoice using a Logged Invoice.
106
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
txtGroup
String
Group Id
intVendorNum
Int32
Vendor Num
txtInvoiceNum
String
Invoice Num
ds
APInvoice data set
UpdateAPInvPaySched Method to call when updating the payment schedule for an invoice header. Validates the payment amounts and and writes the new payment schedule to the APInvHed datatable. Prior to calling this method all APInvPaySched records must be marked as modified by setting the APInvPaySched.RowMod field to 'U'. Parameters Name
Type
Description
ds Returns
UpdateMaster Parameters Name
Type
Description
cGroupID
String
current GroupID on Invoice
cTableName
String
Indicates the tableName that triggered the update
runPreUpdate
Boolean
Indicates whether the preUpdateCore method should be called
runChkCPay
Boolean
Indicates whether the chkCPayCore method should be called
runChkBankRef
Boolean
Indicates whether the chkBankRefCore method should be called
runChkRevChrg
Boolean
Indicates whether the chkRevChrgCore method should be called
suppressUserPrompts
Boolean
Indicates if user prompts should be suppressed
grpTotalInvAmt
Decimal@
APInvGrp.BaseAmount to update in UI
requiresUserInput
Boolean@
Indicates if the legal number requires user input
opMessage
String@
output message returned to user for response
opMsgChkBankRef
String@
output message returned to user for response
opChkRevMsg
String@
output message returned to user for response
ds
Epicor 9.05 | 9.05.605
107
A-E
Business Object Reference Guide
Name
Type
Description
lEnableGenLegalNum
Boolean@
Indicates whether the Generate legal Numbers option should be enabled on action menu
lUpdateRan
Boolean@
Indicates that the Update process did run
UpdGetLogAPInv Updates name of supplier. Parameters Name
Type
Description
ds
The LogAPInv data set
UsePurchaseCode Method to call to determine if Purchase Codes are in use or not. They are only in use when Financial Integration is implemented with Purchase Types. Parameters Name
Type
Description
usePurchaseCode
Boolean@
True if purchase codes are in use; otherwise false
ValidateInvoiceID Validate InvoiceID and return a true if a logged invoice exist for it. Parameters Name
Type
Description
txtVendorID
String
Vendor ID
txtInvoiceNum
String
Invoice Num
intVendorNum
Int32@
Returns VendorNum as a character
logAPInvFound
Boolean@
ValidateTaxRateCodes Method to call when changing the rate code on a tax record. Validates the rate and tax code Parameters Name
Type
Description
proposedRateCode
String
The proposed rate code
ds
108
The APInvoice data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
APInvoiceLoad Epicor.Mfg.BO.APInvoiceLoad: This business object contains 19 methods.
GetNewAPInvoiceLoad Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
109
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeApplyDate This method updates the A/P Apply Date. Parameters Name
Type
ds
Description A/P Invoice Load Data Set
ChangeInvoiceBalance This method updates the A/P Invoice Amounts when the invoice balance changes or the exchange rate changes. Use the external fields APInvoiceLoad.DispInvoiceBal and APInvoiceLoad.DocDispInvoiceBal to accept the user entered amount. An input parameter is expected to indicate if this method is called after changing the Exchange Rate or the Base Invoice Balance or the Doc Invoice Balance. When changing the actual InvoiceBal and DocInvoiceBal fields instead of the Disp counterparts, set the Change Type to be: 'B1' and 'D1' for base and doc fields. Parameters Name
Type
ds ipChangeType
Description A/P Invoice Load Data Set
String
Valid values: 'E' = Exchange Rate; 'B' = DispInvoiceBal; 'D' = DocDispInvoiceBal 'B1' = InvoiceBal; 'D1' = DocInvoiceBal
ChangeInvoiceDate This method updates the A/P Invoice Dates and Exchange Rates when the Invoice Date changes. Parameters Name ds
Type
Description A/P Invoice Load Data Set
ChangeTerms This method updates the A/P Invoice Due Date when the Terms Code changes.
110
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
A/P Invoice Load Data Set
ChangeVendorID This method defaults the A/P Invoice Load details based on the proposed Vendor ID. Parameters Name
Type
ds ipProposedVendorID
Description A/P Invoice Load Data Set
String
The proposed Vendor ID
CheckBeforePost This method checks if okay to post and returns a warning message to let the user decide whether to continue posting or not. This should be called prior to calling the PostOpenInvLoad method if the user chooses to continue with the posting. Parameters Name
Type
Description
opMessage
String@
Warning Message for the user.
GetCurrencyBase This method returns the Base CurrencyCode Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
GetExchangeRate This method returns the Exchange Rate information for the selected Currency. The system may not have an exchange rate between the APInvHed and Base so it may use an middle Currency so that it will go A/P Invoice Currency -> Ref Currency -> Base Currency. This method also returns the converted Invoice Balance (DispInvoiceBal) into Doc Invoice Balance (DocDispInvoiceBal) based on the new exchange rate. Parameters Name
Type
Description
vCurrencyCode
String
Currency selected for the Invoice
vRateGrpCode
String
Rate Group selected for the Invoice
Epicor 9.05 | 9.05.605
111
A-E
Business Object Reference Guide
Name
Type
Description
vDispInvBal
Decimal
User entered Invoice Balance to convert
vDocDispInvBal
Decimal@
Doc Invoice Balance using the new exchange rate
vExchangeRate
Decimal@
Current exchange rate between the A/P Invoice currency and the Ref Currency
vXRateLabel
String@
Label for the Exchange Rate field
GetNewAPInvoiceLoad1 This method is to be used in place of GetNewAPInvoiceLoad. Parameters Name
Type
Description
ds
A/P Invoice Load Data Set
GetTotalBalance This method returns the total unposted invoice load balance and the base currency symbol. Parameters Name
Type
Description
opTotalInvBal
Decimal@
Total Invoice Balance
opBaseCurrSymbol
String@
Base Currency Symbol
This method performs the actual posting of open invoice loads. It is assumed that the user already okayed to continue with the posting. Returns A/P Invoice Load Data Set
APInvSearch Epicor.Mfg.BO.APInvSearch: This business object contains 7 methods.
GetNewAPInvHed Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
112
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
APLOC Epicor.Mfg.BO.APLOC: This business object contains 16 methods.
GetNewAPLOC Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
113
A-E
Business Object Reference Guide
GetNewAPLOCAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
114
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeCurrencyCode Called when the CurrencyCode field has been changed. Parameters Name
Type
ds
Description The APLOC data set
ChangeLCValue Called when the LCValue field has been changed. Parameters Name
Type
ds
Description The APLOC data set
GetAPLOCInvc This method will retrieve all the information related to Purchase Orders. Parameters Name
Type
Description
aplocid
String
AP Letters Of Credit ID
Returns The APLOC data set
GetAPLOCPO This method will retrieve all the information related to Purchase Orders. Parameters Name
Type
Description
aplocid
String
AP Letters Of Credit ID
Returns The APLOC data set
Epicor 9.05 | 9.05.605
115
A-E
Business Object Reference Guide
OnChangeOfCurrencyCode Called when the CurrencyCode field is changing. Parameters Name
Type
Description
ds
The APLOC data set
OnChangeOfFromDate Called when changing the FromDate field. Parameters Name
Type
Description
proposedFromDate
Nullable{System.DateTime}
Proposed From Date
ds
The APLOC data set
OnChangeOfLCValue Called when changing the LCValue field. Parameters Name
Type
Description
proposedLCValue
Decimal
Proposed LCValue
warningMsg
String@
Warning message
ds
The APLOC data set
OnChangeOfToDate Called when changing the ToDate field. Parameters Name
Type
Description
proposedToDate
Nullable{System.DateTime}
Proposed To Date
ds
116
The APLOC data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
APPIWriteOff Epicor.Mfg.BO.APPIWriteOff: This business object contains 15 methods.
GetNewAPPNHead Inserts a new row in the DataSet with defaults populated.
GetNewAPPNMove Inserts a new row in the DataSet with defaults populated.
GetNewAPPNMoveTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
117
A-E
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckGLInterface Call this method once to validate the G/L Interface. This method checks for GLSyst availability and if G/L is interfaced with A/P. If A/P is not interfaced with G/L then user should be asked if okay to continue without posting to G/L. This method will return a Message for the user if not interfaced else the Message is blank. If the user do not wish to continue then exit this object. This method also returns a logical flag to indicate if Posting to G/L. This value should be passed on to each new A/P Adjustment (APPNMove) record to process. Parameters Name
Type
Description
opMessage
String@
The Message to ask the user if A/P is not interfaced with G/L.
opPostToGL
Boolean@
Indicates if the A/P Adjustment will be Posted to G/L.
CheckPNoteExisted Parameters
118
Name
Type
Description
ipPIType
String
ipPIType
ipID
String
ipID
ipVendID
String
ipVendID
opRet
String@
opRet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetAPPNList Parameters Name
Type
Description
ipType
String
ipType
ipPNID
String
ipPNID
ipVendID
String
ipVendID
Returns The AP Promissory Notes data set for Write Off
GetGroupIDForPI This method will retrieve the GroupID for an APPNHead record that's for the APPromNoteID supplied. Parameters Name
Type
Description
apPromNoteID
String
AR Promissory Note ID
groupID
String@
Cash Group ID
headNum
Int32@
HeadNum
GetNewAPPNMove1 This method is to be used in place of GetNewAPPNMove. This method asks for vendor number and invoice number to link the A/P Invoice Header (APPNHead) to A/P Invoice Adjustment (APPNMove). Parameters Name
Type
Description
ds
The AP Promissory Notes data set for Write Off
ipGroupID
String
The Group ID for this A/P Promissory Note Head
ipHeadNum
Int32
The A/P Promissory Note Head Number
GetPNByID Parameters Name
Type
Description
ipHeadNum
Int32
ipHeadNum
ipPIType
String
ipPIType
ipID
String
ipID
Epicor 9.05 | 9.05.605
119
A-E
Business Object Reference Guide
Name
Type
Description
ipVendID
String
ipVendID
ipCurGroupID
String
ipCurGroupID
ipNewPIType
String
ipNewPIType
ds
The AP Promissory Notes data set for Write Off
ApplyCreditMemo Epicor.Mfg.BO.ApplyCreditMemo: This business object contains 24 methods.
GetNewCashHead Inserts a new row in the DataSet with defaults populated.
GetNewCashDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
120
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ApplyCreditMemo This method needs to be run as the last method as the user leaves the CashHead record. It validates that the entire memo has been applied and creates the required GL records If the entire memo has not been applied, then an exception will be raised and the user cannot leave the record until it all has been applied. Parameters Name
Type
Description
inHeadNum
Int32
CashReceipt ID
inPNRef
String
PNRef Number, blank if the line is a normal invoice credit
ChangeCMAmount This method updates the DocTranAmt, UnuppliedAmt fields after the CMAmount field is updated. Parameters Name
Type
Description
cmAmount
Decimal
Proposed value change to the DocTranAmt field
ds
Apply Credit Memo Data Set
ChangePNRef Procedure to be called when changing the PNRef field in the CashDtl table. This field will only be used for Credit Payment records
Epicor 9.05 | 9.05.605
121
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
String
Apply Credit Memo Data Set
proposedPNRef
The PNRef to validate against CreditTran
CheckCreditCardRecords This procedure will look for Credit Card records within CreditTran using the information in the CashHead table Parameters Name
Type
Description
iHeadNum
Int32
Cash Head Number
oHasCreditCardRecords
Boolean@
Logical output parameter, true if any Credit Card records are found
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
InvoiceNum
CheckOnScreenLoad This method is called first thing when opening the screen. It checks to see if the G/L is interfaced and if the Fiscal Period is valid. If the G/L is not interfaced, a question asking if the user wants to continue will be returned. If the user answers no, then they are returned to the main menu. If the Fiscal Period is invalid, an exception will be raised and the user should be returned to the main menu. Parameters Name
Type
Description
vQuestion
String@
Ask the user if they want to continue if the G/L is not interfaced
DeleteCashDetails This method needs to be run as the last method if the user chooses not to Apply Credit Memo but wants to leave the CashHead record to create a new one or closes/exits the ApplyCreditMemo UI screen. This will delete the appropriate CashHead and CashDtl records and update the related InvcHead to reflect the appropriate invoice balance.
122
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipHeadNum
Int32
CashHead HeadNum
DocumentHasTaxes This method is used to determine whenever the document has taxes Parameters Name
Type
Description
documentNum
Int32
Document Number
documentType
String
Document Type
hasTaxes
Boolean@
True if the document has taxes
GetCurrencyInfo This method is used when the Currency Code changed Parameters Name
Type
Description
currencyCode
String
Proposed Currency Code
ds
Apply Credit Memo Data Set
GetDtlInvoiceInfo This method is called when the CashDtl InvoiceNum field is modified Parameters Name
Type
Description
invoiceNum
Int32
Proposed Invoice Number
ds
Apply Credit Memo Data Set
GetDtlTranAmtInfo This method is run when the DocTranAmt field is modified Parameters Name
Type
Description
docTranAmt
Decimal
Proposed discount amount
ds
Epicor 9.05 | 9.05.605
Apply Credit Memo Data Set
123
A-E
Business Object Reference Guide
GetFiscalInfo This method is run when the Transaction date is changed to update the fiscal period fields Parameters Name
Type
Description
tranDate
Nullable{System.DateTime}
Proposed Transaction Date
ds
Apply Credit Memo Data Set
GetHdrDocumentInfo This method will validate the document number provided and if valid, will default CashHead fields to the values in the Document (Credit Memo, Deposit Invoice or Deposit Payment) Parameters Name
Type
Description
documentNum
Int32
proposed Document Number
ds
Apply Credit Memo Data Set
GetHdrTranAmtInfo This method is used to validate/update the dataset when the DocTranAmt is udpated Parameters Name
Type
Description
docTranAmt
Decimal
Proposed value change to the DocTranAmt field
ds
Apply Credit Memo Data Set
GetNewCreditPayment This method is to be used when creating new Credit Payments. In this case the invoice should be the same used in the header Parameters Name
Type
ds
124
Description Apply Credit Memo Data Set
inGroupID
String
Credit memo Group ID field
inHeadNum
Int32
CashHead.HeadNum field
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
OnDocumentTypeChanging This method validates changings of the 'DocumentType' field Parameters Name
Type
Description
ds
Apply Credit Memo Data Set
documentType
String
Document Type
ApplyDebitMemo Epicor.Mfg.BO.ApplyDebitMemo: This business object contains 21 methods.
GetNewCheckHed Inserts a new row in the DataSet with defaults populated.
GetNewAPTran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
125
A-E
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CalcTaxes Parameters
126
Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ApplyDebitMemo This method needs to be run as the last method as the user leaves the CheckHed record. It validates that the entire memo has been applied and creates the required GL records If the entire memo has not been applied, then an exception will be raised and the user cannot leave the record until it all has been applied. Parameters Name
Type
Description
inHeadNum
Int32
CheckHead.HeadNum
outRevJrnUID
Int32@
Review Journal UID
ChangeAmtToApply This method is used to validate/update the dataset when the DocPaymentTotal is udpated Parameters Name
Type
Description
paymentAmt
Decimal
Proposed value change to the DocPaymentTotal field
ds
Apply Debit Memo Data Set
ChangeDtlInvoice This method is called when the APTran InvoiceNum field is modified Parameters Name
Type
Description
invoiceNum
String
Proposed Invoice Number
ds
Apply Credit Memo Data Set
ChangeDtlTranAmt This method is run when the DocTranAmt field is modified Parameters Name
Type
Description
docTranAmt
Decimal
Proposed amount
ds
Apply Credit Memo Data Set
ChangeHedInvoice This method is used when no Invoice Number is specified in the GetNewCheckHedInv function This will validate the invoice number provided and if valid, will default CheckHed fields to the values in the Invoice
Epicor 9.05 | 9.05.605
127
A-E
Business Object Reference Guide
Parameters Name
Type
Description
invoiceNum
String
proposed Invoice Number
ds
Apply Credit Memo Data Set
ChangeTranDate This method is run when the Transaction date is changed to update the fiscal period fields Parameters Name
Type
Description
tranDate
Nullable{System.DateTime}
Proposed Transaction Date
ds
Apply Credit Memo Data Set
ChangeVendor Call this method when the user enters the ttCheckHed.VendorID Parameters Name
Type
Description
pcVendorID
String
Vendor ID - character code for Vendor
ds
The ApplyDebitMemo data set
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue1
String
VendorNum
keyValue2
String
InvoiceNum
CheckOnScreenLoad This method is called first thing when opening the screen. It checks to see if the G/L is interfaced and if the Fiscal Period is valid. If the G/L is not interfaced, a question asking if the user wants to continue will be returned. If the user answers no, then they are returned to the main menu. If the Fiscal Period is invalid, an exception will be raised and the user should be returned to the main menu.
128
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
vQuestion
String@
Ask the user if they want to continue if the G/L is not interfaced
DeleteCheckDetails This method needs to be run as the last method if the user chooses not to Apply Debit Memo but wants to leave the CheckHed record to create a new one or closes/exits the ApplyDebitMemo UI screen. This will delete the appropriate CheckHed and APTran records and update the related APInvHed to reflect the appropriate invoice balance. Parameters Name
Type
Description
ipHeadNum
Int32
CheckHed.HeadNum
GetNewCheckHedInv This method replaces the standard GetNewCheckHed method. Requires a Debit Memo Invoice Parameters Name
Type
Description
vendorNum
Int32
Vendor Number
invoiceNum
String
Invoice Number
ds
Apply Debit Memo Data Set
SetReadyToCalc Parameters Name
Type
Description
ipHeadNum
Int32
ipHeadNum
ipAPTranNo
Int32
ipAPTranNo
ipCalcAll
Boolean
ipCalcAll
ds
Epicor 9.05 | 9.05.605
ApplyDebitMemo dataset
129
A-E
Business Object Reference Guide
APPromissoryNotes Epicor.Mfg.BO.APPromissoryNotes: This business object contains 57 methods.
GetNewAPPNHead Inserts a new row in the DataSet with defaults populated.
GetNewAPPNHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewAPPNDtl Inserts a new row in the DataSet with defaults populated.
GetNewBankTran Inserts a new row in the DataSet with defaults populated.
GetNewBankTranTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewBankTranGLC Inserts a new row in the DataSet with defaults populated.
GetNewAPPNHeadTGLC Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewAPPNDtlTaxDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
130
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
131
A-E
Business Object Reference Guide
Returns
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AssignLegalNumber Assigns a legal number to the miscellaneous shipment.
132
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipGroupID
String
Group ID number
ipHeadNum
Int32
Header number
String@
Legal number message
ds opLegalNumMsg Returns The Promissory Note data set
ChangePIType Call method when the user changes APPNHead.TransDate. Parameters Name
Type
Description
ds
The APPromissoryNotes data set
ChangeTranAmt This method updates the BankTran amounts when the adjustment amount changes or the currency switch toggles. Parameters Name
Type
Description
ipTranAmtType
String
Indicate which of the transaction amount is changed. Valid values are: 'B' for Base Tran Amount and 'D' for Doc Tran Amount
proposedTranAmt
Decimal
The proposed Transaction Amount
ds
The AP Promissory Notes data set
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
GroupID
keyValue2
String
HeadNum
Epicor 9.05 | 9.05.605
133
A-E
Business Object Reference Guide
CreateAPPNHead Create Vendor Checks for selected invoices. Parameters Name
Type
Description
pcGroupID
String
AP Promissory Note Group ID
ds
The APInvSel data set
CreateNewAPPNHead Create New CheckHed record. To be used instead of GetNewCheckHed record. Parameters Name
Type
Description
pcGroupID
String
AP Promissory Note Group ID
ds
The AP Promissory Note data set
DeleteNegPayment DeleteNegPayments. Deletes all checks in the group that have negative check. amounts. Works the same as MassDelete but only deletes negative balance checks. Parameters Name
Type
Description
pcGroupID
String
AP Check Group ID
GenerateAPPNDtl This method combines the GetNewAPPNDtl and Update() method into one routine so that the user can run an "Auto Apply" Payment function Parameters Name
Type
Description
groupID
String
Cash Group ID
headNum
Int32
Promissory Note HeadNum
Returns AP Promissory Notes data set
GetAPPNMove Get the APPNMove records for an APPromissoryNotes.
134
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
iGroupID
String
The Group Number
iHeadNum
Int32
The Header Number
Returns The APPNMove data set
GetBankAcctInfo This method is called when the BankAcctID field is modified Parameters Name
Type
Description
bankAcctID
String
Proposed BankAcctID
ds
AR Promissory Notes data set
GetGLJrnDtl Get the GLJrnDtl records for an APPromissoryNote. Parameters Name
Type
Description
iGroupID
String
The Group Number
iHeadNum
Int32
The Header Number
Returns The GLJrnlDtlMov data set
GetGroupIDForPI This method will retrieve the GroupID for an APPNHead record that's for the APPromNoteID supplied. Parameters Name
Type
Description
apPromNoteID
String
AR Promissory Note ID
groupID
String@
Cash Group ID
headNum
Int32@
HeadNum
GetLegalNumGenOpts Returns the legal number generation options.
Epicor 9.05 | 9.05.605
135
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipGroupID
String
Group ID number
ipHeadNum
Int32
Header number
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
GetNewAPPNHeadByGroupID Alternate routine to create new Payment Instrument from AP Invoice Entry Parameters Name
Type
Description
pcGroupID
String
AP Promissory Note Group ID
ds
The AP Promissory Notes data set
GetNewAPPNMoveByAPPNHead Get new record for APPNMove table. Parameters Name
Type
Description
ipGroupID
String
APPNHead.GroupID
ipHeadNum
Int32
APPNHead.HeadNum
Returns The AP Promissory Notes Move data set
GetNewBankTranByHeadNum Alternate routine to load the Bank Fee Parameters Name
Type
Description
lvHeadNum
Int32
Bank Fee Code
lvBankAcctID
String
Bank Account ID
ds
136
The AP Promissory Notes data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetPostCodeByPIStatus Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetRowsTracker Wrapper on GetRows for Trackers so Adjustment records are not deleted
MassDelete Mass Delete. Delete all checks in the Group. Parameters Name
Type
Description
pcGroupID
String
AP Promissory Note Group ID
OnChangeBankFeeID Validate for a Correct Bank Fee Code Parameters Name
Type
Description
pcBankFeeID
String
Bank Fee Code
ds
The AP Promissory Notes Entry data set
OnChangeDocTranAmt Call method when the user changes the Doc Tran Amount. Parameters Name
Type
Description
pdDocTranAmt
Decimal
Proposed Document Amount value
ds
The AP Promissory Notes data set
OnChangeFixedAmount Call method when the user changes the FixedAmount in Tax screen. Use this method with Misc. Payment screen for APPromissoryNotesDataSet.
Epicor 9.05 | 9.05.605
137
A-E
Business Object Reference Guide
Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch
pdFixed
Decimal
Proposed taxable amount value
taxtbl
String
Tax temp-table name
ds
The AP Promissory Notes data set
OnChangeInvoiceNum Call this method when the user enters the Invoice Number in Pay Invoice screen. Parameters Name
Type
Description
pcInvoiceNum
String
Invoice Num
pcChangeExchangeRateResponse String
Response to the question pcChangeExchangeRateResponse. ? means question has not been asked. Yes/No is considered a response.
ds
The AP Promissory Notes data set
pcQuestion
String@
Question to be answered by the user in pcChangeExchangeRateResponse.
OnChangeInvSelPayment Call this method when the user changes either Gross Payment or Disc. Taken field. Use this method with Payment maintenance screen for ApInvSelDataSet. Parameters Name
Type
Description
pdDocGrossPay
Decimal
Proposeed Document Gross Payment value
pcRowIdent
String
Pass ttAPInvSel.RowIdent value here to uniquely identify the record to change.
ds
The APInvSel data set
OnChangeRateCode This method updates the dataset when the RateCode field changes Parameters
138
Name
Type
Description
rateCode
String
Proposed RateCode value
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
taxtbl
String
Tax temp-table name
ds
The AP Promissory Notes data set
OnChangeTaxableAmt Call method when the user changes the Taxable Amt in Tax screen. Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch
pdTaxableAmt
Decimal
Proposed taxable amount value
taxtbl
String
Tax temp-table name
ds
The AP Promissory Notes data set
OnChangeTaxAmt Call method when the user changes the Tax Amt in Tax screen. Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch
pdTaxAmt
Decimal
Proposed taxable amount value
taxtbl
String
Tax temp-table name
ds
The AP Promissory Notes data set
OnChangeTaxCode Call method when the user changes the Tax ID in Tax maintainence. Parameters Name
Type
Description
pcTaxCode
String
Proposed Tax ID
taxtbl
String
Tax temp-table name
ds
The AP Promissory Notes data set
OnChangeTaxPercent Call method when the user changes the Tax Percent in Tax screen.
Epicor 9.05 | 9.05.605
139
A-E
Business Object Reference Guide
Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch
pdPercent
Decimal
Proposed taxable amount value
taxtbl
String
Tax temp-table name
ds
The AP Promissory Notes data set
OnChangeTransDate Call method when the user changes APPNHead.TransDate. Parameters Name
Type
Description
pdtTransDate
Nullable{System.DateTime}
Propopsed TransDate
ds
The APPromissoryNotes data set
OnChangeVendBankAcctID Call this method when the user enters the ttAPNHead.VendBankAcctID Parameters Name
Type
Description
pcVendBankAcctID
String
Vendor Bank Acct ID - Bank Account ID for Vendor
ds
The AP Promissory Notes data set
OnChangeVendor Call this method when the user enters the ttAPNHead.VendorNum Parameters Name
Type
Description
pcVendorID
String
Vendor ID - character code for Vendor
ds
The AP Promissory Notes data set
PrePost Check APPNHead before posting
140
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
inGroupID
String
Group ID number
inHeadNum
Int32
Header number
inPIStatusNew
String
new value of PIStatus
inTypeNew
String
new value of Type
outPostToGL
String@
run posting to GL and whar kind
Returns The Promissory Note data set
SelectInvoices Read ApInvHed records and create ApinvSel records if they meet the selection criteria. Parameters Name
Type
Description
pcGroupID
String
AP Check Group ID
pcPayableAccountsList
String
Delimited list of Payable Accounts
pdtDueDate
Nullable{System.DateTime} Select invoices due by this date.
pdtInvoicePM
Boolean
Select invoices wihtout Payment Method.
pcSupplierList
String
Select invoices for the supplier list.
pcPaymentMethod
String
Select payment methods for the specific.
Returns The APInvSel data set
SetReadyToCalc Parameters Name
Type
Description
ipGroupID
String
ipGroupID
ipHeadNum
Int32
ipHeadNum
ipInvoiceNum
String
ipInvoiceNum
ipBankAcctID
String
ipBankAcctID
ipTranNum
Int32
ipTranNum
ipVoided
Boolean
ipVoided
ipCalcAll
Boolean
ipCalcAll
ds
Epicor 9.05 | 9.05.605
AP Promissory Notes dataset
141
A-E
Business Object Reference Guide
UpdateAPPNMove4WriteOff Update APPNMove table and write off APPNHead. Parameters Name
Type
Description
ipGroupID
String
APPNHead.GroupID
ipHeadNum
Int32
APPNHead.HeadNum
ds
The AP Promissory Notes Move data set
UpdateDueDateDescription Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
VoidLegalNumber Voids the legal number. Parameters Name
Type
Description
ipGroupID
String
Group ID number
ipHeadNum
Int32
Header number
ipVoidedReason
String
Reason for the void
Returns The Promissory Note data set
APPromNoteGrp Epicor.Mfg.BO.APPromNoteGrp: This business object contains 11 methods.
GetNewAPChkGrp Inserts a new row in the DataSet with defaults populated.
GetNewAPChkGrpAttch Inserts a new row in the DataSet with defaults populated.
142
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
143
A-E
Business Object Reference Guide
LockGroup This procedure is GetById + Lock the Group. This procedure can be run instead of GetById if you want to lock along with doing a GetByID. If the lock is acquired successfully, plSuccess is returned as true. Parameters Name
Type
Description
pcGroupID
String
The Group ID selected by the user.
plSuccess
Boolean@
Returns a True or False value. True means successfully locked the Group
Returns Returns Epicor.Mfg.BO.APPromNoteGrpDataSet
OnChangeBankAcctID Call this method when the user changes the Bank Account. Parameters Name
Type
Description
pcBankAcctID
String
The proposed value of BankAcctID.
ds
Returns Epicor.Mfg.BO.APPromNoteGrpDataSet
UnLockGroup Unlock the group. The user who locked the group can only unlock it. Parameters Name
Type
Description
pcGroupID
String
The Group ID selected by the user.
plSuccess
Boolean@
Returns a True or False value. True means successfully locked the Group
AprvCode Epicor.Mfg.BO.AprvCode: This business object contains 0 methods.
AprvVend Epicor.Mfg.BO.AprvVend: This business object contains 21 methods.
GetNewAprvVend Inserts a new row in the DataSet with defaults populated.
144
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetNewPartXRefVend Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
145
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetAprvData . Parameters Name
Type
Description
ipCalledFrom
String
Called From
whereClauze
String
WhereClauze
Returns AprvVendDataSet DataSet
GetListbyVendorName Search suppliers by Vendor Name. Call normal GetList method. Parameters Name
Type
Description
whereClause
String
Whereclause.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
vendorName
String
Vendor Name.
morePages
Boolean@
More pages.
Returns The AprvVendListDataSet data set
GetRowsCustom Search suppliers by Vendor Name. Call normal GetList method. Parameters
146
Name
Type
Description
whereClauseAprvVend
String
Where Clause for AprvVend.
whereClausePartXRefVend
String
Where Clause for PartXRefVend.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
vendorID
String
Vendor Name.
morePages
Boolean@
More pages.
Returns The AprvVend data set
OnChangeClassID . Parameters Name
Type
Description
ipClassID
String
The new value for VendorID.
ds
The Receipt data set
OnChangeCustID . Parameters Name
Type
Description
ipCustID
String
The new value for VendorID.
ds
The Receipt data set
OnChangeCustNum . Parameters Name
Type
Description
ipCustNum
Int32
The new value for VendorID.
ds
The Receipt data set
OnChangeMfgNum . Parameters Name
Type
Description
ipMfgNum
Int32
The new value for VendorID.
Epicor 9.05 | 9.05.605
147
A-E
Business Object Reference Guide
Name
Type
ds
Description The Receipt data set
OnChangeMfgPartNum . Parameters Name
Type
Description
ipMfgPartNum
String
The new value for VendorID.
ds
The Receipt data set
OnChangeOpCode . Parameters Name
Type
Description
ipOpCode
String
The new value for VendorID.
ds
The Receipt data set
OnChangePartNum . Parameters Name
Type
Description
ipPartNum
String
The new value for VendorID.
ds
The Receipt data set
OnChangeVendorID . Parameters Name
Type
Description
ipVendorID
String
The new value for VendorID.
ds
148
The Receipt data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
OnChangeVendorNum . Parameters Name
Type
Description
ipVendorNum
Int32
The new value for VendorID.
ds
The Receipt data set
OnChangeVendPartNum Run when the PartXRefVend.VendPartNum is changing. Parameters Name
Type
Description
ipVendPartNum
String
The new value for VendPartNum.
ds
The Receipt data set
APTranSearch Epicor.Mfg.BO.APTranSearch: This business object contains 7 methods.
GetNewAPTranSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
149
A-E
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ARAdjustment Epicor.Mfg.BO.ARAdjustment: This business object contains 17 methods.
GetNewInvcHeadAdj Inserts a new row in the DataSet with defaults populated.
GetNewCashDtl Inserts a new row in the DataSet with defaults populated.
GetNewCashDtlTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
150
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
151
A-E
Business Object Reference Guide
ChangeAdjAmount This method updates the CashDtl details when the adjustment amount changes or the currency switch toggles. Use the external fields CashDtl.DispTranAmt and CashDtl.DocDispTranAmt to accept the user entered adjustment amount. Parameters Name
Type
Description
ds
A/R Invoice Adjustment Data Set
ChangeIncomeTaxCode Performs required logic when CashDtl.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
ARAdjustment data set
ChangeTranDate This method updates the CashDtl fiscal period and year when the transaction date changes. Parameters Name
Type
Description
ds
The A/R Adjustment Entry data set
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
InvoiceNum
CheckGLInterface Call this method once to validate the G/L Interface. This method checks for GLSyst availability and if G/L is interfaced with A/R. If A/R is not interfaced with G/L then user should be asked if okay to continue without posting to G/L. This method will return a Message for the user if not interfaced else the Message is blank. If the user do not wish to continue then exit this object. This method also returns a logical flag to indicate if Posting to G/L. This value should be passed on to each new A/R Adjustment (CashDtl) record to process.
152
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
opMessage
String@
The Message to ask the user if A/R is not interfaced with G/L.
opPostToGL
Boolean@
Indicates if the A/R Adjustment will be Posted to G/L.
GenerateLegalNumber This method generates a legal number if necessary date changes. Parameters Name
Type
ds
Description The A/R Adjustment Entry data set
GetNewCashDtl1 This method is to be used in place of GetNewCashDtl. This method asks for invoice number to link the A/R Invoice Header (InvcHead) to A/R Invoice Adjustment (CashDtl). Parameters Name
Type
Description
ds ipInvoiceNum
The A/R Adjustment Entry data set Int32
The A/R Invoice Number to adjust
ValidateTransaction This method checks that all necessary data are entered, that should be done before adjustment. Parameters Name ds
Type
Description The A/R Adjustment Entry data set
ARAgingTracker Epicor.Mfg.BO.ARAgingTracker: This business object contains 11 methods.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
Epicor 9.05 | 9.05.605
153
A-E
Business Object Reference Guide
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
DoRlsHeadCalculations Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GenerateReport This method should be called after all the input parameters have been entered. It will generate a dataset containing records for the AR Aging report used by a tracker. Parameters Name
Type
ds
Description Epicor.Mfg.BO.ARDtlsDataSet
GenerateTracker This method should be called to populate the dataset for the AR Aging Tracker. Parameters Name
Type
Description
custID
String
Customer ID.
Returns Epicor.Mfg.BO.ARTrackerTotDataSet
GetAgeBy This method should be called after all the input parameters have been entered. It will generate a dataset containing records for the AR Aging report used by a tracker.
154
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ageBylist
String@
AgeBylist
GetAgingFormatCode This method returns a list of valid 'AgingFormatCode' codes UI note - user should select only ONE of the valid codes. Parameters Name
Type
Description
agingFormatCodelist
String@
'AgingFormatCode' codes
GetARAccounts This method returns a list of ARAccounts and descriptions Parameters Name
Type
Description
arActsList
String@
ARAccounts and description
GetNewParams This method should be called after all the input parameters have been entered. It will generate a dataset containing records for the AR Aging report used by a tracker. Parameters Name
Type
Description
ds
Epicor.Mfg.BO.ARDtlsDataSet
GetSelectBy This method returns a select by list. Parameters Name
Type
Description
selectbylist
String@
Select by list
GetSortByList This method returns a sort by list.
Epicor 9.05 | 9.05.605
155
A-E
Business Object Reference Guide
Parameters Name
Type
Description
sortbylist
String@
Sort by list
ARInvcDtlSearch Epicor.Mfg.BO.ARInvcDtlSearch: This business object contains 7 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
156
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListAlternalSearch Allows use of InvcHead filter but returns only InvcDtl records. Parameters Name
Type
Description
invcHeadWhereClause
String
Whereclause for invcHead table.
invcDtlWhereClause
String
Whereclause for InvcDtl table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The ARInvcDtlSearch data set
ARInvoice Epicor.Mfg.BO.ARInvoice: This business object contains 157 methods.
GetNewInvcHead Inserts a new row in the DataSet with defaults populated.
GetNewInvcHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewInvcDtl Inserts a new row in the DataSet with defaults populated.
GetNewInvcDtlAttch Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
157
A-E
Business Object Reference Guide
GetNewInvcChrg Inserts a new row in the DataSet with defaults populated.
GetNewInvcDtlRasch Inserts a new row in the DataSet with defaults populated.
GetNewInvcMisc Inserts a new row in the DataSet with defaults populated.
GetNewInvcTax Inserts a new row in the DataSet with defaults populated.
GetNewInvcDtlTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
158
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetCustNum Receives CustId, returns CustNum Parameters Name
Type
Description
ipCustID
String
Customer ID
opCustNum
Int32@
Returns Customer Num
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
Epicor 9.05 | 9.05.605
159
A-E
Business Object Reference Guide
Name
Type
Description
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GenerateRebateInv This method create the invoices for the rebates selected. Parameters Name
Type
Description
invoiceType
String
Type of invoice, AP or AR
groupID
String
Invoice Group to generate the invoices in
opMsg
String@
tax connect message
ds
List of rebates available for invoicing
GetRebateInvList This method returns a list of rebates available for invoicing. Parameters
160
Name
Type
Description
invoiceType
String
Type of invoice, AP or AR
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns List of rebates available for invoicing
AssignLegalNumber Assigns a legal number to the invoice. Parameters Name
Type
Description
ipInvoiceNum
Int32
Invoice number
String@
Legal number message
ds opLegalNumMsg Returns The Miscellaneous Shipment data set
calcLineExtPriceAjust Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CashRecGetInvoices This procedure returns the invoices to Cash Receipt Entry Parameters Name
Type
Description
payDay
Nullable{System.DateTime}
Payment date.
whereClause
String
Where clause for Cash Receipt.
Returns A/R invoice data set.
ChangeIncomeTaxCode Performs required logic when InvcDtl.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
Epicor 9.05 | 9.05.605
161
A-E
Business Object Reference Guide
Name
Type
ds
Description ARInvoice data set
CheckAmortSchedules Parameters Name
Type
Description
String@
text UI prompts user with if schedules are to be generated
ds opGenMessage
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
InvoiceNum
showError
Boolean
true/false to show error message box if doc is locked
isLocked
Boolean@
true if doc is locked.
CheckGroupIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
GroupID
showError
Boolean
true/false to show error message box if group is locked
isLocked
Boolean@
true if group is locked.
lockedStatus
String@
Locked status: Not Posted, Posting, Reviewing.
CheckLtrOfCredit Parameters
162
Name
Type
Description
iInvoiceNum
Int32
Invoice number
cARLOCID
String
Letter of Credit ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
dTotalCharges
Decimal
OrderHed.TotalCharges
outMsg
String@
Output message
Returns The AR Invoice data set
CopyInvoiceLines Copy Invoice lines from source invoice to ttInvc tables Parameters Name
Type
Description
sourceInvoiceNum
Int32
Invoice num which should be cancelled
destInvoiceNum
Int32
Destination invoice number
recalculateTaxes
Boolean
reverseSignQty
Boolean
ds
CreateCorrectionInvoice Creates a correction invoice from a another invoice. Parameters Name
Type
Description
groupID
String
Current group for new invoice
sourceInvoiceNum
Int32
Invoice num which should be corrected
newInvoiceDate
Nullable{System.DateTime} Date of new invoice
newDocType
String
Document Type for the new invoice
recalculateTaxes
Boolean
Flag to indicate if is necessary to recalculate taxes
opNewInvoiceNum
Int32@
Correction Invoice Num
CreateInvFromDep Creates deposit invoices from deposit payments. The list of deposit payments should be ~ delimited. Parameters Name
Type
Description
groupID
String
Group to generate invoices for.
payments
String
The list of deposit payments
Epicor 9.05 | 9.05.605
163
A-E
Business Object Reference Guide
Name
Type
Description
invoices
String@
Invoice numbers generated delimited by a ~.
errors
String@
Errors that may have occured during the processing
msgNumInvoices
String@
message displaying the number of invoices created
grpTotalInvAmt
Decimal@
new InvcGrp total accumulated from all invoices to update UI
DeleteAmortizationSchedule Parameters Name
Type
Description
ipResetDefRevFlag
Boolean
indicates if the invcdtl.DeferredRev is to be reset
ds
A/R invoice data set.
DeleteMaster Parameters Name
Type
Description
cGroupID
String
current APInvGrp GroupID
keyValue
String
VendorNum
grpTotalInvAmt
Decimal@
return new TotalInvAmt to update APInvGrp in UI
ds
DeselectSelectedDropShipments Method to call to deselect selected drop shipments. Parameters Name
Type
Description
ds Returns
EnableARDates This method return wish dates have to be enable on AR Invoice.
164
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
enApplyDate
Boolean@
Enable Apply Date.
enShipDate
Boolean@
Enable Shipment Date.
enTaxPDate
Boolean@
Enable Tax Point Date.
enTaxRDate
Boolean@
Enable Tax Rate Date.
enCurrRDate
Boolean@
Enable Currency Rate Date.
enTaxRCDate
Boolean@
Enable Tax Rate Date for credits.
ETCValidateAddress Call tax integration and loads temp tables from the results. Parameters Name
Type
Description
invoiceNum
Int32
InvcHead.InvoiceNum
invoiceLine
Int32
InvcDtl.InvoiceLine
statusFlag
Boolean@
Set to true if the integration is up, false if down.
errorFlag
Boolean@
If true, an error occured.
errorMsg
String@
If Error Flag is true, this is the associated message.
Returns The ETCAddrValidation data set
GenerateAmortizationSchedule Parameters Name
Type
ds
Description A/R invoice data set.
GetARUninvoicedDropShipments Method to call to get uninvoiced receipts for Receipt billing. Parameters Name
Type
Description
groupID
String
Group to generate invoices for.
custNums
String
A list customer numbers
plantChoice
String
Current or All
Epicor 9.05 | 9.05.605
165
A-E
Business Object Reference Guide
Name
Type
Description
billToFlag
Boolean
If true, customers are bill to's. If false they are sold to's.
onlyNotInvoiced
Boolean
All or Only Only Not Invoiced for better perfomance
Returns
GetByBOEInvoiceNum This method finds the invoice for Bill of Exchange Parameters Name
Type
Description
invoiceNum
Int32
The invoice num
Returns The AR Invoice data set
GetCancellationInvoice Creates new credit memo invoice as cancellation invoice. Parameters Name
Type
Description
groupID
String
Current group for new invoice
sourceInvoiceNum
Int32
Invoice num which should be cancelled
newInvoiceDate
Nullable{System.DateTime}
Date of new invoice
newDocType
String
recalculateTaxes
Boolean
GetCurrencyBase This method returns the Base Currency Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
GetDepositsToConvert Method selects deposit payments for specified customers and the earliest payment date.
166
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
custNums
String
A list customer numbers
fromDate
Nullable{System.DateTime}
The earliest date of deposit payments
Returns
GetDropShipments Creates invoices for Drop Shipments. The list of customers should be a ~ delimited list of customer numbers. The Plant should be either the string "CURRENT" or "ALL". The invoice numbers are in a ~ delimited list. Parameters Name
Type
Description
groupID
String
Group to generate invoices for.
custList
String
A list of ~ delimited customer numbers.
plant
String
the string "CURRENT" or "ALL".
billToFlag
Boolean
If true, customers are bill to's. If false they are sold to's.
invoices
String@
Invoice numbers generated delimited by a ~.
errors
String@
Errors that may have occured during the processing
msgNumInvoices
String@
message displaying the number of invoices created
grpTotalInvAmt
Decimal@
new InvcGrp total accumulated from all invoices to update UI
ds
GetFSCalls Creates an FS Call invoice. The list of customers should be a ~ delimited list of customer numbers. The Plant should be either the string "CURRENT" or "ALL". The number of invoices is an integer. Parameters Name
Type
Description
groupID
String
Group to generate invoices for.
custList
String
A list of ~ delimited customer numbers.
plant
String
the string "CURRENT" or "ALL".
numInvs
Int32@
Number of Invoices generated.
grpTotalInvAmt
Decimal@
new InvcGrp total accumulated from all invoices to update UI
Epicor 9.05 | 9.05.605
167
A-E
Business Object Reference Guide
GetInvoiceLines Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetInvoiceReminders Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetLegalNumGenOpts Returns the legal number generation options. Parameters Name
Type
Description
ipInvoiceNum
Int32
Packing Slip number
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
GetMilestoneBilling Creates Milestone billing invoices. Parameters
168
Name
Type
Description
groupID
String
Group for this invoice.
custList
String
A list of ~ delimited customer numbers.
selectedItems_Key1
String
A list of ~ delimited project numbers.
selectedItems
String
A list of ~ delimited project/milestone numbers.
invoicesCreated
Boolean@
True if invoice was created.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
msgNumInvoices
String@
message displaying the number of invoices created
grpTotalInvAmt
Decimal@
new InvcGrp total accumulated from all invoices to update UI
GetMilestoneSearch Search for Milestone billing that could create an invoice and return them for customer's selection. Parameters Name
Type
Description
groupID
String
Group for this invoice.
custList
String
A list of ~ delimited customer numbers.
Returns ARInvGetMilestoneDataSet
GetNewDepositType Creates a new InvcHead record for Deposit Billing or Deposit Billing Credit Memo based on Deposit Billing type. This method is separate from GetNewInvcHeadType so security can be set on deposit invoices. Parameters Name
Type
Description
groupID
String
Group for this invoice.
depositBillType
String
Deposit Billing type. Valid types are DEPOSIT-BILL- Deposit invoice. DEPOSIT-MEMO- Deposit credit memo invoice.
ds
ARInvoiceDataSet.
GetNewInvcHeadBOE Creates a new InvcHead record for Bill of Exchange. Parameters Name ds
Type
Description A/R invoice data set.
GetNewInvcHeadType Creates a new InvcHead record based on the Invoice type.
Epicor 9.05 | 9.05.605
169
A-E
Business Object Reference Guide
Parameters Name
Type
Description
groupID
String
Group for this invoice.
invoiceType
String
Invoice type. Valid types are MISC-BILL - Miscelaneous invoice. ADV-BILL - Advanced billing. CREDIT-MEMO - Credit memo invoice. ADV-MEMO - Advanced billing credit
ds
A/R invoice data set.
GetPaymentDataForViewing Method to call when obtaining the payment schedule for the invoice header. Parameters Name
Type
Description
invoiceNum
Int32
The invoice number
ds Returns
GetPBInvcSearch Search for Projects that could create an invoice and return them for customer's selection. Parameters Name
Type
Description
ipGroupID
String
Group to generate invoices for.
ipPrjList
String
A list of ~ delimited projects.
Returns ARInvGetPBDataSet
GetPBInvoices Creates an Project invoice. The list of projects should be a ~ delimited. Parameters
170
Name
Type
Description
ipGroupID
String
Group to generate invoices for.
ipPrjList
String
A list of ~ delimited projects.
opInvcList
String@
Invoice numbers generated delimited by a ~ delimiter.
opErrorList
String@
Errors that may have occured during the processing.
msgNumInvoices
String@
message displaying the number of invoices created
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
grpTotalInvAmt
Decimal@
new InvcGrp total accumulated from all invoices to update UI
GetRecurBill Creates a re occurring invoice. Parameters Name
Type
Description
groupID
String
Group for this invoice.
custList
String
A list of ~ delimited customer IDs.
contractList
String
A list of ~ delimited contract numbers.
invoicesCreated
Boolean@
True if invoice was created.
msgNumInvoices
String@
message displaying the number of invoices created
grpTotalInvAmt
Decimal@
new InvcGrp total accumulated from all invoices to update UI
GetRecurBillSearch Search for Service Contracts that could create an invoice and return them for customer's selection. Parameters Name
Type
Description
custList
String
A list of ~ delimited customer numbers.
Returns ARInvGetFSContDataSet
GetRMACredits Selects InvcHead records with a group of RMACRREQ and changes the group to the group ID passed in. A GetList needs to be run after this process so the user can choose the invoice they want to process. This method returns a of how many invoices were converted. Parameters Name
Type
Description
groupID
String
Group for this invoice.
custList
String
A list of ~ delimited customer numbers.
invList
String
A list of ~ delimited invoice numbers.
rMAMessage
String@
Numbers of RMA's converted.
invoicesCreated
Boolean@
True if invoice was created.
Epicor 9.05 | 9.05.605
171
A-E
Business Object Reference Guide
Name
Type
Description
grpTotalInvAmt
Decimal@
new InvcGrp total accumulated from all invoices to update UI
GetRMACreditsSearch Selects InvcHead records with a group of RMACRREQ and return them for customer's selection. Parameters Name
Type
Description
custList
String
A list of ~ delimited customer numbers.
Returns ARInvGetRMADataSet
GetRowsContactTracker Calls the normal GetRows method and then constructs a custom data set combining Head/Dtl fields for the contact tracker. Parameters Name
Type
Description
whereClauseInvcHead
String
Whereclause for InvcHead table.
whereClauseInvcHeadAttch
String
Whereclause for InvcHeadAttch table.
whereClauseInvcDtl
String
Whereclause for InvcDtl table.
whereClauseInvcDtlAttch
String
Whereclause for InvcDtlAttch table.
whereClauseInvcMisc
String
Whereclause for InvcMisc table.
whereClauseInvcTax
String
Whereclause for InvcTax table.
whereClauseARIHeadTax
String
Whereclause for ARIHeadTax table.
contactName
String
Contact to return data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.InvcCustTrkDataSet
GetRowsCustomerTracker Calls the normal GetRows method and then constructs a custom data set combining Head/Dtl fields for the customer tracker.
172
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClauseInvcHead
String
Whereclause for InvcHead table.
whereClauseInvcHeadAttch
String
Whereclause for InvcHeadAttch table.
whereClauseInvcDtl
String
Whereclause for InvcDtl table.
whereClauseInvcDtlAttch
String
Whereclause for InvcDtlAttch table.
whereClauseInvcMisc
String
Whereclause for InvcMisc table.
whereClauseInvcTax
String
Whereclause for InvcTax table.
whereClauseARIHeadTax
String
Whereclause for ARIHeadTax table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.InvcCustTrkDataSet
GetShipments Creates an Shipment invoice. The list of customers should be a ~ delimited list of customer numbers. The list of pack slips should be null (room for enhancement). The Plant should be either the string "CURRENT" or "ALL". The invoice numbers are in a ~ delimited list. Parameters Name
Type
Description
groupID
String
Group to generate invoices for.
custList
String
A list of ~ delimited customer numbers.
packSlips
String
As of the initial release, null
plant
String
the string "CURRENT" or "ALL".
billToFlag
Boolean
If true, customers are bill to's. If false they are sold to's.
overBillDay
Boolean
If true, create all selected invoices irrespective of the billing days
invoices
String@
Invoice numbers generated delimited by a ~.
errors
String@
Errors that may have occured during the processing
msgNumInvoices
String@
message displaying the number of invoices created
grpTotalInvAmt
Decimal@
new InvcGrp total accumulated from all invoices to update UI
GetShipmentsSearch Method to call when the search is done on GetShipments. CustIDs: You can specify a list of customers. Plant Choice: C is for current.
Epicor 9.05 | 9.05.605
173
A-E
Business Object Reference Guide
Parameters Name
Type
Description
groupID
String
Group to generate invoices for.
custNums
String
A list customer numbers
plantChoice
String
Current or All
billToFlag
Boolean
If true, customers are bill to's. If false they are sold to's.
onlyNotInvoiced
Boolean
All or Only Only Not Invoiced for better perfomance
Returns
InvcGrpExists Checkes if InvcGrp record exists or not. Parameters Name
Type
Description
groupID
String
Group for this invoice.
result
Boolean@
return true if Group exists
IsConvertedFromDep Returns true if deposit invoice is converted from deposit payment. Parameters Name
Type
Description
invoiceNum
Int32
Invoice number.
converted
Boolean@
True if deposit invoice is converted from deposit payment
IsPMForGenPIType Parameters Name
Type
Description
ipPMUID
Int32
Payment Method
ipIsGenPIType
Boolean@
Is invoice payment method for a generated PI Type
OnChangeARLOCID This procedure is used to validate the ARLOCID (AR Letter of Credit ID) for both AR Invoice Entry and Posted Invoice Update. The argument "ipInvoiceNum is only supplied when called from Posted Invoice Update. For AR Invoice Entry, if either the Terms or the Bill To Customer is different on the Invoice than it is on the Letter of
174
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Credit, a message to the user and a value for the UI to put in that field (if the user decides to) are passed back. When called from Posted Invoice Update, the Customer, Bill To Customer and the Currency must match or an error is given. Parameters Name
Type
Description
ipARLOCID
String
The Letter of Credit ID value
ipInvoiceNum
Int32
Current Invoice number
opTermsCodeValue
String@
The value to put in the InvcHead.TermsCode field
opTermsCodeMsg
String@
The message to give the user if the TermsCode needs to be changed
opBTCustIDValue
String@
The value to put in the InvcHead.BTCustID field
opBTCustIDMsg
String@
The message to give the user if the BTCustID needs to be changed
ds
The AR Invoice data set
OnChangeBlockedFin This method should be called when the plant is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
ds
A/R invoice data set.
OnChangeHold Parameters Name
Type
Description
ipHold
Boolean
proposed hold value
ds
A/R invoice data set.
OnChangeHoldReason Parameters Name
Type
Description
ipReason
String
proposed reason code
ds
Epicor 9.05 | 9.05.605
A/R invoice data set.
175
A-E
Business Object Reference Guide
OnChangeInvDtlUseOTS Method to call when changed the UseOTS field the contract header record. Refreshes the address list and contact info Parameters Name
Type
Description
ds
A/R invoice data set.
OnChangeLineDefRev Parameters Name
Type
Description
ipDefRev
Boolean
Input deferred revenue option
ds opOutMsg
A/R invoice data set. String@
out message the user is prompted for
OnChangeLineDspWithholdAmt This method should be called when the withhold amount on the invoice detail record is changed. Parameters Name
Type
Description
newDspWithholdAmt
Decimal
Proposed withhold amount.
ds
A/R invoice data set.
OnChangeLineInvoiceRef This method should be called before the InvcDtl invoice reference has been updated. Specific to Bill of Exchange invoices. Parameters Name
Type
Description
newInvoiceRef
Int32
Proposed invoice reference.
ds
176
A/R invoice data set.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
OnChangeOfAmortDate Parameters Name
Type
Description
ipAmortDate
Nullable{System.DateTime}
Proposed Amortization Date
ds
The AR Invoice data set
OnChangeofApplyDate This method should be called before the apply date has been updated. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newApplyDate
Nullable{System.DateTime}
Proposed Apply Date.
recalcamts
String
Recalc amount and taxes.
ds
A/R invoice data set.
OnChangeofChrgAmt Calculates the amounts for Miscellaneous charges when the misc. amt. changes. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice Line Number.
seqNum
Int32
Fin charge sequence number.
newChrgAmt
Decimal
Fin charge proposed amount.
ds
A/R invoice data set.
OnChangeofContact This method should be called when the contact is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newContact
Int32
Proposed Contact.
ds
Epicor 9.05 | 9.05.605
A/R invoice data set.
177
A-E
Business Object Reference Guide
OnChangeofCurrency If it is a new invoice, the currency fields are set. Otherwise they are updated. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newCurrencyCode
String
The New currency code.
ds
A/R invoice data set.
OnChangeofCustomer Called for change of bill to customer. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newCustomerID
String
Proposed customer Number.
ds
A/R invoice data set.
OnChangeOfDefRevStart Parameters Name
Type
Description
ipDefRevStart
Nullable{System.DateTime}
Deferred Revenue Start Date
ipInvoiceNum
Int32
invoice number
ipInvoiceLine
Int32
Invoice line number
OnChangeofDepAmt This method should be called after the document deposit amount has been changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
depositAmt
Decimal
DepositAmt
ds
178
A/R invoice data set.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
OnChangeofDeposit This method should be called after the document deposit amount has been changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
dspCredit
Decimal
DspCredit.
ds
A/R invoice data set.
OnChangeofExchangeRate This method should be called when the exchange rate is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newExchangeRate
Decimal
The New exchange rate.
ds
A/R invoice data set.
OnChangeofFixedAmt This method should be called when the tax amount on the invoice tax record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
taxCode
String
Invoice line tax code.
rateCode
String
Invoice line tax rate code.
newTaxAmt
Decimal
Proposed Tax amount.
ds
A/R invoice data set.
OnChangeofFOB This method should be called when the FOB changes. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
Epicor 9.05 | 9.05.605
179
A-E
Business Object Reference Guide
Name
Type
Description
newFOB
String
Proposed FOB.
ds
A/R invoice data set.
OnChangeofInvDate This method should be called before the invoice date has been updated. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newInvoiceDate
Nullable{System.DateTime}
Proposed invoice Date.
ds
A/R invoice data set.
OnChangeofInvoiceAddress This method will set the BillToInvoiceAddress field and the SoldToInvoiceAddress based on the field name and value passed in. If one is true, then the other is false. Parameters Name
Type
Description
fieldName
String
Either BillTo/SoldToInvoiceAddress.
fieldValue
Boolean
True or false.
ds
A/R invoice data set.
OnChangeofInvoiceRef This method should be called before the invoice reference has been updated. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newInvoiceRef
Int32
Proposed invoice reference.
ds
A/R invoice data set.
OnChangeofLineAdvBill This method should be called when the advanced billing amount on the invoice detail record is changed.
180
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newAdvBillAmt
Decimal
Proposed advanced billing amount.
ds
A/R invoice data set.
OnChangeofLineContact This method should be called when the Contact on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newContact
Int32
Proposed Contact number.
ds
A/R invoice data set.
OnChangeofLineDesc This method should be called when the part description on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newPartDesc
String
Proposed part description.
ds
A/R invoice data set.
OnChangeofLineDiscAmt This method should be called when the discount amount on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newDiscAmt
Decimal
Proposed discount amount.
ds
Epicor 9.05 | 9.05.605
A/R invoice data set.
181
A-E
Business Object Reference Guide
OnChangeofLineDiscPerc This method should be called when the discount percent on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newDiscPerc
Decimal
Proposed discount percent.
ds
A/R invoice data set.
OnChangeofLineExtPrice This method should be called when the extended amount on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newExtAmt
Decimal
Proposed discount amount.
ds
A/R invoice data set.
OnChangeofLineInvoiceLineRef This method should be called when the Invoice Line Reference number on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newInvoiceLineRef
Int32
Proposed Invoice Line Reference number
ds
A/R invoice data set.
OnChangeofLineOrderLine This method should be called when the OrderLine number on the invoice detail record is changed. Parameters
182
Name
Type
Description
invoiceNum
Int32
Invoice Number.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
invoiceLine
Int32
Invoice line number.
newOrderLine
Int32
Proposed order line number.
ds
A/R invoice data set.
OnChangeofLineOrderRelease This method should be called when the order release number on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newOrderRel
Int32
Proposed order release number.
ds
A/R invoice data set.
OnChangeofLinePartNum This method should be called when the part number on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newPartNum
String
Proposed part number.
ds
A/R invoice data set.
OnChangeofLinePricePerCode This method should be called when the price per code on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newPricePer
String
Proposed price per code.
ds
Epicor 9.05 | 9.05.605
A/R invoice data set.
183
A-E
Business Object Reference Guide
OnChangeofLineProdCode This method should be called when the Product code on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newProdCode
String
Proposed product code.
ds
A/R invoice data set.
OnChangeofLineQty This method should be called when the quantity on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newQty
Decimal
Proposed quantity.
ds
A/R invoice data set.
OnChangeofLineRevNum This method should be called when the revision number on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newRevNum
String
Proposed revision number.
ds
A/R invoice data set.
OnChangeofLineSalesUM This method should be called when the sales UM on the invoice detail record is changed. Parameters
184
Name
Type
Description
invoiceNum
Int32
Invoice Number.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
invoiceLine
Int32
Invoice line number.
newSalesUM
String
Proposed sales UM.
ds
A/R invoice data set.
OnChangeofLineShipDate This method should be called when the ship date on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newShipDate
Nullable{System.DateTime}
Proposed ship date.
ds
A/R invoice data set.
OnChangeOfLineShipToCustID This method should be called when the Customer ShipTo ID on the invoice detail record is changed. Parameters Name
Type
Description
newShipToCustID
String
Proposed Customer ShipTo ID.
ds
AR Invoice data set.
OnChangeofLineShipToNum This method should be called when the ship to number on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newShipToNum
String
Proposed ship to number.
ds
A/R invoice data set.
OnChangeofLineShipVia This method should be called when the ship via on the invoice detail record is changed.
Epicor 9.05 | 9.05.605
185
A-E
Business Object Reference Guide
Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newShipVia
String
Proposed ship via.
ds
A/R invoice data set.
OnChangeofLineTaxCat This method should be called when the Tax category on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newTaxCat
String
Proposed tax category.
ds
A/R invoice data set.
OnChangeofLineTaxExempt This method should be called when the Tax exempt on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newTaxExempt
String
Proposed tax exempt.
ds
A/R invoice data set.
OnChangeofLineTaxRgn This method should be called when the Tax Region on the invoice detail record is changed. Parameters Name
Type
Description
iTaxRegionCode
String
Proposed tax category.
ds
186
A/R invoice data set.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
OnChangeofLineUnitPrice This method should be called when the unit price on the invoice detail record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
newUnitPrice
Decimal
Proposed unit price.
ds
A/R invoice data set.
OnChangeofLockRate This method should be called when the invoice lock rate has been changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newLockRate
Boolean
Proposed invoice lock rate.
ds
A/R invoice data set.
OnChangeofManualTax This method should be called when the manual tax switch on the invoice tax record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
taxCode
String
Invoice line tax code.
rateCode
String
Invoice line tax rate code.
newManualTax
Boolean
Proposed Manual tax.
ds
A/R invoice data set.
OnChangeofMiscAmt Calculates the amounts for Miscellaneous charges when the misc. amt. changes.
Epicor 9.05 | 9.05.605
187
A-E
Business Object Reference Guide
Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice Line Number.
seqNum
Int32
Misc charge sequence number.
newMiscAmt
Decimal
Misc charge proposed amount.
ds
A/R invoice data set.
OnChangeofMiscCode Obtains defaults from the MiscCode table. This method needs to be called when a code is being changed or after a new InvcMisc record is obtained. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice Line Number.
seqNum
Int32
Misc charge sequence number.
newMiscCode
String
New miscellaneous code.
ds
A/R invoice data set.
OnChangeofMiscPrcnt Calculates the amounts for Miscellaneous charges when the misc. percentage changes. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice Line Number.
seqNum
Int32
Misc charge sequence number.
newPrcnt
Decimal
Misc charge proposed percentage.
ds
A/R invoice data set.
OnChangeofOrderNum This method should be called before the Order number has been updated.
188
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newOrderNum
Int32
Proposed Order number.
ds
A/R invoice data set.
OnChangeofPayMethod Method to call when changing the payment amount on the payment schedule for Parameters Name
Type
ds
Description A/R invoice data set.
invoiceNum
Int32
The invoice number.
newPayMethod
Int32
The Proposed Payment method PMUID.
OnChangeofPaySchedAmt Method to call when changing the payment amount on the payment schedule for the invoice header. All ARInvPaySched temp table records must be marked as 'dirty' so they will pass through the framework. Parameters Name
Type
Description
invoiceNum
Int32
The invoice number.
lineNumber
Int32
The line number or sequence number.
newPayAmt
Decimal
The Proposed Pay Sched Amount.
ds
OnChangeofPaySchedDate Method to call when changing the payment date on the payment schedule for the invoice header. All ARInvPaySched temp table records must be marked as 'dirty' so they will pass through the framework. Parameters Name
Type
Description
invoiceNum
Int32
The invoice number.
lineNumber
Int32
The line number or sequence number.
ds
Epicor 9.05 | 9.05.605
189
A-E
Business Object Reference Guide
OnChangeofPlant This method should be called when the plant is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newPlant
String
Proposed Plant.
ds
A/R invoice data set.
OnChangeOfRACode Parameters Name
Type
Description
ipRACode
String
Deferred Revenue Code
ds
OnChangeofRateCode This method should be called when the tax code on the invoice tax record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
taxCode
String
Invoice line tax code.
newRateCode
String
Invoice line tax rate code.
ds
A/R invoice data set.
OnChangeofRateGrpCode Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newRateGrpCode
String
The New currency code.
ds
190
A/R invoice data set.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
OnChangeofSalesRep This method should be called when a sales rep code on the invoice header record is changed. All the line items will be updated with the new sales rep. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
repIndexNum
Int32
The index number for the rep. If it is the 2nd rep in the list then 2 would be passed. If it is a new rep then the last line number plus one would be passed. The maximum index number is 5.
newRepCode
String
Proposed sales rep code.
ds
A/R invoice data set.
OnChangeofShipDate This method should be called before the shipment date has been updated. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newShipDate
Nullable{System.DateTime}
Proposed Ship Date.
ds
A/R invoice data set.
OnChangeofSoldToCustID This method returns the Sold To customer info. Parameters Name
Type
Description
newSoldToCustID
String
Proposed sold to custid
ds
The ARInvoice data set
OnChangeofTaxableAmt This method should be called when the taxable amount on the invoice tax record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
Epicor 9.05 | 9.05.605
191
A-E
Business Object Reference Guide
Name
Type
Description
taxCode
String
Invoice line tax code.
rateCode
String
Invoice line tax rate code.
newTaxableAmt
Decimal
Proposed Taxable amount.
ds
A/R invoice data set.
OnChangeofTaxAmt This method should be called when the tax amount on the invoice tax record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
taxCode
String
Invoice line tax code.
rateCode
String
Invoice line tax rate code.
newTaxAmt
Decimal
Proposed Tax amount.
ds
A/R invoice data set.
OnChangeofTaxCode This method should be called when the tax code on the invoice tax record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
rateCode
String
Invoice line tax rate code.
newTaxCode
String
Invoice line tax code.
ds
A/R invoice data set.
OnChangeofTaxLock This method should be called when the invoice tax lock rate has been changed. Parameters
192
Name
Type
Description
invoiceNum
Int32
Invoice Number.
newLockRate
Boolean
Proposed invoice tax lock rate.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
A-E
Type
ds
Description A/R invoice data set.
OnChangeofTaxPDate This method should be called before the Tax Point date has been updated. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newTaxPDate
Nullable{System.DateTime}
Proposed Tax Point Date.
ds
A/R invoice data set.
OnChangeofTaxPercent This method should be called when the tax percent on the invoice tax record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
taxCode
String
Invoice line tax code.
rateCode
String
Invoice line tax rate code.
newPercent
Decimal
Proposed Tax percent.
ds
A/R invoice data set.
OnChangeofTaxRateDate This method should be called before the tax rate date has been updated. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newTaxRateDate
Nullable{System.DateTime}
Proposed Tax Rate Date.
ds
Epicor 9.05 | 9.05.605
A/R invoice data set.
193
A-E
Business Object Reference Guide
OnChangeofTaxRateGrpCode Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newRateGrpCode
String
The New currency code.
ds
A/R invoice data set.
OnChangeofTaxReportAmt This method should be called when the reportable amount on the invoice tax record is changed. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice line number.
taxCode
String
Invoice line tax code.
rateCode
String
Invoice line tax rate code.
newRptAmt
Decimal
Proposed reportable amount.
ds
A/R invoice data set.
OnChangeofTaxRgn This method should be called when the InvcHead.TaxRegionCode changes Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number
taxRegionCode
String
Proposed Tax Region Code.
ds
A/R invoice data set.
OnChangeofTermsCode This method should be called when the Terms Code changes. Parameters
194
Name
Type
Description
invoiceNum
Int32
Invoice Number.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
newTermsCode
String
Proposed Terms code.
ds
A/R invoice data set.
OnChangeOfTransApplyDate This method should be called before the transferred invoice apply date has been updated. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
newTransApplyDate
Nullable{System.DateTime}
Proposed Transferred Invoice Apply Date.
ds
A/R invoice data set.
OnChangeofUseSOCCDefaults This method should be called when the user changes the value in the UseSOCCdefaults. The UseSOCCdefaults allows the user to specify whether or not to use the sales order credit card info or enter it themselves.. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
useSOCC
Boolean
Use sales order credit card defaults.
ds
A/R invoice data set.
OnChangeTranDocTypeID Sets default values when the TranDocTypeID changes Parameters Name
Type
Description
ipTranDocTypeID
String
TranDocTypeID supplied
ds
OnChooseofPaySched Method to call when obtaining the payment schedule for the invoice header.
Epicor 9.05 | 9.05.605
195
A-E
Business Object Reference Guide
Parameters Name
Type
Description
invoiceNum
Int32
The invoice number
ds Returns
PrePostBOEInvoice This method should be called before a BOE Invoice is posted. If the GL is not interfaced the user will be asked to continue Y/N. If they choose N, the PostInvoices method should not be called. Parameters Name
Type
Description
ipBOEInvoiceNum
Int32
BOE Invoice Number.
ipTCOnline
Boolean
Tax Connect status.
glMessage
String@
Error messages generated.
glWarning
String@
Warning message.
PrePrintInvoices Purpose: Check if Taxes are calculated, for whole Group (ipInvoiceNum=0), or for one invoice (ipGroupID = "") Copied from Rpt/ARInvForm/ARInvForm.p Parameters Name
Type
Description
ipGroupID
String
Group ID
ipInvoiceNum
Int32
Invoice Num
RecalcAmortAmount Parameters Name
Type
Description
ipProposedPct
Decimal
proposed amortization percent
ds
196
A/R invoice data set.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
RecalcAmortPercent Parameters Name
Type
Description
ipProposedAmt
Decimal
proposed amortization amount
ds
A/R invoice data set.
RecalcDeferredTotals Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
RestoreAmortizationSchedule Parameters Name
Type
Description
ipInvoiceNum
Int32
Invoice Number
ipInvoiceLine
Int32
invoice line number
ds
A/R invoice data set
RMALineTax This method creates tax lines when we create invoice from RMA Processing Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number.
invoiceLine
Int32
Invoice Line Number
ds
ARInvoice dataset
SelectUninvoicedDropShipments Method to call to select uninvoiced drop shipments.
Epicor 9.05 | 9.05.605
197
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds Returns
SetReadyToCalc Parameters Name
Type
Description
ipGroupID
String
ipGroupID
ipInvoiceNum
Int32
ipInvoiceNum
ipCalcAll
Boolean
ipCalcAll
ds
ARInvoice dataset
UpdateMaster Parameters Name
Type
Description
cGroupID
String
current GroupID on Invoice
cTableName
String
Indicates the tableName that triggered the update
runCheckAmortSched
Boolean
Indicates whether the chkAmortSchedCore method should be called
runChkLtrOfCredit
Boolean
Indicates whether the chkLtrOfCredit method should be called
genAmortSched
Boolean@
Indicates whether Amortization schedules should be either restored or generated
lRASchedExists
Boolean
value of current InvcDtl.RASchedExists field
ipInvoiceNum
Int32
current invoice num used to call chkLtrOfCredCore
ipInvoiceLine
Int32
current invoice line
cARLOCID
String
current ARLOCID used to call chkLtrOfCredCore
suppressUserPrompts
Boolean
Indicates if user prompts should be suppressed
dTotalCharges
Decimal
InvcHead.InvoiceAmt used in call to CheckLtrOfCredit
grpTotalInvAmt
Decimal@
InvGrp.BaseAmount to update in UI
opGenMessage
String@
possible output message from chkAmortSchedCore
opLtrCrdMsg
String@
possible output message from chkLtrOfCredCore
lUpdateRan
Boolean@
Indicates that the Update process did run
ds
198
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateofPaySched Method to call when updating the payment schedule for the invoice header. The only reason the Parameters Name
Type
Description
invoiceNum
Int32
The invoice number
ds
VoidLegalNumber Voids the legal number. Parameters Name
Type
Description
ipInvoiceNum
Int32
Invoice number
ipVoidedReason
String
Reason for the void
Returns The Miscellaneous Shipment data set
GetLegalNumByInvcRefNum Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ARInvoiceLoad Epicor.Mfg.BO.ARInvoiceLoad: This business object contains 23 methods.
GetNewARInvoiceLoad Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
199
A-E
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AnotherInvoice Gets another invoice with the same customer and customer defaults..
200
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
priorCustNum
Int32
Customer number
priorLockRate
Boolean
Rate
Returns ARInvoiceLoad DataSet
GetCurrencyBase This method returns the Base CurrencyCode Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
GetTotals Gets the total base invoice amount for invoices available for posting. Parameters Name
Type
Description
totInvoiceAmt
Decimal@
The total amount for invoices available for posting.
currSymbol
String@
The base currency symbol.
OnChangeofApplyDate Called when the ApplyDate field changes. Validates the ApplyDate field. Updates the FiscalPeriod and FiscalYear fields. Parameters Name
Type
ds
Description ARInvoiceLoad DataSet
OnChangeofCreditMemo Called when the CreditMemo field changes. Reverses the sign of the InvoiceBal and DocInvoiceBal fields. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description ARInvoiceLoad DataSet
201
A-E
Business Object Reference Guide
OnChangeofCurrencyCode Called when the currency code changes. Gets the new currency information. Gets the xrate label and currency symbol. Recalc the DocInvoiceBal. Parameters Name
Type
ds
Description ARInvoiceLoad DataSet
OnChangeofCustomer Gets new defaults from the Customer table. Parameters Name
Type
ds
Description ARInvoiceLoad DataSet
OnChangeofDispInvoiceBal Called when the DispInvoiceBal field is changed. Updates the InvoiceBal, DocInvoiceBal, DispInvoiceBal and DocDispInvoiceBal fields. Parameters Name
Type
ds
Description ARInvoiceLoad DataSet
OnChangeofDocDispInvoiceBal Called when the DocDispInvoiceBal field is changed. Updates the InvoiceBal, DocInvoiceBal, DispInvoiceBal and DocDispInvoiceBal fields. Parameters Name
Type
ds
Description ARInvoiceLoad DataSet
OnChangeofDocInvoiceBal Called when the DocInvoiceBal field is changed. Updates the InvoiceBal, DocInvoiceBal, DispInvoiceBal, DocDispInvoiceBal and CreditMemo fields.
202
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description ARInvoiceLoad DataSet
OnChangeofExchangeRate Called when the ExchangeRate field changes. Updates the balance fields. Parameters Name
Type
ds
Description ARInvoiceLoad DataSet
OnChangeofFiscalPeriod Called when the FiscalPeriod field is changed. Validates the FiscalPeriod field. Parameters Name
Type
ds
Description ARInvoiceLoad DataSet
OnChangeofFiscalYear Called when the FiscalYear field changes. Validates the FiscalYear field. Parameters Name
Type
ds
Description ARInvoiceLoad DataSet
OnChangeofInvoiceBal Called when the InvoiceBal field is changed. Updates the InvoiceBal, DocInvoiceBal, DispInvoiceBal, DocDispInvoiceBal and CreditMemo fields. Parameters Name ds
Type
Description ARInvoiceLoad DataSet
OnChangeofInvoiceDate Called when the InvoiceDate field changes. Validates the InvoiceDate field. Updates the FiscalPeriod and FiscalYear fields and gets the correct exchange rate.
Epicor 9.05 | 9.05.605
203
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description ARInvoiceLoad DataSet
PostInvoices Sets the posted flag on the InvcHead records. The OK to post flag is used to determine what to do under certain circumstances. Parameters Name
Type
Description
oktoPost
Int32@
A value of zero will be sent back to the UI when the open balance does not match the total invoice amount and an error will be thrown. A value of one sent by the UI means it is ok to post, but the open balance must match the total invoice amount. A value of two sent by the UI means that it is ok to post when the open balance does not match total invoice amount. In this case the business logic will not set the error flag to zero and the ErrMsg parameter will not be set.
errMsg
String@
Error message
ARInvSearch Epicor.Mfg.BO.ARInvSearch: This business object contains 8 methods.
GetNewInvcHead Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
204
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListARTaxConfirmSearch Returns InvcHead records which have Taxes waiting for Confirmation. Parameters Name
Type
Description
invcHeadWhereClause
String
Whereclause for invcHead table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The ARInvSearch data set
Epicor 9.05 | 9.05.605
205
A-E
Business Object Reference Guide
ARLOC Epicor.Mfg.BO.ARLOC: This business object contains 17 methods.
GetNewARLOC Inserts a new row in the DataSet with defaults populated.
GetNewARLOCAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
206
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeBTCustID This method returns the Bill To customer info. Parameters Name
Type
Description
newBillToCustID
String
Proposed bill to custid
ds
The ARLOC data set
ChangeCurrencyCode Called when the CurrencyCode field has been changed. Parameters Name
Type
ds
Description The ARLOC data set
ChangeDocLCValue Called when the DocLCValue field has been changed. Parameters Name ds
Type
Description The ARLOC data set
GetARLOCInvoices This method will retrieve all the information related to AR Invoices.
Epicor 9.05 | 9.05.605
207
A-E
Business Object Reference Guide
Parameters Name
Type
Description
arlocid
String
AR Letters Of Credit ID
Returns The ARLOC data set
GetARLOCSOrders This method will retrieve all the information related to Sales Orders. Parameters Name
Type
Description
arlocid
String
AR Letters Of Credit ID
Returns The ARLOC data set
GetAvailBTList This procedure returns a list of Alternate Bill To Customer for a Customer. Parameters Name
Type
Description
pcCurComp
String
Current Company
piCustNum
Int32
Customer Number
pcCustID
String
Customer ID
cBillToList
String@
Delimited list of Customer ID Customer Named
OnChangeOfDocLCValue Called when changing the DocLCValue field. Parameters Name
Type
Description
proposedLCValue
Decimal
Proposed From Date
warningMsg
String@
Warning message
ds
The ARLOC data set
OnChangeOfFromDate Called when changing the FromDate field.
208
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
proposedFromDate
Nullable{System.DateTime}
Proposed From Date
ds
The ARLOC data set
OnChangeOfToDate Called when changing the ToDate field. Parameters Name
Type
Description
proposedToDate
Nullable{System.DateTime}
Proposed To Date
ds
The ARLOC data set
ARPIStatusChg Epicor.Mfg.BO.ARPIStatusChg: This business object contains 20 methods.
GetNewARPNHead Inserts a new row in the DataSet with defaults populated.
GetNewARPNDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
209
A-E
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AddSinglePI Add a single PI to the group
210
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
piGroup
String
Header Group ID
piHeadNum
Int32
Header Number
piNewGroup
String
New Group ID
piGrpStatus
String
Group Status
Returns The Status Change data set
AssignLegalNumber Assigns a legal number to the status change. Parameters Name
Type
Description
ipGroupID
String
Group ID
ipHeadNum
Int32
Payment Instrument Head Number
String@
Legal number message
ds opLegalNumMsg Returns The Status Change data set
BankExport Create Bank Export output file Parameters Name
Type
Description
ipGroupID
String
Group ID
ipFileFormat
Int32
Output File Format
ipOutFileName
String
Output Filename
DeleteLastARPNMove Parameters Name
Type
Description
ipGroupID
String
ipGroupID
Epicor 9.05 | 9.05.605
211
A-E
Business Object Reference Guide
GetByGroup Get Current ARPNHead records by group Parameters Name
Type
Description
piGroup
String
Group ID
morePages
Boolean@
more pages
Returns The Status Change data set
GetLegalNumGenOpts Returns the legal number generation options. Parameters Name
Type
Description
ipGroupID
String
Group ID
ipHeadNum
Int32
Payment Instrument Head Number
ipStatusChgTranDocType
String
Document Type for the status change
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
PrePost Parameters Name
Type
Description
piGroup
String
Group ID
poRunGL
String@
poRunGL
RemoveFromGroup Removes AR PN records from the current group Returns The Status Change data set
SelectPI Select Payment Instruments to add to group
212
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
piGroup
String
Group ID
piGrpStatus
String
Group Status
piFromDate
Nullable{System.DateTime}
From DueDate
piToDate
Nullable{System.DateTime}
To DueDate
piType
String
PI Type
piCustFilter
String
Customer Filter
piCurrencyFilter
String
Currency Filter
piStatusFilter
String
StatusFilter
Returns The Status Change list data set
SelectPIData Select Payment Instruments to add to group Parameters Name
Type
Description
piGroup
String
Group ID
piGrpStatus
String
Group Status
piType
String
PI Type
piPIList
String
PI List
ds Returns The Status Change data set
VoidLegalNumber Voids the legal number. Parameters Name
Type
Description
ipGroupID
String
Group ID
ipHeadNum
Int32
Payment Instrument Head Number
ipVoidedReason
String
Reason for the void
Returns The Status Change data set
Epicor 9.05 | 9.05.605
213
A-E
Business Object Reference Guide
ARPIWriteOff Epicor.Mfg.BO.ARPIWriteOff: This business object contains 15 methods.
GetNewARPNHead Inserts a new row in the DataSet with defaults populated.
GetNewARPNMove Inserts a new row in the DataSet with defaults populated.
GetNewARPNMoveTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
214
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckGLInterface Call this method once to validate the G/L Interface. This method checks for GLSyst availability and if G/L is interfaced with A/P. If A/P is not interfaced with G/L then user should be asked if okay to continue without posting to G/L. This method will return a Message for the user if not interfaced else the Message is blank. If the user do not wish to continue then exit this object. This method also returns a logical flag to indicate if Posting to G/L. This value should be passed on to each new A/P Adjustment (ARPNMove) record to process. Parameters Name
Type
Description
opMessage
String@
The Message to ask the user if A/P is not interfaced with G/L.
opPostToGL
Boolean@
Indicates if the A/P Adjustment will be Posted to G/L.
CheckPNoteExisted Parameters Name
Type
Description
ipPIType
String
ipPIType
ipID
String
ipID
ipCustID
String
ipCustID
opRet
String@
opRet
Epicor 9.05 | 9.05.605
215
A-E
Business Object Reference Guide
GetARPNList Parameters Name
Type
Description
ipType
String
ipType
ipPNID
String
ipPNID
ipCustID
String
ipCustID
Returns The AR Promissory Notes data set for Write Off
GetGroupIDForPI This method will retrieve the GroupID for an ARPNHead record that's for the ARPromNoteID supplied. Parameters Name
Type
Description
arPromNoteID
String
AR Promissory Note ID
groupID
String@
Cash Group ID
headNum
Int32@
HeadNum
GetNewARPNMove1 This method is to be used in place of GetNewARPNMove. This method asks for vendor number and invoice number to link the A/R Invoice Header (ARPNHead) to A/R Invoice Adjustment (ARPNMove). Parameters Name
Type
Description
ds
The AR Promissory Notes data set for Write Off
ipGroupID
String
The Group ID for this A/R Promissory Note Head
ipHeadNum
Int32
The A/R Promissory Note Head Number
GetPNByID Parameters
216
Name
Type
Description
ipHeadNum
Int32
ipHeadNum
ipPIType
String
ipPIType
ipID
String
ipID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipCustID
String
ipCustID
ipCurGroupID
String
ipCurGroupID
ipNewPIType
String
ipNewPIType
ds
The AR Promissory Notes data set for Write Off
ARPromissoryNotes Epicor.Mfg.BO.ARPromissoryNotes: This business object contains 76 methods.
GetNewARPNHead Inserts a new row in the DataSet with defaults populated.
GetNewBankTran Inserts a new row in the DataSet with defaults populated.
GetNewBankTranTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewBankTranTGLC Inserts a new row in the DataSet with defaults populated.
GetNewARPNDtl Inserts a new row in the DataSet with defaults populated.
GetNewARPNDTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewARPNHeadTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
217
A-E
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
218
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AssignLegalNumber Assigns a legal number to the miscellaneous shipment. Parameters Name
Type
Description
ipGroupID
String
Group ID number
ipHeadNum
Int32
Header number
String@
Legal number message
ds opLegalNumMsg
Epicor 9.05 | 9.05.605
219
A-E
Business Object Reference Guide
Returns The Promissory Note data set
BatchGenPIs Parameters Name
Type
Description
ipCutOffDate
Nullable{System.DateTime}
ipCutOffDate
ipPIStatus
String
ipPIStatus
ipPmntMeth
String
ipPmntMeth
ipGroupID
String
ipGroupID
ipCurrencyCode
String
ipCurrencyCode
Returns The Promissory Note data set
CancelGenPI Parameters Name
Type
Description
ipARPNID
String
ipARPNID
ipInvoiceNum
Int32
ipInvoiceNum
Name
Type
Description
ipHeadNum
Int32
ipHeadNum
ipID
String
ipID
ipCustID
String
ipCustID
ipCurGroupID
String
ipCurGroupID
ipNewPIType
String
ipNewPIType
ChangeCurGroupID Parameters
ChangeTranAmt This method updates the BankTran amounts when the adjustment amount changes or the currency switch toggles.
220
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipTranAmtType
String
Indicate which of the transaction amount is changed. Valid values are: 'B' for Base Tran Amount and 'D' for Doc Tran Amount
proposedTranAmt
Decimal
The proposed Transaction Amount
ds
The AR Promissory Notes data set
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
GroupID
keyValue2
String
HeadNum
checkPNoteExisted Parameters Name
Type
Description
ipPIType
String
ipPIType
ipID
String
ipID
ipCustID
String
ipCustID
opRet
String@
opRet
CheckPNotesExistTracker Checks to see if any AR Promissory Notes exist for a given promissory note ID regardless of customer number or PI type Parameters Name
Type
Description
ipID
String
ipID
opRet
String@
opRet
headNum
Int32@
HeadNum for promissory note ID
groupID
String@
groupID for promissory note ID
Epicor 9.05 | 9.05.605
221
A-E
Business Object Reference Guide
createARPNMove Parameters Name
Type
Description
ipGroupID
String
ipGroupID
ipHeadNum
Int32
ipHeadNum
ipCurGroupID
String
ipCurGroupID
ipPIStatus
String
ipPIStatus
ipPIType
String
ipPIType
ipPIStage
String
ipPIStage
DeletePICashGroup This method deletes a CashGrp from AR Invoice Entry Parameters Name
Type
Description
groupID
String
Cash Group ID
DeletePNbyID Parameters Name
Type
Description
ipGroupID
String
ipGroupID
ipHeadNum
Int32
ipHeadNum
DeletePNotes Parameters Name
Type
Description
ipGroupID
String
ipGroupID
FillPNSummary Method to call when obtaining the payment schedule for the invoice header.
222
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipcustNum
Int32
The customer number
ipStageFilter
String
All, Open, Closed, or New
Returns
GenerateARPNDtl This method combines the GetNewARPNDtl and Update() method into one routine so that the user can run an "Auto Apply" cash receipt function Parameters Name
Type
Description
groupID
String
Cash Group ID
headNum
Int32
Promissory Note HeadNum
invoiceNum
Int32
Promissory Note Invoice Num
Returns AR Promissory Notes data set
GetARPNList Parameters Name
Type
Description
ipType
String
ipType
ipPNID
String
ipPNID
ipCustID
String
ipCustID
Returns The Promissory Note data set
GetARPNListTracker Create a list of ARPN for a certail ARPromNoteID regardless of customer, type or post status Parameters Name
Type
Description
ipPNID
String
ipPNID
Returns The Promissory Note data set
Epicor 9.05 | 9.05.605
223
A-E
Business Object Reference Guide
GetARPNMove Get the ARPNMove records for an ARPromissoryNote. Parameters Name
Type
Description
iGroupID
String
The Group Number
iHeadNum
Int32
The Header Number
Returns The ARPNMove data set
GetBankAcctInfo This method is called when the BankAcctID field is modified Parameters Name
Type
Description
bankAcctID
String
Proposed BankAcctID
ds
AR Promissory Notes data set
GetById4PITracker Procedure wrapper for procedure GetById for PI tracker to prevent removing ARPNHead when there is not corresponded record in CashGrp table.(It was removed after posting in post_post file) Parameters Name
Type
Description
ipGroupID
String
Group ID
ipHeadNum
Int32
Head Num
ds
AR Promissory Notes data set
GetCurrencyCodeForBatch Parameters
224
Name
Type
Description
ipGroupID
String
ipGroupID
opCurrencyCode
String@
ipCurrencyCode
opDefaultFound
Boolean@
ipDefaultFound
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetCurrencyInfo This method is used when the Currency Code changes for Invoice payments only Parameters Name
Type
Description
currencyCode
String
Proposed Currency Code
ds
AR Promissory Notes data set
GetCurrencyInfoMaster This method is used when the Currency Code changes for Invoice payments only Parameters Name
Type
Description
currencyCode
String
Proposed Currency Code
ds
AR Promissory Notes data set
GetCustomerInfo This method is called when the CustID field is modified Parameters Name
Type
Description
custID
String
Proposed Customer ID
ds
AR Promissory Notes data set
GetCustPIFlags This method gets the AutoGenPromNotes and DirectDebiting flags from the Customer record. Also sets the flag hasBank to true if there are CustBank records associated to the Customer and false if not. Parameters Name
Type
Description
custID
String
CustID for Customer
autoGenPromNotes
Boolean@
Value of AutoGenPromNotes field
directDebiting
Boolean@
Value of DirectDebiting field
hasBank
Boolean@
True if Customer has a least one CustBank record
Epicor 9.05 | 9.05.605
225
A-E
Business Object Reference Guide
GetDtlInvoiceInfo This method is called when the InvoiceNum field is modified Parameters Name
Type
Description
invoiceNum
Int32
Proposed Invoice Number
ds
AR Promissory Notes data set
GetDtlLegalNumberInfo This method is called when the InvLegalNumber field is modified Parameters Name
Type
Description
legalNumber
String
Proposed Legal Number
ds
AR Promissory Notes data set
GetDtlTranAmtInfo This method is run when the DocTranAmt field is modified Parameters Name
Type
Description
docTranAmt
Decimal
Proposed transaction amount
ds
AR Promissory Notes data set
GetGLJrnDtl Get the GLJrnDtl records for an ARPromissoryNote. Parameters Name
Type
Description
iGroupID
String
The Group Number
iHeadNum
Int32
The Header Number
Returns The GLJrnDtlMov data set
GetGroupIDForPI This method will retrieve the GroupID for an ARPNHead record that's for the ARPromNoteID supplied.
226
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
arPromNoteID
String
AR Promissory Note ID
groupID
String@
Cash Group ID
headNum
Int32@
HeadNum
GetHdrInvoiceInfo This method will default customer information from an invoice. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number to get Customer information from
ds
AR Promissory Notes data set
GetHdrLegalNumberInfo This method will default customer information from an invoice. Parameters Name
Type
Description
legalNumber
String
Legal Number to get Customer information from
ds
AR Promissory Notes data set
GetHeadNumForPI This method will retrieve the HeadNum for an ARPNHead record that's for the invoice number supplied. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number
headNum
Int32@
ARPN Head Num
GetInvcsSinglGenPI Retur list of open posted AR invoices for a specific Customer. Parameters Name
Type
Description
ipCustID
String
customer ID
Epicor 9.05 | 9.05.605
227
A-E
Business Object Reference Guide
Name
Type
Description
ipCurrencyCode
String
currency code
Returns Invoices for customer data set
GetLegalNumberInfo This method is called when the InvLegalNumber field is modified Parameters Name
Type
Description
legalNumber
String
Proposed Legal Number
ds
AR Promissory Notes data set
GetLegalNumGenOpts Returns the legal number generation options. Parameters Name
Type
Description
ipGroupID
String
Group ID number
ipHeadNum
Int32
Header number
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
GetNewARPNHeadByGroupID Alternate routine to create new Payment Instrument Parameters Name
Type
Description
piGroupID
String
Group ID
ds
The AR Promissory Notes data set
GetNewARPNHeadByInvoiceNum Alternate routine to create new Payment Instrument from AR Invoice Entry
228
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number to create Payment Instrument for
ds
The AR Promissory Notes data set
GetNewBankTranByHeadNum Alternate routine to load the Bank Fee Parameters Name
Type
Description
lvHeadNum
Int32
Bank Fee Code
lvBankAcctID
String
Bank Account ID
ds
The AR Promissory Notes data set
getPITypePropByPMUID Parameters Name
Type
Description
ipPMUID
Int32
PMUID
opCustBankDtl
Boolean@
CustBankDtl
opInitiation
String@
Initiation
opBankAcctID
String@
BankAcctID
GetPNotesByGroupID Parameters Name
Type
Description
ipGroupID
String
ipGroupID
Returns The Promissory Note List data set
GetRateCodeInfo This method updates the dataset when the RateCode field changes
Epicor 9.05 | 9.05.605
229
A-E
Business Object Reference Guide
Parameters Name
Type
Description
rateCode
String
Proposed RateCode value
taxtbl
String
Tax temp-table name
ds
AR Promissory Notes data set
GetRowsByGrpID Parameters Name
Type
Description
ipGroupiD
String
Group ID
Returns The Promissory Note data set
GetSalesTaxInfo This method updates the dataset when the TaxCode field changes Parameters Name
Type
Description
taxCode
String
Proposed TaxCode value
taxtbl
String
Tax temp-table name
ds
AR Promissory Notes data set
GetTaxableInfo This method is called when the Taxable Amount Tax Percent or Fixed Amount is changed to recalculate the Tax Total Parameters Name
Type
Description
taxableAmt
Decimal
Proposed new taxable Amount
taxPercent
Decimal
Proposed Tax Percent
fixedAmount
Decimal
Propoed Fixed Amount
taxtbl
String
tax temp-table name
ds
230
AR Promissory Notes data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetTranAmt This method upates the TranAmt/DocTranAmt field after the TranAmt, DocTranAmt or ExchangeRate field is updated. If BaseEntered flag is yes, the TranAmt and DocTranAmt fields will be used to calculat the exchangeRate. Otherwise, the TranAmt will be calculated using the exchangeRate and DocTranAmt fields. Parameters Name
Type
Description
baseEntered
Boolean
If the TranAmt field was updated then value should be yes, otherwise no
ds
AR Promissory Notes data set
GetUnapprovedPI This function will retrived existing Unapproved Stage PIs and pull them into the group to be converted to Portfolio Stage PIs. Parameters Name
Type
Description
piGroup
String
Group ID
piPayMethodFilter
String
PayMethodFilter Filter
Returns The Promissory Note List data set
LeaveARPNHead This method checks calculates the GainLoss Adjustment record when finally leaving a ARPNHead record after adding/updating all the ARPNDtl records Parameters Name
Type
Description
groupID
String
Cash Receipt Group ID
headNum
Int32
Cash Receipt number
onAccount
Boolean
Indicates if excess cash should go on account
ds
AR Promissory Notes data set
MarkSent This method marks a Promissory Note as "Sent".
Epicor 9.05 | 9.05.605
231
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
AR Promissory Notes Data Set
MarkSigned This method marks a Promissory Note as "Signed". Parameters Name
Type
Description
ds
AR Promissory Notes Data Set
OnChangeBankFeeID Validate for a Correct Bank Fee Code Parameters Name
Type
Description
pcBankFeeID
String
Bank Fee Code
ds
The AR Promissory Notes Entry data set
OnChangeType Run when user changes Payment Instrument type Parameters Name
Type
Description
pcType
String
Payment Instrument Type
ds
The AR Promissory Notes Entry data set
PostPIGroupWithoutGL PostPIGroupWithoutGL is to update ARPNMove records and delete CashGrp if all ARPNMove records were posted. Parameters
232
Name
Type
Description
ipGroupID
String
Group ID of PI
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
PostPNWithoutGL Parameters Name
Type
Description
ipGroupID
String
ipGroupID
RecalcARPNDTax This method is called after the TaxAmt is changed to recalculate the doc or base tax amounts Parameters Name
Type
Description
ds
AR Promissory Notes data set
RecalcBankTax This method is called after the TaxAmt is changed to recalculate the doc or base tax amounts Parameters Name
Type
Description
ds
ARPromissoryNotes data set
RecalcTax This method is called after the TaxAmt is changed to recalculate the doc or base tax amounts Parameters Name
Type
Description
ds
ARPromissoryNotes data set
SetReadyToCalc Parameters Name
Type
Description
ipGroupID
String
ipGroupID
ipHeadNum
Int32
ipHeadNum
ipInvoiceNum
Int32
ipInvoiceNum
ipInvoiceRef
Int32
ipInvoiceRef
ipBankAcctID
String
ipBankAcctID
Epicor 9.05 | 9.05.605
233
A-E
Business Object Reference Guide
Name
Type
Description
ipTranNum
Int32
ipTranNum
ipVoided
Boolean
ipVoided
ipCalcAll
Boolean
ipCalcAll
ds
AR Promissory Notes dataset
SingleGenPI Parameters Name
Type
Description
ipCustNum
Int32
ipCustNum
ipPIStatus
String
ipPIStatus
ipPIType
String
ipPIType
ipInvcList
String
ipInvcList
ipGroupID
String
ipGroupID
ipCurrencyCode
String
ipCurrencyCode
Returns The Promissory Note data set
VoidLegalNumber Voids the legal number. Parameters Name
Type
Description
ipGroupID
String
Group ID number
ipHeadNum
Int32
Header number
ipVoidedReason
String
Reason for the void
Returns The Promissory Note data set
AssetAddEntry Epicor.Mfg.BO.AssetAddEntry: This business object contains 27 methods.
GetNewFAAddition Inserts a new row in the DataSet with defaults populated.
234
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetNewFAAddReg Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
235
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
LeaveAdded To be called on leave of FAAddition.Added field to update costs based on new exchange rate derived from this apply date. Parameters Name
Type
Description
ipAdded
Nullable{System.DateTime}
Added Date that was entered.
ds
The FAAddition data set
LeaveAdditionCost To be called on leave of addition cost field to update the Book Value field. Parameters Name
Type
Description
ipAdditionCost
Decimal
AdditionCost that was entered.
ipbaseordoc
String
The field type - base or doc
ds
The FAAddition data set
LeaveAdditionType To be called on leave of AdditionType field
236
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipAdditionType
String
addition type that was selected.
ds
Asset Add Entry data set
LeaveGrantAmt To be called on leave of grant amount field to update the Book Value field. Parameters Name
Type
Description
ipGrantAmt
Decimal
GrantAmt that was entered.
ipbaseordoc
String
The field type - base or doc
ds
The FAAddition data set
LeaveInterGroup To be called on leave of FAAddition.InterGroup field to populate or delete the miscellaneous addition registers (FAAddReg). Parameters Name
Type
Description
ipInterGroup
Boolean
InterGroup value that was entered.
ds
The FAAddition data set
LeaveInvoiceLine Called on the leave of FAAddition.InvoiceLine for validation purpose. Parameters Name
Type
Description
ipInvoiceLine
Int32
Invoice Line Number that was entered.
ds
The FAAddition data set
LeaveInvoiceNum Called on the leave of Invoice Number for validation purpose.
Epicor 9.05 | 9.05.605
237
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipInvoiceNum
String
Invoice Number that was entered.
ds
The FAAddition data set
LeaveJobNum To be called on leave of Job Number field for validating an existing Job. Parameters Name
Type
Description
ipJobNum
String
Job Number that was entered.
ds
The FAAddition data set
LeaveLotNum To be called on leave of FAAddition.LotNum field Parameters Name
Type
Description
ipLotNum
String
Lot Number that was entered.
ds
Asset Addition Entry data set
LeavePartNum To be called on leave of FAAddition.PartNum field Parameters Name
Type
Description
ipPartNum
String
partnum that was entered.
ds
Asset Addition Entry data set
LeavePONum To be called on leave of VendorID field to validate an existing PO Parameters Name
Type
Description
ipPONum
Int32
PO Number that was entered.
ds
238
The AssetAddEntry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
LeaveRegCurrDepreciation To be called on leave of FAAddReg.CurrDepreciation field to update the Book Value field. Parameters Name
Type
Description
ipAssetNum
String
asset number
ipAdditionNum
Int32
asset addition number
ipAssetRegID
String
asset register ID
ipCurrDepreciation
Decimal
current depreciation that was entered.
ipAdditionCost
Decimal
addition cost
ipGrantAmt
Decimal
grant amount
ipBaseOrDoc
String
The field type - base or doc
ds
The FAAddition data set
LeaveRegCurrGrantDep To be called on leave of FAAddReg.CurrGrantDep field to update the Grant Book Value field. Parameters Name
Type
Description
ipAssetNum
String
asset number
ipAdditionNum
Int32
asset addition number
ipAssetRegID
String
asset register ID
ipCurrGrantDep
Decimal
current depreciation that was entered.
ipGrantAmt
Decimal
grant amount
ipBaseOrDoc
String
The field type - base or doc
ds
The FAAddition data set
LeaveRegPrevDepreciation To be called on leave of FAAddReg.PrevDepreciation field to update the Book Value field. Parameters Name
Type
Description
ipAssetNum
String
asset number
ipAdditionNum
Int32
asset addition number
ipAssetRegID
String
asset register ID
Epicor 9.05 | 9.05.605
239
A-E
Business Object Reference Guide
Name
Type
Description
ipPrevDepreciation
Decimal
previous years depreciation that was entered.
ipAdditionCost
Decimal
addition cost
ipGrantAmt
Decimal
grant amount
ipBaseOrDoc
String
The field type - base or doc
ds
The FAAddition data set
LeaveRegPrevGrantDep To be called on leave of FAAddReg.PrevGrantDep field to update the Grant Book Value field. Parameters Name
Type
Description
ipAssetNum
String
asset number
ipAdditionNum
Int32
asset addition number
ipAssetRegID
String
asset register ID
ipPrevGrantDep
Decimal
current depreciation that was entered.
ipGrantAmt
Decimal
grant amount
ipBaseOrDoc
String
The field type - base or doc
ds
The FAAddition data set
LeaveTransferQty To be called on leave of FAAddition.TransferQty field. This qty is always expressed in IUM. Parameters Name
Type
Description
ipTransferQty
Decimal
Transfer Qty that was entered.
ds
Asset Addition Entry data set
LeaveVendorID To be called on leave of VendorID field to validate an existing Vendor Parameters Name
Type
Description
ipVendorID
String
VendorID or SupplierID that was entered.
ds
240
The AssetAddEntry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
LeaveWarehouse To be called on leave of FAAddition.WarehouseCode field. Parameters Name
Type
Description
ipWarehouseCode
String
Warehouse Code that was entered.
ds
Asset Addition Entry data set
AssetClosePeriod Epicor.Mfg.BO.AssetClosePeriod: This business object contains 9 methods.
GetNewFiscalPer Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
241
A-E
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckYearEndStatus Returns a logical value to indicate if the Year End Process should be enabled. Parameters Name
Type
Description
ipCalendarID
String
The input fiscal calendar ID
ipYear
Int32
The input fiscal year
ipYearSuffix
String
The input fiscal year suffix
opAllowed
Boolean@
Logical value to indicate if Year End Process is allowed
OnChangeFAClosedPeriod Run when the FiscalPer.FAClosedPeriod field changes. Parameters Name
Type
Description
ipProposedValue
Boolean
Value that the user has entered (yes/no)
opMessage
String@
Warning message to the user
ds
242
The AssetClosePeriod data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
AssetDispEntry Epicor.Mfg.BO.AssetDispEntry: This business object contains 19 methods.
GetNewFADisposal Inserts a new row in the DataSet with defaults populated.
GetNewFADispReg Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
243
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
LeaveCustID To be called on leave of custid field Parameters Name
Type
Description
ipcustid
String
custid that was entered.
ds
Asset Disposal Entry data set
LeaveDisposalCost To be called on leave of DisposalCost field Parameters Name
Type
Description
ipdisposalcost
Decimal
disposalcost that was entered.
ipbaseordoc
String
The field type - base or doc
ds
244
Asset Disposal Entry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
LeaveDisposalType To be called on leave of DisposalType field Parameters Name
Type
Description
ipdisposaltype
String
disposal type that was selected.
ds
Asset Disposal Entry data set
LeaveJobNum To be called on leave of Job Number field Parameters Name
Type
Description
ipjobnum
String
jobnum that was entered.
ds
The AssetDispEntryDataSet data set
LeaveOrderNum To be called on leave of ordernum field Parameters Name
Type
Description
ipordernum
Int32
ordernum that was entered.
ds
Asset Disposal Entry data set
LeavePartNum To be called on leave of partnum field Parameters Name
Type
Description
ippartnum
String
partnum that was entered.
ds
Asset Disposal Entry data set
LeaveProceed To be called on leave of Proceed field
Epicor 9.05 | 9.05.605
245
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipproceed
Decimal
disposalcost that was entered.
ipbaseordoc
String
The field type - base or doc
ds
Asset Disposal Entry data set
LeaveRegCurrDepreciation To be called on leave of FADispReg.CurrDepreciation field Parameters Name
Type
Description
ipcurrdepreciation
Decimal
current depreciation that was entered.
ipdisposalcost
Decimal
disposal cost
ipbaseordoc
String
The field type - base or doc
ds
Asset Disposal Entry data set
LeaveRegPrevDepreciation To be called on leave of FADispReg.PrevDepreciation field Parameters Name
Type
Description
ipprevdepreciation
Decimal
previous depreciation that was entered.
ipdisposalcost
Decimal
disposal cost
ipbaseordoc
String
The field type - base or doc
ds
Asset Disposal Entry data set
RecalcRegDefaults Recalculates default values for FADispReg depreciation values Parameters Name
Type
Description
inassetnum
String
The Asset Number to recalc for.
indisposalnum
Int32
The Disposal Number
ds
246
Asset Disposal Entry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
AssetImpair Epicor.Mfg.BO.AssetImpair: This business object contains 8 methods.
GetNewFAImpairment Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
247
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeImpairmentCost Method to call when changing the impairment cost. Parameters Name
Type
Description
proposedImpairCost
Decimal
The proposed impairment cost
baseOrDoc
String
The field type - base or doc
ds
The AssetImpair data set
ATP Epicor.Mfg.BO.ATP: This business object contains 6 methods.
Forecast Call this method from Forecast button of ATP screen. Parameters Name
Type
Description
pcPartNum
String
Part number.
pcPlant
String
Plant
pdtStartDate
Nullable{System.DateTime}
Start Date
Returns Returns Epicor.Mfg.BO.ATPForecastDataSet
OnChangeField When the user changes the value of any field except Plant and Part call this method.
248
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
pcFieldName
String
Field name from where this method is called.
pcPartNum
String
Part number.
pcPlant
String
Plant
pcRowIdent
String@
RowIdent of AvailableToPromise datatable. If non-blank, reposition the AvailableToPromise browse to the row with this value of RowIdent.
ds
Returns Epicor.Mfg.BO.ATPDataSet
OnChangePlant When the user changes the Plant, call this method. Parameters Name
Type
Description
pcPartNum
String
Part number.
pcPlant
String
Plant
Returns Returns Epicor.Mfg.BO.ATPDataSet
ProjectedReceipts Call this method from Receipts button of ATP screen. Parameters Name
Type
Description
pcPartNum
String
Part number.
pcPlant
String
Plant
Returns Returns Epicor.Mfg.BO.ProjectedReceiptsDataSet
SalesOrder Call this method from Sales Order button of ATP screen. Parameters Name
Type
Description
pcPartNum
String
Part number.
pcPlant
String
Plant
Epicor 9.05 | 9.05.605
249
A-E
Business Object Reference Guide
Name
Type
Description
pdtStartDate
Nullable{System.DateTime}
Start Date
Returns Returns Epicor.Mfg.BO.ATPOrderRelDataSet
TransferOrder Call this method from Transfer Order button of ATP screen. Parameters Name
Type
Description
pcPartNum
String
Part number.
pcPlant
String
Plant
pdtStartDate
Nullable{System.DateTime}
Start Date
Returns Returns Epicor.Mfg.BO.ATPTFOrderDataSet
Attachment Epicor.Mfg.BO.Attachment: This business object contains 8 methods.
GetNewXFileAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
250
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetPathReferences Returns a list of rows that reference the same path. Parameters Name
Type
Description
path
String
The path to match.
Returns The list DataSet.
AttrBin Epicor.Mfg.BO.AttrBin: This business object contains 9 methods.
GetNewAttrBin Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
251
A-E
Business Object Reference Guide
GetNewAttrBinAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
252
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
Attribut Epicor.Mfg.BO.Attribut: This business object contains 7 methods.
GetNewAttribut Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
253
A-E
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AttrWhseGroup Epicor.Mfg.BO.AttrWhseGroup: This business object contains 9 methods.
GetNewAttrWhseGroup Inserts a new row in the DataSet with defaults populated.
GetNewAttrWhseGroupAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
254
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
255
A-E
Business Object Reference Guide
Returns
AutoRpt Epicor.Mfg.BO.AutoRpt: This business object contains 10 methods.
GetNewAutoRpt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
256
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AutoPrintReport Emulates the Auto-Printing of a Report like if it was fired from a BAM Action. Parameters Name
Type
Description
ipTableName
String
Table Name
ipReportID
String
Report ID
ipRptDefID
String
Data Definition ID used by the Report
ipTableRowId
String
RowId of a row of the Table where the BAM we want to emulate was defined.
ReportCanAutoPrint Checks if a given Report can be used on Auto-Print actions in BAMs Parameters Name
Type
Description
ipReportID
String
Report ID
canAutoPrint
Boolean@
Indicates if the given Report can be used on Auto-Print actions in BAMs
TableCanAutoPrint Checks if a given table can enable the Auto-Print action in BAMs Parameters Name
Type
Description
ipTableName
String
Table Name
canAutoPrint
Boolean@
Indicates if the given table can enable the Auto-Print action in a BAM
Epicor 9.05 | 9.05.605
257
A-E
Business Object Reference Guide
AutoTranReversal Epicor.Mfg.BO.AutoTranReversal: This business object contains 5 methods.
CheckReverseDate Check if New Reversing Apply Date is valid or not. Parameters Name
Type
Description
reverseDate
Nullable{System.DateTime}
Reversing Apply Date
bookID
String
BookID
DeleteLinkingMemos Delete linking memos is posting was not run. Parameters Name
Type
Description
iABTUID
String
ABTUID of GLTransaction.
ds
Epicor.Mfg.BO.AutoTranReversalDataSet
GetGLTranList Get a list of GL journal Lines. Parameters Name
Type
Description
abtUID
String
ABTUID for the search. Epicor.Mfg.BO.AutoTranReversalDataSet
GetList Returns a list of rows that satisfy the where clause. Parameters
258
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Post Post Parameters Name
Type
ds outErrorMessage
Epicor 9.05 | 9.05.605
Description DataSet
String@
outErrorMessage
259
A-E
Business Object Reference Guide
Chapter 2: B BackflushLabor Epicor.Mfg.BO.BackflushLabor: This business object contains 2 methods. Run BackFlushLabor Get company list Returns BackflushLabor data set
BankAcct Epicor.Mfg.BO.BankAcct: This business object contains 19 methods.
GetNewBankAcct Inserts a new row in the DataSet with defaults populated.
GetNewBankAcctAttch Inserts a new row in the DataSet with defaults populated.
GetNewBankPayMethod Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
260
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeBankBranchCode Check if the Bank Branch code changed.
Epicor 9.05 | 9.05.605
261
A-E
Business Object Reference Guide
Parameters Name
Type
Description
proposedBankBranchCode
String
The proposed Bank Branch code
ds
BankAcct data set
ChangeDebNoteOnly Check if the Bank DebNoteOnly flag could be changed. Parameters Name
Type
ds debNoteOnly
Description Bank Acct data set
Boolean
Proposed value of the flag
ChangeLOCLimit Method to call when changing the Limit of Credit amount on an Bank record. Updates BankAcct amounts based on the new Limit of Credit amount. Parameters Name
Type
Description
proposedLOCLimit
Decimal
The proposed Limit amount
ds
The Bank Account data set
GetAPLOCClosed This method will retrieve information about Letter of Credit with status Closed Parameters Name
Type
Description
bankAcctID
String
Bank Account ID
Returns The APLOC data set
GetAPLOCOpen This method will retrieve information about Letter of Credit with status Open Parameters
262
Name
Type
Description
bankAcctID
String
Bank Account ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The APLOC data set
GetBankBal Get bank balance. Parameters Name
Type
Description
fyear
Int32
Fiscal Year
fyearsuffix
String
Fiscal Year Suffix
bankID
String
Bank ID
Returns Balance data set
GetCurrencyBase This method returns the Base Currency Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
BankAdjEntry Epicor.Mfg.BO.BankAdjEntry: This business object contains 29 methods.
GetNewBankGrp Inserts a new row in the DataSet with defaults populated.
GetNewBankTran Inserts a new row in the DataSet with defaults populated.
GetNewBankTranTaxDtl Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
263
A-E
Business Object Reference Guide
GetNewBankTranTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
264
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
BeforeGetBankGrp This method checks to see if the selected Bank Group is valid (i.e. not in use by other user and not a CashBook entry) before fetching the dataset. Parameters Name
Type
Description
groupID
String
Selected Bank Group ID
Epicor 9.05 | 9.05.605
265
A-E
Business Object Reference Guide
ChangeGrpBankAcct Call this method to update the BankGrp Bank Account information when the Bank Account ID changes. Parameters Name
Type
Description
proposedBankAcctID
String
The proposed Bank Account ID
ds
The Bank Adjustment Entry data set
ChangeGrpTranDate Call this method to update the BankGrp fiscal period and year when the transaction date changes. Parameters Name
Type
Description
proposedTranDate
Nullable{System.DateTime}
The proposed Transaction Date
ds
The Bank Adjustment Entry data set
ChangeTranAmt This method updates the BankTran amounts when the adjustment amount changes or the currency switch toggles. Parameters Name
Type
Description
ipTranAmtType
String
Indicate which of the transaction amount is changed. Valid values are: 'B' for Base Tran Amount and 'D' for Doc Tran Amount
proposedTranAmt
Decimal
The proposed Transaction Amount
ds
The Bank Adjustment Entry data set
ChangeTranDate Call this method to update the Rate field when the Adjustment Transaction date changes. Parameters Name
Type
Description
proposedTranDate
Nullable{System.DateTime}
The proposed Adjustment Transaction Date
ds
266
The Bank Adjustment Entry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
vGroupID
String
GroupID
DeleteZeroAmtTaxRec This method deletes TaxDtl records which have zero amounts Since Payments TAx logic calculates tax conditionally only for the first tax line the invoice could have multiple zero tax records. Parameters Name
Type
Description
postGroupID
String
The Group ID of the Group to post
GetByTranNum Same functionality as GetByID. Except you can use BankAcctID and TranNum to fetch the BankAdjEntryDataSet. Parameters Name
Type
Description
pcBankAcctID
String
Bank Acct ID
piTranNum
Int32
BankTran.TranNum
plVoided
Boolean
BankTran.Voided
Returns The Bank Adjustment Entry data set
GetNewBankTran1 This method is to be used in place of GetNewBankTran. This method asks for Group ID to link the Bank Adjustment Group (BankGrp) to BankTran. Parameters Name
Type
ds vGroupID
Description The Bank Adjustment Entry data set
String
The Bank Adjustment Group ID
GetRateCodeInfo This method updates the dataset when the RateCode field changes
Epicor 9.05 | 9.05.605
267
A-E
Business Object Reference Guide
Parameters Name
Type
Description
rateCode
String
Proposed RateCode value
ds
Cash Receipt data set
GetSalesTaxInfo This method updates the dataset when the TaxCode field changes Parameters Name
Type
Description
taxCode
String
Proposed TaxCode value
ds
Cash Receipt data set
GetTaxableInfo This method is called when the Taxable Amount Tax Percent or Fixed Amount is changed to recalculate the Tax Total Parameters Name
Type
Description
taxableAmt
Decimal
Proposed new taxable Amount
taxPercent
Decimal
Proposed Tax Percent
fixedAmount
Decimal
Propoed Fixed Amount
ds
Cash Receipt data set
LeaveBankGrp This method must be run whenever the use is leaving the current BankGrp record (either by selecting a new Bank Group or by leaving the screen) Parameters Name
Type
Description
groupID
String
Bank Group ID to clear
OnChangeBankFeeID Validate for a Correct Bank Fee Code
268
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
pcBankFeeID
String
Bank Fee Code
ds
The Bank Adjustment Entry data set
PrePostGrp Method to call before posting bank adjustment group.. This method will check if there are tax records with zero amounts and return message text asking the user if they would like to continue with posting or delete these tax records before posting. Parameters Name
Type
Description
postGroupID
String
The Group ID of the Group to post
taxRecMessage
String@
Contains text of the message to present to the user if zero amount tax line exist.
RecalcBankTax This method is called after the TaxAmt is changed to recalculate the doc or base tax amounts Parameters Name
Type
Description
ds
Cash Receipt data set
SetReadyToCalc Parameters Name
Type
Description
ipGroupID
String
ipGroupID
ipTranNum
Int32
ipTranNum
ipBankAcctID
String
ipBankAcctID
ipVoided
Boolean
ipVoided
ipCalcAll
Boolean
ipCalcAll
ds
Epicor 9.05 | 9.05.605
BankAdjEntry dataset
269
A-E
Business Object Reference Guide
BankBrnch Epicor.Mfg.BO.BankBrnch: This business object contains 7 methods.
GetNewBankBrnch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
270
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BankFee Epicor.Mfg.BO.BankFee: This business object contains 10 methods.
GetNewBankFee Inserts a new row in the DataSet with defaults populated.
GetNewLangDesc Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
271
A-E
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeIncomeTaxCode Performs required logic when BankFee.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
BankFee data set
BankFileImport Epicor.Mfg.BO.BankFileImport: This business object contains 23 methods.
GetNewIMCashGrp Inserts a new row in the DataSet with defaults populated.
GetNewIMCashHead Inserts a new row in the DataSet with defaults populated.
GetNewIMCashDtl Inserts a new row in the DataSet with defaults populated.
272
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
273
A-E
Business Object Reference Guide
ChangeARInvSelApplyAmt Method to call when changing the apply amount on the invoice to match. Parameters Name
Type
Description
proposedApplyAmt
Decimal
The proposed apply amount
inInvoiceNum
Int32
The invoice number
ds
The Invoice Selection data set
ChangeARInvSelDocDiscAmt Method to call when changing the discount amount for the invoice to match. Parameters Name
Type
Description
proposedDocDiscAmt
Decimal
The proposed doc discount amount
inInvoiceNum
Int32
The invoice number
ds
The Invoice Selection data set
ChangeARInvSelSelected Method to call when selecting or deselecting an invoice to match. Parameters Name
Type
Description
proposedSelected
Boolean
The proposed selected value
inInvoiceNum
Int32
The invoice number
inTranDate
Nullable{System.DateTime}
The tran date
ds
The Invoice Selection data set
ChangeIMCashDtlDocDiscount Method to call when changing the discount on the payment detail. Parameters Name
Type
Description
proposedDocDiscount
Decimal
The proposed discount
ds
274
The Bank File Import data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangeIMCashDtlDocTranAmt Method to call when changing the tran amount on the payment detail. Parameters Name
Type
Description
proposedDocTranAmt
Decimal
The proposed tran amt
ds
The Bank File Import data set
ChangeIMCashDtlInvoiceNum Method to call when changing the invoice number. Parameters Name
Type
Description
proposedInvoiceNum
Int32
The proposed invoice number
ds
The Bank File Import data set
ChangeIMCashGrpBankAcctID Method to call when changing the bank account. Parameters Name
Type
Description
proposedBankAcctID
String
The proposed bank account id
ds
The Bank File Import data set
ChangeIMCashHeadCustID Method to call when changing the customer. Parameters Name
Type
Description
proposedCustID
String
The proposed bank account id
ds
The Bank File Import data set
CreatePymtForInvoices Create payments for selected invoices.
Epicor 9.05 | 9.05.605
275
A-E
Business Object Reference Guide
Parameters Name
Type
Description
pcGroupID
String
Cash Receipt Group ID
pcHeadNum
Int32
Imported payment to create the line for
ds
The ARInvSel data set
Returns Bank File Import data set
GetBankFileImportParam Returns record in BankFileImportParam dataset Parameters Name
Type
Description
cGroupID
String
The Cash Group ID
Returns
ImportBankFile Imports a bank file Parameters Name
Type
Description
ds
MatchPayments Method to call to automatically match the invoices, called after import Parameters Name
Type
Description
matchGroupID
String
The Group to match
ProcessReceipts Method to call to accept the matched receipts Parameters
276
Name
Type
Description
cGroupID
String
The group id to process
cReturnMsg
String@
Return message to display to the user
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
lClearRcds
Boolean@
Clear the dataset records - will be true if all payments were processed
SelectInvoices Read InvcHead records and create ARInvSel records if they meet the selection criteria. Parameters Name
Type
Description
pcGroupID
String
AR Check Group ID
piHeadNum
Int32
IMCashRec header number
Returns The ARInvSel data set
BankFundTran Epicor.Mfg.BO.BankFundTran: This business object contains 9 methods.
ChangeFromAmt This method validates the proposed Tranfer Amount and updates the dataset accordingly Parameters Name
Type
Description
docTranAmt
Decimal
Proposed Transaction Amount
ds
Bank Funds Transfer data set
ChangeFromBank This method validates the proposed from (source) bank and updates the dataset accordingly Parameters Name
Type
Description
bankAcctID
String
Proposed From Bank Accout ID
ds
Bank Funds Transfer data set
ChangeRateGrp This method validates the proposed RateGrpCode and updates the dataset accordingly
Epicor 9.05 | 9.05.605
277
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipRateGrpCode
String
Proposed RateGrpCode
ds
Bank Funds Transfer data set
ChangeTargetBank This method validates the proposed target bank and updates the dataset accordingly Parameters Name
Type
Description
toBankAcctID
String
Proposed Target Bank Accout ID
ds
Bank Funds Transfer data set
ChangeToAmt This method validates the proposed To Tranfer Amount and updates the dataset accordingly Parameters Name
Type
Description
toDocTranAmt
Decimal
Proposed To Transaction Amount
ds
Bank Funds Transfer data set
ChangeTranDate This method validates the proposed Transaction date and updates the dataset according to the new date/fiscal period Parameters Name
Type
Description
tranDate
Nullable{System.DateTime}
Proposed Transaction Date
ds
Bank Funds Transfer data set
This method creates the BankFundTran record for the user to edit Returns Bank Funds Transfer data set
GetLegalNumGenOpts This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does,
278
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds requiresUserInput
Description Bank Funds Transfer data set
Boolean@
Indicates if the legal number requires user input
ValidateBeforeTransfer This method validates all entered data, that need to do before transfer. Parameters Name
Type
ds
Description Bank Funds Transfer data set
BankPayMethodSearch Epicor.Mfg.BO.BankPayMethodSearch: This business object contains 0 methods.
BankRec Epicor.Mfg.BO.BankRec: This business object contains 52 methods.
GetNewCashBHed Inserts a new row in the DataSet with defaults populated.
GetNewCashBDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
279
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AddStatement Add Statement. It is similar to GetNewCashBHed in functionality. It should be used to create CashBHed with BankAcctID as input. Parameters Name
Type
Description
pcBankAcctID
String
Bank Account ID of the statement.
ds
Epicor.Mfg.BO.BankRecDataSet
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth.
280
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
iBankAcctID
String
BankAcctID
iFiscalYear
Int32
FiscalYear
iFiscalYearSuffix
String
FiscalYearSuffix
iBankSlip
Int32
BankSlip
iFiscalCalendarID
String
FiscalCalendarID
CheckExists Call this method to validate if a check exists in the db Parameters Name
Type
Description
inCheckNum
Int32
Check number
inBankAcctID
String
Bank account
outExists
Boolean@
outExists
ClearAPPI Used in A/P Payment clearing to clear a single A/R Payment Instrument. Parameters Name
Type
Description
piHeadNum
Int32
HeadNum for the Payment Instrument to be cleared.
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
plClearingMode
Boolean
Clearing Mode, Yes for Clear Payment Instrument No for Not Clear
ds
Epicor.Mfg.BO.BankRecAPPIClearingDataSet
ClearARPI Used in A/P Payment clearing to clear a single A/R Payment Instrument. Parameters Name
Type
Description
piHeadNum
Int32
HeadNum for the Payment Instrument to be cleared.
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
Epicor 9.05 | 9.05.605
281
A-E
Business Object Reference Guide
Name
Type
Description
plClearingMode
Boolean
Clearing Mode, Yes for Clear Payment Instrument No for Not Clear
ds
Epicor.Mfg.BO.BankRecARPIClearingDataSet
ClearChecks Used in A/P Payment clearing to clear a single or range of checks. Parameters Name
Type
Description
piStartCheckNum
Int32
Starting check number of the range of checks to be cleared.
piEndCheckNum
Int32
Ending check number of the range of checks to be cleard.
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
plClearingMode
Boolean
Clearing Mode, Yes for Clear Check No for Not Clear
ds
Epicor.Mfg.BO.BankRecPaymentClearingDataSet
ClearPayrollChecks Used in Payroll clearing to clear a single or range of checks. Parameters Name
Type
Description
piStartCheckNum
Int32
Starting check number of the range of checks to be cleared.
piEndCheckNum
Int32
Ending check number of the range of checks to be cleard.
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
plClearingMode
Boolean
Clearing Mode, Yes for Clear Check No for Not Clear
ds
Epicor.Mfg.BO.BankRecPayrollClearingDataSet
ClearTransactionClearing Used in Transaction clearing to clear or not clear BankTran. Parameters
282
Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
pcBankAcctID
String
Bank Account ID from BankTran datatable
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
piTranNum
Int32
Transaction number from BankTran datatable
plClearingMode
Boolean
Clearing Mode, Yes for Clear Check No for Not Clear
ds
Epicor.Mfg.BO.BankRecTransClearingDataSet
CreateLine Call this method before calling other business objects like Cash Receipts, PaymentEntry, Bank Adjustment etc. This method creates the CashBDtl record and any other records required to call the business object. Parameters Name
Type
Description
pcLineType
String
Line Type. For example, Manual, MisPay, PayInv, Deposit, APPay, PRPay, CRPay, BankTran, APPIPay and ARPIPay
pdCashBookNum
Decimal
Cash book number
piCashBookLine
Int32@
Cash book line number.
ds
Epicor.Mfg.BO.BankRecDataSet
DeSelectAllAPPIClearing Used in A/P Payment Instrument clearing - to De-Select All A/P Payment Instrument clearing. Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecAPPIClearingDataSet
DeSelectAllARPIClearing Used in A/R Payment Instrument clearing - to De-Select All A/R Payment Instrument clearing. Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecARPIClearingDataSet
DeSelectAllPaymentClearing Used in A/P Payment clearing - to De-Select All Payment clearing.
Epicor 9.05 | 9.05.605
283
A-E
Business Object Reference Guide
Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecPaymentClearingDataSet
DeSelectAllPayrollClearing Used in Payroll clearing - to De-Select All Payroll clearing. Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecPayrollClearingDataSet
DeSelectAllTransactionClearing Used in A/P Transaction Clearing - to De-Select BankTran. Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecTransClearingDataSet
GetAPPIClearing Get a list of A/P Payment Instruments. Parameters Name
Type
ds
Description Epicor.Mfg.BO.BankRecDataSet
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
Returns Epicor.Mfg.BO.BankRecAPPIClearingDataSet
GetARPIClearing Get a list of A/R Payment Instruments.
284
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
Epicor.Mfg.BO.BankRecDataSet
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
Returns Epicor.Mfg.BO.BankRecARPIClearingDataSet
GetCurrencyBase This method returns the Base CurrencyCode Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
GetLegNumDefaults This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
Boolean@
Indicates if the legal number requires user input
ds requiresUserInput
GetPaymentClearing Get a list of A/P Payments. Parameters Name
Type
ds
Description Epicor.Mfg.BO.BankRecDataSet
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
Returns Epicor.Mfg.BO.BankRecPaymentClearingDataSet
Epicor 9.05 | 9.05.605
285
A-E
Business Object Reference Guide
GetPayrollClearing Get a list of Payroll Clearing. Parameters Name
Type
ds
Description Epicor.Mfg.BO.BankRecDataSet
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
Returns Epicor.Mfg.BO.BankRecPayrollClearingDataSet
GetStatement Get Statement. Call this method when the user enters the Statement#. It is similar to GetByID in functionality. Parameters Name
Type
Description
pcBankAcctID
String
Bank Account ID of the statement.
piFiscalYear
Int32
Fiscal Year of the statement
piBankSlip
Int32
Bank slip#
Returns Epicor.Mfg.BO.BankRecDataSet
GetTransactionClearing Used Transaction Clearing - To get a list of Transactions Clearing from BankTran. Parameters Name
Type
ds
Description Epicor.Mfg.BO.BankRecDataSet
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
Returns Epicor.Mfg.BO.BankRecTransClearingDataSet
OnChangeAPPIClearedAmt Used in A/P Payment Instrument clearing - Call after user enters a Cleared Amt.
286
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch, If Yes, accept input in ClearedAmt, else accept input in DocClearedAmt
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecAPPIClearingDataSet
OnChangeARPIClearedAmt Used in A/P Payment Instrument clearing - Call after user enters a Cleared Amt. Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch, If Yes, accept input in ClearedAmt, else accept input in DocClearedAmt
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecARPIClearingDataSet
OnChangeClearedAmt Used in A/P Payment clearing - Call after user enters a Cleared Amt. Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch, If Yes, accept input in ClearedAmt, else accept input in DocClearedAmt
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecPaymentClearingDataSet
ds1
Epicor.Mfg.BO.BankRecDataSet
OnChangeofApplyDate This method should be called before the apply date has been updated. Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashBHed datatable
Epicor 9.05 | 9.05.605
287
A-E
Business Object Reference Guide
Name
Type
Description
newApplyDate
Nullable{System.DateTime}
Proposed Apply Date.
ds
Epicor.Mfg.BO.BankRecPaymentClearingDataSet
OnChangePayrollClearedAmt Used in Payroll clearing - Call after user enters a Cleared Amt. Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch, If Yes, accept input in ClearedAmt, else accept input in DocClearedAmt
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecPayrollClearingDataSet
OnChangingMXRecDate Used to validate new Reconciled Date. Parameters Name
Type
Description
plMXRecDate
Nullable{System.DateTime}
New Reconciled Date
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
Post Post bank reconciliation transactions. Parameters Name
Type
Description
pcBankAcctID
String
Bank Account ID
pdCashBookNum
Decimal
Cash book number to be posted.
plGLWarningContinue
String
Yes/No response to the question "WARNING: A/P is NOT interfaced with General Ledger. G/L transactions will NOT be created. Do you wish to continue?"
pcPostErrorLog
String@
Posting Errors
PRCheckExists Call this method to validate if a check exists in the db
288
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
inCheckNum
Int32
Check number
inBankAcctID
String
Bank account
outHeadNum
Int32@
out Head number
RefreshCashBDtl Call this method after calling other business objects like Cash Receipts, PaymentEntry, Bank Adjustment etc. This method updates the CashBDtl record with the data from other business objects. Parameters Name
Type
Description
pdCashBookNum
Decimal
Cash book number
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
Returns Epicor.Mfg.BO.BankRecDataSet
SelectAllAPPIClearing Used in A/P Payment Instrument clearing - to Select All A/P Payment Instrument clearing. Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecAPPIClearingDataSet
SelectAllARPIClearing Used in A/R Payment Instrument clearing - to Select All A/R Payment Instrument clearing. Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecARPIClearingDataSet
SelectAllPaymentClearing Used in A/P Payment clearing - to Select All Payment clearing.
Epicor 9.05 | 9.05.605
289
A-E
Business Object Reference Guide
Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecPaymentClearingDataSet
SelectAllPayrollClearing Used in Payroll clearing - to Select All Payroll checks for clearing. Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecPayrollClearingDataSet
SelectAllTransactionClearing Used in A/P Transaction Clearing - to Select BankTran. Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds
Epicor.Mfg.BO.BankRecTransClearingDataSet
SelectBank Select a Bank. Parameters Name
Type
Description
pcBankAcctID
String
Bank account ID
pdCashBookNum
Int32@
Returns a Cash book number if there is an un-posted CashBHed present.
Returns Epicor.Mfg.BO.BankRecBankAcctDataSet
SelectReferenceClearing Used in Transaction Clearing - to Select BankTran.
290
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
cReference
String
Cash group reference selected
ds
Epicor.Mfg.BO.BankRecTransClearingDataSet
UnSelectBank Unlocks the group record locked by group name pcBankAcctID and by the user DCD-USERID. Parameters Name
Type
Description
pcBankAcctID
String
Unlock the groups for Bank account ID
plSuccess
Boolean@
Returns Yes if successfully unlocked the group.
UpdateAPPIClearing Update the changes made to A/P Payment Instrument Clearing browse. Parameters Name
Type
ds
Description Epicor.Mfg.BO.BankRecAPPIClearingDataSet
pdCashBookNum
Decimal
CashBookNum from CashBDtl datatable
piCashBookLine
Int32
CashBookLine from CashBDtl datatable
ds1
Epicor.Mfg.BO.BankRecDataSet
UpdateARPIClearing Update the changes made to A/R Payment Instrument Clearing browse. Parameters Name
Type
ds
Description Epicor.Mfg.BO.BankRecARPIClearingDataSet
pdCashBookNum
Decimal
CashBookNum from CashBDtl datatable
piCashBookLine
Int32
CashBookLine from CashBDtl datatable
ds1
Epicor 9.05 | 9.05.605
Epicor.Mfg.BO.BankRecDataSet
291
A-E
Business Object Reference Guide
UpdatePaymentClearing Update the changes made to Payment Clearing browse. Parameters Name
Type
ds
Description Epicor.Mfg.BO.BankRecPaymentClearingDataSet
pdCashBookNum
Decimal
CashBookNum from CashBDtl datatable
piCashBookLine
Int32
CashBookLine from CashBDtl datatable
ds1
Epicor.Mfg.BO.BankRecDataSet
UpdatePayrollClearing Update the changes made to Payroll clearing browse. Parameters Name
Type
ds
Description Epicor.Mfg.BO.BankRecPayrollClearingDataSet
pdCashBookNum
Decimal
CashBookNum from CashBDtl datatable
piCashBookLine
Int32
CashBookLine from CashBDtl datatable
ds1
Epicor.Mfg.BO.BankRecDataSet
UpdateTransactionClearing Used in Transaction clearing - to Update transaction clearing. Parameters Name
Type
ds
Description Epicor.Mfg.BO.BankRecTransClearingDataSet
pdCashBookNum
Decimal
CashBookNum from CashbDtl datatable
piCashBookLine
Int32
CashBookLine from CashbDtl datatable
ds1
Epicor.Mfg.BO.BankRecDataSet
BAQDesigner Epicor.Mfg.BO.BAQDesigner: This business object contains 31 methods.
GetNewDynamicQueryDesigner Inserts a new row in the DataSet with defaults populated.
292
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetNewQueryTableDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryFieldDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryCalcFldDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryCtrlDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryCtrlValuesDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryCustomActionDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryParameterDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryRelationDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryRelationFieldDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQuerySortByDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryUpdateFieldDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryWhereItemDesigner Inserts a new row in the DataSet with defaults populated.
GetNewQueryValueSetItemsDesigner Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
293
A-E
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CreateUBAQ Create files for updatable query
294
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
dcdUserID
String
UserID, to which the query belongs
pcQueryID
String
The Query(Exports) ID
Returns Returns PcDynLst
GetPcDynLst Get list from PcDynLst where specified query is used Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
Returns Returns PcDynLst
GetABTQueryLst Get list from ABTQuery where specified query BAQID is used Parameters Name
Type
Description
baQID
String
The Query(Exports) ID
Returns Returns ABTQueryLst
GetUsedInBAQList Get list from of BAQs where specified query is used Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
Returns Returns UsedInBAQListDataSet dataset Get full list of tables from zDataTable for palette and code editor Returns Returns list from zDataTable
Epicor 9.05 | 9.05.605
295
A-E
Business Object Reference Guide
LoadQueryDiagram This method returns serialized query diagram Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
companyID
String
The Company) ID
dcdUserID
String
The User ID
Returns Returns the dataset with diagram
DeleteQueryDiagram This method returns serialized query diagram Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
companyID
String
The Company) ID
dcdUserID
String
The User ID
Returns Returns the dataset with diagram
SaveQueryDiagram This method saves SOAP-serialized query diagram Parameters Name
Type
ds
Description The dataset representing the current diagram
ValidQueryName Check if query name entered is valid Parameters
296
Name
Type
Description
pcQueryID
String@
The proposed Query(Exports) ID
queryFound
Boolean@
true, if such query exists
cUser
String@
The User ID, who created query
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
PossibleBONames returns list of BOs where query tables are used Parameters Name
Type
Description
tableNames
String
comma delimeted table name list
boNames
String@
comma delimeted BO name list
GetBOTableList This method returns the list of tables, belonging to specified business object Parameters Name
Type
Description
boName
String
Business Object Name
topTableID
String@
comma delimeted BO name list
BAQExtODBCSearch Epicor.Mfg.BO.BAQExtODBCSearch: This business object contains 5 methods. Get full list of ODBC DSN Returns Returns list from zDataTable
GetList Get full list of ODBC DSN - equal to GetDSNList. Used for Combobox listing Returns Returns list from zDataTable
GetTableList Get full list of tables from Recordset.Open for palette and code editor Returns Returns list from zDataTable
GetFieldList Get full list of columns for the specified table Returns Returns list of table fields
Epicor 9.05 | 9.05.605
297
A-E
Business Object Reference Guide
GetFKRelList Get full list of foreign key realtions for the specified table using infrmational views Returns Returns list of FK And FK fields
BAQQueryParamSearch Epicor.Mfg.BO.BAQQueryParamSearch: This business object contains 7 methods.
GetNewBAQQueryParamSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
298
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BAQSelFieldSearch Epicor.Mfg.BO.BAQSelFieldSearch: This business object contains 3 methods.
GetByID This method returns a dataset representing an existing query Parameters Name
Type
Description
exportID
String
The Query(Exports) ID
Returns Returns the dataset representing the query
GetList This method returns a list of existing queries Parameters Name
Type
Description
whereClauseExports
String
Exports where clause
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Epicor.Mfg.BO.BAQSelFieldSearchDataSet
GetRows This method returns a list of existing queries
Epicor 9.05 | 9.05.605
299
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClauseExports
String
Exports where clause
whereClauseSelectedField
String
SelectedField where clause
pageSize
Int32
size of page
absolutePage
Int32
absolutePage
morePages
Boolean@
true = more pages yet to be retrieved, false = end of result
Returns Epicor.Mfg.BO.BAQSelFieldSearchDataSet
BatchOps Epicor.Mfg.BO.BatchOps: This business object contains 1 methods.
DoBatching Combines the given list of job operations from different jobs into a single "bathced" job. Parameters Name
Type
Description
jobProcessMode
String
Process Mode for the new job. Values: S(Sequential) or C(Concurrent).
pullDirection
String
Direction to pull operations beginning at the specified operation. Can be Forward or Backward
autoReceive
Boolean
AutoReceive
oPRowIDList
String
Comma separated list of Operations (JobOper.RowIdent) to begin pulling into batched job.
newJobNumber
String@
Job number of the newly created batched job.
BdnCd Epicor.Mfg.BO.BdnCd: This business object contains 9 methods.
GetNewBdnCd Inserts a new row in the DataSet with defaults populated.
GetNewBdnCdAttch Inserts a new row in the DataSet with defaults populated.
GetNewBdnCdRole Inserts a new row in the DataSet with defaults populated.
300
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
301
A-E
Business Object Reference Guide
BdnSetActPct Epicor.Mfg.BO.BdnSetActPct: This business object contains 8 methods.
GetNewBdnCd Inserts a new row in the DataSet with defaults populated.
GetNewBdnCdHist Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
302
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BinSize Epicor.Mfg.BO.BinSize: This business object contains 10 methods.
GetNewBinSize Inserts a new row in the DataSet with defaults populated.
GetNewBinSizeAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
303
A-E
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CalcVolume This method returns the volume for the defined Warehouse Bin Size Group. Parameters Name
Type
Description
ipLength
Decimal
Length Value
ipWidth
Decimal
Width Value
ipHeight
Decimal
Height Value
ds
304
The Warehouse Bin Size Group Dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
BOL Epicor.Mfg.BO.BOL: This business object contains 17 methods.
GetNewBOLHead Inserts a new row in the DataSet with defaults populated.
GetNewBOLDetail Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
305
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeBOLHeadUseOTS Method to call when changing the UseOTS field the contract header record. Refreshes the address list and contact info Parameters Name
Type
Description
ds
The Service Contract data set
ChangeShipToCustID Update BOL Header information with values from the Third Party Ship To when the Ship To is changed. Parameters Name
Type
Description
iShipToCustID
String
Proposed Third-Party Ship To
ds
The BOL data set
ChangeType This method sets the default values when the BOLType field changes. This should only be possible on adds. The field is not updateable in Update Mode.
306
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
Bill of Lading DataSet
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetBillingInfo This method populates the address information when the BillID field changes Parameters Name
Type
Description
billID
String
Proposed Billing ID.
ds
Bill of Lading DataSet
GetShippingInfo This method populates the Shipping information when the ShipID field changes Parameters Name
Type
Description
shipID
String
Proposed Shipping ID
ds
Bill of Lading DataSet
GetSlips This method generates a list of linked or unlinked packs. If the bolNum field is not 0, then only the packs associated with that record will be returned. Otherwise unlinked packs will be returned. The records returned will be unlinked pack lines (not the headers). Parameters Name
Type
Description
bolNum
Int32
Bill of lading for which to get the linked Packs for. If 0, then unlinked Packs will be returned
bolType
String
Type of BOL record to create. If left blank, all unlinked packs will be returned so the UI can filter based on BOLType. Otherwise only the
Epicor 9.05 | 9.05.605
307
A-E
Business Object Reference Guide
Name
Type
Description specified BOLType records will be returned. Can be left Blank if returning linked packs
updateLinkFlag
Boolean
it's true when the method is called after Update Linked Packs
Returns
PrintBOL This method will print out the Bill of Lading. Gives the option of Print Preview Parameters Name
Type
Description
bolNum
Int32
Bill of Lading number to print
printPreview
Boolean
Flag indicating whether to preview the print job
BOLGenerateSearch Epicor.Mfg.BO.BOLGenerateSearch: This business object contains 1 methods.
GetRows This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table (BOLSlip) we need our own public method. Code is based on GetSlips from bo/BOL/BOL.p Parameters Name
Type
Description
whereClause
String
The where clause to restrict data for
ipType
String
The type of shipment
ipShipDate
Nullable{System.DateTime} The ship date
ipShipViaCode
String
The ship via code
ipCustNum
Int32
The customer when type is Custopmer (ShipHead)
ipVendorNum
Int32
The supplier when type is Subcontract (SubShipH)
ipPackNum
Int32
Pack Num
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Returns The BOLGenerateSearchDataSet data set
308
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
BomSearch Epicor.Mfg.BO.BomSearch: This business object contains 3 methods.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetAllAlternateTrees This methods will return a dataset that will include PartRev, PartOpr, PartOpDtl, PartMtl, PartMtlRestriction, PartMtlRestrictSubst, PartMtlRefDes, PartOprRestriction and PartOprRestrictSubst if those records exist for the appropriate input parameters. ALL ALTERNATES OF THE PARTREVISION WILL BE RETURNED if ipcomplete is true This method will also allow you to return the whole dataset or allow the user to specify how far down the tree they would like to return possible "part" records for. Parameters Name
Type
Description
ipPartNum
String
The Part Number to return data for.
ipRevisionNum
String
The Revision Number to return data for.
ipUseDefaultMethod
Boolean
For partrev records other than the first one, would you like to use the default alternate method or the inputted one?
ipAsOfDate
Nullable{System.DateTime} The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this group?
Returns Dataset to search for Bom records.
GetDatasetForTree This methods will return a dataset that will include PartRev, PartOpr, PartOpDtl, PartMtl, PartMtlRestriction, PartMtlRestrictSubst, PartOprRestriction and PartOprRestrictSubst if those records exist for the appropriate input parameters. This method will also allow you to return the whole dataset or allow the user to specify how the revision to return possible "part" records for. Parameters Name
Type
Description
ipPartNum
String
The Part Number to return data for.
Epicor 9.05 | 9.05.605
309
A-E
Business Object Reference Guide
Name
Type
Description
ipRevisionNum
String
The Revision Number to return data for.
ipAltMethod
String
The Alternate Method to return data for.
ipUseDefaultMethod
Boolean
For partrev records other than the first one, would you like to use the default alternate method or the inputted one?
ipAsOfDate
Nullable{System.DateTime} The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this group?
Returns Dataset to search for Bom records.
BookOrd Epicor.Mfg.BO.BookOrd: This business object contains 8 methods.
GetNewBookOrd Inserts a new row in the DataSet with defaults populated.
GetNewBookDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
310
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BORelationSearch Epicor.Mfg.BO.BORelationSearch: This business object contains 2 methods.
GetBODataset Parameters Name
Type
Description
boName
String
The BO name
ds
The BORelationSearchDataSet data set
GetBOTables Parameters Name
Type
Description
boName
String
The BO name
ds
Epicor 9.05 | 9.05.605
The BORelationSearchDataSet data set
311
A-E
Business Object Reference Guide
BpActionGroup Epicor.Mfg.BO.BpActionGroup: This business object contains 10 methods.
GetNewBpActionGroup Inserts a new row in the DataSet with defaults populated.
GetNewBpAction Inserts a new row in the DataSet with defaults populated.
GetNewBpActionData Inserts a new row in the DataSet with defaults populated.
GetNewBpActionSrc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
312
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BpConditionGroup Epicor.Mfg.BO.BpConditionGroup: This business object contains 10 methods.
GetNewBpConditionGroup Inserts a new row in the DataSet with defaults populated.
GetNewBpCondition Inserts a new row in the DataSet with defaults populated.
GetNewBpConditionData Inserts a new row in the DataSet with defaults populated.
GetNewBpConditionSrc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
313
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
314
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
BpDirectiveExport Epicor.Mfg.BO.BpDirectiveExport: This business object contains 0 methods.
BpDirectiveImport Epicor.Mfg.BO.BpDirectiveImport: This business object contains 0 methods.
BpDirectiveUpdate Epicor.Mfg.BO.BpDirectiveUpdate: This business object contains 0 methods.
BpHolds Epicor.Mfg.BO.BpHolds: This business object contains 9 methods.
GetNewBpHoldType Inserts a new row in the DataSet with defaults populated.
GetNewBpHoldAttachHist Inserts a new row in the DataSet with defaults populated.
GetNewBpHoldAttachment Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
315
A-E
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BpInstanceCounter Epicor.Mfg.BO.BpInstanceCounter: This business object contains 7 methods.
GetNewBpInstanceCounter Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
316
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BpmCodeGen Epicor.Mfg.BO.BpmCodeGen: This business object contains 0 methods.
BpMethod Epicor.Mfg.BO.BpMethod: This business object contains 12 methods.
GetNewBpMethod Inserts a new row in the DataSet with defaults populated.
GetNewBpArgument Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
317
A-E
Business Object Reference Guide
GetNewBpBaseProcDirective Inserts a new row in the DataSet with defaults populated.
GetNewBpPostProcDirective Inserts a new row in the DataSet with defaults populated.
GetNewBpPreProcDirective Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
318
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Returns The BO data set
BpTableDependSearch Epicor.Mfg.BO.BpTableDependSearch: This business object contains 0 methods.
BpTextStorage Epicor.Mfg.BO.BpTextStorage: This business object contains 7 methods.
GetNewBpTextStorage Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
319
A-E
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BurdenSet Epicor.Mfg.BO.BurdenSet: This business object contains 11 methods.
GetNewBdnSet Inserts a new row in the DataSet with defaults populated.
GetNewBdnSetAttch Inserts a new row in the DataSet with defaults populated.
GetNewBSBdnCd Inserts a new row in the DataSet with defaults populated.
GetNewBSBdnCdAttch Inserts a new row in the DataSet with defaults populated.
GetNewBSBdnRt Inserts a new row in the DataSet with defaults populated.
320
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
321
A-E
Business Object Reference Guide
BusEntities Epicor.Mfg.BO.BusEntities: This business object contains 7 methods.
GetNewBusEntities Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
322
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BuyerWorkbench Epicor.Mfg.BO.BuyerWorkbench: This business object contains 12 methods.
AddSuggSupplier This methods will add supplier record for an individual suggestion. Parameters Name
Type
Description
ipBuyerID
String
The buyer id to add data for.
ipSugNum
Int32
The suggestion number to link suppliers to.
ipVendorNum
Int32
The vendor number of the supplier to add.
ipPurPoint
String
The purchase point of the supplier to add.
opStatusMsg
String@
Message to be displayed showing potential non error messages
ds
Buyer Workbench Data Set
ChangeRFQSuggVendPurPoint This method validates the RFQSuggVend.PurPoint when it changes. This method should run when changing the RFQSuggVend.PurPoint. Parameters Name
Type
Description
ipRFQSuggVendRowid
String
The rowident of the record being updated/created.
ds
Buyer Workbench Data Set
ChangeRFQSuggVendVendorID This methods takes the RFQSuggVend.VendorNum and populates the associated fields with value based on the vendornum. This method should run when changing the RFQSuggVend.VendorNum. Parameters Name
Type
Description
ipBuyerID
String
The buyer id used to locate records.
ipRFQSuggVendRowid
String
The rowident of the record being updated/created.
Epicor 9.05 | 9.05.605
323
A-E
Business Object Reference Guide
Name
Type
Description
opStatusMsg
String@
Message to be displayed showing potential non error messages
ds
Buyer Workbench Data Set
CheckRFQSuggVendVendorID This methods checks to see if the new RFQSuggVend.VendorNum has changed from the original RFQSuggVend.VendorNum and validates the value. This method should run before changing the RFQSuggVend.VendorNum. Parameters Name
Type
Description
ipProposedVendorID
String
The new proposed RFQSuggVend.VendorID value
ipRFQSuggVendRowid
String
The rowident of the record being updated/created.
ds
Buyer Workbench Data Set
CreateDataset This methods will return all of the records for the Buyer Workbench. Parameters Name
Type
Description
ipBuyerID
String
The buyer id to return data for.
Returns Buyer Workbench Data Set
DeleteSuggSupplier This methods will delete supplier record for an individual suggestion. Parameters Name
Type
Description
ipSugNum
Int32
The suggestion number to delete suppliers for.
ipVendorNum
Int32
The vendor number of the supplier to delete.
opStatusMsg
String@
Message to be displayed showing potential non error messages from this process.
ds
Buyer Workbench Data Set
DeselectAll This method will change the ProcessRFQ field in the RFQSugg table and the RFQSuggBWB temp table to false (deselected) for the inputted buyerid.
324
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipBuyerID
String
The buyer id to deselect all for.
ds
Buyer Workbench Data Set
Generate This method will generate RFQ's for lines. This method can generate for all suggestions for a buyer by only entering a buyerid or a specific suggestion by also entering a suggestion number. This method will call CreateDataset at the end of running to refresh the dataset. Parameters Name
Type
Description
ipBuyerID
String
The buyer id to generate for.
ds
Buyer Workbench Data Set
GetNewSuggSupp This methods will create a blank RFQSuggVend record for an individual suggestion and allow the user to type in field values through the grid. Parameters Name
Type
Description
ipBuyerID
String
The buyer id to add data for.
ipSugNum
Int32
The suggestion number to link suppliers to.
ds
Buyer Workbench Data Set
PreSupplierWizard This methods will return logical values to be passed to the SupplierWizard method. Parameters Name
Type
Description
ipBuyerID
String
The buyer id to return data for.
ipSugNum
Int32
The suggestion number to link suppliers to.
opSoldPart
Boolean@
Suppliers have sold us this part?
opPreviousRFQ
Boolean@
Suppliers have previously received an RFQ?
opPriceBreak
Boolean@
Suppliers have provided price break information?
ds
Epicor 9.05 | 9.05.605
Buyer Workbench Data Set
325
A-E
Business Object Reference Guide
SelectAll This method will change the ProcessRFQ field in the RFQSugg table and the RFQSuggBWB temp table to true (selected) for the inputted buyerid. Parameters Name
Type
Description
ipBuyerID
String
The buyer id to select all for.
ds
Buyer Workbench Data Set
SupplierWizard This methods will return suppliers for the suggestion based on the 6.1 vendor wizard button. Parameters Name
Type
Description
ipBuyerID
String
The buyer id to return data for.
ipSoldPart
Boolean
Suppliers have sold us this part?
ipPreviousRFQ
Boolean
Suppliers have previously received an RFQ?
ipPriceBreak
Boolean
Suppliers have provided price break information?
ipComplianceList
String
Compliance list
opStatusMsg
String@
Message to be displayed showing potential non error messages from this process.
ds
326
Buyer Workbench Data Set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Chapter 3: C CallType Epicor.Mfg.BO.CallType: This business object contains 7 methods.
GetNewCallType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
327
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Capability Epicor.Mfg.BO.Capability: This business object contains 9 methods.
GetNewCapability Inserts a new row in the DataSet with defaults populated.
GetNewCapAddl Inserts a new row in the DataSet with defaults populated.
GetNewCapResLnk Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
328
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CapAddl Epicor.Mfg.BO.CapAddl: This business object contains 7 methods.
GetNewCapAddl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
329
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CapPromise Epicor.Mfg.BO.CapPromise: This business object contains 25 methods. Built Temp Table for processing ATP. Procedure to calculate the ATP qty for the Temp Table ATP record.
doAtp Passing in a quantity returns a date when that quantity will be available. Passing in a date returns a quantity that will be available.
330
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
atpdate
Nullable{System.DateTime}@
Date
atpqty
Decimal@
Quantity
ipPast
Boolean
Use past dates
FillOrders Will set Temp Table ATP records ATP Quantity to the input quantity value passed in for records >= today and less than the input date value. Parameters Name
Type
Description
curDate
Nullable{System.DateTime}
Date
atpqty
Decimal@
Quantity
GetAtp Passing in a part and quanity, returns a date when avail. Parameters Name
Type
Description
ipPart
String
Part
ipStartDate
Nullable{System.DateTime}
Start Date
ipQtyNeeded
Decimal
Quantity needed decimal
opDateAvail
Nullable{System.DateTime}@
Date Available
GetAtpAmount Passing in a part and date, returns quanity avail. Parameters Name
Type
Description
ipPart
String
Part
ipStartDate
Nullable{System.DateTime}
Start Date
ipJobNum
String
JobNum
ipAsmSeq
Int32
Assembly Seq
ipLeadTime
Int32
Lead Time
ipMfgLeadTime
Int32
Mfg Lead Time
ipQuantity
Decimal
Quantity
Epicor 9.05 | 9.05.605
331
A-E
Business Object Reference Guide
Name
Type
Description
atpamount
Decimal@
Available To Promise Amount
getforecastdays Get system parameters Forecast Days Before and Forecast Days After. Parameters Name
Type
Description
daysbefore
Int32@
Forecast Days Before
daysafter
Int32@
Forecast Days After
getNextMpsDate Passing in a part and plant and date, returns next MPS date. Parameters Name
Type
Description
inputPartNum
String
Part
inputPlant
String
Plant
inputDate
Nullable{System.DateTime}
Date
nextDate
Nullable{System.DateTime}@
Next MPS Date
getonhandqty Passing in a part and plant, returns onhand quantity. Parameters Name
Type
Description
inpartnum
String
Part
inplant
String
Plant
outqty
Decimal@
Onhand Quantity
GetSchedAtp Passing in a part and quanity, returns a date when avail. This also will look at demand through the end of the leadtime add that to current demand, so that demands after will not be effected. Parameters
332
Name
Type
Description
ipPart
String
Part
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipStartDate
Nullable{System.DateTime}
Start Date
ipLeadDate
Nullable{System.DateTime}
Lead Date
ipQtyNeeded
Decimal
Quantity needed decimal
ctpProcess
Boolean
Ctp Process
curjobnum
String
Job Number
lookinpast
Boolean
Look In Past
opDateAvail
Nullable{System.DateTime}@
Date Available
getSupplyBetweenMPS Passing in a part, plant, Begin Date and End Date, returns supply quantity. Parameters Name
Type
Description
ipPartNum
String
Part
ipPlant
String
Plant
begdate
Nullable{System.DateTime}
Begin Date
enddate
Nullable{System.DateTime}
End Date
suppqty
Decimal@
Supply Quantity
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
Epicor 9.05 | 9.05.605
333
A-E
Business Object Reference Guide
CalculateCTP Performs the calculation logic for CTP. Before calling this method all CapPromiseDtl records must have the RowMod field set to 'U'. Parameters Name
Type
Description
lDemandEntry
Boolean
If comes from Demand Entry or not.
outMessage
String@
Output message
ds
The CapPromise data set
CancelCTP Performs the cancellation of CTP. Before calling this method all CapPromiseDtl records must have the RowMod field set to 'U'. Parameters Name
Type
Description
ds
The CapPromise data set
CapPromiseDmdGetNew Creates a temporary record to store information needed for the Capable To Promise process. Parameters Name
Type
Description
demandContractNum
Int32
The Demand Contract number for the process
demandHeadSeq
Int32
The Demand Head Sequence for the process
demandDtlSeq
Int32
The Demand Detail Sequence for the process
demandScheduleSeq
Int32
The Demand Schedule Sequence number for the process
Returns The CapPromise data set
CapPromiseGetNew Creates a temporary record to store information needed for the Capable To Promise process. Parameters
334
Name
Type
Description
orderNum
Int32
The order number for the process
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The CapPromise data set
ChangeCapPromiseDtlFiniteSchedule Reassigns the OverrideMtlConstraints and EnableOverrideMtlConstraints fields based on the value of FiniteSchedule. Parameters Name
Type
Description
proposedFiniteSchedule
Boolean
The proposed value for FiniteSchedule
orderNum
Int32
The Order Number
orderLine
Int32
The Order Line
orderRelNum
Int32
The Order Release Number
ds
The CapPromise data set
ChangeCapPromiseGlobalCTP Updates CapPromiseDtl records based on the new value of CapPromise.GlobalCTP. Before calling this method all CapPromiseDtl records must have the RowMod field set to 'U'. Parameters Name
Type
Description
proposedGlobalCTP
Boolean
The proposed value for GlobalCTP
ds
The CapPromise data set
ChangeCapPromiseProjectedStartDate Updates CapPromiseDtl records based on the new value of CapPromise.ProjectedStartDate. Before calling this method all CapPromiseDtl records must have the RowMod field set to 'U'. Parameters Name
Type
Description
proposedProjectedStartDate
Nullable{System.DateTime}
The proposed value for ProjectedStartDate
ds
The CapPromise data set
ConfirmCTP Performs the confirmation logic for CTP. Before calling this method all CapPromiseDtl records must have the RowMod field set to 'U'. Parameters Name
Type
Description
opError
String@
opError
Epicor 9.05 | 9.05.605
335
A-E
Business Object Reference Guide
Name
Type
ds
Description The CapPromise data set
ConfirmCTPPOSug Performs the confirmation logic for the PO Suggestion created for CTP. Parameters Name
Type
Description
iSugNum
Int32
PO Suggestion Number to be confirmed.
opError
String@
opError
doWhseAtp Passing in a quantity returns a date when that quantity will be available. Passing in a date returns a quantity that will be available. Parameters Name
Type
Description
atpdate
Nullable{System.DateTime}@
ATP Date
atpWhseqty
Decimal@
ATP Whse Quantity
ipPast
Boolean
Use past dates
FindMaxConv Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
scheduleJobMain Case A - If the User enters in the CTP sheet a date in the Completion Date field (ttCapPromiseDtl.UserCompDate) for a line then the job (the CTP job) that is created needs to be backward scheduled from that date. If the scheduling engine concludes that this date is achievable (i.e. the job was not bounce due to being job being scheduled in the past) then the Estimated Completion date is set the same as the user entered date. If the job due date is different to the user entered completion date then this will be used. Case B - If the User DOES NOT enter a completion date and we ONLY have a projected start date then the job created will the forward scheduled using the projected start date as the start date. The job due date is then displayed and used in CTP sheet.
336
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
opJobNum
String
JobNum
lError
Boolean@
Error has occurred
SetOrderPromiseDate Sets the completion date for all detail records based on the latest date of the detail records. Before calling this method all CapPromiseDtl records must have the RowMod field set to 'U'. Parameters Name
Type
ds
Description The CapPromise data set
CapResLnk Epicor.Mfg.BO.CapResLnk: This business object contains 7 methods.
GetNewCapResLnk Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
337
A-E
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Carrier Epicor.Mfg.BO.Carrier: This business object contains 7 methods.
GetNewCarrier Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
338
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CartonStage Epicor.Mfg.BO.CartonStage: This business object contains 7 methods.
GetNewCartonStage Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
339
A-E
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CashDtlSearch Epicor.Mfg.BO.CashDtlSearch: This business object contains 9 methods.
GetNewCashDtl Inserts a new row in the DataSet with defaults populated.
340
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
341
A-E
Business Object Reference Guide
GetRowsContactTracker Called from Contact tracker instead of GetRows for better performance Parameters Name
Type
Description
whereClauseCashDtl
String
Whereclause for CashDtl table.
contactName
String
Contact to retrieve data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
GetRowsCustomerTracker Called from Customer tracker instead of GetRows for better performance Parameters Name
Type
Description
whereClauseCashDtl
String
Whereclause for CashDtl table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
CashFlow Epicor.Mfg.BO.CashFlow: This business object contains 1 methods.
GetRows This method replaces the standard GetRows method Parameters Name
Type
Description
bookID
String
Book ID
startingCash
Decimal
Starting Cash
displayType
String
T = Terms, D = Terms w/Discount, A = Avg Pay Days
Returns Cash Flow Data Set
342
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CashGrp Epicor.Mfg.BO.CashGrp: This business object contains 19 methods.
GetNewCashGrp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
343
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
BeforeGetByID This method checks to see if the selected group is in use before fetching the dataset if the group is in use, the user must answer yes to continue before the GetByID method is run Parameters Name
Type
Description
groupID
String
Selected Group ID
ipCheckUserID
Boolean
Selected Group ID
vQuestion
String@
Question to ask if group is in use
Returns The Cash Group data set
DeleteZeroAmtTaxRec This method deletes TaxDtl records which have zero amounts Since Payments TAx logic calculates tax conditionally only for the first tax line the payment could have multiple zero tax records. Parameters Name
Type
Description
postGroupID
String
The Group ID of the Group to post
GetGrpBankInfo This method is called when the Bank Account changes
344
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
bankAcctId
String
Proposed Bank Account
ds
Cash Grp Data Set
GetGrpFiscal This method is run when the Transaction date is changed to update the fiscal period fields Parameters Name
Type
Description
tranDate
Nullable{System.DateTime}
Proposed Transaction Date
ds
Cash Grp Data Set
GetNewCashGrpForPI Parameters Name
Type
Description
ipStage
String
Stage to get default status for
ds
Cash Grp Data Set
GetNewCashGrpForPIStatus Parameters Name
Type
ds
Description Cash Grp Data Set
GetPIGroupByID Parameters Name
Type
Description
groupID
String
Selected Group ID
Returns Cash Group DataSet
Epicor 9.05 | 9.05.605
345
A-E
Business Object Reference Guide
GetPIStatusGroupByID Parameters Name
Type
Description
groupID
String
Selected Group ID
Returns Cash Group DataSet
LeaveCashGrp This method must be run whenever the use is leaving the current CashGrp record (either by selecting a new Group or by leaving the screen) Parameters Name
Type
Description
groupID
String
Cash Group ID to clear
PrePostEPGroup This methos is for Electronically processed group This methos first checks if the Group Receipt/Payment was processed and CashGrp.EIPaymSent fiels is true This method checks that the A/R is interfaced to the G/L. If not, then ask the user if they want to go ahead and post the cash receipts Parameters Name
Type
Description
groupID
String
Cash Group ID to check if it was processed
vQuestion
String@
Question to Continue with Post if not interfaced
vTaxQuestion
String@
Question to Continue with Post if any Tax records with 0 amounts are found
PrePostGroup This method checks that the A/R is interfaced to the G/L. If not, then ask the user if they want to go ahead and post the cash receipts This method also checks if this Group has any related Tax Records with 0 amounts The user is asked if these reacords are supposed to be deleted before Post Parameters
346
Name
Type
Description
groupID
String
Cash Group ID to check if it was processed
vQuestion
String@
Question to Continue with Post if not interfaced
vTaxQuestion
String@
Question to Continue with Post if any Tax records with 0 amounts are found
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CashRec Epicor.Mfg.BO.CashRec: This business object contains 69 methods.
GetNewCashHead Inserts a new row in the DataSet with defaults populated.
GetNewCashHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewBankTran Inserts a new row in the DataSet with defaults populated.
GetNewBankTranTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewBankTranTGLC Inserts a new row in the DataSet with defaults populated.
GetNewCashDtl Inserts a new row in the DataSet with defaults populated.
GetNewCDTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewCashHeadTGLC Inserts a new row in the DataSet with defaults populated.
GetNewDebNote Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
347
A-E
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
348
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
CalcTaxRecNumber Assigns a legal number (Tax Receipt) to the selected invoice when apply With Holding Tax. Parameters Name
Type
Description
ipGroupID
String
Group ID
opLegalNumMsg
String@
Legal number message
ds
Cash Receipt data set
CCClear Procedure to Clear the Credit Card Information Parameters Name ds
Type
Description The SalesOrder data set
CCLoadTranData Procedure to be called when selecting a record in the Transaction history grid, the data selected is loaded in the CashHead table
Epicor 9.05 | 9.05.605
349
A-E
Business Object Reference Guide
Parameters Name
Type
Description
inTranDate
TranDate from the CreditTran table
inTranTime
Nullable{System.DateTime}
TranTime from the CreditTran table
inTranNum
Int32
TranNum from the CreditTran table
ds
Int32
The SalesOrder data set
Returns opMessage
CCProcessCard Procedure to attempt to process transaction for the amount specified in the "Total" field. Parameters Name
Type
Description
inTranType
String
The transaction type to apply to the credit card. Valid transaction types : D (Deposit), S (Sale), A (Authorize), C (Credit - 803), V (Void).
opMessage
String@
returns opMessage
ds
The SalesOrder data set
ChangeBankAmount This method upates the TranAmt, DocTranAmt, ReceiptAmount fields after the BankAmount field is updated. Parameters Name
Type
ds
Description Cash Receipt data set
ChangeBankReceiptExgRate This method upates the BankAmount field after the BankReceiptExchangeRate field is updated. Parameters Name
Type
Description
exchangeRate
Decimal
The exchange rate from Receipt currency to Bank currency
ds
Cash Receipt data set
ChangeCCAmounts This procedure should be called when any of the Credit Card amounts change (from the Column Changed event in the UI) to calculate the total to be charged to the credit card
350
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The Cash Rec data set
ChangeCreditExp Procedure to validate Credit Card Expiration Date Parameters Name
Type
Description
ipExpMonth
Int32
Expiration Month
ipExpYear
Int32
Expiration Year
ds
The Sales Order data set
ChangeDNAmount This method is called when the Debit Note value field is modified Parameters Name
Type
Description
dnAmount
Decimal
Proposed Debit Note Value
ds
Cash Receipt data set
ChangeIncomeTaxCode Performs required logic when CashHead.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
CashRec data set
ChangeReceiptAmt This method upates the TranAmt, DocTranAmt, BankAmount fields after the ReceiptAmt field is updated. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Cash Receipt data set
351
A-E
Business Object Reference Guide
ChangeReceiptCurrency This method upates the TranAmt, DocTranAmt, BankAmount fields after the ReceiptCurrencyCode field is updated. Parameters Name
Type
Description
currencyCode
String
Proposed Currency Code
ds
Cash Receipt data set
ChangeSettlementExgRate This method upates the TranAmt, DocTranAmt fields after the SettlementExchangeRate field is updated. Parameters Name
Type
Description
exchangeRate
Decimal
The exchange rate from Receipt currency to settlement currency
ds
Cash Receipt data set
ChangeTaxWhld Parameters Name
Type
Description
taxWhld
Decimal
Withhold tax amount withheld by the customer
ds
Cash Receipt data set
ChangeTranAmt This method updates the BankTran amounts when the adjustment amount changes or the currency switch toggles. Parameters Name
Type
Description
ipTranAmtType
String
Indicate which of the transaction amount is changed. Valid values are: 'B' for Base Tran Amount and 'D' for Doc Tran Amount
proposedTranAmt
Decimal
The proposed Transaction Amount
ds
The Cash Receipt data set
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth.
352
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
keyValue
String
GroupID
keyValue2
String
HeadNum
CreateChecks Create Customer Checks for selected invoices. Parameters Name
Type
Description
pcGroupID
String
Cash Receipt Group ID
useDisc
Boolean
Yes or no
ds
The ARInvSel data set
opTotalCashReceived
Decimal@
The new Cash Group total received amount
opTotalApplied
Decimal@
The new Cash Group total applied amount
opUnappliedBalance
Decimal@
The new Cash Group unapplied balance
opTotalMisc
Decimal@
The new Cash Group total misc amount
opTotalDiscount
Decimal@
The new Cash Group total discount amount
opTotalDeposit
Decimal@
The new Cash Group total deposit amount
opTotalARAmount
Decimal@
The new Cash Group total AR amount
opTotalWithhold
Decimal@
The new Cash Group total withhold amount
Returns Cash Receipt data set
CreateNewDebitNote This method calls GetNewCashDtl to create a new Debit Note record instead of the standard way so DebNote.CashHeadNum and DebNote.GroupID fields could be assigned . Parameters Name
Type
ds
Description Cash Receipt data set
groupID
String
Cash Group ID
headNum
Int32
Cash Receipt HeadNum
Epicor 9.05 | 9.05.605
353
A-E
Business Object Reference Guide
DeleteMaster Parameters Name
Type
Description
pcGroupID
String
current CashGrp GroupID
ipHeadNum
String
Cash Header HeadNum
opTotalCashReceived
Decimal@
The new Cash Group total received amount
opTotalApplied
Decimal@
The new Cash Group total applied amount
opUnappliedBalance
Decimal@
The new Cash Group unapplied balance
opTotalMisc
Decimal@
The new Cash Group total misc amount
opTotalDiscount
Decimal@
The new Cash Group total discount amount
opTotalDeposit
Decimal@
The new Cash Group total deposit amount
opTotalARAmount
Decimal@
The new Cash Group total AR amount
opTotalWithhold
Decimal@
The new Cash Group total withhold amount
ds
EnterCustDebNote This method is called when the Debit Note number assigned by the customer is entered or modified Parameters Name
Type
Description
dnCustNbr
String
Proposed Debit Note Number
ds
Cash Receipt data set
GenerateCashDtl This method combines the GetNewCashDtl and Update() method into one routine so that the user can run an "Auto Apply" cash receipt function Parameters
354
Name
Type
Description
groupID
String
Cash Group ID
headNum
Int32
Cash Receipt HeadNum
invoiceNum
Int32
Cash Receipt Invoice Num
takeDiscount
Boolean
If yes, force the line to take the discount. If no, the discount will be taken only if within the discount parameters
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns Cash Receipt data set
GetCurrencyInfo This method is used when the Currency Code changes for Invoice payments only Parameters Name
Type
Description
currencyCode
String
Proposed Currency Code
ds
Cash Receipt data set
GetCustomerInfo This method is called when the CustID field is modified Parameters Name
Type
Description
custID
String
Proposed Customer ID
ds
Cash Receipt data set
GetDNInvInfo This method is called when invoice number field (DNInvNbr) referenced by Debit Note is modified Parameters Name
Type
Description
dnInvNbr
Int32
Proposed Invoice Number
ds
Cash Receipt data set
GetDtlDiscountInfo This method is run when the DocDiscount field is modified Parameters Name
Type
Description
docDiscount
Decimal
Proposed discount amount
ds
Cash Receipt data set
GetDtlInvoiceInfo This method is called when the InvoiceNum field is modified
Epicor 9.05 | 9.05.605
355
A-E
Business Object Reference Guide
Parameters Name
Type
Description
invoiceNum
Int32
Proposed Invoice Number
ds
Cash Receipt data set
GetDtlLegalNumberInfo This method is called when the InvLegalNumber field is modified Parameters Name
Type
Description
legalNumber
String
Proposed Legal Number
ds
Cash Receipt data set
GetDtlTranAmtInfo This method is run when the DocTranAmt field is modified Parameters Name
Type
Description
docTranAmt
Decimal
Proposed discount amount
ds
Cash Receipt data set
GetHdrInvoiceInfo This method will default customer information from an invoice. Parameters Name
Type
Description
invoiceNum
Int32
Invoice Number to get Customer information from
ds
Cash Receipt data set
GetHdrLegalNumberInfo This method will default customer information from an invoice. Parameters Name
Type
Description
legalNumber
String
Legal Number to get Customer information from
ds
356
Cash Receipt data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetNewBankTranByHeadNum Alternate routine to load the Bank Fee Parameters Name
Type
Description
lvHeadNum
Int32
Bank Fee Code
lvBankAcctID
String
Bank Account ID
ds
The AP Payment Entry data set
GetNewCashHeadType This method replaces the standard GetNewCashHead method. The 3 Tran Types available are "PayInv":U for AR Receipt, "Deposit":U for Deposits, or "MisPay":U for Miscellaneous Parameters Name
Type
ds
Description Cash Receipt data set
groupID
String
Cash Group ID
tranType
String
Transaction type
GetOrderInfo This method is run when the OrderNum field is changing to validate/update dataset fields Parameters Name
Type
Description
orderNum
Int32
Proposed Order Number
ds
Cash Receipt data set
GetOrderInfo4DskCurr This method is run when the OrderNum field is changing to validate/update dataset fields Parameters Name
Type
Description
orderNum
Int32
Proposed Order Number
dskCurrCode
String
Petty Cash Desc Currency Code
ds
Epicor 9.05 | 9.05.605
Cash Receipt data set
357
A-E
Business Object Reference Guide
GetRateCodeInfo This method updates the dataset when the RateCode field changes Parameters Name
Type
Description
rateCode
String
Proposed RateCode value
taxtbl
String
Tax temp-table name
ds
Cash Receipt data set
GetSalesTaxInfo This method updates the dataset when the TaxCode field changes Parameters Name
Type
Description
taxCode
String
Proposed TaxCode value
taxtbl
String
Tax temp-table name
ds
Cash Receipt data set
GetTaxableInfo This method is called when the Taxable Amount Tax Percent or Fixed Amount is changed to recalculate the Tax Total Parameters Name
Type
Description
taxableAmt
Decimal
Proposed new taxable Amount
taxPercent
Decimal
Proposed Tax Percent
fixedAmount
Decimal
Propoed Fixed Amount
taxtbl
String
tax temp-table name
ds
Cash Receipt data set
GetTranAmt This method upates the TranAmt/DocTranAmt field after the TranAmt, DocTranAmt or ExchangeRate field is updated. If BaseEntered flag is yes, the TranAmt and DocTranAmt fields will be used to calculat the exchangeRate. Otherwise, the TranAmt will be calculated using the exchangeRate and DocTranAmt fields.
358
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
baseEntered
Boolean
If the TranAmt field was updated then value should be yes, otherwise no
ds
Cash Receipt data set
LeaveCashHead This method checks calculates the GainLoss Adjustment record when finally leaving a CashHead record after adding/updating all the CashDtl records Parameters Name
Type
Description
groupID
String
Cash Receipt Group ID
headNum
Int32
Cash Receipt number
onAccount
Boolean
Indicates if excess cash should go on account
ds
Cash Receipt data set
MassApplyDebitNotes This procedure processes un-applied Debit Notes, ttDebNote records with RowMod = "U" is passed in, changed ttDebNote, ttCashDtl, ttCashHead are passed back. Parameters Name
Type
Description
custNum
Int32
Customer Number
dnApplyErrorMsg
String@
Indicates if one or more selected debit notes generated an error
ds
Cash Receipt data set
MassDelete Delete cash receipts from group having electronic payment method. Parameters Name
Type
Description
pcGroupID
String
Cash Receipt Group ID
MassGenerateCashDtl Create multiple CashDtl for a CashHead from multiple selected invoices. CahsHead and CashGrp must exist
Epicor 9.05 | 9.05.605
359
A-E
Business Object Reference Guide
Parameters Name
Type
Description
pcGroupID
String
Cash Receipt Group ID
ipHeadNum
Int32
Cash Receipt Header HeadNum
useDisc
Boolean
Yes or no
ds
The ARInvSel data set for selected invoices
massGenErrorMsg
String@
Indicates if one or more selected invoices generated an error
opTotalCashReceived
Decimal@
The new Cash Group total received amount
opTotalApplied
Decimal@
The new Cash Group total applied amount
opUnappliedBalance
Decimal@
The new Cash Group unapplied balance
opTotalMisc
Decimal@
The new Cash Group total misc amount
opTotalDiscount
Decimal@
The new Cash Group total discount amount
opTotalDeposit
Decimal@
The new Cash Group total deposit amount
opTotalARAmount
Decimal@
The new Cash Group total AR amount
opTotalWithhold
Decimal@
The new Cash Group total withhold amount
Returns Cash Receipt data set
OnChangeBankFeeID Validate for a Correct Bank Fee Code Parameters Name
Type
Description
pcBankFeeID
String
Bank Fee Code
ds
The Cash Receipt Entry data set
RecalcBankTax This method is called after the TaxAmt is changed to recalculate the doc or base tax amounts Parameters Name ds
Type
Description Cash Receipt data set
RecalcCDTax This method is called after the TaxAmt is changed to recalculate the doc or base tax amounts
360
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
Cash Receipt data set
RecalcTax This method is called after the TaxAmt is changed to recalculate the doc or base tax amounts Parameters Name
Type
Description
ds
Cash Receipt data set
ReverseCashReceipt Reverse Cash Receipt Parameters Name
Type
Description
headNum
Int32
Head number
reverseDate
Nullable{System.DateTime}
Reverse Date
postErrorLog
String@
Error log
SelectInvoices Read InvcHead records and create ARInvSel records if they meet the selection criteria. Parameters Name
Type
Description
pcGroupID
String
AR Check Group ID
pdtDueDate
Nullable{System.DateTime}
Select invoices due by this date.
pdtTranDate
Nullable{System.DateTime}
The date of the transaction.
plApplyDiscount
Boolean
Yes or no
pcCustomerList
String
Select invoices for the customer list.
pcPaymentMethod
String
Select payment methods for the specific.
Returns The ARInvSel data set
Epicor 9.05 | 9.05.605
361
A-E
Business Object Reference Guide
SetReadyToCalc Parameters Name
Type
Description
ipGroupID
String
ipGroupID
ipHeadNum
Int32
ipHeadNum
ipInvoiceNum
Int32
ipInvoiceNum
ipInvoiceRef
Int32
ipInvoiceRef
ipBankAcctID
String
ipBankAcctID
ipTranNum
Int32
ipTranNum
ipVoided
Boolean
ipVoided
ipCalcAll
Boolean
ipCalcAll
ds
CashRec dataset
TakeDiscount This method is run when the Take discount option is selected Parameters Name
Type
ds
Description Cash Receipt data set
UpdateMaster This method is called instead of the standard Update because several actions in relation to the update might be required and it avoids multiple BL calls from the UI. This method will a create record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. And then this method will be called again. Parameters Name
Type
Description
ipGroupID
String
current GroupID Cash Receipts
ipTableName
String
Indicates the tableName that triggered the update
needsLegalNumGenOpt
Boolean
Indicates whether the LegalNumGenOpts logic should be executed
updGroupTotals
Boolean
Indicates if the group totals should be calculated
requiresUserInput
Boolean@
Indicates if the legal number requires user input
opTotalCashReceived
Decimal@
The new Cash Group total received amount
ds
362
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
opTotalApplied
Decimal@
The new Cash Group total applied amount
opUnappliedBalance
Decimal@
The new Cash Group unapplied balance
opTotalMisc
Decimal@
The new Cash Group total misc amount
opTotalDiscount
Decimal@
The new Cash Group total discount amount
opTotalDeposit
Decimal@
The new Cash Group total deposit amount
opTotalARAmount
Decimal@
The new Cash Group total AR amount
opTotalWithhold
Decimal@
The new Cash Group total withhold amount
opUpdateRan
Boolean@
Indicates that the Update process did run
CashRecSearch Epicor.Mfg.BO.CashRecSearch: This business object contains 7 methods.
GetNewCashHead Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
363
A-E
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CCCountCycle Epicor.Mfg.BO.CCCountCycle: This business object contains 26 methods.
GetNewCCHdr Inserts a new row in the DataSet with defaults populated.
GetNewCCDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
364
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CancelPI This procedure will delete all records relating to a physical inventory cycle.
Epicor 9.05 | 9.05.605
365
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description Epicor.Mfg.BO.CCCountCycleDataSet
CloseCCDtlNoTags Closes Parts on the Cycle with no associated Tags if the user indicates to do so after Post Counts. Parameters Name
Type
ds pcMessage
Description Epicor.Mfg.BO.CCCountCycleDataSet
String@
Non-error, informational message.
GenerateRecountTags Parameters Name
Type
ds
Description The CCCountCycle data set
GenerateTags Parameters Name
Type
Description
vFirstTag
Int32@
First Tag generated integer
vLastTag
Int32@
Last Tag generated integer
ds
The CCCountCycle data set
GetBlankTags Parameters
366
Name
Type
Description
vBlankTagsAvail
Boolean@
Blank tags available for void logical
ds
The CCCountCycle data set
ds1
The CCTag data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetCycles Parameters Name
Type
Description
ipWarehouseCode
String
Selected Warehouse.
ipPeriod
Int32
period.
ipYear
Int32
Year.
opCycles
String@
opCycles.
GetLegalNumGenOpts Returns the legal number generation options. Parameters Name
Type
ds requiresUserInput
Description The CCCountCycleDataSet dataset
Boolean@
Requires User Input
GetPartTranPKs Return Primary Keys for generated PartTran records. Parameters Name
Type
Description
ipWarehouseCode
String
The Warehouse Code
ipCCYear
Int32
The CCYear
ipCCMonth
Int32
The CCMonth
ipCycleSeq
Int32
The CycleSeq
partTranPKs
String@
The PartTranPKs number
GetPeriods Parameters Name
Type
Description
ipWarehouseCode
String
Selected Warehouse.
ipYear
Int32
Selected Year
opPeriodList
String@
list of periods.
Epicor 9.05 | 9.05.605
367
A-E
Business Object Reference Guide
GetWarehouses Parameters Name
Type
Description
opWhseList
String@
list of warehouses.
GetYears Parameters Name
Type
Description
ipWarehouseCode
String
Selected Warehouse.
opYears
String@
opYears.
PostCount Post Count. Parameters Name
Type
ds
Description Epicor.Mfg.BO.CCCountCycleDataSet
pcMessage
String@
Non-error, informational message.
noTags
Boolean@
Flag indicating if parts with no tags were skipped.
ReverseStartCount Parameters Name
Type
ds
Description The CCCountCycle data set
StartCountSequence Parameters Name
Type
ds
Description The CCCountCycle data set
ValidateVoidPartNum Validate void tags by part number
368
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
warnmsg
String@
Warning message to return to UI
ds
The CCCountCycle data set
VoidBlankTags Parameters Name
Type
Description
ds
The CCTag data set
vTextMessage
String@
Message to display in UI
VoidTagsByPart Validate void tags by part number Parameters Name
Type
ds
Description The CCCountCycle data set
CCDtlSearch Epicor.Mfg.BO.CCDtlSearch: This business object contains 8 methods.
GetNewCCDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
369
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCountHistoryData Retrieves Count History related to a Part Parameters Name
Type
Description
partNum
String
Part Number
Returns The CCDtlSearch data set.
370
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CCHdrSearch Epicor.Mfg.BO.CCHdrSearch: This business object contains 8 methods.
GetNewCCHdr Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
371
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CCPartSelectUpd Epicor.Mfg.BO.CCPartSelectUpd: This business object contains 12 methods.
GetNewCCHdr Inserts a new row in the DataSet with defaults populated.
GetNewCCDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
372
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
373
A-E
Business Object Reference Guide
Returns
MoveParts Parameters Name
Type
Description
moveToMonth
Int32
The move-to month
moveToYear
Int32
The move-to month
moveToCycle
Int32
The move-to month
ds
CCPartSelectUpd dataset
OnChangePartNum Parameters Name
Type
Description
ipPartNum
String
Part Number
ds
CCPartSelectUpd dataset
RemoveParts Parameters Name
Type
ds
Description CCPartSelectUpd dataset
CCPeriodDefn Epicor.Mfg.BO.CCPeriodDefn: This business object contains 7 methods.
GetNewCCPeriodDefn Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
374
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CCSchedule Epicor.Mfg.BO.CCSchedule: This business object contains 17 methods.
GetNewCCWhsCtrl Inserts a new row in the DataSet with defaults populated.
GetNewCCHdr Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
375
A-E
Business Object Reference Guide
GetNewCCDtl Inserts a new row in the DataSet with defaults populated.
GetNewCCWhsABC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
376
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetCCDtlUOMSum Parameters Name
Type
Description
vWarehouseCode
String
Warehouse
vCCYear
Int32
Year
vCCMonth
Int32
Month
vFullPhysical
Boolean
Full Physical
vCycleSeq
Int32
cycle Seq
vPartNum
String
Part Number
Returns CCDtlUOM data set
OnChangeOfCCMonth This method validates CCProdCal Parameters Name
Type
Description
periodSeq
Int32
Proposed Cycle Count Period Defintion PeriodSeq
ds
The Warehouse Cycle Count Schedule Control data set
OnChangeOfCCProdCal This method validates CCProdCal
Epicor 9.05 | 9.05.605
377
A-E
Business Object Reference Guide
Parameters Name
Type
Description
calendarID
String
Proposed Cycle Count Calendar ID field
ds
The Warehouse Cycle Count Schedule Control data set
OnChangeOfCCYear This method validates CCProdCal Parameters Name
Type
Description
ccYear
Int32
Proposed Cycle Count Year
ds
The Warehouse Cycle Count Schedule Control data set
OnChangeWhseCode Parameters Name
Type
Description
ipWhseCode
String
ipWhseCode
ds
CCSchedule dataset
SelectParts Parameters Name
Type
ds
Description CCSchedule dataset
CCSheetSearch Epicor.Mfg.BO.CCSheetSearch: This business object contains 7 methods.
GetNewCCSheet Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
378
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CCTagSearch Epicor.Mfg.BO.CCTagSearch: This business object contains 7 methods.
GetNewCCTag Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
379
A-E
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
380
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangeImpact Epicor.Mfg.BO.ChangeImpact: This business object contains 2 methods. Loads the start up data for Change Impact Informer If a change is made to this method the same change should be applied to the GetSpecificBinSearch method. Returns Returns the new Change Impact Calculations
OnChangeParameters This method will recalculate the Early/Late/OnTime jobs when the JobReq, EarlyGracePeriod and LateGracePeriod change. Parameters Name
Type
ds
Description Change Impact DataSet
CheckLst Epicor.Mfg.BO.CheckLst: This business object contains 12 methods.
GetNewCheckList Inserts a new row in the DataSet with defaults populated.
GetNewCheckListAttch Inserts a new row in the DataSet with defaults populated.
GetNewCheckListDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
381
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
382
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns
ExportCheckList This method returns the data table ttChecklistImportExport containing all appropriate checklist information. The resulting records from the ttChecklistImportExport will then need to be outputted as a CSV file (comma delimited). Parameters Name
Type
Description
ipListID
String
The List ID of the selected Checklist.
opMessage
String@
Returns message about the status of the process.
Returns
ImportCheckList This method upload data into the database. This method expects an input data table ttCheckListImportExport with data coming from an external comma delimited file. The ttChecklistImportExport table should only contain data (i.e. if the first line of the external file is just the field descriptions then this record should not be included in ttChecklistImportExport.) Parameters Name
Type
Description
ipListID
String
The List ID of the selected Checklist.
opMessage
String@
Returns message about the status of the process.
ds
CheckRecSearch Epicor.Mfg.BO.CheckRecSearch: This business object contains 7 methods.
GetNewCheckHed Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
383
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChgLog Epicor.Mfg.BO.ChgLog: This business object contains 1 methods.
GetChgLog Gets the related ChgLog records based on TableName,RowID Parameters
384
Name
Type
Description
ip_TableName
String
Tablename to retrieve ChgLog records for
ip_RowID
String
RowID of the record to retrieve ChgLog records for
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChgLogGA Epicor.Mfg.BO.ChgLogGA: This business object contains 16 methods.
GetNewChgLogGA Inserts a new row in the DataSet with defaults populated.
GetNewBAMRule Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
385
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeRuleField Validate and update the data type of the field selected. Parameters Name
Type
Description
ds
ChgLogGA Dataset
ChangeTableName Only specific tables will have the ability to enable auto-printing. Parameters Name
Type
Description
proposedTableName
String
Table to validate if it can auto-print
ds
ChgLogGA Dataset
ChangeUseFieldList Validate that no column name is removed from the ChgLogGA.UseFieldList if it's already being used on a BAMRule.RuleField.
386
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
proposedUseFieldList
String
Proposed Use Field List
ds
ChgLogGA Dataset
ChangeUseFromToday Validate external fields for Row Rules when changing the UseFromToday field Parameters Name
Type
Description
ds
ChgLogGA Dataset
GetAvailableFields This method updates the dataset with the AvailableFields once a table has been specified Parameters Name
Type
Description
ds
Change Log/User Defined Global Alerts data set
This method returns a list of tables that a change log can be added to. Returns The list of tables returned
GetOperatorList Gets the Operator List to compare FieldName against a constant or another field Parameters Name
Type
Description
fieldType
String
Field Data-Type
operatorList
String@
Operator List
ClosePeriod Epicor.Mfg.BO.ClosePeriod: This business object contains 9 methods.
GetNewGLBookPer Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
387
A-E
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
388
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CloseAllPeriods Close all periods in a Fiscal Year Parameters Name
Type
Description
ipBookID
String
BookID
ipFiscalCalendarID
String
FiscalCalendarID
ipFiscalYear
Int32
FiscalYear
ipFiscalYearSuffix
String
FiscalYearSuffix
ds
The ClosePeriod data set
OnChangeClosedPeriod Run when the ClosedPeriod field is changed. Parameters Name
Type
Description
ipProposedValue
Boolean
Value that the user has entered (yes/no)
opMessage
String@
Warning message to the user
opCloseAll
Boolean@
Indication to the UI that the CloseAllPeriods method should be run if the user answers Yes
ds
The ClosePeriod data set
COA Epicor.Mfg.BO.COA: This business object contains 33 methods.
GetNewCOA Inserts a new row in the DataSet with defaults populated.
GetNewCOASegment Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
389
A-E
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IsSegValInUse Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
390
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CheckAllowAlpha Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckLengthWithRefEntity Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckCOALengthWithSegment Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckChartLength Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckConsolidatedCOA Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
Epicor 9.05 | 9.05.605
391
A-E
Business Object Reference Guide
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
IsCOAMasterCOA Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
IsChartUsedInTransaction Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckBalanceChange Determines if a balance segment is changing, and if it is, checks if a budget is setup. If it is, and the number of balance segments are being increased, informs the user the budgets may be invalid with this change. Parameters Name
Type
ds ipMessage
Description Chart of Accounts Data Set
String@
Message to display to the user
CheckDynamic Parameters Name
Type
Description
ipDynamic
Boolean
Proposed value of COASegment.Dynamic
ds
392
Chart of Accounts Data Set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CheckIfDeletingLastSegment Parameters Name
Type
Description
ipCOACode
String
Chart of Accounts Code
ipSegmentNbr
Int32
Segment Number the user wants to delete
opWarningMsg
String@
Warning message if this is NOT the last segment
opRenumberRequired
Boolean@
Indicates if the segments have to be renumbered
CheckRebuildBalances Parameters Name
Type
ds
Description Chart of Accounts Data Set
CheckSeparatorChar Parameters Name
Type
Description
ipSepChar
String
proposed separator character
CheckUseRefEntity Parameters Name
Type
Description
ipUseRefEntity
Boolean
Proposed value of COASegment.UseRefEntity
ds
Chart of Accounts Data Set
COAStructureChange Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Chart of Accounts Data Set
393
A-E
Business Object Reference Guide
DeleteAndRenumberSegments Parameters Name
Type
Description
ipCOACode
String
COA Code
ipSegDelete
Int32
Segment Number to Delete
Returns Chart of Accounts Dataset
MoveOnePosition This method moves the COASegment Display Order Up/Down one position in the grid and returns the whole updated datatable. Parameters Name
Type
Description
coaCode
String
Chart of Accounts Code
segmentNbr
Int32
COA Segment Number
dynamicOpt
Boolean
Indicates if a dynamic (yes) or controlled (no) segment (yes) is being moved
displayOrder
Int32
Current display order
moveDir
String
Direction to move task, "Up" or "Down"
Returns Chart of Accounts Dataset
PromptAutoCreateDynSegVals Parameters Name
Type
ds opAutoCreateSegValMsg
Description Chart of Accounts Data Set
String@
Message asking the user if dynamic seg values are to be created
SetRefEntityFields Parameters Name ds
394
Type
Description Chart of Accounts Data Set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateCOADynamicSegValues Parameters Name
Type
Description
ipCOACode
String
COA Code
ipSegmentNbr
Int32
Segment Number
UpdateDynamicSegment Parameters Name
Type
Description
ipDynamic
Boolean
Proposed value of COASegment.Dynamic
ds
Chart of Accounts Data Set
ValidateEntryControl Parameters Name
Type
Description
ipSegmentNbr
Int32
Segment Number
ipRefEntity
String
Reference entity value
ipEntryControl
String
Entry Control
ValidateRefEntity Parameters Name
Type
Description
ipRefEntity
String
Reference Entity to validate
ds
Chart of Accounts Data Set
opAutoCreateSegValMsg
String@
Message asking the user if dynamic seg values are to be created
opValuesAlreadyExist
String@
Message informing the user that COASegValues already exist
Epicor 9.05 | 9.05.605
395
A-E
Business Object Reference Guide
ValidateSegmentMaxLength Parameters Name
Type
Description
ipMaxLength
Int32
Proposed value of COASegment.MaxLength
ds
Chart of Accounts Data Set
ValidateSegmentMinLength Parameters Name
Type
Description
ipMinLength
Int32
Proposed value of COASegment.MaxLength
ds
Chart of Accounts Data Set
COAActCat Epicor.Mfg.BO.COAActCat: This business object contains 15 methods.
GetNewCOAActCat Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
396
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
BuildParentCategoryList returns a list-delimited of available parent categories in id,description pairs for selection Parameters Name
Type
Description
cCategory
String
Unique identifier of this category of accounts
Epicor 9.05 | 9.05.605
397
A-E
Business Object Reference Guide
Name
Type
Description
cType
String
Indicates if this category is a (B)alance Sheet or (I)ncome statement category.
cCOACode
String
COA Code of the account category.
cParentCatList
String@
list of available parent categories
CheckCOACode Checks COACode entered Parameters Name
Type
Description
newCoaCode
String
COA code entered
CheckNetIncome Checks netincome flag when the column changes Parameters Name
Type
Description
ipNetIncome
Boolean
proposed net income flag
ipCOACode
String
COA Code
ipCategoryID
String
Category ID
ds
COA Account Category Data Set
CheckType Checks type flag when the column changes Parameters Name
Type
Description
ipType
String
proposed net income flag
opWarnMsg
String@
warning message
ds
COA Account Category Data Set
CopyCategories This method copy Account Categories from one COA (Chart Of Account) to another COA.
398
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
fromCOACode
String
COA code to copy from
toCOACode
String
COA code to create
Returns The COA Category dataset
GetDefaultCoa returns a COA code, Master flag and description of default COA code Parameters Name
Type
Description
defaultCoaCode
String@
default COA code
defaultCoaDescription
String@
The description of the default COA code .
isDefaultCoaMaster
Boolean@
the flaf to indicate if it is master COA code
ValidateCOACode returns a description and Master COA flag of the entered COA code Parameters Name
Type
Description
coaCode
String
COA code entered
coaDescription
String@
The description of the COA code entered.
coaMaster
Boolean@
list of available parent categories
COABookSearch Epicor.Mfg.BO.COABookSearch: This business object contains 7 methods.
GetNewCOA Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
399
A-E
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
COAMapData Epicor.Mfg.BO.COAMapData: This business object contains 15 methods.
GetNewCOAMap Inserts a new row in the DataSet with defaults populated.
GetNewGLAccLink Inserts a new row in the DataSet with defaults populated.
400
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetNewSegmentLink Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
401
A-E
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
GetByDisplayName This method returns COAMapData dataset if display name is known Parameters Name
Type
Description
displayName
String
Display Name
Returns COAMap Data Data set
HistoryCleanup This method cleares history lookup tables. Parameters Name
Type
Description
inDate
Nullable{System.DateTime}
Oldest record date
OnChangeCOA This method called when value of Source/Target COA were changed. Parameters Name
Type
Description
coa
String
Source/Target COA
Populate Populates dataset Parameters Name
Type
Description
iCoaMap
Int32
srcSeg
cSource
String
field
cTarget
String
field
iSrcSeg
Int32
srcSeg
iTrgSeg
Int32
trgSeg
cFld
String
field
ds
402
COAMap Data Data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ValidateTargetCOA Parameters Name
Type
Description
ipTargetCOA
String
Proposed COA code
ds
Coa map Data Set
ValidateTargetCompany Parameters Name
Type
Description
ipTargetCompany
String
Proposed target Company
ds
Coa map Data Set
COAPE Epicor.Mfg.BO.COAPE: This business object contains 9 methods.
GetNewCOA Inserts a new row in the DataSet with defaults populated.
GetNewCOASegment Inserts a new row in the DataSet with defaults populated.
GetNewCOASegValues Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
403
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
COARefSearch Epicor.Mfg.BO.COARefSearch: This business object contains 7 methods.
GetNewCOA Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
404
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
COARefSegSearch Epicor.Mfg.BO.COARefSegSearch: This business object contains 7 methods.
GetNewCOA Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
405
A-E
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
406
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CoaSegAcctSearch Epicor.Mfg.BO.CoaSegAcctSearch: This business object contains 7 methods.
GetNewCOASegAcct Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
407
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
COASegBalance Epicor.Mfg.BO.COASegBalance: This business object contains 14 methods.
GetNewCOASegment Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
408
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckCOACode Checks COACode entered Parameters Name
Type
Description
newCoaCode
String
COA code entered
ComboValue returns a COA code, Master flag and description of default COA code Parameters Name
Type
Description
defaultCoaCode
String@
default COA code
defaultCoaDescription
String@
The description of the default COA code .
isDefaultCoaMaster
Boolean@
the flaf to indicate if it is master COA code
OnChangeBalancing This method convert the document currency to the journal currency. Parameters Name
Type
Description
iSegSelfBal
Boolean
The entry for the check box Self-Balancing
ds
Epicor 9.05 | 9.05.605
The Self-Balancing Segment Entry data set
409
A-E
Business Object Reference Guide
OnChangeBalancingAcct Parameters Name
Type
Description
iBalancingAcct
String
The balancing account to validate
icoaCode
String
COA Code
isegmentNbr
Int32
Segment Number
ds
The Self-Balancing Segment Entry data set
OnChangeLevel This method validates the level Parameters Name
Type
Description
ipProposedLevel
Int32
The proposed new level
ipSegmentNbr
Int32
Segment number currently being maintained
ipCOACode
String
COA Code for this segment
OnChangeOffsetAcct Parameters Name
Type
Description
iOffsetAcct
String
The offset account to validate
icoaCode
String
COA Code
isegmentNbr
Int32
Segment Number
ds
The Self-Balancing Segment Entry data set
ValidateCOACode returns a description and Master COA flag of the entered COA code Parameters
410
Name
Type
Description
coaCode
String
COA code entered
coaDescription
String@
The description of the COA code entered.
coaMaster
Boolean@
list of available parent categories
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
COASegmentSearch Epicor.Mfg.BO.COASegmentSearch: This business object contains 7 methods.
GetNewCOASegmentSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
411
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
COASegValues Epicor.Mfg.BO.COASegValues: This business object contains 16 methods.
GetNewCOASegValues Inserts a new row in the DataSet with defaults populated.
GetNewCOASegAcct Inserts a new row in the DataSet with defaults populated.
GetNewCOASegOpt Inserts a new row in the DataSet with defaults populated.
GetNewCOASegRes Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
412
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeCategory This method convert the document currency to the journal currency. Parameters Name
Type
Description
proposedCategory
String
The proposed Amount
ds
The GL COASegValues Entry data set
ChangeSegvalue Parameters Name
Type
Description
ipValue
String
The proposed segment value
ds
Epicor 9.05 | 9.05.605
The GL COASegValues Entry data set
413
A-E
Business Object Reference Guide
CheckForDupSegOpt Parameters Name
Type
Description
ipCOACode
String
COA Code
ipSubSegmentNbr
Int32
Segment Number to check for existence
ipSegmentCode
String
Segment Code to search for
ComboValues Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ValidateCurrencyAccount Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ValidateDefaultSegment Parameters Name
Type
Description
ipCOACode
String
COA Code
ipSubSegmentNbr
Int32
Segment Number to check for existence
ipSegmentCode
String
Segment Code to search for
Company Epicor.Mfg.BO.Company: This business object contains 48 methods.
GetNewCompany Inserts a new row in the DataSet with defaults populated.
414
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetNewCompanyAttch Inserts a new row in the DataSet with defaults populated.
GetNewAPSyst Inserts a new row in the DataSet with defaults populated.
GetNewARSyst Inserts a new row in the DataSet with defaults populated.
GetNewBMSyst Inserts a new row in the DataSet with defaults populated.
GetNewBorderPct Inserts a new row in the DataSet with defaults populated.
GetNewCRSyst Inserts a new row in the DataSet with defaults populated.
GetNewCSFSyst Inserts a new row in the DataSet with defaults populated.
GetNewCurrency Inserts a new row in the DataSet with defaults populated.
GetNewEQSyst Inserts a new row in the DataSet with defaults populated.
GetNewFASyst Inserts a new row in the DataSet with defaults populated.
GetNewFSSyst Inserts a new row in the DataSet with defaults populated.
GetNewGLSyst Inserts a new row in the DataSet with defaults populated.
GetNewISSyst Inserts a new row in the DataSet with defaults populated.
GetNewJCSyst Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
415
A-E
Business Object Reference Guide
GetNewPDMSyst Inserts a new row in the DataSet with defaults populated.
GetNewPRSyst Inserts a new row in the DataSet with defaults populated.
GetNewTaxSvcConfig Inserts a new row in the DataSet with defaults populated.
GetNewXaSyst Inserts a new row in the DataSet with defaults populated.
GetNewXBSyst Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewMMSyst Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
416
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeITFiscalCalendarID Performs required logic when XbSyst.ITFiscalCalendarID is modified. Parameters Name
Type
Description
ipITFiscalCalendarID
String
Proposed input value of Income Tax Fiscal Calendar
ds
Company data set
ChangeJPFiscalCalendarID Performs required logic when XbSyst.JPFiscalCalendarID is modified.
Epicor 9.05 | 9.05.605
417
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipJPFiscalCalendarID
String
Proposed input value of Japan Fiscal Calendar
ds
Company data set
CheckARinvcDates This method test the link of the dates in AR Invoice Parameters Name
Type
Description
opMessage
String@
Message to display to user if not null
CheckPayrollDate This method is to be run before the update method (or on leave of the field). If there is a problem with the date, a message will be returned for the user to approve or cancel. If the user approved the error, then the update method can be run. Parameters Name
Type
Description
payrollDate
Nullable{System.DateTime}
Payroll Start Date
payrollMessage
String@
Error message that the user needs to respond to
CheckVATFormat This method test the validity of the VAT format Parameters Name
Type
Description
opMessage
String@
Message to display to user if not null
ds
Company data set
ChgCompanyFisCal Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
418
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChgCountry This method defaults the tax region information when the Company.CountryNum field changes Parameters Name
Type
Description
ds
Company data set
ChgFASystFisCal Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChgingMJTemplate This method defaults the Maintenance Job Description when the MMSyst.TemplateJobNum field changes Parameters Name
Type
ds proposedTemplateJobNum
Description Company data set
String
Proposed input value of the Template Job Num
DisabledGLFields This method sens back a list of fields to be disabled Parameters Name
Type
Description
vCompany
String
Company number
vFieldList
String@
List of G/L Fields to be disabled
ETCAfterAddrVal After the tax integration has been called, update the Company address if it was changed.
Epicor 9.05 | 9.05.605
419
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The Company data set
ds1
The ETCAddrValidation data set
companyID
String
Company.CompanyID
ETCValidateAddress Call tax integration and loads temp tables from the results. Parameters Name
Type
Description
companyID
String
Company.Company
statusFlag
Boolean@
If set to true, the service is up. Else false it is down
errorFlag
Boolean@
If true, an error occured.
errorMsg
String@
If Error Flag is true, this is the associated message.
Returns The ETCAddrValidation data set
FormatList This method returns the list of available G/L account format styles Parameters Name
Type
Description
vCompany
String
Company number
formatList
String@
List of G/L formats
GetCheckOffLabels This method returns a delimited list of the CheckOff labels for either Job, Quote or DMR Parameters Name
Type
Description
appName
String
Either Job, Quote or DMR
labelList
String@
List of delimited labels
GetCPayCompanyList This method returns a list of valid Central Payment 'Parent Company' IDs UI note - user should select only ONE of the valid codes.
420
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
cpayCompanyList
String@
List of valid external company IDs
GetModLicensing This method returns the licensing flags for the company beging updates. If updating a company different from the one logged in on, then you need to use these variables in your licensing checks Parameters Name
Type
Description
vCompany
String
Company number
vModules
String@
List of Licensed Modules
GetNewBorderPercent This method replaces the standard GetNewBorderPct() method so the Company can be passed as a parameter Parameters Name
Type
ds company
Description Company data set
String
The company ID
GetSerialNumbers This method provides a list of license serial number available for use Parameters Name
Type
Description
serialList
String@
List of License Numbers
TestTaxConnection This method will test the tax integration connection to Avalara Parameters Name
Type
Description
svcURL
String
SvcURL
svcAccount
String
SvcAccount
svcLicense
String
SvcLicense
testResult
Boolean@
is Connection good, true or false
Epicor 9.05 | 9.05.605
421
A-E
Business Object Reference Guide
Name
Type
Description
testMessage
String@
text of whether test was good or why it wasn't good
ConfigSearch Epicor.Mfg.BO.ConfigSearch: This business object contains 8 methods. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
422
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListCustom Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the Part rows. Can be left blank for all rows.
whereClause2
String
An expression used to filter InspPlan rows. Can be left blank for all rows.
inspPlanOnly
Boolean
Only return InspPlan records
partOnly
Boolean
Only return Part records.
pageSize
Int32
Number of rows to return.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetConfigureableRevs This methods will return ConfigResultsRevs that will get populated for the given part number Parameters Name
Type
Description
ipPartNum
String
The PartNum to filter by
ipInspPlan
Boolean
True if inspection plan
Returns Dataset to search for configureable records.
Configuration Epicor.Mfg.BO.Configuration: This business object contains 48 methods.
GetNewPcInValue Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
423
A-E
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
424
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ApplyLeave Parameters Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
pageNum
Int32
The page of the configuration on which the event has taken place
Epicor 9.05 | 9.05.605
425
A-E
Business Object Reference Guide
Name
Type
Description
inputName
String
The name of the input for which the LEAVE triggers should be applied
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
ds
ds1 Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
DeleteTestRulePrograms Parameters Name
Type
Description
testMode
String
Current test mode
ds ds1
ApplyOrderPricing Parameters Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
ds
426
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
totalPrice
Decimal@
The total price (in the base currency) of the configuration pricing
basePrice
Decimal@
The base price (in the base currency) of the configuration that not associated with an input
ds1 Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ApplyPurchasePricing Parameters Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
totalPrice
Decimal@
The total price (in the base currency) of the configuration pricing
basePrice
Decimal@
The base price (in the base currency) of the configuration that not associated with an input
ds
ds1 Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
427
A-E
Business Object Reference Guide
ApplyQuotePricing Parameters Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
totalPrice
Decimal@
The total price (in the base currency) of the configuration pricing
basePrice
Decimal@
The base price (in the base currency) of the configuration that not associated with an input
ds
ds1 Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ProcessKeepWhen Parameters
428
Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
parentPartNum
String
parent part number
parentRevisionNum
String
parent revision number
parentRuleTag
String
parent rule tag
subPartNum
String
sub part number
subRevisionNum
String
sub revision number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
mtlSeq
Int32
Material Sequence to check
ruleTag
String
Rule tag to check
relatedToFile
String
Related to source file
relatedType
String
Related Type
sourceKey1
String
Source Link Key1
sourceKey2
String
Source Link Key1
sourceKey3
String
Source Link Key1
sourceKey4
String
Source Link Key1
sourceKey5
String
Source Link Key1
configMode
String
Configuration Mode
pcStructRowID
String
Rowid of PcStruct Record
Boolean@
Keep the material
Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
parentPartNum
String
parent part number
parentRevisionNum
String
parent revision number
parentRuleTag
String
parent rule tag
subPartNum
String
sub part number
subRevisionNum
String
sub revision number
mtlSeq
Int32
Material Sequence to check
ruleTag
String
Rule tag to check
relatedToFile
String
Related to source file
relatedType
String
Related Type
sourceKey1
String
Source Link Key1
sourceKey2
String
Source Link Key1
ds keepIt ds1 ds2
GetNextPartSeq Parameters
Epicor 9.05 | 9.05.605
429
A-E
Business Object Reference Guide
Name
Type
Description
sourceKey3
String
Source Link Key1
sourceKey4
String
Source Link Key1
sourceKey5
String
Source Link Key1
configMode
String
Configuration Mode
pcStructRowID
String
Rowid of PcStruct Record
Int32
Current Part Configuration Sequence
ds curPartCfgSeq ds1 ds2
DeleteOrderConfiguration Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
orderNum
Int32
The order for which the configuration should be deleted.
orderLine
Int32
The order line for which the configuration should be deleted.
DeleteQuoteConfiguration Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
quoteNum
Int32
The quote for which the configuration should be deleted.
quoteLine
Int32
The quote line for which the configuration should be deleted.
EnterPage Parameters
430
Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pageNum
Int32
The current page of the configuration
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
previousPage
Int32
The previous page of the configuration
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
Boolean@
Skipping OnLeave expressions when page loads
ds skipOPL ds1
GetConfigurationSequence Parameters Name
Type
Description
configMode
String
Configuration Mode
partNum
String
The main part being configured
revisionNum
String
The main revision being configured
relatedToFile
String
Related To File
relatedType
String
Related Type
linkKey1
String
Source Key1 value
linkKey2
String
Source Key1 value
linkKey3
String
Source Key1 value
linkKey4
String
Source Key1 value
linkKey5
String
Source Key1 value
nonApprvMessage
String@
Message with non approved part revisions
Returns
GetConfigurationSummary Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
relatedToFile
String
Related to source file
relatedType
String
Related Type
Epicor 9.05 | 9.05.605
431
A-E
Business Object Reference Guide
Name
Type
Description
sourceKey1
String
Source Link Key1
sourceKey2
String
Source Link Key1
sourceKey3
String
Source Link Key1
sourceKey4
String
Source Link Key1
sourceKey5
String
Source Link Key1
mtlSeq
Int32
Material Sequence of the revision being configured
Returns
GetPcInValueList Parameters Name
Type
Description
linkMode
String
QuoteDtl, OrderDtl, or JobAsmbl
key1
String
Key1 on which the configuration was saved.
key2
String
Key2 on which the configuration was saved.
key3
String
Key3 on which the configuration was saved.
key4
String
Key4 on which the configuration was saved.
key5
String
Key5 on which the configuration was saved.
Returns
GetDispConfSummary Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
partNum
String
Configured Part Number
revisionNum
String
Configured Part Revision Number
displaySummary
Boolean@
Returns true if the summary grid should be displayed.
GetGeneratedConfiguration Parameters
432
Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
partNum
String
The part being configured
revisionNum
String
The revision being configured
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
Returns
GetInputs Parameters Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
mtlSeq
Int32
Material Sequence of the revision being configured
specID
String
If a test plan then specification ID to test
specRev
String
If a test plan then specification revision to test
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
Returns
GetJobValues Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
jobNum
String
The job on which the configuration should be saved.
targetAssembly
Int32
The assembly sequence of the configured part.
partNum
String
The part being configured
revisionNum
String
The revision being configured
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
ds
ds1
Epicor 9.05 | 9.05.605
433
A-E
Business Object Reference Guide
GetOrderValues Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
orderNum
Int32
The order on which the configuration should be saved.
orderLine
Int32
The order line on which the configuration should be saved.
partNum
String
The part being configured
revisionNum
String
The revision being configured
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
kitFlag
String
Kit Flag
kitCompOrigSeq
Int32
Kit component original sequence
kitCompParentPart
String
Kit component parent part number
kitCompParentSeq
Int32
Kit component parent sequence
Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
demandContractNum
Int32
The demand contract number on which the configuration should be saved.
demandHeadSeq
Int32
The demand head sequence on which the configuration should be saved.
demandDtlSeq
Int32
The demand detail sequence on which the configuration should be saved.
partNum
String
The part being configured
revisionNum
String
The revision being configured
ds
ds1
GetDemandValues Parameters
ds
434
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
kitFlag
String
Kit Flag
kitCompOrigSeq
Int32
Kit component original sequence
kitCompParentPart
String
Kit component parent part number
kitCompParentSeq
Int32
Kit component parent sequence
ds1
GetTestPlanValues Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
relatedRowID
String
The rowID of the current InspResults record
ds ds1
LoadValuesFromSmartString Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
String
Smart String value
ds ipSmartString ds1
Epicor 9.05 | 9.05.605
435
A-E
Business Object Reference Guide
ValidateSmartString Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
partNum
String
The part being configured
revisionNum
String
The revision being configured
ipSmartString
String
Smart String value
Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
partNum
String
The part being configured
revisionNum
String
The revision being configured
relatedToFile
String
configuration related to file
targetAssembly
Int32
Target assembly sequence
key1
String
key1 of related to file
key2
String
key2 of related to file
key3
String
key3 of related to file
key4
String
key4 of related to file
key5
String
key5 of related to file
displaySmartString
Boolean@
Display smart string form
DisplaySmartString Parameters
EDIDemandConfiguration Parameters
436
Name
Type
Description
parentMfgCompID
String
Parent Manufacturing Company ID
iDemandContractNum
Int32
Demand Contract Number
iDemandHeadSeq
Int32
Demand Head Sequence that contains the configurable line
iDemandDtlSeq
Int32
Demand Detail Sequence that contains the configurable part
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
iSmartString
String
Smart String value
GetQuoteValues Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
quoteNum
Int32
The quote on which the configuration should be saved.
quoteLine
Int32
The quote line on which the configuration should be saved.
targetAssembly
Int32
The quote assembly on which the configuration should be saved.
partNum
String
The part being configured
revisionNum
String
The revision being configured
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
kitFlag
String
Kit Flag
kitCompOrigSeq
Int32
Kit component original sequence
kitCompParentPart
String
Kit component parent part number
kitCompParentSeq
Int32
Kit component parent sequence
ds
ds1
GetSmartString Parameters Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
relatedToFile
String
Related to source file
Epicor 9.05 | 9.05.605
437
A-E
Business Object Reference Guide
Name
Type
Description
relatedType
String
Related Type
sourceKey1
String
Source Link Key1
sourceKey2
String
Source Link Key1
sourceKey3
String
Source Link Key1
sourceKey4
String
Source Link Key1
sourceKey5
String
Source Link Key1
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
smartString
String@
The generated smartstring of the configuration
createPart
Boolean@
True if a new part should be created
promptForPartNum
Boolean@
True if the user should be prompted for the part number
notifyOfExistingPart
Boolean@
If true the user should be warned if the new part number already exists
newPartNum
String@
The generated portion of the new part number
createCustPart
Boolean@
If true the user should be asked if they want the Customer Part Number assigned
promptForCustPartNum
Boolean@
If true the user should be prompted to update the new Customer Part Number
newCustPartNum
String@
The generated customer part number
promptForAutoCreatePart
Boolean@
True if the user should be prompted to create part
Boolean@
If returned true then prompt user to overwrite existing configuration
ds promptForSIValues ds1
UpdateGlobalValues When paging paging forward to a lower level subassembly configured part, the GetxxxValues methods are called and the global variables defined in the ttConfigurationValue are updated from the ttGlbConfigurationValue table. This doesn't happen when paging backward from a subassembly configured part to a parent configured part. This procedure will update the GIVs in the current configurations ttConfigurationValue table from the ttGlbConfigurationValue. Parameters
438
Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The parent configured part
revisionNum
String
The revision number of the parent part
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
newPageNum
Int32
The new page number we are moving to
mtlSeq
Int32
Material Sequence of the parent part
ruleTag
String
Generated Rule Tag of the part being configured
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
ds
GetValues Parameters Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
specID
String
If a test plan then specification ID to test
specRev
String
If a test plan then specification revision to test
ds
ds1
NextPage Parameters Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
currentPageNum
Int32
The current page of the configuration
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
Epicor 9.05 | 9.05.605
439
A-E
Business Object Reference Guide
Name
Type
Description
newPageNum
Int32@
The next page number. If 0 the current page is the last page.
errText
String@
Text of error message.
Boolean@
Skipping OnLeave expressions when page loads
ds skipOPL ds1
GetInspResultsValues Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
inTgtRowID
String
RowID of the InspResults record
startKey1
String@
Key1 value from InspResults record
startKey2
String@
Key2 value from InspResults record
startKey3
String@
Key3 value from InspResults record
startKey4
String@
Key4 value from InspResults record
startKey5
String@
Key5 value from InspResults record
startInspDate
String@
Inspection Date from InspResults record
startInspTime
String@
Inspection Date from InspResults record
ProcessPassFail Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
basePartNum
String
The base part number used of the configuration.
baseRevisionNum
String
The base revision number used of the configuration.
testPassed
Boolean@
Inspection plan passed
failText
String@
Fail text to be displayed
ds ds1
440
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
PartExists Part exists. Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
basePartNum
String
Base Part Number
baseRevisionNum
String
Base Revision Number
newPartNum
String
The part being configured
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
partExists
Boolean@
Part Exists
promptForSIValues
Boolean@
Prompt to overwrite SI values
sIValues
Boolean@
Saving input values for this configuration
PreviousPage Parameters Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
currentPageNum
Int32
The current page of the configuration
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
Int32@
The previous page number. If 0 the current page is the first page.
ds newPageNum ds1
Epicor 9.05 | 9.05.605
441
A-E
Business Object Reference Guide
SaveJobConfiguration Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
jobNum
String
The job on which the configuration should be saved.
targetAssembly
Int32
The assembly sequence of the configured part.
basePartNum
String
The base part number used of the configuration.
baseRevisionNum
String
The base revision number used of the configuration.
smartString
String
The generated smartstring of the configuration
newPartNum
String
The Part Number to be used for a new part creation. If blank, a part will not be created.
responseAutoCrtPart
Boolean
Answer to the question presented to user about auto creating a part.
overwriteSIValues
Boolean
If user answers yes to question about overwrite saved input values then input true else always input false
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
configSmartString
String
Config Smart String Value
Boolean@
Returns true a new part was not created because it already exists.
Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
orderNum
Int32
The order on which the configuration should be saved.
orderLine
Int32
The order line on which the configuration should be saved.
basePartNum
String
The base part number used of the configuration.
ds newPartAlreadyExists ds1 ds2
SaveOrderConfiguration Parameters
442
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
baseRevisionNum
String
The base revision number used of the configuration.
smartString
String
The generated smartstring of the configuration
newPartNum
String
The Part Number to be used for a new part creation. If blank, a part will not be created.
newCustPartNum
String
The Customer Part Number to stored on the order line.
responseAutoCrtPart
Boolean
Answer to the question presented to user about auto creating a part.
overwriteSIValues
Boolean
If user answers yes to question about overwrite saved input values then input true else always input false
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
configSmartString
String
Config Smart String Value
Boolean@
Returns true a new part was not created because it already exists.
ds newPartAlreadyExists ds1 ds2
SaveDemandConfiguration Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
demandContractNum
Int32
The demand contract number on which the configuration should be saved.
demandHeadSeq
Int32
The demand head sequence on which the configuration should be saved.
demandDtlSeq
Int32
The demand detail sequence on which the configuration should be saved.
basePartNum
String
The base part number used of the configuration.
baseRevisionNum
String
The base revision number used of the configuration.
smartString
String
The generated smartstring of the configuration
newPartNum
String
The Part Number to be used for a new part creation. If blank, a part will not be created.
newCustPartNum
String
The Customer Part Number to stored on the demand detail line.
Epicor 9.05 | 9.05.605
443
A-E
Business Object Reference Guide
Name
Type
Description
responseAutoCrtPart
Boolean
Answer to the question presented to user about auto creating a part.
overwriteSIValues
Boolean
If user answers yes to question about overwrite saved input values then input true else always input false
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
configSmartString
String
Config Smart String Value
Boolean@
Returns true a new part was not created because it already exists.
Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
quoteNum
Int32
The quote on which the configuration should be saved.
quoteLine
Int32
The quote line on which the configuration should be saved.
targetAssembly
Int32
The quote assembly on which the configuration should be saved.
basePartNum
String
The base part number used of the configuration.
baseRevisionNum
String
The base revision number used of the configuration.
smartString
String
The generated smartstring of the configuration
newPartNum
String
The Part Number to be used for a new part creation. If blank, a part will not be created.
newCustPartNum
String
The Customer Part Number to stored on the quote line.
responseAutoCrtPart
Boolean
Answer to the question presented to user about auto creating a part.
overwriteSIValues
Boolean
If user answers yes to question about overwrite saved input values then input true else always input false
mtlSeq
Int32
Material Sequence of the revision being configured
ruleTag
String
Generated Rule Tag of the part being configured
configSmartString
String
Config Smart String Value
ds newPartAlreadyExists ds1 ds2
SaveQuoteConfiguration Parameters
444
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
A-E
Type
Description
Boolean@
Returns true a new part was not created because it already exists.
ds newPartAlreadyExists ds1 ds2
SaveTestPlan Parameters Name
Type
Description
testMode
String
The configuration test mode ("INPUTS" - Test Inputs Only, "RULES" Test Inputs and Rules, otherwise production mode)
relatedRowID
String
The RowID of the related InspResults record
ds ds1
TestRules Parameters Name
Type
Description
parentMfgCompID
String
The manufacturing company of the parent of the part being configured
partNum
String
The part being configured
revisionNum
String
The revision being configured
workStationID
String
The name of the workstation requesting the test
mtlSeq
Int32
Material Sequence of the revision being configured
ds
Configurator Epicor.Mfg.BO.Configurator: This business object contains 77 methods.
GetNewPcStatus Inserts a new row in the DataSet with defaults populated.
GetNewPcStatusAttch Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
445
A-E
Business Object Reference Guide
GetNewPcAudit Inserts a new row in the DataSet with defaults populated.
GetNewPcDocRules Inserts a new row in the DataSet with defaults populated.
GetNewPcPage Inserts a new row in the DataSet with defaults populated.
GetNewPcInputs Inserts a new row in the DataSet with defaults populated.
GetNewPcDynLst Inserts a new row in the DataSet with defaults populated.
GetNewPcDynLstCriteria Inserts a new row in the DataSet with defaults populated.
GetNewPcInputsExpr Inserts a new row in the DataSet with defaults populated.
GetNewPcPageExpr Inserts a new row in the DataSet with defaults populated.
GetNewPcPriceHed Inserts a new row in the DataSet with defaults populated.
GetNewPcInPrice Inserts a new row in the DataSet with defaults populated.
GetNewPcRules Inserts a new row in the DataSet with defaults populated.
GetNewPcStrComp Inserts a new row in the DataSet with defaults populated.
GetNewPcStruct Inserts a new row in the DataSet with defaults populated.
GetNewPcStructRules Inserts a new row in the DataSet with defaults populated.
446
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
447
A-E
Business Object Reference Guide
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
UpdateExpression Update expression fields for the given table using the text in the PcTempExpr dataset Parameters Name
Type
Description
ipTableName
String
Table for expression being updated
ipPartNum
String
Current Part Number
ipRevisionNum
String
Current Revision Number
ds
The Temp Expression data set
ipInputName
String
Current Input Name
ipTypeCode
String
Type of expression
ipPageSeq
Int32
Current Page Sequence
ds1
The Configurator data set
DeleteExpression Delete expression fields for the given table Parameters Name
Type
Description
ipTableName
String
Table for expression being updated
ipPartNum
String
Current Part Number
ipRevisionNum
String
Current Revision Number
ipInputName
String
Current Input Name
ipPageSeq
Int32
Current PageSeq
ipTypeCode
String
Type of expression to delete
ds
448
The Configurator data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
BuildSampleSmartString Updates the PcStatus Sample Smart String when the smart string parameters are changed. Parameters Name
Type
Description
ds
The Configurator data set
ChangingEntConf This methods checks to see if any enterprise configurator specific settings have been created. If so then a message should be displayed prior to unchecking the enterprise configurator checkbox Parameters Name
Type
Description
ipPartNum
String
Current Part Number
ipRevisionNum
String
Current Revision Number
settingsExist
Boolean@
Returns if enterprise configurator setting exist
CheckIsConfigured This methods is called prior to expanding a tree node on the Rules tab. If the part is a configureable part, the node will not be expanded Parameters Name
Type
Description
ipPartNum
String
The proposed part number
isConfigured
Boolean@
Returns true if the part is configured
CopyOrderPricingToQuote Copy the Order Input Pricing to the Quote Input Pricing. Parameters Name
Type
Description
configPartNum
String
The configuration Part Number
configRevisionNum
String
The configuration Revision Number
ds
The Configurator data set
CopyQuotePricingToOrder Copy the Quote Input Pricing to the Order Input Pricing.
Epicor 9.05 | 9.05.605
449
A-E
Business Object Reference Guide
Parameters Name
Type
Description
configPartNum
String
The configuration Part Number
configRevisionNum
String
The configuration Revision Number
ds
The Configurator data set
CreateNewInput Create a new input for a configuration Parameters Name
Type
Description
partNumber
String
The configuration Part number
revisionNumber
String
The configuration revision number
pageNumber
Int32
The configuration page number
controlType
String
The type of control being created
dataType
String
The datatype of the control
xPos
Int32
The initial x position of the control. If 0 then a default will be provided.
yPos
Int32
The initial y position of the control. If 0 then a default will be provided.
pWidth
Int32
The initial width of the control. If 0 then a default will be provided.
pHeight
Int32
The initial height of the control. If 0 then a default will be provided.
ds
The Configurator data set
CreatePcPage Create a new configuration page Parameters Name
Type
Description
partNum
String
The configuration Part number
revisionNum
String
The configuration revision number
newPageNumber
Int32
Page number of the new page
ds
The Configurator data set
CreatePcRules Create a new PcRules record
450
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
elementType
String
The type of element "par" - Header level rule "opr" - Operation level rule "dtl" - Operation Detail level rule "asm" - Assembly level rule "mtl" - Material level rule
partNum
String
The configuration Part number
revisionNum
String
The configuration revision number
altMethod
String
The alternate method of the rule
asmPartNum
String
The Assembly Part Number for subassemblies
oprSeq
Int32
The related operation
opDtlSeq
Int32
The OpDtlSeq for "dtl" rules
mtlSeq
Int32
The MtlSeq for "mtl" and "asm" rules
ruleType
String
The type of rule: "Calculation": A calculated value "Set Field": Set a field on a record "Keep When": Keep a operation, detail, or material only if the expression is true "Program Call": Run a program
ruleExpr
String
The expression of the rule
calcName
String
The name
calcDataType
String
The datatype of the calculation
dbTable
String
The DB table name of any referenced field (either as a Set Field or an expression reference)
dbField
String
The DB Field for a "Set Field" rule
ruleTag
String
User defined Rule Tag for this rule
ds
The Configurator data set
CreatePcStatus Create a new configuration for a Part Revision Parameters Name
Type
Description
partNum
String
The configuration Part number
revisionNum
String
The configuration revision number
isInspPlan
Boolean
Is this an inspection plan configuration
Returns The Configurator data set
GetAllAlternateTrees This methods will return a dataset that will include PartRev, PartOpr, PartOpDtl, PartMtl, PartMtlRestriction, PartMtlRestrictSubst, PartOprRestriction and PartOprRestrictSubst if those records exist for the appropriate input
Epicor 9.05 | 9.05.605
451
A-E
Business Object Reference Guide
parameters. ALL ALTERNATES OF THE PARTREVISION WILL BE RETURNED if ipcomplete is true This method will also allow you to return the whole dataset or allow the user to specify how far down the tree they would like to return possible "part" records for. Parameters Name
Type
Description
ipPartNum
String
The Part Number to return data for.
ipRevisionNum
String
The Revision Number to return data for.
ipUseDefaultMethod
Boolean
For partrev records other than the first one, would you like to use the default alternate method or the inputted one?
ipCurrentRuleTag
String
Generated Rule Tag for current material record
Returns The Rule BOM data set
GetDatasetForTree This methods will return a dataset that will include PartRev, PartOpr, PartOpDtl, PartMtl, PartMtlRestriction, PartMtlRestrictSubst, PartOprRestriction and PartOprRestrictSubst if those records exist for the appropriate input parameters. This method will also allow you to return the whole dataset or allow the user to specify how the revision to return possible "part" records for. Parameters Name
Type
Description
ipPartNum
String
The Part Number to return data for.
ipRevisionNum
String
The Revision Number to return data for.
ipAltMethod
String
The Alternate Method to return data for.
ipUseDefaultMethod
Boolean
For partrev records other than the first one, would you like to use the default alternate method or the inputted one?
ipCurrentRuleTag
String
Generated Rule Tag for current material record
ds
PC Rules BOM dataset
GenerateHTML Generate the HTML that can be used as a template for Customer Connect Parameters
452
Name
Type
Description
partNum
String
The configuration Part number
revisionNum
String
The configuration revision number
productCode
String
The product for which the HTML should be generated "CustConnect" = Customer Connect "SalesConnect" = Sales Connect
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pageSeq
Int32
The sequence number of the configuration page being generated.
allPages
Boolean
If true, PageSeq will be ignored and all pages will be generated.
outputPath
String@
The path to which the HTML files were generated.
GetAvailInputs Get the available inputs that may be used to build smart string. Parameters Name
Type
Description
partNum
String
The part number of the configurator
revisionNum
String
The part number of the configurator
availInputs
String@
The list of available inputs
GetBaseString Get the base string for use with expression building methods Parameters Name
Type
Description
expressionType
String
The type of base expression string "PW": Prompt When "PR": Pricing "OL": On Leave "DL": Dynamic List "PPW": Page Prompt When "POL": Page On Leave "PPF": Page Pass Fail
baseString
String@
GetConfigurationOptions Get the valid options that are used for populating configuration design options. This will populate the ConfigPartCreateMethod, ConfigSmartStringStyle, Parameters Name
Type
Description
optionType
String
The type of option to get. Valid values are: PartCreateMethods, SmartStringStyles, SeparatorChars, NumberFormats, PriceMultipliers, SmartStringDateFormats, SmartStringDateSeparators, SmartStringLogicalFormats, NumFormatSignOptions, HTMLProducts
optionList
String@
A list of valid options.
GetFieldExprType Move a rule up in the order of configuration rules.
Epicor 9.05 | 9.05.605
453
A-E
Business Object Reference Guide
Parameters Name
Type
Description
tableName
String
The name of the database table
fieldName
String
The name of the database field
exprType
String@
The expression type of the database field
GetFunctionList Get the functions available for a specific token Parameters Name
Type
Description
token
String
The token for which to get functions
expressionMode
String
The mode of the expression string "PW" - Prompt When "OL" - On Leave "DL" - Dynamic List "PR" - Pricing "RU" - Rules
curPartNum
String
Current part number
curRevisionNum
String
Current revision number
curInputName
String
Current input name
Returns The Configurator data set
GetGlbInputVarList Get a list of Global Input Variables to be used as available inputs in an expression. Parameters Name
Type
Description
iPartNum
String
Part Number where the global input variables may reside
iRevisionNum
String
Revision Number where the global input variables may reside
ds
The GlbInputVarList data set
GetInputsList Get the list of inputs and input functions available Parameters
454
Name
Type
Description
expressionMode
String
The mode of the expression string "PW" - Prompt When "OL" - On Leave "DL" - Dynamic List "PR" - Pricing "RU" Rules
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
token
String
The token being evaluated
partNum
String
The part number of the configurator
revisionNum
String
The part number of the configurator
currentInputName
String
The input for which the expression is being built
lastInputName
String
The last input referenced in the expression
ruleElementType
String
The type of rule expression (from PcRules.ElementType) Ignored if not processing a rule.
isForRule
String
Document Rule, Structure Rule, or Method Rule
inputList
String@
The list of inputs that can be selected
inputFunctionList
String@
The functions that can be chosen instead of an input
GetInputValues Get the potential values of an input. This will include static values and dynamic list values Parameters Name
Type
Description
partNum
String
The part number of the configurator
revisionNum
String
The part number of the configurator
currentInputName
String
The input for which the expression is being built
inputValues
String@
The list of potential values for the input
GetNextToken Get the next expression token out of an expression string Parameters Name
Type
Description
currentString
String
The string to be parsed for a token
token
String@
The token that was found. If blank, no token was found.
tokenStart
Int32@
The index (one-based) of the first character of the token
tokenEnd
Int32@
The index of the last character of the token.
GetNextPageSeq Get the next page sequence to be defaulted into new page form
Epicor 9.05 | 9.05.605
455
A-E
Business Object Reference Guide
Parameters Name
Type
Description
currentPartNum
String
Current Part Number
currentRevisionNum
String
Current Revision Number
newPageSeq
Int32@
Next page number
GetRuleFunctionList Get the functions available for a rule element type Parameters Name
Type
Description
ruleElementType
String
The type of element
Returns The Configurator data set
GetRuleList The types of rules that can be added for a specific element type/part number Parameters Name
Type
Description
ruleParPartNum
String
The base configured part number
ruleAsmPartNum
String
The assembly part number
ruleElementType
String
The type of element
ruleList
String@
The list of rule types that can be added
GetRuleSetFields Get a list of available field that can be set for a table. The list is returned in the PcFuncList of the ConfiguratorDataSet Parameters
456
Name
Type
Description
ruleParPartNum
String
The base configured part number
ruleElementType
String
The type of rule expression (from PcRules.ElementType)
ruleTable
String
The table that has been selected
tokenType
String
The token that the field should replace
currentlyCreating
String
Valid options are Document if creating document rule or null for method rule.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The Configurator data set
GetRuleTables Get a list of available tables for selection Parameters Name
Type
Description
ruleParPartNum
String
The base configured part number
ruleElementType
String
The type of rule expression (from PcRules.ElementType)
currentTable
String
The current table in use for the rule expression. (PcRules.dbTable)
currentlyCreating
String
Valid options are Document if creating document rule or null for method rule.
Returns The Configurator data set
ImportConfigurator Receives a dataset that contains the information about another configurator and will be imported into the current configurator. Parameters Name
Type
Description
iPartNum
String
Part Number
iRevisionNum
String
Revision Number
replComp
Boolean
Replace Company
aprvConfig
Boolean
Approve configurator after data is imported
doInputs
String
Import Inputs
doPartCreation
Boolean
Import Part Creation
doSmartString
Boolean
Import SmartString
doComments
Boolean
Import Comments
doStructRules
String
Import Structure Rules
doDocRules
String
Import Document Rules
doPcRules
String
Import Method Rules
doQuotePricing
String
Import Quote Pricing
doOrderPricing
String
Import Order Pricing
doPOPricing
String
Import PO Pricing
ds
Epicor 9.05 | 9.05.605
The ConfiguratorDataSet
457
A-E
Business Object Reference Guide
OnChangeBAQProgramName Check if the given BAQProgramName is valid and default the initial value Parameters Name
Type
Description
baqProgramName
String
The proposed BAQ Program Name
ds
The Configurator data set
OnChangeColumnName Check if the given ColumnName is valid and default the initial value Parameters Name
Type
Description
newColumnName
String
The proposed Column Name
ds
The Configurator data set
OnChangeDocRuleCompany Default values using the selected external company Parameters Name
Type
Description
inExtCompany
String
The proposed external company ID
ds
The Configurator data set
OnChangeInputValue Check if the given Input Value is valid and default the initial value Parameters Name
Type
Description
newInputValue
String
The proposed input value
ds
The Configurator data set
OnChangeGlbInputVarName Check if the given GlbInputVarName is valid and default the initial value
458
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
glbInputVarName
String
The new global input var name
ds
The Configurator data set
OnChangePriceInValue Check if the given PcInPrice.InValue is valid Parameters Name
Type
Description
inValue
String
The new InValue setting
ds
The Configurator data set
OnChangePriceAllValues Check if the given PcInPrice.AllValues setting is valid Parameters Name
Type
Description
allValues
Boolean
The new InValue setting
ds
The Configurator data set
OnChangeMinMaxDecimalValue Defaults the PcInputs Increment Precision when the Minimum or Maximum value changes Parameters Name
Type
Description
ds
The Configurator data set
OnChangeSingleLevelConf Check to see if any plant exist with a SourceType other than Sales Kit. Parameters Name
Type
Description
pcPartNum
String
The current part number
newSingleLevelConf
Boolean
The new singlelevelconf setting
ds
Epicor 9.05 | 9.05.605
The Configurator data set
459
A-E
Business Object Reference Guide
PromptForPassword This method checks the BMSyst record to see if a password should prompted for and then validated by the ValidatePassword method in UserFile BO. Run this before SyncRevision method is called. Parameters Name
Type
Description
ipTestPlan
Boolean
Is this a test plan.
ipPartNum
String
Part number of the revision being synched.
ipRevisionNum
String
Revision number being synched.
opPromptForPassword
Boolean@
Logical value stating whether the UI should prompt to validate for a password.
opRevisionStatus
Boolean@
Logical value indicating the current revision status.
opRevisionFound
Boolean@
Logical value indicating whether the revision was found.
RefreshStructDefs This methods will return a dataset that will include PcStruct records. It's for the parent configured part. Parameters Name
Type
Description
ipPartNum
String
The Part Number to return data for.
ipRevisionNum
String
The Revision Number to return data for.
ds
The Configurator data set
ReplaceToken Replace the first occurance of a token in an expression string with another string Parameters Name
Type
Description
expressionString
String@
The expression string to be modified
token
String
The token to replace
replacementString
String
The string that will replace the token
RulesMoveDown Move a rule down in the order of configuration rules.
460
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
pcRulesRowid
String
The RowIdent of the rule to be moved down
ds
The Configurator data set
RulesMoveUp Move a rule up in the order of configuration rules. Parameters Name
Type
Description
pcRulesRowid
String
The RowIdent of the rule to be moved up
ds
The Configurator data set
SalesKitConfiguration If a partplant record is available for the current plant then check the SourceType If not partplant available then check the typecode on the part record. Parameters Name
Type
Description
pcPartNum
String
The current part number
salesKit
Boolean@
SalesKit
SmartStringMoveDown Move a smart string input down in the available inputs list Parameters Name
Type
Description
pcStrCompRowid
String
The RowIdent of the input to be moved down
ds
The Configurator data set
SmartStringMoveUp Move a smart string input up in the selected inputs list Parameters Name
Type
Description
pcStrCompRowid
String
The RowIdent of the PcStrComp to be moved up
ds
Epicor 9.05 | 9.05.605
The Configurator data set
461
A-E
Business Object Reference Guide
SyncRevision This method synchronizes the part revision approval flag when the PcStatus.Approved flag changes Parameters Name
Type
Description
ipTestPlan
Boolean
Is this a test plan configuration
ipApproved
Boolean
The proposed approval flag
ipValidPassword
Boolean
Did the user supply a valid password to run this functionality? The value for this parameter should come from running the ValidatePassword method in the UserFile BO.
ipPartNum
String
The part number of the revision to synchronize
ipRevisionNum
String
The revision number to synchronize
ipAuditDesc
String
The audit description entered for the configuration approval
revSynched
Boolean@
Returns true if the revision was successfully approved
TestRuleSyntax Test the syntax for the expression builders Parameters Name
Type
Description
configPartNum
String
The configurator part number
configRevisionNum
String
The configurator revision number
elementType
String
The element type of the rule
ruleType
String
The rule type
ruleExpression
String
The rule expression to be checked
calcName
String
If a calcuation, the name of the calculation
calcDataType
String
If a calcuation, the datatype of the calculation
isForRule
String
Document Rule, Structure Rule, or Method Rule
syntaxIsCorrect
Boolean@
True if the syntax passes
syntaxMessage
String@
A message regarding the syntax to return to the user.
GenerateConfigSequence Called prior to testing input/rules to generate configuration sequence records Parameters
462
Name
Type
Description
configPartNum
String
The configurator part number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
configRevisionNum
String
The configurator revision number
DeleteConfigSequence Called after testing inputs/rules to delete configuration sequence records Parameters Name
Type
Description
configPartNum
String
The configurator part number
configRevisionNum
String
The configurator revision number
TestSyntax Test the syntax for the expression builders Parameters Name
Type
Description
configPartNum
String
The configurator part number
configRevisionNum
String
The configurator revision number
codeType
String
The type of syntax to be checked
syntaxIsCorrect
Boolean@
True if the syntax passes
syntaxMessage
String@
A message regarding the syntax to return to the user.
ds
The Temp Expression data set
ValidateCalcName Validate a new calculation name Parameters Name
Type
Description
partNum
String
The configuration Part number
revisionNum
String
The configuration revision number
altMethod
String
The alternate method of the rule
calcName
String
Calculation Name
Epicor 9.05 | 9.05.605
463
A-E
Business Object Reference Guide
ValidateFormatString Parameters Name
Type
Description
ipFormatString
String
input format string to validate
GetConditionList Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ConsolidToParent Epicor.Mfg.BO.ConsolidToParent: This business object contains 21 methods.
GetNewConsTgtGen Inserts a new row in the DataSet with defaults populated.
GetNewConsSrcCtrl Inserts a new row in the DataSet with defaults populated.
GetNewConsSrcRates Inserts a new row in the DataSet with defaults populated.
GetNewConsSrcAcctBal Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
464
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckConsReadyToPost Method to check if the Consolidation is ready to Generate. This needs to be run before GenerateConsolidation. Parameters Name
Type
Description
intGenID
Int32
GenID of record to post
txtSourceBook
String
Source Book of record to post
txtFiscalCalendarID
String
FiscalCalendarID of record to post
intFiscalYear
Int32
FiscalYear of record to post
txtFiscalYearSuffix
String
Fiscal Year Suffix of record to post
Epicor 9.05 | 9.05.605
465
A-E
Business Object Reference Guide
Name
Type
Description
intFiscalPeriod
Int32
Fiscal Period of record to post
txtpriorPeriodNotPostedMsg
String@
Prior Period not posted message text
txtperiodAlreadyPostedMsg
String@
Period already posted message text
txtperiodAlreadyGeneratedMsg
String@
Period already generated message text
txtfileAlreadyExistsMsg
String@
File Already Exists message text
sendErrorMsg Send a Error message Parameters Name
Type
Description
ipcMethod
String
Who is calling the method.
ipcGenID
String
Gen ID of the record with error.
ipcSourceBook
String
Source Book of the record with error.
ipcMsg
String
Error Messaged to be displayed.
ValidateClosingPeriods Validate ClosingPeriods Parameters Name
Type
Description
ipFiscalCalendarID
String
FiscalCalendarID
ipFiscalYear
Int32
FiscalYear
ipFiscalYearSuffix
String
Fiscal Year Suffix
proposedClosingPeriods
Int32
Proposed Closing Periods
ipCalledFromUI
Boolean
Logical value. True = Called from UI, False = Called from internal method in BO
opcMsg
String@
A message is returned if the given Period is invalid.
ValidateFiscalPeriod Validate FiscalPeriod Parameters
466
Name
Type
Description
ipcompany
String
Company. If left empty, the method use current company value.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipFiscalCalendarID
String
FiscalCalendarID
ipFiscalYear
Int32
Fiscal Year
ipFiscalYearSuffix
String
Fiscal Year Suffix
proposedFiscalPeriod
Int32
proposed Fiscal Period
ipCalledFromUI
Boolean
Logical value. True = Called from UI, False = Called from internal method in BO
opcMsg
String@
A message is returned if the given Period is invalid.
ValidateFiscalYear Validate FiscalYear and send back FiscalYearSuffix Parameters Name
Type
Description
ipFiscalCalendarID
String
FiscalCalendarID
proposedFiscalYear
Int32
Proposed FiscalYear
opFiscalYearSuffix
String@
FiscalYearSuffix
ipCalledFromUI
Boolean
Logical value. True = Called from UI, False = Called from internal method in BO
opcMsg
String@
A message is returned if the given Period is invalid.
ValidateGenID Validate the GenID Parameters Name
Type
Description
intGenID
Int32
GenID. Also know as Consolidation ID
GetConsDefIDData Validate ConsDefID and updates TgtCompany, TgtBook, TragetCOA, IntermediateBookID and ImmediateTrans Parameters Name
Type
Description
proposedConsDefID
String
Proposed ConsDefID
ds
Epicor 9.05 | 9.05.605
ConsolidToParent Dataset
467
A-E
Business Object Reference Guide
GetDefaults Method to call to get the default consolidation types and currency exchange rates. Parameters Name
Type
Description
ipGetDefaultType
Int32
GetDefault Type. 1 - All, 2 - Just record in screen.
ds
The ConsolidToParent data set
ValidateExchangeRate Validate changes on ExchangeRates and updates User Modified accordingly. Parameters Name
Type
Description
ds
ConsolidToParent dataset row
ValidateSrcFiscalPeriod Validate FiscalPeriod Parameters Name
Type
Description
proposedFiscalPeriod
Int32
proposed Fiscal Period
ds
ConsolidToParent Dataset
opcMsg
String@
A message is returned if the given Period is invalid.
opClosingPeriod
Int32@
Closing period number if proposed period is a closing period.
ValidatePrevRecords Validates record and returns message if a previous period has o has not been posted/generated. Parameters Name
Type
Description
intYear
Int32
Fiscal year to be evaluated
intPeriod
Int32
Fiscal period to be evaluated
txtPriorPeriodNotPostedMsg
String@
Prior Period not posted message text
txtPeriodAlreadyPostedMsg
String@
Period already posted message text
txtPeriodAlreadyGeneratedMsg
String@
Period already generated message text
ds
468
ConsolidToParent dataset row
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ConsTgtDef Epicor.Mfg.BO.ConsTgtDef: This business object contains 21 methods.
GetNewConsTgtDef Inserts a new row in the DataSet with defaults populated.
GetNewConsTgtSrc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
469
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckCOAMap Parameters Name
Type
Description
ipCOAMapUID
Int32
COA Map ID to validate
CheckConsolidationType Parameters Name
Type
Description
ipConsolidationType
String
proposed consolidation type (Periodic/Continuous)
ds
Consolidation targetDefinition Data Set
CheckConsType Parameters Name
Type
Description
ipConsType
String
ConsType to edit
ipConsTypeText
String
text that identifies the constype being validated
CheckCurrencyCode Parameters
470
Name
Type
Description
ipCurrencyCode
String
currency code to validate
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CheckIfResetTgtBook Parameters Name
Type
Description
ds
Consolidation targetDefinition Data Set
CheckIntermediateBook Parameters Name
Type
Description
ipIntermediateBook
String
IntermediateBookID
ds
Consolidation targetDefinition Data Set
CheckJournalCode Parameters Name
Type
Description
ipJrnlCode
String
Journal code to edit
ipJrnlCodeType
String
Identifies which journal code to edit: target or intermediate
ds
Consolidation targetDefinition Data Set
CheckOutputFile Parameters Name
Type
Description
ipOutputFile
String
output file
CheckRemoteParent Parameters Name
Type
Description
ipRemoteParent
Boolean
remote parent value
ds
Epicor 9.05 | 9.05.605
Consolidation targetDefinition Data Set
471
A-E
Business Object Reference Guide
CheckTargetBook Parameters Name
Type
Description
ipTargetBook
String
target book ID
ds
Consolidation targetDefinition Data Set
CheckTargetCompany Parameters Name
Type
Description
ipTargetCompany
String
target Company ID
ds
Consolidation targetDefinition Data Set
GetSourceCOA Parameters Name
Type
Description
ipSourceBook
String
Source GL Book ID
ds
Consolidation targetDefinition Data Set
IsSourceBookDefined Parameters Name
Type
Description
ipConsDefID
String
Consolidation Definition ID
ipSourceBook
String
Source GL Book ID
ConsType Epicor.Mfg.BO.ConsType: This business object contains 9 methods.
GetNewConsType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
472
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field.
Epicor 9.05 | 9.05.605
473
A-E
Business Object Reference Guide
Parameters Name
Type
Description
tableName
String
fieldName
String
Returns
GetRateTypeList Get rate type list Parameters Name
Type
Description
cRateTypeList
String@
Rate type list
Contact Epicor.Mfg.BO.Contact: This business object contains 6 methods.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
Description
tableName
String
fieldName
String
Returns
CondenseContactList Condenses the list of contacts. Parameters Name ds
Type
Description The ContactListDataSet Set
GetByID Get customers, shiptos and contacts by Contact Name.
474
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
contactName
String
The Contact Name
custNumList
String
Delimited list of customer numbers selected
inCustNum
Int32
Specific Customer number. Used for context menu
inShipToNum
String
Specific ShipTo Number. Used for context menu
inConNum
Int32
Specific Contact Number. Used for context menu
Returns The ContactDataSet Set
GetList List of contacts. Parameters Name
Type
Description
whereClause
String
Where condition
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The ContactListDataSet Set
GetListCustom List of contacts. Parameters Name
Type
Description
whereClause
String
Where condition
shipToWhereClause
String
ShipTo Where condition
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The ContactListDataSet Set
GetNewCustCntAttch Empty method so the adapter will add the attachment logic for CustCnt.
Epicor 9.05 | 9.05.605
475
A-E
Business Object Reference Guide
Parameters Name
Type
Description
custNum
Int32
The Customer Number
shipToNum
String
The ShipTo Number
conNum
Int32
The Contact Number
ContainerClass Epicor.Mfg.BO.ContainerClass: This business object contains 13 methods.
GetNewContainerClass Inserts a new row in the DataSet with defaults populated.
GetNewContClassMisc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
476
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DefaultContainerCost Calculates container cost when CostPerVolume or Volume change. Parameters Name
Type
ds
Description Container Class Data Set
DefaultCostPerVolume Calculates the CostPerVolume. Parameters Name
Type
ds
Description Container Class Data Set
OnContactChange Verifies if proposed Vendor Contact number is valid. If so, loads Vendor Contact Information. Parameters Name
Type
Description
ipContactNum
Int32
The Contact Number
ds
Epicor 9.05 | 9.05.605
The Supplier Shipment Class Data Set.
477
A-E
Business Object Reference Guide
OnIndirectCostChange Verifies if proposed Landed Cost Indirect Cost Code is valid. If so, loads Indirect Cost Amount and Currency code. Parameters Name
Type
Description
ipMiscCode
String
The Supplier ID
ds
The Supplier Shipment Class Data Set.
OnSupplierChange Verifies if proposed Supplier ID is valid. If so, loads Supplier's name. Parameters Name
Type
Description
ipSupplierID
String
The Supplier ID
ds
The Supplier Shipment Class Data Set.
ContainerTracking Epicor.Mfg.BO.ContainerTracking: This business object contains 59 methods.
GetNewContainerHeader Inserts a new row in the DataSet with defaults populated.
GetNewContainerHeaderAttch Inserts a new row in the DataSet with defaults populated.
GetNewContainerDetail Inserts a new row in the DataSet with defaults populated.
GetNewContainerDetailAttch Inserts a new row in the DataSet with defaults populated.
GetNewContainerDuty Inserts a new row in the DataSet with defaults populated.
GetNewContainerMisc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
478
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
479
A-E
Business Object Reference Guide
CalculateExtCostAndWeight Parameters Name
Type
Description
shipQty
Decimal
Quantity to ship
shipUOM
String
Shipping UOM
partNum
String
Part number on container detail
ourUnitCost
Decimal
Unit Cost on container detail
weight
Decimal@
Extended weight of detail
grossWeight
Decimal@
Gross weight of detail
vExtCost
Decimal@
Extended container cost or value
CheckContainerBeforeShipping Parameters Name
Type
Description
ipContainerID
Int32
ContainerID
CreateContainerIndCost Creates the default Miscellaneous Charges for the Container based on the Parameters Name
Type
Description
ds
APInvMiscCharges DataSet
ds1
Container Tracking Data Set
CreateMultiDetails Parameters Name
Type
ds
Description Container Tracking Data Set
containerErrors
String@
List of PO releases not added as container details
detailAdded
Boolean@
Indicates that at least one detail was added and is used by the UI to determine if the zero volume message is to be displayed
DefaultContainerCost Calculates container cost when CostPerVolume or Volume change
480
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
Container Tracking Data Set
DefaultCostPerVolume Calculates the CostPerVolume Parameters Name
Type
Description
ds
Container Tracking Data Set
DisburseLandedCosts Parameters Name
Type
Description
ipContainerID
Int32
Container IDt
opLCApplied
Decimal@
Total applied landed cost
GetAPInvMiscCharges Gets the list of AP Invoice Miscellaneous Charges marked as Landed Cost and and not linked to any container or receipt yet. Parameters Name
Type
Description
ipContainerID
Int32
Container ID
Returns The APInvMiscCharges DataSet
GetContainerClassInfo This method defaults the container class information into the conatiner header file whenever the container class is added/amended Parameters Name
Type
Description
cclass
String
cclass
volume
Decimal@
volume
containerCost
Decimal@
container Cost
costPerVolume
Decimal@
Cost per volume
Epicor 9.05 | 9.05.605
481
A-E
Business Object Reference Guide
Name
Type
Description
shippingDays
Int32@
shipping Days
validContainer
Boolean@
valid Container
GetContainerDetailToSplit Gets the Detail of a specific Container Header to be splitted. Parameters Name
Type
Description
ipContainerID
Int32
Container ID
Returns The ContainerDetailToSplit DataSet
GetContainerMiscToTransfer Gets the Indirect Costs of a specific Container Header to be transfered. Parameters Name
Type
Description
ipContainerID
Int32
Container ID
Returns The ContainerMiscToTransfer DataSet
GetDtlPOInfo This method updates the dataset when the detail Line PONum field has changed. Parameters Name
Type
ds
Description The Receipt data set
poLine
Int32
Receipt Line to check
poNum
Int32
New PO Number
GetDtlPOLineInfo This method updates the dataset when the detail Line POLine field has changed. Parameters
482
Name
Type
Description
poNum
Int32
New POLine Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
poLine
Int32
Receipt Line to check
ds
The Receipt data set
GetDtlQtyInfo This method updates the dataset when the ShipQty or IUM field changes Parameters Name
Type
ds
Description The ContainerTracking data set
poNum
Int32
Container PO Number
poLine
Int32
Container PO Line
poRelNum
Int32
Container PO Rel
inputShipQty
Decimal
Proposed change to the Ship qty field
inputIUM
String
Proposed change to the IUM field
whichField
String
Indicates either 'QTY' or 'UOM' field changed
warnMsg
String@
A warning message for users. Does not stop processing
GetPOReleaseInfo This method defaults the container class information into the conatiner header file whenever the container class is added/amended Parameters Name
Type
Description
porelnum
Int32
pore num
ds
Container Tracking Data Set
OnChangeClassCode This method should be invoked when the Container Class ID changes. This method will validate the container class and pull in the new default class information. Parameters Name
Type
Description
ipClassCode
String
Proposed Container Class Code to be validated
ds
Epicor 9.05 | 9.05.605
The Container Tracking data set
483
A-E
Business Object Reference Guide
OnChangeConNum This method should be invoked when the ConNum changes. This method will validate the VendCnt and pull in the new default information. Parameters Name
Type
Description
ipConNum
Int32
Proposed ConNum to be validated
ds
The Container Tracking data set
OnChangedPOTransValue This method should be invoked when the PO Transaction Value has changed. Parameters Name
Type
ds
Description The Container Tracking data set
OnChangeDtlCommodity This method should be invoked when the CommodityCode in ContainerDetail changes. This method will validate the commodity code and get defaults. Parameters Name
Type
Description
ipCommCode
String
Proposed Commodity Code to be validated
ds
The Container Tracking data set
OnChangeDtlCountryNum This method should be invoked when the OrigCountryNum in ContainerDetail changes. This method will validate country of origin. Parameters Name
Type
Description
ipCountryNum
Int32
Proposed Country of Origin to be validated
ds
The Container Tracking data set
OnChangeDtlLCIndCost This method should be invoked when the LCIndCost in ContainerDetail changes. This method will validate the manually disbursed indirect cost.
484
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipLCIndCost
Decimal
Proposed LC Indirect Cose to be validated
ds
The Container Tracking data set
OnChangeDtlUpliftPercent This method should be invoked when the UpliftPercent in ContainerDetail changes. This method will validate the UpliftPercent and calculate the Uplift Indirect Cost. Parameters Name
Type
Description
ipUpliftPercent
Decimal
Proposed Uplift Percentage to be validated
ds
The Container Tracking data set
OnChangeDutyTariffCode This method should be invoked when the Tariff Code changes. This method will validate the tariffcode and defaults the duty amount. Parameters Name
Type
Description
ipTariffCode
String
Proposed Tariff Code to be validated
ds
The Container Tracking data set
OnChangeLoadPort This method should be invoked when the Loading Port ID changes. This method validate selected Port and set default value of Country Imported From. Parameters Name
Type
Description
ipLoadPortID
String
Loading Port ID
ds
The Container Tracking data set
OnChangeMiscApplyDate This method should be invoked when the Apply Date in ContainerMisc changes. This method will validate the date and get new exchange rate.
Epicor 9.05 | 9.05.605
485
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipApplyDate
Nullable{System.DateTime}
Proposed Apply Date to be validated
ds
The Container Tracking data set
OnChangeMiscCharge This method should be invoked when the Miscellaneous Charge ID changes. This method will validate the misc. charge and pull in the new default information. Parameters Name
Type
Description
ipChargeID
String
Proposed PurMisc ID to be validated
ds
The Container Tracking data set
OnChangeMiscCurrencyCode This method should be invoked when the Currency Code in ContainerMisc changes. This method will validate the currency code and pull in the new default information. Parameters Name
Type
Description
ipCurrCode
String
Proposed Currency Code to be validated
ds
The Container Tracking data set
OnChangeMiscDocEstimateAmt This method should be invoked when the ContainerMisc.EstimateAmt changes. This method will validate the amount and convert it to the base currency. Parameters Name
Type
Description
ipDocEstimateAmt
Decimal
Proposed Estimate Amount in document currency
ds
The Container Tracking data set
OnChangeMiscExchangeRate This method should be invoked when the Currency Exchange Rate in ContainerMisc changes. Parameters
486
Name
Type
Description
ipExchangeRate
Decimal
Proposed Currency Exchange Rate to be validated
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
ds
Description The Container Tracking data set
OnChangeMiscInvoiceLine This method should be invoked when the Invoice Line in ContainerMisc changes. This method will validate the invoice line and pull in the new default information. Parameters Name
Type
Description
ipInvLine
Int32
The AP Invoice Line to be validated
ds
The Receipt data set
OnChangeMiscInvoiceNum This method should be invoked when the Invoice Number in ContainerMisc changes. This method will validate the invoice number and pull in the new default information. Parameters Name
Type
Description
ipInvNum
String
The AP Invoice Number to be validated
ipVendorNum
Int32
The Vendor Number associated with the invoice
ds
The Receipt data set
OnChangeMiscMscNum This method should be invoked when the MscNum in ContainerMisc changes. This method will validate the MscNum and pull in the new default information. Parameters Name
Type
Description
ipMscNum
Int32
The AP Invoice Line Miscellaneous Sequence Number to be validated
ds
The Receipt data set
OnChangeMiscRateGrp This method should be invoked when the Currency Rate Group in ContainerMisc changes. This method will validate the rate group and get new exchange rate.
Epicor 9.05 | 9.05.605
487
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipRateGrpCode
String
Proposed Currency Rate Group Code to be validated
ds
The Container Tracking data set
OnChangeMiscVendor This method should be invoked when the vendor ID in ContainerMisc changes. This method will validate the vendor and pull in the new default vendor information. Parameters Name
Type
Description
vendID
String
Proposed vendor ID to be validated
ds
The Container Tracking data set
OnChangeShipStatus This method should be invoked when the Ship Status changes. This method will validate the ship status and returns a value to indicate if the UI needs to run special method to ship/unship container details when necessary. Parameters Name
Type
Description
ipShipStat
String
Proposed Shipment Status to be validated
opShipLogic
String@
Returns one of the valid values: SHIP, UNSHIP, or blank
ds
The Container Tracking data set
OnChangeVendor This method should be invoked when the vendor ID changes. This method will validate the vendor and pull in the new default vendor information. Parameters Name
Type
Description
vendID
String
Proposed vendor ID to be validated
ds
The Container Tracking data set
PreUpdateContainer This method will return a message if the Container Header has a change in UpliftPercent. The user will be asked if the change should be applied to all the Container Details as well. This method should be called when the user saves the record but before the Update method is called.
488
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
opWarnMsg
String@
The warning message to be returned to the user.
ds
The Container Tracking data set
ReceiveContainerLCAmt Parameters Name
Type
Description
inContainerID
Int32
Container ID
opMessage
String@
Message to return back to user.
RefreshLCApplied Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ResetLandedCostDisbursements Initialize landed cost amounts to 0 and updates the landed cost disburse method. Parameters Name
Type
Description
ipContainerID
Int32
Container ID to reset
ipDisburseMethod
String
Landed Cost Disbursment method
ShipContainer container To Ship Parameters Name
Type
Description
containerToShip
Int32
container To Ship
Epicor 9.05 | 9.05.605
489
A-E
Business Object Reference Guide
SplitContainerShipment Splits a Container by creating a new Container Header and assigning the selected Container Detail lines into the new Container. Parameters Name
Type
Description
ds opContainerID
The ContainerDetailToSplit DataSet Int32@
New Container ID
TransferIndirectCosts Transfers Indirect Costs from one container to another. Parameters Name
Type
Description
ipTargetContainerID
Int32
Target Container ID
ds
The ContainerMiscToTransfer DataSet
UnShipContainer container To UnShip Parameters Name
Type
Description
containerToUnShip
Int32
container To UnShip
UpdateLCAppliedAmt Parameters
490
Name
Type
Description
origLCAmt
Decimal
original landed cost amount
newLCAmt
Decimal
new landed cost amount
ipcontainerID
Int32
container ID
ipAppliedAmt
Decimal
current applied landed cost amount
totApplied
Decimal@
total applied landed cost
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ValidateLandedCostDisbursements Parameters Name
Type
ds lcError
Description Container Tracking Data Set
String@
error message
ValidateShipQty Parameters Name
Type
Description
shipQty
Decimal
Proposed Ship Qty
shipUOM
String
Ship Qty UOM
ium
String
PODetail.IUM
partNum
String
PartNum
poNum
Int32
Purchase order number
poLine
Int32
Purchase order line number
poRelNum
Int32
Purchase order release number
warningMsg
String@
Warning mesage
ContractRenewalSearch Epicor.Mfg.BO.ContractRenewalSearch: This business object contains 8 methods.
GetNewContractRenewalSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
491
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRenewals Returns the renewals Parameters
492
Name
Type
Description
customerNum
Int32
customer number to return renewals for
whereClause
String
WhereClause to filter the Parent records.
sortByClause
String
To sort by the detail records.
pageSize
Int32
Page Size.
absolutePage
Int32
Absolute Page
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
morePages
Boolean@
More Pages
Returns The Service Contract Search list data set
CorrectiveAction Epicor.Mfg.BO.CorrectiveAction: This business object contains 9 methods.
GetNewDMRCorAct Inserts a new row in the DataSet with defaults populated.
GetNewDMRCorActAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
493
A-E
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ReopenDMRCorAct Call this method to reopen a particular DMR Corrective Action record. Parameters Name
Type
Description
ipActionID
Int32
The Action ID of the Corrective Action to reopen
Returns Corrective Actions Data Set
CostAdjustment Epicor.Mfg.BO.CostAdjustment: This business object contains 14 methods.
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCostAdjustment Obtains the cost fields, part description, transaction date, cost method and other fields for the Cost Adjustment UI.
494
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
pcPartNumber
String
The part number entered by the user..
ds
DataSet for the cost adjustment UI.
GetCostAdjustmentMultiple It accepts a list of Partnumber and builds a CostAdjustmentDataSet. The CostAdjustmentDataSet contains the cost fields, part description, transaction date, cost method and other fields for the Cost Adjustment UI. Parameters Name
Type
ds
Description List of Partnumber
Returns DataSet for the cost adjustment UI.
GetFIFOCosts Obtains the FIFO costs for a part which has a cost method of 'F'. Parameters Name
Type
ds
Description Updated dataset with the FIFO costs.
GetLotCosts Obtains the lot costs for a part which has a cost method of 'T'. Parameters Name
Type
ds
Description Updated dataset with the lot costs.
GetNewCostAdjustment This method creates a new CostAdjustmentDataSet row entry. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description DataSet for the cost adjustment UI.
495
A-E
Business Object Reference Guide
GetNewCostAdjustmentList This method creates a new ttCostAdjustmentList row entry. Parameters Name
Type
ds
Description DataSet for the cost adjustment UI.
OnChangeAvgMtlUnitCost Call this method when the user changes the Average Material Unit Cost. Parameters Name
Type
Description
dAvgMtlUnitCost
Decimal
The average material unit cost entered by the user..
ds
DataSet for the cost adjustment UI.
OnChangeFIFOMaterialCost Call this method when the user changes the FIFO Material Unit Cost. Parameters Name
Type
Description
dFIFOMaterialCost
Decimal
The FIFO material unit cost entered by the user.
ds
DataSet for the cost adjustment UI.
OnChangeLastMtlUnitCost Call this method when the user changes the Last Material Unit Cost. Parameters Name
Type
Description
dLastMtlUnitCost
Decimal
The last material unit cost entered by the user..
ds
DataSet for the cost adjustment UI.
OnChangePartNum Call this method when the user enters a PartNum.
496
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
pcPartNumber
String
The part number entered by the user..
ds
DataSet for the cost adjustment UI.
OnChangeStdMtlUnitCost Call this method when the user changes the Standard Material Unit Cost. Parameters Name
Type
Description
dStdMtlUnitCost
Decimal
The standard material unit cost entered by the user..
ds
DataSet for the cost adjustment UI.
PreSetCostAdjustment This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
Boolean@
Indicates if the legal number requires user input
ds requiresUserInput
SetCostAdjustment This procedure validates the fields in the CostAdjustment dataset. Then updates the costs in the Part record, PartLot (if applicable) and creates the appropriate PartTran records. Parameters Name
Type
ds partTranPKs
Description CostAdjustment data set.
String@
Part Tran primary keys.
CostBurdenSearch Epicor.Mfg.BO.CostBurdenSearch: This business object contains 7 methods.
GetNewCostBurden Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
497
A-E
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
498
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CostLaborSearch Epicor.Mfg.BO.CostLaborSearch: This business object contains 7 methods.
GetNewCostLabor Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
499
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CostPartSearch Epicor.Mfg.BO.CostPartSearch: This business object contains 7 methods.
GetNewCostPart Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
500
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CostWorkBench Epicor.Mfg.BO.CostWorkBench: This business object contains 33 methods.
GetNewCostGrp Inserts a new row in the DataSet with defaults populated.
GetNewCostBurden Inserts a new row in the DataSet with defaults populated.
GetNewCostLabor Inserts a new row in the DataSet with defaults populated.
GetNewCostPart Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
501
A-E
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeCopyFromGroupID Method to call when changing the copy from group id on the cost group. Validates the group id and updates CostGrp with default values based on the new group id.
502
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
proposedGroupID
String
The proposed plant cost id
ds
The CostWorkBench data set
ChangeCopyFromPlantCostID Method to call when changing the copy from plant cost id on the cost group. Validates the plant cost id and updates CostGrp with default values based on the new plant cost id. Parameters Name
Type
Description
proposedPlantCostID
String
The proposed plant cost id
ds
The CostWorkBench data set
ChangeCWBPostPostToPlantCostID Method to call when changing the post to cost id on the post cost table (CostWorkBenchPost). Validates the plant cost id recreates CostWorkBenchPostPlants records for the new cost id. Prior to calling this method all CostWorkBenchPostPlants records must have the RowMod value set to U because they will be deleted. Parameters Name
Type
Description
proposedPlantCostID
String
The proposed plant cost id
ds
The CostWorkBenchPost data set
ChangePrimaryPlant Method to call when changing the primary plant on the cost group. Validates the plant id and updates CostGrp with default values based on the new plant. Parameters Name
Type
Description
proposedPlant
String
The proposed plant
ds
The CostWorkBench data set
CostPost Post costs for the group.
Epicor 9.05 | 9.05.605
503
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description The CostWorkBenchPost data set
pcCostsNotUpdatedMsg
String@
Informational message to display to indicate which costs were not updated.
pcLegalNumberMessage
String@
Message text to indicate the generated number.
Returns The CostWorkBench data set
CostRollUp Roll up costs for the group. Parameters Name
Type
ds pcPartsNotUpdatedMsg
Description The CostWorkBenchRollUp data set
String@
Informational message to display to indicate which parts were not updated.
Returns The CostWorkBench data set
GetCostSet This method creates/refreshes the costs for the Cost Group. Parameters Name
Type
Description
ds cReturnMessage
The CostWorkBenchCostSet data set String@
Informational message to display after the process is done
Returns The CostWorkBench data set
GetCostWBInternalPrices This method will create an empty CostWBInternalPrices record to use in populating the parameters required to update the internal prices The WorkstationID, DateFormat and NumericFormat fields are not user updatable The Action field is one of 3 values 'All' = 'Calculate, Print, Update', 'Print' = 'Calculate, Print', 'Update' = 'Calculate, Update' Parameters
504
Name
Type
Description
cGroupID
String
The Group ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The CostWBInternalPrices data set
GetCostWorkBenchCostSet This method will create a CostWorkbenchCostSet record which is used to store user options for the getting the CostPart, CostLabor, and CostBurden records. Parameters Name
Type
Description
cGroupID
String
The Group ID
Returns The CostWorkBenchCostSet data set
GetCostWorkBenchPost This method will create a CostWorkbenchPost record which is used to store user options for the Post option. Parameters Name
Type
Description
cGroupID
String
The Group ID
Returns The CostWorkBenchPost data set
GetCostWorkBenchRefresh This method will create a CostWorkbenchRefresh record which is used to store user options for refreshing costs in the CostPart, CostLabor, and CostBurden records. Parameters Name
Type
Description
cGroupID
String
The Group ID
Returns The CostWorkBenchRefresh data set
GetCostWorkBenchRollUp This method will create a CostWorkbenchRollUp record which is used to store user options for the rollup option. Parameters Name
Type
Description
cGroupID
String
The Group ID
Returns The CostWorkBenchRollUp data set
Epicor 9.05 | 9.05.605
505
A-E
Business Object Reference Guide
ListCostingEdits Returns the list for Costing Edits. The list is in code1`desc1~code2`desc2 format. Parameters Name
Type
Description
cCostingEditList
String@
The Costing Edits List.
ListFilters Returns the list for filter options for parts. The list is in code1`desc1~code2`desc2 format. Parameters Name
Type
Description
cFilterList
String@
The Filter List.
ListOprAndResourceSortBy Returns the list for sort by options for Operations and Resource Groups. The list is in code1`desc1~code2`desc2 format. Parameters Name
Type
Description
cOprResourceSortByList
String@
The Sort By List.
ListPartCostingMethod Returns the list of available costing methods for a part. The list is in code1`desc1~code2`desc2 format. Parameters Name
Type
Description
cPartCostingMethodList
String@
The Part Costing Method List.
ListPartSortBy Returns the list for sort by options for parts. The list is in code1`desc1~code2`desc2 format. Parameters
506
Name
Type
Description
cPartSortByList
String@
The Sort By List.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ListRates Returns the list of available rates for Resource Groups and Operations. The list is in code1`desc1~code2`desc2 format. Parameters Name
Type
Description
cRatesList
String@
The Rates List.
PreCostRollUp Pre-processing before the rolling up of costs for the group. Check if there are unapproved revisions that are in the rollup criteria. If there are, return a message to the UI to ask the user if it is ok to proceed. If pcQuestion is blank, a question does not need to be asked. Parameters Name
Type
Description
ds
The CostWorkBenchRollUp data set
pcQuestion
String@
The text of the question to ask the user.
RefreshCosts This method refreshes the costs for the Cost Group. Parameters Name
Type
ds
Description The CostWorkBenchRefresh data set
Returns The CostWorkBench data set
UpdateInternalPrices This method takes the CostWBInternalPricesDataSet and either prints and/or updates the Internal Price change Parameters Name
Type
ds cReturnMessage
Description The CostWBInternalPrices data set
String@
Informational message to display after the process is done
ViewCosts This method will return the data need to display Part Rev costs.
Epicor 9.05 | 9.05.605
507
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipGroupID
String
The Cost Group ID to return costs for.
ipTypeCode
String
The Type Code of the Part to return costs for (CostPart.TypeCode).
ipPartNum
String
The Part Number to return costs for.
ipQuantity
Decimal
The Quantity to return costs for.
ipMaxLevel
Int32
The Max Level to return costs for.
ipAssembliesOnly
Boolean
Assemblies only
Returns The CostWorkBenchCosts data set
COSWIP Epicor.Mfg.BO.COSWIP: This business object contains 7 methods.
CaptureCOSWIP Capture COS/WIP Activity Parameters Name
Type
ds
Description The COSWIP data set
ChangeEndingDate Change ending date Parameters Name
Type
ds endDate
Description The COSWIP data set
Nullable{System.DateTime}
The ending date
CheckInconsistentDates Check inconsistent dates Parameters Name
Type
ds daStartingDate
508
Description The COSWIPDates data set
Nullable{System.DateTime}
The starting date for the wip/cos process
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
lAskToContinue
Boolean@
Boolean that defines if we ask to continue
cMessageText
String@
The message text
COSWIPDatesUpdate Update COSWIPDates data set Parameters Name
Type
ds
Description The COSWIPDates data set
Get new record in COSWIP data set Returns The COSWIP data set
GetCOSWIPDatesList Public method to get the COSWIPDates dataset. Parameters Name
Type
Description
ipGLPost
Boolean
Boolean that defines if we can post to GL
daStartingDate
Nullable{System.DateTime}
The starting date for the wip/cos process
pageSize
Int32
The size of page
absolutePage
Int32
The number of pages
morePages
Boolean@
Boolean that defines if we need more pages
Returns The COSWIPDates data set
TranDateChanged Changing of Transaction Date Parameters Name
Type
ds
Description The COSWIPDates data set
cRowIdent
String
The Row Identifier for the COSWIPDates datatable
daStartingDate
Nullable{System.DateTime}
The starting date for the wip/cos process
proposedTranDate
Nullable{System.DateTime}
The proposed transaction date
Epicor 9.05 | 9.05.605
509
A-E
Business Object Reference Guide
Country Epicor.Mfg.BO.Country: This business object contains 9 methods.
GetNewCountry Inserts a new row in the DataSet with defaults populated.
GetNewCountryPort Inserts a new row in the DataSet with defaults populated.
GetNewCountryRestriction Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
510
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CountryPortSearch Epicor.Mfg.BO.CountryPortSearch: This business object contains 7 methods.
GetNewCountryPort Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
511
A-E
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CountTag Epicor.Mfg.BO.CountTag: This business object contains 22 methods.
GetNewCCTag Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
512
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
Epicor 9.05 | 9.05.605
513
A-E
Business Object Reference Guide
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CalcCountedQty Parameters Name
Type
Description
pQty
Decimal
CCTag.CountedQty
ds
The CountTag data set
CustomGetByID This is a custome GetByID to be used when the user manually enters a tag number in count Tag Entry. It will ensure that the tag belongs to the specific cycle that is selected in Count Tag Entry.
514
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
iTagNum
String
The Tag Number
iWarehouseCode
String
The Warehouse Code
iMonth
Int32
The TFOrdLine code
iYear
Int32
The Year
iCycleSeq
Int32
The Cycle Number
iFullPhysical
Boolean
Full Physical Inventory flag
Returns The Count Tag dataSet
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
uomCode
String@
UOM Code (only used for Product Codes)
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetUOMData Parameters Name
Type
Description
ipPartNum
String
Proposed PartNum
ds
The CountTag data set
OnChangeBinNum Procedure that validates the Bin Num
Epicor 9.05 | 9.05.605
515
A-E
Business Object Reference Guide
Parameters Name
Type
Description
inBinNum
String
Proposed BinNum
ds
The CountTag data set
OnChangeCountedQty Recalculate the CountedQty field. Parameters Name
Type
Description
pQty
Decimal
Proposed DimCode
ds
The CountTag data set
OnChangeLotNumber This method returns an error or question if the LotNum field does not exist depending upon the security of the user Parameters Name
Type
ds
Description The CountTag data set
lotNum
String
New Lot Number to validate
questionMsg
String@
Asks if user want to create new lot
errorMsg
String@
Tells user if they can't create a new lot
OnChangePartNum CountTag - Call this method when the user changes the PartNum. Parameters Name
Type
Description
pcPartNum
String
Proposed PartNum
uomCode
String
UOM Code (only used for Product Codes)
ds
The CountTag data set
OnChangeUOM CountTag - Call this method when the user changes the PartNum.
516
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipCCUOM
String
Proposed UOM
ds
The CountTag data set
Course Epicor.Mfg.BO.Course: This business object contains 15 methods.
GetNewCourseRevision Inserts a new row in the DataSet with defaults populated.
GetNewCourseRevisionAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
517
A-E
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AdjustContainsWhereClause Adjust 'where' clause with 'contains' keyword Parameters Name
Type
Description
whereClause
String@
Where clause
DuplicateCourse Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCourseExpirationTypeList This method returns the list of Expiration type codes and descriptions . /// Returns The expiratin types list
ValidateCourseDeletion Method to validate the possibility of Course deletion.
518
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
courseID
String
Course ID
isDeleteOK
Boolean@
Is it possible to delete the course
ValidateCourseID Validation of course ID Parameters Name
Type
Description
courseID
String
Course ID
ValidateCourseRevision Validation of course revision Parameters Name
Type
Description
courseID
String
Course ID
revisionCode
String
Revision Code
ValidateCourseRevisionDeletion Method to validate the possibility of Course revision deletion. Parameters Name
Type
Description
courseID
String
Course ID
revisionCode
String
Course Revision Code
isDeleteOK
Boolean@
Is it possible to delete the course
CourseSch Epicor.Mfg.BO.CourseSch: This business object contains 14 methods.
GetNewCourseSch Inserts a new row in the DataSet with defaults populated.
GetNewCourseSchAttd Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
519
A-E
Business Object Reference Guide
GetNewCourseSchAttdAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
520
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The dataset with list of errors occured during update process.
InstrTypeChanged Method to call when changing the InstrType field. Parameters Name
Type
Description
proposedInstrType
String
The proposed Instructor Type
ds
The Course Schedule data set
CourseResultChanged Method to call when changing the CourseResult field. Parameters Name
Type
Description
proposedCourseResult
String
The proposed Course Result
ds
The Course Schedule data set
OnStartDateChanging Method to call when changing the StartDate field. Parameters Name
Type
Description
proposedStartDate
Nullable{System.DateTime}
The proposed Start Date
ds
The Course Schedule data set
AddAttendees The method for assigning employees to the scheduled course. Parameters Name
Type
Description
courseID
String
The Course ID
revisionCode
String
The Course Revision ID
startDate
Nullable{System.DateTime}
The Course Start Date
endDate
Nullable{System.DateTime}
The Course End Date
empCourses
String
The list of employee records IDs from EmpCourse table
Epicor 9.05 | 9.05.605
521
A-E
Business Object Reference Guide
Name
Type
Description
ds
The Course Schedule data set
CheckFreeSpotsForCourseAttendee The method for assigning employees to the scheduled course. Parameters Name
Type
Description
courseID
String
The Course ID
revisionCode
String
The Course Revision ID
startDate
Nullable{System.DateTime}
The Course Start Date
endDate
Nullable{System.DateTime}
The Course End Date
numAttendees
Int32
The number of attendees to be added to the Scheduled Course
roomOK
Boolean@
The room for the requested number of attendees is available
CreditCardProc Epicor.Mfg.BO.CreditCardProc: This business object contains 10 methods.
GetNewCreditCardProc Inserts a new row in the DataSet with defaults populated. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
522
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
OnChangeProcessor This method validates the Processor ID Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description CreditCardProcDataSet
523
A-E
Business Object Reference Guide
The purge process will remove any credit card account number that has not been used within the number of days as specified in the CreditCardProc.DaysToRetainInfo field. Other characteristics that would prevent the account number from being purged would be if the account number is in use on an order that has not been completely shipped, or if the account number is used on an invoice that has not been fully paid.
CreditCardType Epicor.Mfg.BO.CreditCardType: This business object contains 8 methods.
GetNewCreditCardType Inserts a new row in the DataSet with defaults populated.
GetNewCreditCardTypeAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
524
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CreditManager Epicor.Mfg.BO.CreditManager: This business object contains 28 methods.
GetNewCMCustomer Inserts a new row in the DataSet with defaults populated.
GetNewGlbCustCred Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
525
A-E
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
getGlbNACreditPools Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
526
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
getGlbNACreditsAvail Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
isNAGlobalCustomer Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustomerGlobalFields To return the list of fields that are maintained by the "Master/Owner" of global record. The client can use this list to disable these fields on the UI.
ChangeOrderCreditHold Call this method when the user updates the order's credit hold field. This will calculate or reset the default Credit Override Limit of a particular order. The toggling of the credit hold check box will determine when OrderHed.CreditOverrideLimit should be enabled. The Credit Override Limit should be enabled if the Credit Hold field is unchecked. Conversely, Credit Override Limit is disabled if Credit Hold is checked. Parameters Name
Type
ds
Description The CreditManager data set
CheckCreditHold This method checks if customer will go on credit hold. Then asks if the user wants all orders to go on credit hold. To be called right before update. If the user answers yes to putting orders on hold, then the ApplyHoldToOrder field needs to be populated. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Credit Manager data set
527
A-E
Business Object Reference Guide
Name
Type
Description
vMessage
String@
If customer going on credit hold, returns question UI needs to ask User before update
ExportCustCredit Call this method to export customer credit information. This method accepts an input parameter to exclude or include customer with credit limit of zero. This method returns the data table ttExportCustCred containing all valid customer credit information. The resulting records from the ttExportCustCred will then need to be outputted as a CSV file (comma delimited) with the first output line containing the description or label of all fields. Parameters Name
Type
Description
inpIncludeZero
Boolean
A logical flag to indicate whether to include 0 Credit Limit Customers.
Returns The ExportCustCred
GetARLOC Parameters Name
Type
Description
ipCustID
String
The customer character ID
Returns The ARLOCDataSet data set
GetByCustID This method finds the customer record by CustId instead of CustNum Parameters Name
Type
Description
custID
String
The customer character ID
Returns The CreditManager data set
GetContacts Parameters
528
Name
Type
Description
ipCustID
String
The customer character ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The CustCntDataSet data set
GetInvoices Parameters Name
Type
Description
ipCustID
String
The customer character ID
Name
Type
Description
ipCustID
String
The customer character ID
Returns The InvcHeadDataSet data set
GetOrders Parameters
Returns The CMOrderHedDataSet data set
GetPayIns Parameters Name
Type
Description
ipCustID
String
The customer character ID
Name
Type
Description
ipCustID
String
The customer character ID
Returns The ARPNHeadDataSet data set
GetPayments Parameters
Returns The CashHeadDataSet data set
ImportCustCredit Call this method to import customer credit information into the database. This method expects an input data table ttImportCustCred with data coming from an external comma delimited file.
Epicor 9.05 | 9.05.605
529
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description The ImportCustCred data set
Returns The CreditManager data set
MassCreditUpdate Call this method to do a mass credit information update on all customers. This method returns a log file (MassUpdLog) to store minimal information about the affected customers after the credit check evaluation process. Display the process log if not empty. Parameters Name
Type
Description
ipCustID
String
The Customer ID currently on display.
ds
The CreditManager data set
Returns The MassUpdLog data set
UpdateCMOrderHed This method updates the ttCMOrderHed's fisical table Parameters Name
Type
Description
ipCustNum
Int32
The customer Num
ds
The CMOrderHedDataSet data set
UpdateCreditTotals This method updates the TotOpenCredit and TotGlobalCredit fields. To be called when the include credit flags are changed. Parameters Name ds
Type
Description The CreditManager data set
UpdateGlobalLimits This method converts the global credit limit from the global currency value to the local currency value. To be used when the global currency code changes or when the global credit limits are changed.
530
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The CreditManager data set
CreditTran Epicor.Mfg.BO.CreditTran: This business object contains 9 methods.
GetNewCreditTran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
531
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsContactTracker Called from Contact tracker instead of GetRows for better performance Parameters Name
Type
Description
whereClauseCreditTran
String
Whereclause for HDCase table.
whereClauseOrderHed
String
Whereclause for OrderHed table.
contactName
String
The contact to return data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.CreditTranDataSet
GetRowsForCreditCard Filter by Credit Card Fields Parameters
532
Name
Type
Description
whereClause
String
Whereclause.
inGroupID
String
CashHead.GroupID field if available
inHeadNum
Int32
CashHead.HeadNum field if available
inOrderNum
Int32
CashHead.OrderNum field if available
inCardProcess
String
Encrypted Credit Card.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns Epicor.Mfg.BO.CreditTranDataSet
CRMCall Epicor.Mfg.BO.CRMCall: This business object contains 32 methods.
GetNewCRMCall Inserts a new row in the DataSet with defaults populated.
GetNewCRMCallAttch Inserts a new row in the DataSet with defaults populated.
GetNewCRMCallCnt Inserts a new row in the DataSet with defaults populated.
GetNewCRMCallHistory Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
533
A-E
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeConName Update CRMCallCnt information when the contact Name is changed. Parameters Name
Type
Description
pName
String
Proposed Name
ds
The CRMCall data set
ChangeConPerConLnkRowID Update CRMCallCnt information when the contact PerConLnkRowID is changed. Parameters Name
Type
Description
pPerConLnkRowID
String
Proposed PerConLnkRowID
ds
534
The CRMCall data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangeCustomerID Update CRMCall information when the CustomerId is changed. Parameters Name
Type
Description
pCustomerId
String
Proposed Customer ID
ds
The CRMCall data set
ChangeFSCallNum Update CRMCall information when the FSCall Number is changed. Parameters Name
Type
Description
pFSCallNum
Int32
Proposed FSCall Number
ds
The CRMCall data set
ChangeHDCaseNum Update CRMCall information when the Case Number is changed. Parameters Name
Type
Description
pHDCaseNum
Int32
Proposed Case Number
ds
The CRMCall data set
ChangeInvoiceNum Update CRMCall information when the AR Invoice Number is changed. Parameters Name
Type
Description
pInvoiceNum
Int32
Proposed Invoice Number
ds
The CRMCall data set
ChangeOrderNum Update CRMCall information when the Order Number is changed.
Epicor 9.05 | 9.05.605
535
A-E
Business Object Reference Guide
Parameters Name
Type
Description
pOrderNum
Int32
Proposed Order Number
ds
The CRMCall data set
ChangePurPoint Update CRMCall information when the Purchase Point is changed. Parameters Name
Type
Description
pVendorNum
Int32
Proposed Supplier number.
pPurPoint
String
Proposed purchase point..
ds
The CRMCall data set
ChangeQuoteNum Update CRMCall information when the Quote Number is changed. Parameters Name
Type
Description
pQuoteNum
Int32
Proposed Quote Number
ds
The CRMCall data set
ChangeRMANum Update CRMCall information when the RMA Number is changed. Parameters Name
Type
Description
pRMANum
Int32
Proposed RMA Number
ds
The CRMCall data set
ChangeShipToNum Update CRMCall information when the ShipToNum is changed. Parameters
536
Name
Type
Description
pCustNum
Int32
Proposed Customer number.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pShipToNum
String
Proposed Ship To number.
ds
The CRMCall data set
ChangeTaskID Update CRMCall information when the Task ID is changed. Parameters Name
Type
Description
pTaskID
String
Proposed Task ID
ds
The CRMCall data set
ChangeVendorID Update CRMCall information when the VendorID (Supplier ID) is changed. Parameters Name
Type
Description
pVendorID
String
Proposed Supplier ID
ds
The CRMCall data set
DefaultContactFields Update CRMCall information when the contact is changed. Parameters Name
Type
ds
Description The CRMCall data set
DefaultSupplierCntFields Update CRMCall information when the supplier contact is changed. Parameters Name ds
Type
Description The CRMCall data set
GetCRMCallsToShow Gets the number of CRM Calls to show at startup according to the Company settings.
Epicor 9.05 | 9.05.605
537
A-E
Business Object Reference Guide
Parameters Name
Type
Description
crmCallsToShow
Int32@
Number of CRM Calls to show.
GetRowsContactTracker Called from Contact tracker for better performance. Parameters Name
Type
Description
whereClauseCRMCall
String
Whereclause for CRMCall table.
whereClauseCRMCallHistory
String
Whereclause for CRMCallHistory table.
contactName
String
The contact to return data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
GetRowsCustomerTracker Called from Customer tracker for better performance. Parameters Name
Type
Description
whereClauseCRMCall
String
Whereclause for CRMCall table.
whereClauseCRMCallHistory
String
Whereclause for CRMCallHistory table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
GetRowsForPerson Gets the list of calls where the DcdUserID is an authorized user for the Workforce specified in the call. Parameters
538
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The rows DataSet.
SortByData Return a list of the sort by options based on the data passed in. Parameters Name
Type
Description
cTableName
String
The table name to base the sort by on. Valid values are: Customer, QuoteHed, Task
iCustNum
Int32
The Customer ID if available. Can be blank.
iQuoteNum
Int32
The Quote Number if available. Can be zero.
iVendorNum
Int32
The Vendor ID if available. Can be blank.
cSortByList
String@
The Sort By List.
UserIsAuthorized Checks if user is authorized Parameters Name
Type
Description
cSalesRepCode
String
The SalesRep code
CRMComp Epicor.Mfg.BO.CRMComp: This business object contains 9 methods.
GetNewCRMComp Inserts a new row in the DataSet with defaults populated.
GetNewCRMCompAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
539
A-E
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetByCompID This method finds the CRMComp record by CompId instead of CompNum Parameters
540
Name
Type
Description
compID
String
The CRMComp character ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The CRMComp data set
CrossDock Epicor.Mfg.BO.CrossDock: This business object contains 8 methods.
GetNewCrossDock Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
541
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
Currency Epicor.Mfg.BO.Currency: This business object contains 18 methods.
GetNewCurrency Inserts a new row in the DataSet with defaults populated.
GetNewCurrencyAttch Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
542
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCurrencyBase This method returns the Base CurrencyCode Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
Epicor 9.05 | 9.05.605
543
A-E
Business Object Reference Guide
GetCurrencyForLink This returns the Currency dataset for linking. Parameters Name
Type
Description
currencyCode
String
Global currency code field on the Glbcurrency record to link
Returns The currency data set
GetGlbCurrencyList This method returns the GlbCurrency dataset based on a delimited list of GlbCurrCode values passed in. Parameters Name
Type
Description
glbCurrCodeList
String
Delimited list of glbCurrCode values
Returns The GlbCurrency data set This method returns a list of reporting currency positions and the the currencies that are currently populating each slot Returns The Global Currency data set
GlbCurrenciesExist This method checks if GlbCurrency records exist or not. Can be used to determine if the option to link/unlink customers is available. Parameters Name
Type
Description
glbCurrenciesExist
Boolean@
Yes - they do exist; No - they do not exist
LinkGlbCurrency This method performs the actual logic behind linking a currency. It is run after the PreLinkGlbCurrency method which determines the Currency Code to link to. If the Currency Code is for a Currency that already exists, the GlbCurrency information is translated and then copied to the CurrencyDataSet as an update. If the Currency Code is for a new Currency, the GlbCurrency information is translated and then copied to the CurrencyDataSet as an Add. Until the update method is run on Currency record the Link process is not completed.
544
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCurrency record to link
glbCurrencyCode
String
Global Currency Code field on the GlbCurrency record to link
ds
The Global Currency data set
ds1
The Currency data set
PreLinkGlbCurrency Linking a GlbCurrency record ties a global record to a new or existing Currency record so that any changes made to the GlbCurrency record in another company are automatically copied to any linked Currencies. This method performs the pre link logic to check of okay to link or get the new currencyid to create/link to. Will be run before LinkGlbCurrency which actually creates/updates a Currency record and will send the modified record back for update. When the Link "button" is originally selected, the LinkCurrencyID will be defaulted to the GlbCurrencyId field. It will then check to see if this ID is available for Use. If available for use the system will return a question asking the user if they want to use this number. If the answer is no, then the user either needs to select an existing currency's ID to link to or enter a brand new ID. You will run this method until the user answer is yes. Then the LinkGlbCurrency method is called. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCurrency record to link
glbCurrencyCode
String
Global Currency Code field on the GlbCurrency record to link
ds vMessage
The Global Currency data set String@
Returns a message the user needs to respond yes or no to. If the user answers no, then they need to update the LinkCurrencyId field and then run this method again to test the new CurrencyId they want to link to
SkipGlbCurrency This method performs the logic behind the skip option for GlbCurrency Skip - sets the Skipped flag to true. If the CurrencyCode field is not blank will error out Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCurrency record to skip
glbCurrencyCode
String
Global CurrencyCode field on the GlbCurrency record to skip
ds
The Global Currency data set
UnlinkGlbCurrency This method performs the logic behind the unlink option for GlbCurrency Unlink - clears the CurrencyCode and CustId field in GlbCurrency. Returns the Currency DataSet
Epicor 9.05 | 9.05.605
545
A-E
Business Object Reference Guide
Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCurrency record to unlink
glbCurrencyCode
String
Global CurrencyCode field on the GlbCurrency record to unlink
ds
The Global Currency data set
Returns The Currency data set
CurrExRate Epicor.Mfg.BO.CurrExRate: This business object contains 16 methods.
GetNewCurrExRate Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
546
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process. This method exists soley for the purpose of allowing security for updating Exchange Rate information to be defined.
AlternalGetNewCurrExRate This method will be use instead of GetNewCurrExRate because we need to create not one record but a set of records. When a new CurrExRate record is created a new record must be created in CurrExRate for every CurrConvRule record that has a RuleCode of 1 Parameters Name
Type
Description
plRateGrpCode
String
Proposed Rate Group Code
plEffectiveDate
String
Proposed Effective Date
ds
The CurrExRate DataSet to update the EffectiveDate.
GetCurrenciesDefaults This method receive RateGrpCode and gives back default values for Source and Target Currencies. The Default values for Source and Target currencies are found by searching for the first record in CurrConvRule with RuleCode = 1 using the Current company and the given Rate Group Code as filters. Parameters Name
Type
Description
proposedRateGrpCode
String
The RateGrpCode introduced by the user.
plSourceCurrCode
String@
Rate Group CrossCurrCode used here as default for SourceCurrCode.
plTargetCurrCode
String@
Rate Group AltCrossCurrCode used here as default for TargetCurrCode.
Epicor 9.05 | 9.05.605
547
A-E
Business Object Reference Guide
GetListFilterDates Filter Exchange Rate Groups by Date and RateGrp. Parameters Name
Type
Description
whereClause
String
Whereclause.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The CurrExRateList data set
GetRateGrpData This method receive RateGrpCode and gives back RateGrpDesc. Parameters Name
Type
Description
proposedRateGrpCode
String
The RateGrpCode selected by the user.
plRateGrpCode
String@
Rate Group Code whit format as in DataBase.
plRateGrpDesc
String@
Rate Group Description.
ImportExchangeRates This method conditionally Imports Exchange records. Parameters Name
Type
Description
pFileName
String
Name of the file to export
pListDelimiter
String
Selected Delimiter to use when parsing the import file
pDateOrder
String
Selected date format that will be imported.
pNumberFormat
String
Selected numeric format that will be imported.
pSuccess
Boolean@
Flag that tell us if the import of the file was successfully imported.
UpdateCurrExRate and then validate this records against the records of CurrConvRule, if there is any record that exist in CurrConvRule with RuleCode = 1 it must exist in the CurrExRate for the same RateGrp.
548
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
pRateGrpCode
String
The RateGrpCode selected by the user.
pEffectiveDate
String
Effective Date selected by the user.
ds
The CurrExRate DataSet to update the Exchange Rate set of Records
ValidateEffectiveDate Validates the date. Parameters Name
Type
Description
proposedRateGrpCode
String
The RateGrpCode selected by the user.
proposedEffectiveDate
String
Effective Date selected by the user.
ValidateRuleCode Validate if a new set of Exchange Rate can be created. We cannot add exchange rates to a Rate Group until all CurrConvRule records have valid RuleCodes (no 0 s) Parameters Name
Type
Description
plRateGrpCode
String
Proposed Rate Group
CurrRateGrp Epicor.Mfg.BO.CurrRateGrp: This business object contains 30 methods.
GetNewCurrRateGrp Inserts a new row in the DataSet with defaults populated.
GetNewCurrRateGrpAttch Inserts a new row in the DataSet with defaults populated.
GetNewCurrConvRule Inserts a new row in the DataSet with defaults populated.
GetNewCurrRateDisp Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
549
A-E
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
550
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DefaultFieldsCurrConvRule Validate UseBaseRate decide if RuleCode is set to 0. Parameters Name
Type
Description
ds
The CurrRateGrp DataSet.
DefaultFieldsCurrGrp Validate CrossCurrency and Alternative Currency and decide if their rounding fields are to be reset to default values. Parameters Name
Type
Description
ds
The CurrRateGrp DataSet.
GetCurrRateGrpForLink This returns the CurrRateGrp dataset for linking. Parameters Name
Type
Description
currRateGrpCode
String
Global Rate Group Code GLBCurrRateGrp record to link
Returns The Currency Rate Group data set
GetGlbCurrRateGrpList This method returns the GlbCurrRateGrp dataset based on a delimited list of GlbRateGrpCode values passed in. Parameters Name
Type
Description
glbRateGrpCodeList
String
Delimited list of glbRateGrpCode values
Returns The GlbCurrRateGrp data set
GlbCurrRateGrpsExist This method checks if GlbCurrRateGrp records exist or not. Can be used to determine if the option to link/unlink customers is available.
Epicor 9.05 | 9.05.605
551
A-E
Business Object Reference Guide
Parameters Name
Type
Description
glbCurrRateGrpsExist
Boolean@
Yes - they do exist; No - they do not exist
LinkGlbCurrRateGrp This method performs the actual logic behind linking a Currency Rate Group. It is run after the PreLinkGlbCurrRateGrp method which determines the Currency Rate Group Code to link to. If the Currency Rate Group Code is for a Rate Group that already exists, the GlbCurrRateGrp information is translated and then copied to the CurrRateGrpDataSet as an update. If the Rate Group Code is for a new Rate Group, the GlbCurrRateGrp information is translated and then copied to the CurrRateGrpDataSet as an Add. Until the update method is run on CurrRateGrp record the Link process is not completed. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCurrRateGrp record to link
glbRateGrpCode
String
Global CurrRateGrp Code field on the GlbCurrRateGrp record to link
ds
The Global CurrRateGrp data set
ds1
The CurrRateGrp data set
PreLinkGlbCurrRateGrp Linking a GlbCurrRateGrp record ties a global record to a new or existing CurrRateGrp record so that any changes made to the GlbCurrRateGrp record in another company are automatically copied to any linked Rate Groups. This method performs the pre link logic to check of okay to link or get the new RateGrpCode to create/link to. Will be run before LinkGlbCurrRateGrp which actually creates/updates a CurrRateGrp record and will send the modified record back for update. When the Link "button" is originally selected, the LinkRateGrpCode will be defaulted to the GlbRateGrpCode field. It will then check to see if this RateGrpCode is available for Use. If available for use the system will return a question asking the user if they want to use this code. If the answer is no, then the user either needs to select an existing rate group's code to link to or enter a brand new ID. You will run this method until the user answer is yes. Then the LinkGlbCurrRateGrp method is called. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCurrRateGrp record to link
glbRateGrpCode
String
Global Rate Group Code field on the GlbCurrRateGrp record to link
ds vMessage
552
The Global Currency Rate Group data set String@
Returns a message the user needs to respond yes or no to. If the user answers no, then they need to update the LinkRateGrpCode field and then run this method again to test the new RateGrpCode they want to link to
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
SkipGlbCurrRateGrp This method performs the logic behind the skip option for GlbCurrRateGrp Skip - sets the Skipped flag to true. If the CurrRateGrpCode field is not blank will error out Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCurrRateGrp record to skip
glbRateGrpCode
String
Global Rate Group Code field on the GlbCurrRateGrp record to skip
ds
The Global Currency Rate Group data set
UnlinkGlbCurrRateGrp This method performs the logic behind the unlink option for GlbCurrRateGrp Unlink - clears the RateGrpCode field in GlbCurrRateGrp. Returns the CurrRateGrp DataSet Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCurrency record to unlink
glbRateGrpCode
String
Global Rate Group Code field on the GlbCurrRateGrp record to unlink
ds
The Global Currency Rate Group data set
Returns The Currency Rate Group data set
ValidateAltCrossCurrCode This method validates AltCrossCurrCode. AltCrossCurrCode cannot be changed if exist at least one record on CurrConvRule with Rulecode value equal to 5 or 6 Parameters Name
Type
Description
plRateGrpCode
String
The RateGrpCode selected by the user
plCrossRate
String
The CrossCurrCode selected by the user
proposedAltCrossRate
String
The AltCrossCurrCode selected by the user
ValidateBaseRateGrp This method validates that: (1) BaseRate must be a valid, active CurrRateGrp (2) If this CurrRateGrp is used as a BaseRateGrp on any other CurrRateGrp then it's own BaseRateGrp cannot be populate. (3) If choosing a BaseRateGrp, cannot choose a CurrRateGrp that has a BaseRateGrp defined. (4) If any Conversion Rule (currConvRule) have their UseBaseRate set to true, cannot clear BaseRateGrp field.
Epicor 9.05 | 9.05.605
553
A-E
Business Object Reference Guide
Parameters Name
Type
Description
plRateGrpCode
String
The proposed value for Rate Grp
proposedBaseRateGrp
String
The proposed value for Base Rate Grp field
plCrossCurrCode
String
The proposed value for CrossCurrCode field
plAltCrossCurrCode
String
The proposed value for AltCrossCurrCode field
ValidateCrossCurrCode This method validates if exist at least one record on CurrConvRule with Rulecode value equal to 3, 4, 5 or 6 CrossCurrCode cannot be changed if exist at least one record on CurrConvRule with Rulecode value equal to 3, 4, 5 or 6 Parameters Name
Type
Description
plRateGrpCode
String
The RateGrpCode selected by the user
proposedCrossRate
String
The CrossCurrCode selected by the user
plAltCrossRate
String
The AltCrossCurrCode selected by the user
ValidateCurrencies Validate that when changing the cross rate currencies on a RateGrp if BaseRateGrp is defined must validate against the BaseRateGrp's currencies if it is used as a BaseRateGrp on other RateGrps (could be more than one) must validate against the RateGrps' currencies Parameters Name
Type
Description
plRateGrpCode
String
The RateGrpCode
plBaseRateGrp
String
The Base Rate Group
proposedCrossRate
String
The AltCrossCurrCode selected by the user
proposedAltCrossRate
String
The AltCrossCurrCode selected by the user
ValidateGlobal This method validate , that the CurrRateGrp record cannot be marked as Global if there are any CurrConvRule recods that reference currencies that are not marked as global Parameters
554
Name
Type
Description
plRateGrpCode
String
The RateGrpCode selected by the user
proposedGlobal
Boolean
The proposed CrossCurrCode
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ValidateInactive This method validate , that CurrRateGrp.Inactive cannot be marked as true if the rate group is assigned to a Company Default. Parameters Name
Type
Description
plRateGrpCode
String
The RateGrpCode selected by the user
proposedInactive
Boolean
The proposed value for Inactive field
plCrossCurrCode
String
The current Cross Rate Currency
plAltCrossCurrCode
String
The current Alternative Cross Rate Currency
plBaseRateGrpCode
String
The current Base Rate Group
ValidateRateGrpCode This method validate , that RateGrpCode is unique Parameters Name
Type
Description
proposedRateGrpCode
String
The RateGrpCode selected by the user
ValidateRateGrpDescription This method validate , that Description is unique Parameters Name
Type
Description
plRateGrpCode
String
RateGrpCode value
proposedDescription
String
The Rate group description
ValidateRateNumDec This method validate , that RateNumDec not exceed 6 decimal places Parameters Name
Type
Description
plRateGrpCode
String
The RateGrpCode selected by the user
proposedRateNumDec
Int32
The RateNumDec
ValidateRuleCode Validates the value of "RuleCode"
Epicor 9.05 | 9.05.605
555
A-E
Business Object Reference Guide
Parameters Name
Type
Description
plRateGrpCode
String
RateGrpCode value
plUseBaseRate
Boolean
UseBaseRate value
plSourceCurrCode
String
UseBaseRate value
plTargetCurrCode
String
UseBaseRate value
proposedRuleCode
Int32
Proposed RuleCode value
ValidateUseBaseRate Validates the value of "UseBaseRate" Parameters Name
Type
Description
plRateGrpCode
String
RateGrpCode value
proposedUseBaseRate
Boolean
Proposed UseBaseRate value
CustBankSearch Epicor.Mfg.BO.CustBankSearch: This business object contains 7 methods.
GetNewCustBank Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
556
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CustBillTo Epicor.Mfg.BO.CustBillTo: This business object contains 8 methods.
GetNewCustBillTo Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
557
A-E
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListByBTCustID Calls the normal GetList but returns the list dataset with the starting at. Parameters
558
Name
Type
Description
custNum
Int32
Sold to customer number.
btCustID
String
BTCustID to start at and sort by.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.CustBillToListDataSet
CustCnt Epicor.Mfg.BO.CustCnt: This business object contains 16 methods.
GetNewCustCnt Inserts a new row in the DataSet with defaults populated.
GetNewCustCntAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
559
A-E
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCustCntGlobalFields To return the list of fields that are maintained by the "Master/Owner" of global record. The client can use this list to disable these fields on the UI.
CheckEFFieldLength This method checks the Customer Name and address fields to see if they conform to the length allowed in an External Financials integration. Will return a list of fields longer than allowed to allow the users to change them or accept that they will be truncated when sent to External Financials. Needs to be run right before update. If the user answers no to the question then the update method should not be run. Parameters
560
Name
Type
Description
vCustNum
Int32
CustCnt.CustNum
vShipToNum
String
CustCnt.ShipToNum
vConNum
Int32
CustCnt.ConNum
vName
String
CustCnt.Name
vAddress1
String
CustCnt.Address1
vAddress2
String
CustCnt.Address2
vAddress3
String
CustCnt.Address3
vCity
String
CustCnt.City
vState
String
CustCnt.State
vCorpName
String
CustCnt.CorpName
vFirstName
String
CustCnt.FirstName
vMiddleName
String
CustCnt.MiddleName
vLastName
String
CustCnt.LastName
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
vInitials
String
CustCnt.Initials
vMessage
String@
If any fields are too long, returns the question to ask the user before update
DefaultName This method populates the detail fields from CustCnt.Name when targetName = "Detail". When targetField = "Name", then the CustCnt.Name is built from the detail fields. Parameters Name
Type
Description
targetField
String
Indicates which fields to populate either "Detail" or "Name"
custNum
Int32
CustCnt.CustNum
shipToNum
String
CustCnt.ShipToNum
conNum
Int32
CustCnt.ConNum
ds
The CustCnt data set
GetGlbCustCntList This method returns the GlbCustCnt dataset like GetList() method GlbCustCnt.CustNum gt 0 indicates linked GlbCustCnt records GlbCustCnt.CustNum lt = 0 indicates unlinked GlbCustCnt records Parameters Name
Type
Description
whereClause
String
Where clause to specify set of GlbCustCnt records to return
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages
Returns The GlbCustCnt data set
GetPerConData Used to validate the PerCon. Parameters Name
Type
Description
perConID
Int32
Proposed PerConID.
ds
Epicor 9.05 | 9.05.605
CustCnt data set.
561
A-E
Business Object Reference Guide
LinkGlbCustCnt This method performs the actual logic behind linking a contact. It is run after the PreLinkGlbCustCnt method which determines the Contact to link to. If the Contact Number is for a Contact that already exists, the GlbCustCnt information is translated and then copied to the CustCntDataSet as an update. If the Contact Number is for a new Contact, the GlbCustCnt information is translated and then copied to the CustCntDataSet as an Add. Until the update method is run on CustCnt record the Link process is not completed. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCustCnt record to link
glbCustNum
Int32
Global CustNum field on the GlbCustCnt record to link
glbShipToNum
String
Global ShipToNum field on the GlbCustCnt record to link
glbConNum
Int32
Global ConNum field on the GlbCustCnt record to link
ds
The GlbCustCnt data set
Returns The CustCnt data set
OnChangeAltShipToContact This sets the ShipTo table based on the MasterCustNum and MasterShipToNum fields. To be used when the alternate fields change Parameters Name
Type
Description
iProposedMasterCustID
String
The proposed CustID value
iProposedMasterShipToNum
String
The proposed ShipTo Num value
iProposedMasterConNum
Int32
The proposed Contact number value
ds
The Customer data set
SpecialAddressChange This method clears or sets the Address fields based on the SpecialAddress flag. If CustCnt.SpecialAddress is checked then the address fields are defaulted from the Customer. Parameters Name ds
562
Type
Description The CustCnt data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CustContImport Epicor.Mfg.BO.CustContImport: This business object contains 22 methods.
GetNewCustomerImport Inserts a new row in the DataSet with defaults populated.
GetNewCustomerImportAttch Inserts a new row in the DataSet with defaults populated.
GetNewCustCntImport Inserts a new row in the DataSet with defaults populated.
GetNewCustCntImportAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
563
A-E
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process. Method to call to auto match import customers to existing customers. Returns The Customer/Contact import data set
ChangeRoleCode Method to call when changing the role code on an imported customer contact record. Validates the role code and updates the role code description with the new value. Parameters Name
Type
Description
proposedRoleCode
String
The proposed role code
ds
The Customer/Contact import data set
ChangeSalesRepCode Method to call when changing the sales rep code on an imported customer record. Validates the sales rep code and updates the Sales Rep Name with the new value. Parameters Name
Type
Description
proposedSalesRepCode
String
The proposed sales rep code
ds
The Customer/Contact import data set
ChangeTerritoryID Method to call when changing the territory id on an imported customer record. Validates the territory id and updates the territory description with the new value.
564
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
proposedTerritoryID
String
The proposed sales rep code
ds
The Customer/Contact import data set
Method to call delete all CustomerImport and CustCntImport records. The CustContImport dataset should be cleared by the app that called this method after this method is run because the records in the dataset will be obsolete. Method to call to retrieve the existing Customers and Customer contacts. Returns The Customer/Contact existing data set
ImportCustomersAndContacts Method to call to import customers and contacts from a datatable. Parameters Name
Type
ds
Description The Customer/Contact import/export data set
MatchImpCustCnt Method to call to match an import customer contact to an existing customer contact. Parameters Name
Type
Description
iParentImportID
Int32
The ParentImportID of the imported customer contact record
iImportID
Int32
The ImportID of the imported customer contact record
existingCustNum
Int32
The Customer Number of the existing customer contact to match to
existingConNum
Int32
The Contact Number of the existing customer contact to match to
Returns The Customer/Contact import data set
MatchImpCustomer Method to call to match an import customer to an existing customer.
Epicor 9.05 | 9.05.605
565
A-E
Business Object Reference Guide
Parameters Name
Type
Description
impCustomerImportID
Int32
The ImportID of the imported customer record
existingCustNum
Int32
The Customer Number of the existing customer to match to
Returns The Customer/Contact import data set
UnmatchImpCustCnt Method to call to unmatch an import customer contact from an existing customer contact. Parameters Name
Type
Description
iParentImportID
Int32
The ParentImportID of the imported customer contact record
iImportID
Int32
The ImportID of the imported customer contact record
Returns The Customer/Contact import data set
UnmatchImpCustomer Method to call to unmatch an import customer from an existing customer. Parameters Name
Type
Description
iImportID
Int32
The ImportID of the imported customer record
Returns The Customer/Contact import data set Method to call update existing Customers with data from the imported Customers.
CustGrup Epicor.Mfg.BO.CustGrup: This business object contains 13 methods.
GetNewCustGrup Inserts a new row in the DataSet with defaults populated.
GetNewCustGrupAttch Inserts a new row in the DataSet with defaults populated.
566
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetNewCustGrupDiscPriceLst Inserts a new row in the DataSet with defaults populated.
GetNewCustGrupPriceLst Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
567
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeListCode This method validates and populates the ListCode in either CustomerPriceLst or ShipToPriceLst Parameters Name
Type
Description
listCode
String
Proposed Price List Code
tableName
String
Table to look in
ds
The Customer Group data set
MoveOnePosition This method moves the PriceLst or DiscPriceLst Up/Down one position in the grid and returns the whole updated datatable. Parameters Name
Type
Description
groupCode
String
Customer Group Code
seqNum
Int32
Current Sequence number of price list to move
moveDir
String
Direction to move task, "Up" or "Down"
Returns Customer Group Dataset
MoveOnePositionDisc This method moves the PriceLst or DiscPriceLst Up/Down one position in the grid and returns the whole updated datatable. Parameters Name
Type
Description
groupCode
String
Customer Group Code
seqNum
Int32
Current Sequence number of price list to move
moveDir
String
Direction to move task, "Up" or "Down"
Returns Customer Group Dataset
568
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Customer Epicor.Mfg.BO.Customer: This business object contains 107 methods.
GetNewCustomer Inserts a new row in the DataSet with defaults populated.
GetNewCustomerAttch Inserts a new row in the DataSet with defaults populated.
GetNewCustBillTo Inserts a new row in the DataSet with defaults populated.
GetNewCustBank Inserts a new row in the DataSet with defaults populated.
GetNewCustChild Inserts a new row in the DataSet with defaults populated.
GetNewCustDfltDocType Inserts a new row in the DataSet with defaults populated.
GetNewCustIC Inserts a new row in the DataSet with defaults populated.
GetNewCustomerDocs Inserts a new row in the DataSet with defaults populated.
GetNewCustRestriction Inserts a new row in the DataSet with defaults populated.
GetNewCustUPSEmail Inserts a new row in the DataSet with defaults populated.
GetNewCustomerDiscPriceLst Inserts a new row in the DataSet with defaults populated.
GetNewCustomerFSPriceList Inserts a new row in the DataSet with defaults populated.
GetNewGlbCustCred Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
569
A-E
Business Object Reference Guide
GetNewShipTo Inserts a new row in the DataSet with defaults populated.
GetNewShipToAttch Inserts a new row in the DataSet with defaults populated.
GetNewShipToRestriction Inserts a new row in the DataSet with defaults populated.
GetNewCustomerPriceLst Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewTaxExempt Inserts a new row in the DataSet with defaults populated.
GetNewCustMFBill Inserts a new row in the DataSet with defaults populated.
GetNewCustomerDocsSH Inserts a new row in the DataSet with defaults populated.
GetNewMangCust Inserts a new row in the DataSet with defaults populated.
GetNewShipToDiscPriceLst Inserts a new row in the DataSet with defaults populated.
GetNewShipToMFBill Inserts a new row in the DataSet with defaults populated.
GetNewShipToPriceLst Inserts a new row in the DataSet with defaults populated.
GetNewShipToUPSEml Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
570
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field.
Epicor 9.05 | 9.05.605
571
A-E
Business Object Reference Guide
Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetCustomerGlobalFields To return the list of fields that are maintained by the "Master/Owner" of global record. The client can use this list to disable these fields on the UI.
GetShipToGlobalFields To return the list of fields that are maintained by the "Master/Owner" of global record. The client can use this list to disable these fields on the UI.
GetCustBillToGlobalFields To return the list of fields that are maintained by the "Master/Owner" of global record. The client can use this list to disable these fields on the UI.
getGlbNACreditPools Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
getGlbNACreditsAvail Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
isNAGlobalCustomer Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
572
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
This method exists soley for the purpose of allowing security for updating customer detail information to be defined
ChangeCustDfltInvoiceType Set TranDocType when Invice Type was changed Parameters Name
Type
Description
ipInvoiceType
String
Invoice Type value
ds
The Customer data set
ChangeCustomerChargeCode Validates ChargeCode value Parameters Name
Type
Description
ipChargeCode
String
ChargeCode value
ds
The Customer data set
ChangeCustomerFinCharges Validates FinCharges value Parameters Name
Type
Description
ipFinCharges
Boolean
FinCharges value
ds
The Customer data set
ChangeCustomerReminderGroup Validates ReminderGroup value Parameters Name
Type
Description
ipReminderCode
String
ReminderCode value
ds
Epicor 9.05 | 9.05.605
The Customer data set
573
A-E
Business Object Reference Guide
ChangeDeferredRev Performs required logic when Customer.DeferredRev is modified. Parameters Name
Type
Description
ipDeferredRev
Boolean
Proposed input value of Deferred Rev
ds
Customer data set
ChangeListCode This method validates and populates the ListCode in either CustomerPriceLst or ShipToPriceLst Parameters Name
Type
Description
listCode
String
Proposed Price List Code
tableName
String
Table to look in, either Customer or ShipTo or FieldService
ds
The Customer data set
ChangeRACode Performs required logic when Customer.RACode is modified. Parameters Name
Type
Description
ipRACode
String
Proposed input value of RA Code
ds
Customer data set
CheckCreditHold This method checks if customer will go on credit hold. Then asks if the user wants all orders to go on credit hold. To be right befor updated. If the user answers yes to putting orders on hold, then the ApplyHoldToOrder field needs to be populated Parameters Name
Type
ds vMessage
574
Description Customer data set
String@
If customer going on credit hold, returns question UI needs to ask User before update
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CheckDupCustomer This method checks the Name,Address1 and ZipCode fields to see if there are any duplicate customers. A ListDataSet will be returned to the user of any duplicates asking if the user wants to continue. Needs to be run before Update on a NEW record only Parameters Name
Type
Description
vName
String
This parameter takes a value for something
vRowid
String
RowIdent field of the Customer
vAddress1
String
Customer Address field
vZip
String
Customer Postal Code
Returns Epicor.Mfg.BO.CustomerListDataSet
CheckEFFieldLength This method checks if the field length of the Name and address fields will fit within the External Financials integration rules. If not, a list of problem fields will be sent back to the user to either change, or accept that they will be truncated when the customer is sent over to SoftCell. Parameters Name
Type
Description
vCustNum
Int32
Customer.CustNum
vCustType
String
Customer.CustType
vName
String
Customer.Name
vAddress1
String
Customer.Address1
vAddress2
String
Customer.Address2
vAddress3
String
Customer.Address3
vCity
String
Customer.City
vState
String
Customer.State
vBTName
String
Customer.BTName
vBTAddress1
String
Customer.BTAddress1
vBTAddress2
String
Customer.BTAddress2
vBTAddress3
String
Customer.BTAddress3
vBTCity
String
Customer.BTCity
vBTState
String
Customer.BTState
vMessage
String@
Returns a list of problem fields for the user to accept or change
Epicor 9.05 | 9.05.605
575
A-E
Business Object Reference Guide
CheckVATFormat This method test the validity of the VAT format Parameters Name
Type
Description
tableName
String
Indicates which table is being updated, Customer or ShipTo
opMessage
String@
Message to display to user if not null
ds
The Customer data set
ChgBTCountry This method clears the BillTo address format string if the country has changed Parameters Name
Type
ds
Description The Customer data set
ChgCountry This method sets the ShipVia, Language and FormatStr fields when the Country has changed. Parameters Name
Type
Description
ds tableName
The Customer data set String
Indicates which table is being updated, Customer or ShipTo
ChgGlobalCust Method to call when changing the global customer flag on a customer. Assigns the GlbFlag base on the new value. Parameters Name
Type
Description
proposedGlobalCust
Boolean
The proposed global customer value
ds
The Customer data set
ChgICTrader Method to call when changing the ICTrader flag on a customer. Assigns the EnableGlobalCust based on the new value.
576
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
proposedICTrader
Boolean
The proposed IC Trader value
ds
The Customer data set
DeleteBTAddress This method clears out the Billto Address fields. To be run if the user no longer wants a separate Bill To Address Parameters Name
Type
ds
Description The Customer data set
custNum
Int32
Customer.CustNum
ETCAfterAddrVal After the tax integration has been called, update the customer address if it was changed. Parameters Name
Type
Description
ds
The Customer data set
ds1
The ETCAddrValidation data set
custNum
Int32
Customer.CustNum
ETCValidateAddress Call tax integration and loads temp tables from the results. Parameters Name
Type
Description
custNum
Int32
Customer.CustNum
statusFlag
Boolean@
Set to true if the integration is up, false if down.
errorFlag
Boolean@
If true, an error occured.
errorMsg
String@
If Error Flag is true, this is the associated message.
Returns The ETCAddrValidation data set
GetAddrElementList This method returns the available address elements in a delimited list
Epicor 9.05 | 9.05.605
577
A-E
Business Object Reference Guide
Parameters Name
Type
Description
addrElementList
String@
Delimited list of Address Elements available
GetAllShipTo This returns the ShipTo record in the Customer dataset with ShipTo child records returned. Parameters Name
Type
Description
custNum
Int32
CustNum of the customer for the Ship To
ds
The Customer data set
GetAltShipTo This returns the alternate ShipTo record in the Customer dataset. ShipTo child records are not returned. Parameters Name
Type
Description
custID
String
CustID of the customer for the Ship To
shipToNum
String
ShipToNum of the ShipTo to return
masterCustNum
Int32
Alternate CustNum of the customer for the Ship To
masterShipToNum
String
Alternate ShipToNum of the ShipTo to return
Returns The Customer data set
GetBillDayList This method returns the list of Bill Days to select from based on the billing Frequency Parameters Name
Type
Description
billFreq
String
The Customer Billing Frequency "W"eekly or "M"onthly
billDayList
String@
The list of available days to choose from a selection list
GetBillToRefs This method returns all the 'sold to' customers for this alt bill to.
578
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
custID
String
Current CustID
Returns The ttBillToRefs data set
GetByCustID This method finds the customer record by CustId instead of CustNum Parameters Name
Type
Description
custID
String
The customer character ID
withShipTo
Boolean
Indicates if shipTo should be retrieved or not
Returns The Customer data set
GetCustBillToForLink This returns the CustBillTo record in the Customer dataset for linking. Parameters Name
Type
Description
custID
String
CustID field on the GlbCustomer record
Returns The Customer data set
GetCustomer This returns the Customer dataset with only the Customer datatable populated. Customer child records are not returned. Parameters Name
Type
Description
custID
String
CustID of the customer to return
Returns The Customer data set
GetCustomerForLink This returns the Customer dataset for linking. OBSOLETE METHOD: Use method GetCustomer instead.
Epicor 9.05 | 9.05.605
579
A-E
Business Object Reference Guide
Parameters Name
Type
Description
custID
String
LinkCustID field on the GlbCustomer record to link
Returns The Customer data set
GetCustomerTerritory This method sets the Customer's Territory ID according to system rules Parameters Name
Type
ds custNum
Description The Customer data set
Int32
Customer.CustNum
GetDisabledFields This method returns a list of fields the user has access to when the user does not have rights to update detail information. Parameters Name
Type
Description
fieldList
String@
The list if fields to disable
GetGlbCustomerList This method returns the GlbCustomer dataset based on a delimited list of GlbCustNum values passed in. Parameters Name
Type
Description
glbCustNumList
String
Delimited list of GlbCustNum values
Returns The GlbCustomer data set
GetListCustom This overload of GetList adds Customers which ShipTo's fall within authorized territories. Parameters
580
Name
Type
Description
whereClause
String
The search criteria
pageSize
Int32
Size of a page
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
absolutePage
Int32
The absolute page
customClause
String
Custom WhereClause
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of Customers
GetNewAltShipTo This returns the alternate ShipTo record in the Customer dataset using the default ShipTo as a base. Parameters Name
Type
Description
custID
String
CustID of the customer for the Ship To
shipToNum
String
ShipToNum of the ShipTo to return
Returns The Customer data set
GetParentCustInfo This method sets the parent Customer information Parameters Name
Type
ds
Description The Customer data set
custNum
Int32
The Customer Number
parentCustID
String
Parent Customer ID
GetShipTo This returns the ShipTo record in the Customer dataset. ShipTo child records are not returned. Parameters Name
Type
Description
custID
String
CustID of the customer for the Ship To
shipToNum
String
ShipToNum of the ShipTo to return
Returns The Customer data set
Epicor 9.05 | 9.05.605
581
A-E
Business Object Reference Guide
GetShipToForLink This returns the ShipTo record in the Customer dataset for linking. OBSOLETE METHOD: Use method GetShipTo instead. Parameters Name
Type
Description
custID
String
CustID field on the GlbCustomer record
shipToNum
String
LinkShipToNum field on the GlbShipTo record
Returns The Customer data set
GetShipToTerritory This method defaults the ShipTo Territory according to system rules Parameters Name
Type
ds
Description The Customer data set
custNum
Int32
Customer.CustNum
shipToNum
String
ShipTo.ShipToNum
GlbCustomersExist This method checks if GlbCustomer records exists or not. Can be used to determine if the option to link/unlink customers is available. Parameters Name
Type
Description
glbCustomersExist
Boolean@
Yes - they do exist; No - they do not exist
LinkGlbCustBillTo This method performs the actual logic to link CustBillTo records for a linked customer. It will only allow CustBillTo's of linked customers to be processed, otherwise an exception will be raised. The ability to link CustBillTo's for a linked Customer should be offered immediately after performing the update method on a Linked Customer but it does not have to be limited to that time only. It is run after the PreLinkGlbCustBillTo method which determines the CustBillToNum to link to. If the CustBillToNum is for a CustBillTo that already exists, the GlbCustBillTo information is translated and then copied to the CustomerDataSet as an update. If the CustBillToNum is for a new CustBillTo, the GlbCustBillTo information is translated and then copied to the CustomerDataSet as an Add. Until the update method is run on the CustBillTo record the Link process is not completed. Once the CustBillTo record has been linked, the GlbCustCnt records need to be offered up to be linked as well.
582
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCustBillTo record to link
glbCustNum
Int32
Global CustNum field on the GlbCustBillTo record to link
ds
The Global Customer data set
ds1
The Customer data set
warnMsg
String@
Warnings regarding Customer Bill To information that was not accepted during the linking
LinkGlbCustomer This method performs the actual logic behind linking a customer. It is run after the PreLinkGlbCustomer method which determines the Customer ID to link to. If the Customer Id is for a Customer that already exists, the GlbCustomer information is translated and then copied to the CustomerDataSet as an update. If the Customer ID is for a new Customer, the GlbCustomer information is translated and then copied to the CustomerDataSet as an Add. Until the update method is run on Customer record the Link process is not completed. Once the Customer record has been linked, the GlbShipto and GlbCustCnt records needs to be offered up to be linked as well. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCustomer record to link
glbCustNum
Int32
Global CustNum field on the GlbCustomer record to link
ds
The Global Customer data set
ds1
The Customer data set
LinkGlbShipTo This method performs the actual logic to link shipto records for a linked customer. It will only allow shipto's of linked customers to be processed, otherwise an exception will be raised. The ability to link ShipTo's for a linked Customer should be offered immediately after performing the update method on a Linked Customer but it does not have to be limited to that time only. It is run after the PreLinkGlbShipto method which determines the ShiptoNum to link to. If the ShipToNum is for a Shipto that already exists, the GlbShipTo information is translated and then copied to the CustomerDataSet as an update. If the ShipToNum is for a new ShipTo, the GlbShipTo information is translated and then copied to the CustomerDataSet as an Add. Until the update method is run on the ShipTo record the Link process is not completed. Once the ShipTo record has been linked, the GlbCustCnt records need to be offered up to be linked as well. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbShipTo record to link
glbCustNum
Int32
Global CustNum field on the GlbShipTo record to link
glbShipToNum
String
Global ShipToNum field on the GlbShipTo record to linke
ds
Epicor 9.05 | 9.05.605
The Global Customer data set
583
A-E
Business Object Reference Guide
Name
Type
ds1
Description The Customer data set
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
MoveOnePosition This method moves the Customer/ShipTo PriceLst Up/Down one position in the grid and returns the whole updated datatable. Parameters Name
Type
Description
custNum
Int32
Customer Number
shipToNum
String
Ship To Number
seqNum
Int32
Current Sequence number of price list to move
moveDir
String
Direction to move task, "Up" or "Down"
Returns Customer Dataset
MoveOnePositionDisc This method moves the Customer/ShipTo Disc PriceLst Up/Down one position in the grid and returns the whole updated datatable. Parameters
584
Name
Type
Description
custNum
Int32
Customer Number
shipToNum
String
Ship To Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
seqNum
Int32
Current Sequence number of price list to move
moveDir
String
Direction to move task, "Up" or "Down"
Returns Customer Dataset
OnChangeAltShipTo This sets the ShipTo table based on the MasterCustNum and MasterShipToNum fields. To be used when the alternate fields change Parameters Name
Type
Description
iProposedMasterCustID
String
The proposed CustID value
iProposedMasterShipToNum
String
The proposed ShipToNum value
ds
The Customer data set
OnChangeCreditCardOrder This method validates field CreditCardOrder Parameters Name
Type
Description
ipCreditCardOrder
Boolean
Proposed CreditCardOrder value
ds
The Customer data set
OnChangeCustBankPayMethod This method populates Pay Method type. Parameters Name
Type
ds
Description The Customer data set
iProposedBankID
Int32
The proposed BankID value
iProposedPMUID
String
The proposed PMUID value
OnChangeCustomerTaxRegion This method validates TaxRegionCode and populates description for customer.
Epicor 9.05 | 9.05.605
585
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description The Customer data set
iProposedTaxRgnCode
String
The proposed TaxCode value
OnChangeofAltBT This method retrieves the CustBillTo record using the CustID passed. The AllowAsBillTo flag must be set on the bill to customer record. Parameters Name
Type
Description
custID
String
CustBillTo CustID
ds
The Customer data set
OnChangeofCustomerAddr Set the AddressVal flag to false which will indicate the address needs validation. Parameters Name
Type
ds
Description The Customer data set
custNum
Int32
Customer.CustNum
proposedVal
String
Proposed value of change.
addrField
String
Address1, 2, 3, City, State, Zip and CountryNum.
OnChangeofShipToAddr Set the AddressVal flag to false which will indicate the address needs validation. Parameters Name
Type
ds
Description The Customer data set
custNum
Int32
ShipTo.CustNum
shipToNum
String
ShipTo.ShipToNum
proposedVal
String
Proposed value of change.
addrField
String
Address1, 2, 3, City, State, Zip and CountryNum.
OnChangeShipToTaxRegion This method validates TaxRegionCode and populates description for shipto.
586
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
The customer data set
iProposedTaxRgnCode
String
The proposed TaxCode value
iCustNum
Int32
Customer num
iShipToNum
String
ShipTo num
OnChangeVendorID This method validates VendorID and populates vendor name. Parameters Name
Type
Description
ds
The Customer data set
iProposedVendorID
String
The proposed VendorID value
PreLinkGlbCustBillTo Linking a GlbCustBillTo record ties a global record to a new or existing CustBillTo record so that any changes made to the GlbCustBillTo record in another company are automatically copied to any linked CustBillTo's. This method performs the pre link logic to check of okay to link or get the new BTCustNum to create/link to. Will be run before LinkGlbCustBillTo which actually creates/updates a CustBillTo record and will send the modified record back for update. When the Link "button" is originally selected, the LinkBTCustNum will be defaulted to the GlbBTCustNum field. It will then check to see if this ID is available for use. If available for use the system will return a question asking the user if they want to use this number. If the answer is no, then the user either needs to select an existing BTCustNum for the current customer to link to or enter a brand new BTCustNum for the customer. You will run this method until the user's answer is yes. Then the LinkGlbCustBillTo method is called. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCustBillTo record to link
glbCustNum
Int32
Global CustNum field on the GlbCustBillTo record to link
ds vMessage
The Global Customer data set String@
Returns a message the user needs to respond yes or no to. If the user answers no, then they need to update the LinkBTCustNum field and then run this method again to test the new BTCustNum they want to link to
PreLinkGlbCustomer Linking a Glbcustomer record ties a global record to a new or existing Customer record so that any changes made to the GlbCustomer record in another company are automatically copied to any linked customers. This method performs the pre link logic to check of okay to link or get the new custid to create/link to. Will be run before LinkGlbCustomer which actually creates/updates a customer record and will send the modified record back for update. When the Link "button" is originally selected, the LinkCustID will be defaulted to the GlbCustId
Epicor 9.05 | 9.05.605
587
A-E
Business Object Reference Guide
field. It will then check to see if this ID is available for Use. If available for use the system will return a question asking the user if they want to use this number. If the answer is no, then the user either needs to select an existing customer's ID to link to or enter a brand new ID. You will run this method until the user answer is yes. Then the LinkGlbCustomer method is called. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCustomer record to link
glbCustNum
Int32
Global CustNum field on the GlbCustomer record to link
ds vMessage
The Global Customer data set String@
Returns a message the user needs to respond yes or no to. If the user answers no, then they need to update the LinkCustId field and then run this method again to test the new CustId they want to link to
PreLinkGlbShipTo Linking a GlbShipTo record ties a global record to a new or existing ShipTo record so that any changes made to the GlbShipTo record in another company are automatically copied to any linked shipto's. This method performs the pre link logic to check of okay to link or get the new shiptonum to create/link to. Will be run before LinkGlbShipTo which actually creates/updates a shipto record and will send the modified record back for update. When the Link "button" is originally selected, the LinkShipToNum will be defaulted to the GlbShipToNum field. It will then check to see if this ID is available for use. If available for use the system will return a question asking the user if they want to use this number. If the answer is no, then the user either needs to select an existing ShipToNum for the current customer to link to or enter a brand new ShipToNum for the customer. You will run this method until the user's answer is yes. Then the LinkGlbShipTo method is called. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbShipto record to link
glbCustNum
Int32
Global CustNum field on the GlbShipTo record to link
glbShipToNum
String
Global ShipToNum field on the GlbShipto record to link
ds vMessage
The Global Customer data set String@
Returns a message the user needs to respond yes or no to. If the user answers no, then they need to update the LinkShipToNum field and then run this method again to test the new ShipToNum they want to link to
ResetShipToIntl Parameters Name ds
588
Type
Description The customer data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
SetUPSQVEnable Parameters Name
Type
Description
ipQVEnable
Boolean
logical indicating if the quantum view is to enabled/disabled
ipUpdCustUPS
Boolean
Yes, if the CustUPSEmail table is to be updated
ipUPDShipToUPS
Boolean
Yes, if the ShipToUPSPPEml talbe is to be updated
ds
The customer data set
ShipToETCAfterAddrVal After the tax integration has been called, update the customer address if it was changed. Parameters Name
Type
Description
ds
The ETCAddrValidation data set
ds1
The Customer data set
ipCustNum
Int32
ShipTo.CustNum
ipShipToNum
String
ShipTo.ShipToNum
ShipToETCValAddr Call tax integration and loads temp tables from the results. Parameters Name
Type
Description
custNum
Int32
ShipTo.CustNum
shipToNum
String
ShipTo.ShipToNum
statusFlag
Boolean@
Set to true if the service is up, false if down.
errorFlag
Boolean@
errorMsg
String@
Returns The ETCAddrValidation data set
ShipToTerrSelectChange This sets the ShipTo TerritoryID field based on the TerritorySelect flag. To be used when the Territory Select field changes
Epicor 9.05 | 9.05.605
589
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description The Customer data set
SkipGlbCustomer This method performs the logic behind the skip option for GlbCustomer Skip - sets the Skipped flag to true. If the CustNum field is not 0 will error out Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCustomer record to skip
glbCustNum
Int32
Global CustNum field on the GlbCustomer record to skip
ds
The Global Customer data set
UnlinkGlbCustomer This method performs the logic behind the unlink option for GlbCustomer Unlink - clears the CustNum and CustId field in GlbCustomer. Returns the Customer DataSet Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbCustomer record to unlink
glbCustNum
Int32
Global CustNum field on the GlbCustomer record to unlink
ds
The Global Customer data set
Returns The Customer data set
UpdateCreditTotals This method updates the TotOpenCredit and TotGlobalCredit fields. To be called when the include credit flags are changed. Parameters Name ds
Type
Description The Customer data set
UpdateGlobalLimits This method converts the global credit limit from the global currency value to the local currency value. To be used when the global currency code changes or when the global credit limits are changed.
590
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
The Customer data set
ValidateCountry Parameters Name
Type
Description
ipProposedCountry
Int32
country number to validate
ValidatePayBTFlag Parameters Name
Type
Description
ipPayBTFlag
String
requested pay bt flag to edit
ipValCust
Boolean
logical indicating if the pay flag on the CustMFBill is to be checked
ipValShipTo
Boolean
logical indicating if the pay flag on the ShipToMFBill is to be checked
ipCustNum
Int32
customer Number
ipShipTo
String
Ship To
CustomerConnectSetup Epicor.Mfg.BO.CustomerConnectSetup: This business object contains 8 methods.
GetNewSFDBCfg Inserts a new row in the DataSet with defaults populated. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
591
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
592
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns
CustomerPartXRef Epicor.Mfg.BO.CustomerPartXRef: This business object contains 19 methods.
GetNewCustXPrt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
593
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK
594
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
• QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeCustXPrtPartNum When Changing CustXPrt.PartNum field. Parameters Name
Type
Description
iPartNum
String@
Part Number
ds
The CustomerPartXRef dataset
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
ChangeCustXPrtSNMask When Changing CustXPrt.SNMask field. Parameters Name
Type
Description
iSNMask
String
Serial Number Mask Id
ds
The CustomerPartXRef dataset
ChangeCustXPrtSNOverride When Changing PartRef.SNOverride field.
Epicor 9.05 | 9.05.605
595
A-E
Business Object Reference Guide
Parameters Name
Type
Description
iSNOverride
String
Override Mask
ds
The InternalPartCrossRef dataset
ChangeCustXPrtXPartNum When Changing CustXPrt.XPartNum field. Parameters Name
Type
Description
iXPartNum
String
Customer Part Number
ds
The CustomerPartXRef dataset
ChangeMaskPrefixSuffix When Changing CustomerRef.MaskPrefix or Suffix field. Parameters Name
Type
Description
icValue
String
MaskPrefix or MaskSuffix value
icPorC
String
Which one to check
ds
The CustomerPartXRef dataset
GetCustomerParXRef Get all Customer Part References for a given Customer Parameters Name
Type
Description
iCustNum
Int32
Customer Number
ds
The CustomerPartXRef dataset
UpdateCustPartOpts Update Customer CustPartOpts Parameters
596
Name
Type
Description
pcCustID
String
CustID
pcCustPartOpts
String
CustPartOpts
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CustPriceListSearch Epicor.Mfg.BO.CustPriceListSearch: This business object contains 2 methods.
getLineShipToWhse Get Line's ship to warehouse.
GetList Populates the CustPriceList table. Parameters Name
Type
Description
whereClause
String
whereClause.
absolutePage
Int32
absolutePage.
morePages
Int32
More pages.
Returns Inventory qty adj data set
CustReminderSearch Epicor.Mfg.BO.CustReminderSearch: This business object contains 7 methods. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
597
A-E
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CustomerReminderSearch Parameters Name
Type
Description
whereClauseCustReminderSearch
String
Customer search clause
pageSize
Int32
Page size
absolutePage
Int32
Absolute page
morePages
Boolean@
More Pages
Returns CustReminderSearch List Data Set
CustRpt Epicor.Mfg.BO.CustRpt: This business object contains 8 methods.
GetNewCustRpt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
598
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetFileNameList This method returns file name list.
Epicor 9.05 | 9.05.605
599
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description The Customer Report data set
CustShip Epicor.Mfg.BO.CustShip: This business object contains 122 methods.
GetNewShipHead Inserts a new row in the DataSet with defaults populated.
GetNewShipHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewCartonTrkDtl Inserts a new row in the DataSet with defaults populated.
GetNewShipDtl Inserts a new row in the DataSet with defaults populated.
GetNewShipDtlAttch Inserts a new row in the DataSet with defaults populated.
GetNewShipCOO Inserts a new row in the DataSet with defaults populated.
GetNewShipDtlTax Inserts a new row in the DataSet with defaults populated.
GetNewShipMisc Inserts a new row in the DataSet with defaults populated.
GetNewShipUPS Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
600
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
601
A-E
Business Object Reference Guide
Returns
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Name
Type
Description
ipNbrCartonsToCreate
Int32
Number of cartons or cases to create
ipPkgCode
String
Package Code to use when creating cartons
ipPkgLength
Decimal
length to use when creating cartons
ipPkgWidth
Decimal
Width to use when creating cartons
ipPkgHeight
Decimal
Height to use when creating cartons
ipRecalcAmts
Boolean
Logical indicating if the amounts are to be recalculated
ipZeroWeight
Boolean
Logical indicating if the weights are recalculated
Returns pcNeqQtyActionpcMessage
CreateCustomerCartons Parameters
ds
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK
602
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
• QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
603
A-E
Business Object Reference Guide
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
This method exists soley for the purpose of allowing security for unchecking the external delivery note flag to be defined
AskForShipToChange Checks if user must be asked for take a different Shipping Information Parameters
604
Name
Type
Description
iPackNum
Int32
Pack Number
iOrderNum
Int32
Order Number
iOrderLine
Int32
Order Line Number
iOrderRelNum
Int32
Release Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
askUser
Boolean@
Tells if the user must be asked for changing the Shipping Information
AssignLegalNumber Assigns a legal number to the customer shipment. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
String@
Legal number message
ds opLegalNumMsg Returns The Customer Shipment data set
BuildCompSerMatch Parameters Name
Type
Description
ipPartNum
String
ipPartNum
ipRevNum
String
ipRevNum
ipSerialNumbers
String
ipSerialNumbers
Returns Customer Shipment data set
BuildSerialMatchingParams This method fills the SerialMatchingParams Dataset with information Parameters Name
Type
Description
ds
Serial Matching data set
ds1
Customer Shipment data set
packLine
Int32
Detail Line Number to update
BuildShipToCustomerList If the Order has releases to multiple Customers, this will return the list of available Customer shiptos to select from
Epicor 9.05 | 9.05.605
605
A-E
Business Object Reference Guide
Parameters Name
Type
Description
orderNum
Int32
Order Number
shipToCustomerList
String@
delimited list of available ShipTo's
BuildShipToList If the Order has releases to multiple shipto's, this will return the list of available shiptos to select from Parameters Name
Type
Description
orderNum
Int32
Order Number
iShipToCustNum
Int32
Ship To Customer ID
shipToList
String@
delimited list of available ShipTo's
CalculateWeight Parameters Name
Type
Description
cartonNumber
Int32
PackID
calculatedWeight
Decimal@
calculated weight
CancelVoid This method clears the void flag on the Pack Slip Parameters Name
Type
Description
packNum
Int32
Packing Slip Number
Returns Customer Shipment data set
CanStage This method check that a shipment can be staged Parameters
606
Name
Type
Description
ipShipHedRowID
String
Unique Identifier for the Transfer Order Shipment
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CartonValidateWeight Parameters Name
Type
Description
ipWeight
Decimal
weight to validate
ChangeShipCmpl This method performs validations when the ShipDtl.ShipCmpl field changes Parameters Name
Type
Description
ds
Customer Shipment data set
packLine
Int32
Detail Line Number to update
shipCmpl
Boolean
Proposed ShipCmpl change
questionString
String@
If the ShipCmpl is being set for release 1 and OrderDtl.LockQty other releases will be closed ask if the user wants to continue
ChangeShipDtlMFCustID Method to call when changing the Mark For Customer ID on the ShipDtl record. Validates the Mark For Customer ID and ressets the ShipToNum to the Customer default. Parameters Name
Type
Description
ipMFCustID
String
The proposed Mark For Customer ID
ds
The Customer Shipment data set
ChangeShipDtlMFShipToNum Update ShipDtl information with values from the Mark For when the Mark For is changed. Parameters Name
Type
Description
proposedMFShipToNum
String
The Proposed Mark For ShipToNum
ds
The Customer Shipment data set
ChangeShipDtlUseOTMF Method to call when changing the UseOTMF field the ShipDtl record. Refreshes the address list and contact info
Epicor 9.05 | 9.05.605
607
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The Customer Shipment data set
ChangeShipHeadShipToCustID Executed when ShipToCustID has changed in the Ship Header Parameters Name
Type
Description
iShipToCustID
String
Ship To Customer ID
ds
CustShip Data set
ChangeShipMiscPrcnt This method populates the miscellaneous amount fields after a miscellaneous charge percentage has been changed Parameters Name
Type
ds newPrcnt
Description Customer Shipment data set
Decimal
Proposed Miscellaneous Change Percentage
ChangeStatus This method will be called to perform a change in the header status. Parameters Name
Type
Description
ipShipHedRowID
String
Unique Identifier for the Transfer Order Shipment
ipStatus
String
Selected Status. Valid Options: Open, Close, Void, UnVoid, Freight, UnFreight, Stage
ipResetCODCharges
Boolean
Indicates if the CODAmount is to be reset to zero
ipResetInsCharges
Boolean
Indicates if the DeclaredAmt is to be reset to zero
Returns Customer Shipment Data Set
CheckCompliance Check for every line of the Pack if it requires if it is compliant.
608
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
packNum
Int32
Current PackNum.
compliant
Boolean@
Indicates if the current Pack is compliant.
ds
Customer Shipment dataset
CheckCOOPercents Checks to see if the Qty percent and value percent fields total 100 percent. Parameters Name
Type
Description
iPackNum
Int32
The current PackNum
iPackLine
Int32
The current PackLine
CheckOrder This method check releases related with this pack were refused to close because non shipped pack existing. Parameters Name
Type
Description
packNum
Int32
The Pack Number to check out
msg
String@
releases weren't closed message
CheckOrderComplete This method is to be run before update Shipped flag (true) to check if order or line of the pack needs to be shipped complete, and ask the user if he wants to continue. If the user answers no, then the update method should not be called. Parameters Name
Type
ds
Description Customer Shipment data set
ipPackNum
Int32
Pack Num to validate
msg
String@
If the Order or line need to be shipped complete, this asks if the user wants to continue
CheckPrePartInfo This method checks to see if there are any questions or issues with the part entered and returns a message, a part number and if any substitutes exist.
Epicor 9.05 | 9.05.605
609
A-E
Business Object Reference Guide
Parameters Name
Type
Description
partNum
String@
The input-output part number to validate and it gets returned
orderNum
Int32
The Order Number being changed
orderLine
Int32
The Order Line being changed
vMsgText
String@
The returned message for the inputted part
vSubAvail
Boolean@
Returned flag stating if substitutes exist for this part
vMsgType
String@
Type of message returned. Values can be; "Question" (asking if they want to use the substitute part) "Warning" (Warns them that a part is onhold or runout). "Error" (Part in Inactive, or Onhold/Runout parts are not accepted in this case) . "Question" is asking if they want to use the substitute part.
origPartNum
String@
Returned origninal PartNum
CheckReadyToInvoice This method should be run when the ReadyToInvoice flag has been unchecked. It will look to see if the record was sent to an External package and send back an error message for the user to review. Calling the update Method assumes the user answered yes to the question. Parameters Name
Type
Description
readyToInvoice
Boolean
Proposed value of the ReadyToInvoice field to validate
legalNumberMessage
String@
Error warning about Legal Numbers
ds
CheckShipDtl This method is to be run before update to ask the user any question that need to be answered before the record(s) can be saved. If the user answers no to any one of the questions, then the update method should not be called. Parameters Name
Type
ds
610
Description Customer Shipment data set
releaseMessage
String@
If the Order release is closed, this asks if the user wants to continue
completeMessage
String@
If the order complete status has changed, this would alert the user to any problems (yes/no)
shippingMessage
String@
Alerts to any potential shipping error
lotMessage
String@
If the lot doesn't exist, ask the user if they'd like to create it
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
inventoryMessage
String@
If the inventory will go negative, ask user if they want to continue
lockQtyMessage
String@
If the OrderDtl.LockQty=true and release 1 is being set to ship complete, ask user if they want to continue
allocationMessage
String@
If this transaction overrides a allocation, ask user if they want to continue
CheckValidCartonWeight Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to validate weights
ClearConvertedManifestUOMFields Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to clear Manifest fields
ConvertToManifestUOM Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to populate Manifest fields
ConvertUOM This method converts a qty from one UOM to another Parameters Name
Type
Description
partNum
String
Part number
baseQty
Decimal
Qty you wish to convert
baseUOM
String
UOM baseQty is specified in
convUOM
String
UOM to convert to
convQty
Decimal@
Qty converted to UOM specified in convUOM
Epicor 9.05 | 9.05.605
611
A-E
Business Object Reference Guide
CreateMassShipDtl This method copies the available Order Release lines to the ShipDtl datatable for update Parameters Name
Type
Description
packNum
Int32
Pack Number to add new shipment lines to
orderNum
Int32
Order Number to create shipment lines from
ds
Customer Shipment data set
DeletePhantomPacks Parameters Name
Type
Description
ds
Customer Shipment data set
DeleteRangePhantomPacks Parameters Name
Type
Description
ipFromCase
Int32
First case number to start deletes
ipToCase
Int32
Last case number to delete
ds
Customer Shipment data set
This method checks if the shipment is able to ship.
getCartonPackaging Parameters Name
Type
Description
ipPkgCode
String
package code
opPkgHeight
Decimal@
package height
opPkgWidth
Decimal@
package width
opPkgLength
Decimal@
package length
GetCustShipOrdTrk Get Customer Shipments for the Order.
612
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
orderNum
Int32
Order Number
Returns Customer Shipment for Order Tracker data set
GetHeadOrderInfo This method displays the customer/address information when the OrderNum field in the header changes. Should only be called for new Customer Shipments, or Customer Shipments w/o lines Parameters Name
Type
Description
orderNum
Int32
Proposed change to OrderNum
creditMessage
String@
If customer is on credit hold an error message will be returned.
ds
Customer Shipment data set
GetJobDtlInfo This method defaults the ShipDtl fields with the JobNum field changes Parameters Name
Type
ds
Description Customer Shipment data set
packLine
Int32
Detail Line Number to update
jobNum
String
Proposed change to JobNum field
GetJobInfo This method populates the Order and Address fields after the JobNum field has been populated Parameters Name
Type
Description
jobNum
String
proposed JobNum change on ShipDtl
creditMessage
String@
If customer is on credit hold an error message will be returned.
ds
Epicor 9.05 | 9.05.605
Customer Shipment data set
613
A-E
Business Object Reference Guide
GetJobSupOpSeq This method Gets the Job Suboperations Sequence Numbers to retrive the Serial Numbers Selected for the PartNum Parameters Name
Type
Description
jobNum
String
JobNum field
partNum
String
The part number to validate
mtlSeq
String@
Material Sequences
GetLegalNumGenOpts Returns the legal number generation options. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
GetManifestInfo Parameters Name
Type
Description
ipSalesOrder
Int32
Sales Order
ipPackNum
Int32
Pack Number
ds
Customer Shipment data set
GetNewOrdrShipDtl Creates a new ShipDtl record, but defaulting the order number (if provided) as well as other data from the OrderHed record. Parameters Name
Type
ds
614
Description Customer Shipment data set
packNum
Int32
Pack ID
orderNum
Int32
Order number to default in the new record (optional)
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetNewOrdrShipUPS Creates a new ShipUS record, Parameters Name
Type
ds packNum
Description Customer Shipment data set
Int32
Pack ID
GetOrderInfo This method displays the customer/address information when the OrderNum field changes Should only be called for new Customer Shipments, or Customer Shipments w/o lines Parameters Name
Type
Description
orderNum
Int32
Proposed change to OrderNum
creditMessage
String@
If customer is on credit hold an error message will be returned.
ds
Customer Shipment data set
GetOrderLineInfo This method defaults the ShipDtl fields with the OrderLine fields change Parameters Name
Type
ds
Description Customer Shipment data set
packLine
Int32
Detail Line Number to update
orderLine
Int32
Proposed Orderline change
subsPart
String
Proposed substitute PartNum
GetOrderRelInfo This method defaults the ShipDtl fields with the OrderRel fields change Parameters Name
Type
ds
Description Customer Shipment data set
packLine
Int32
Detail Line Number to update
orderRelNum
Int32
Proposed OrderRelease change
Epicor 9.05 | 9.05.605
615
A-E
Business Object Reference Guide
Name
Type
Description
allowNewShipTo
Boolean
Allow to take new ShipTo from release
GetPackaging Parameters Name
Type
Description
ipPkgCode
String
package code
ds
Customer Shipment data set
GetPackClass Parameters Name
Type
Description
ipPkgClass
String
package class
ds
Customer Shipment data set
GetPackOutPartXRef This method defaults PackOut fields when the PartNum field changes Parameters Name
Type
ds
Description Pack Out data set
packLine
Int32
Detail Line Number to update
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the line contains serial numbers
questionString
String@
If the part is being changed to something different than what was
multipleMatch
Boolean@
Multiple matches were found by FindPart on the order, ask if the user wants to continue
GetPartInfo This method defaults ShipDtl fields when the PartNum field changes
616
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
Customer Shipment data set
packLine
Int32
Detail Line Number to update
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the shipdtl line contains serial numbers
questionString
String@
If the part is being changed to something different than what was Multiple matches were found by FindPart on the order, ask if the user wants to continue
GetPayBTFlagDefaults Parameters Name
Type
Description
ipOrderNum
Int32
First sales order on shipment
ipPayFlag
String
Pay Flag to retrieve defaults
ds
The customer shipment data set
GetPOPackaging Parameters Name
Type
Description
ipPkgCode
String
package code
ds
Customer PackOut data set
GetPOPackClass Parameters Name
Type
Description
ipPkgClass
String
package class
ds
Packout data set
GetQtyInfo This method defaults the ShipDtl Netweight and Quantity fields when the ShipDtl.DisplayInvQty or ShipDtl.OurJobShipQty fields change
Epicor 9.05 | 9.05.605
617
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
Customer Shipment data set
packLine
Int32
Detail Line Number to update
displayInvQty
Decimal
Proposed change to Inventory Qty field
ourJobShipQty
Decimal
Proposed change to OurJobShipQty field
GetRowsContactTracker Calls the normal GetRows method and then constructs a custom data set combining Head/Dtl fields for the contact tracker. Parameters Name
Type
Description
whereClauseShipHead
String
Whereclause for ShipHead table.
whereClauseShipHeadAttch
String
Whereclause for ShipHeadAttch table.
whereClauseShipDtl
String
Whereclause for ShipDtl table.
whereClauseShipDtlAttch
String
Whereclause for ShipDtlAttch table.
whereClauseShipMisc
String
Whereclause for ShipMisc table.
whereClauseSelectedSerialNumbers
String
Whereclause for SelectedSerialNumbers table.
whereClauseSerialNumberSearch
String
Whereclause for SerialNumberSearches table.
whereClauseSNFormat
String
Whereclause for SNFormat table.
contactName
String
Contact to return data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.CustShipCustTrkDataSet
GetRowsCustomerTracker Calls the normal GetRows method and then constructs a custom data set combining Head/Dtl fields for the customer tracker. Parameters
618
Name
Type
Description
whereClauseShipHead
String
Whereclause for ShipHead table.
whereClauseShipHeadAttch
String
Whereclause for ShipHeadAttch table.
whereClauseShipDtl
String
Whereclause for ShipDtl table.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
whereClauseShipDtlAttch
String
Whereclause for ShipDtlAttch table.
whereClauseShipMisc
String
Whereclause for ShipMisc table.
whereClauseSelectedSerialNumbers
String
Whereclause for SelectedSerialNumbers table.
whereClauseSerialNumberSearch
String
Whereclause for SerialNumberSearches table.
whereClauseSNFormat
String
Whereclause for SNFormat table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.CustShipCustTrkDataSet
GetScale Calls GetDefaultScale Parameters Name
Type
Description
workstationID
String
Workstation ID
scaleID
String@
Scale ID
GetSelectSerialNumbersParams Parameters Name
Type
Description
ipPartNum
String
ipPartNum
ipQuantity
Decimal
ipQuantity
ipUOM
String
ipUOM
ipPackNum
Int32
ipPackNum
ipPackLine
Int32
ipPackLine
ipTranType
String
ipTranType
ipJobNum
String
ipJobNum
ipWhseCode
String
ipWhseCode
ipBinNum
String
ipBinNum
ipFromPO
Boolean
ipFromPO
Epicor 9.05 | 9.05.605
619
A-E
Business Object Reference Guide
Returns
GetShipMiscDefaults This method populates the Description and miscellaneous amount fields after a miscellaneous charge code has been selected Parameters Name
Type
Description
ds miscCode
Customer Shipment data set String
Proposed Miscellaneous Code change
GetShipToAddr This method displays the shipto address information when the ShipToNum field changes Should only be called on new Shipments or if the Shipment has no lines and if the MultipleShippers flag is yes Parameters Name
Type
Description
ds shipToNum
Customer Shipment data set String
Proposed ShipTo Number change
GetTranDocTypeID Sets default values when the TranDocTypeID changes Parameters Name
Type
Description
ipTranDocTypeID
String
TranDocTypeID supplied
ds
GetWhseInfo This method defaults the ShipDtl Warehouse and bin fields when the warehousecode changes Parameters Name
Type
ds
620
Description Customer Shipment data set
packLine
Int32
Detail Line Number to update
whseCode
String
Proposed WarehouseCode change
whseField
String
Warehouse field that is being changed
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
HHCreateMassShipDtl This method copies the available Order Release lines to the ShipDtl datatable for update Parameters Name
Type
Description
packNum
Int32
Pack Number to add new shipment lines to
orderNum
Int32
Order Number to create shipment lines from
ds
Customer Shipment data set
HHGetOrderInfo This method sets the defaults quantities and Primary Bins fields as CreateMassShipment complements This method is used for HandHelds Version Parameters Name
Type
Description
orderNum
Int32
Proposed change to OrderNum
creditMessage
String@
If customer is on credit hold an error message will be returned.
ds
Customer Shipment data set
HHSetDtlDefaultValues OBSOLETE - OBSOLETE - OBSOLETE - OBSOLETE - OBSOLETE - OBSOLETE - OBSOLETE - OBSOLETE - OBSOLETE Use MarkShipmentLines instead (the same logic that is used by the regular screen) OBSOLETE - OBSOLETE OBSOLETE - OBSOLETE - OBSOLETE - OBSOLETE - OBSOLETE - OBSOLETE - OBSOLETE This method sets the defaults quantities and Primary Bins fields as CreateMassShipment complements This method is used for HandHelds Version Parameters Name
Type
ds
Description Customer Shipment data set
MarkShipmentLines This method sets all the temp-table records to be shipped (Ship all button selected) Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Customer Shipment data set
621
A-E
Business Object Reference Guide
PhantomStatusCheck Parameters Name
Type
Description
ipPackNum
Int32
pack number to check status
PickedOrders OBSOLETE OBSOLETE OBSOLETE OBSOLETE OBSOLETE OBSOLETE OBSOLETE OBSOLETE - Call ProcessPickedOrder directly now - OBSOLETE OBSOLETE OBSOLETE OBSOLETE OBSOLETE OBSOLETE OBSOLETE OBSOLETE This method creates the packing slip for the selected picked order Parameters Name
Type
Description
plant
String
Picked Order Plant
orderNum
Int32
Picked Order Number
orderLine
Int32
Picked Order Line Number
orderRelNum
Int32
Picked Order Release Number
whseCode
String
Picked Order Warehouse
binNum
String
Picked Order Bin Number
jobNum
String
Picked Order Job Number
lotNum
String
Picked Order Lot Number
vMessage
String@
List of lines with errors to be corrected
Returns Customer Shipment data set
POChangeStage This method will be called to perform a change in the pack stage. Parameters Name ds
Type
Description Customer PackOUt data set
POChangeStatus This method will be called to perform a change in the header status from the pack Out screen.
622
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipStatus
String
Selected Status. Valid Options: Open, Close, Void, UnVoid, Freight, UnFreight, Stage
ipResetCODCharges
Boolean
Indicates if the CODAmount is to be reset to zero
ipResetInsCharges
Boolean
Indicates if the DeclaredAmt is to be reset to zero
ds
Customer PackOUt data set
POFindBuffer This method returns a count order of lines that match the incomming scanned criteria. If there is no unique match, logical fields are updated to que the UI as to what need to be prompted in order to find a matching order dtl. Parameters Name
Type
Description
found
Int32@
Number of matches count
rowident
String@
Rowident of unique match order dtl
ds
Customer PackOUt data set
POGetDtlList This method copies the available Order Release lines to the PackOut datatable for update Parameters Name
Type
Description
ipPackNum
Int32
Pack Number
ipOrderNum
Int32
Order to get detail from
ipPackMode
String
Pack Mode
cWarning
String@
ship to warning message
Returns Customer PackOUt data set
POGetNew This method creates a new packout record for the customer shipment packout screen. can pass in a OrderNum or PackNum or Both. Parameters Name
Type
Description
ipOrderNum
Int32
Order Number
Epicor 9.05 | 9.05.605
623
A-E
Business Object Reference Guide
Name
Type
Description
ipPackNum
Int32
Pack Num
pcWarningMsg
String@
If the order is on hold - warning msg
Returns Customer PackOUt data set
POGetShipTo This method creates a new packout record for the customer shipment packout screen Parameters Name
Type
Description
ds
Customer PackOut data set
PostUpdate This method will return a message if a credit card shipment was processed during update or there are warning messages regarding outbound lower level serial tracking Parameters Name
Type
Description
ipPackNum
Int32
Customer Shipment Number
opMessage
String@
Text Message to display
POUpdate This method creates a new packout record to create Shiphead and shipdtl records Parameters Name
Type
Description
opPackNum
Int32@
Pack Num
ipSourceRowID
String
RowIdent
ds
Customer Shipment data set
POValidateOrder This method sets the service contract invoiced flag to match the shiphead flag Parameters
624
Name
Type
Description
ipCustNum
Int32
Customer Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipOrderNum
Int32
Order chose to add to carton
opVaildOrder
Boolean@
If we can add the order
POValidateOrderRel Parameters Name
Type
Description
ipPackNum
Int32
pack number
ipOrderNum
Int32
sales order number
ipOrderLine
Int32
sales order line number
ipOrderRelNum
Int32
sales order release number
POValidatePart Validates whether the provided part is valid or not for a given sales order. Parameters Name
Type
Description
ipPartNum
String
Proposed part number.
ipOrderNum
Int32
Order number.
ds
Customer shipment packout dataset
opValidPart
Boolean@
True if the part is valid, false otherwise.
vMsgText
String@
Part edits message text
vSubAvail
Boolean@
substitution logical
vMsgType
String@
indicates if warning, error, etc
PreCreateMassShipDtl This method checks to see if it's okay to copy the available Order Release lines to the ShipDtl datatable for update in Mass Shipments Parameters Name
Type
Description
packNum
Int32
Pack Number to add new shipment lines to
orderNum
Int32
Order Number to create shipment lines from
warnMsg
String@
Returns a warning of lines that will not be created due to Serial Number tracking
ds
Epicor 9.05 | 9.05.605
Customer Shipment data set
625
A-E
Business Object Reference Guide
PrePickedOrders This method is run right before PickedOrders. If not all of the line details have been picked to ship a question will be returned to the user. If yes, then call PickedOrders, if no allow the user to pick another order Parameters Name
Type
ds vMessage
Description PickedOrders dataset.
String@
Question needed to be asked of user
PrintSlip This method prints the Customer Packing Slip Parameters Name
Type
Description
packNum
Int32
The Packing Slip Number to print
printPreview
Boolean
Flag if print should be previewed.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ProcessPickedOrder This method creates the packing slip for the selected picked order Parameters Name
Type
Description
pConsolidate
Boolean
Consolidates Orders in a single Carton.
vMessage
String@
List of lines with errors to be corrected
skipDelete
Boolean
Skip Delete? (for testing purposes)
ds
PickedOrders dataset.
Returns Customer Shipment List data set
626
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
RebuildShipUPS Parameters Name
Type
Description
ipPackNum
Int32
Packnum to update
ds
The customer shipment data set
SetUPSQVEnable Parameters Name
Type
Description
ipQVEnable
Boolean
logical indicating if the quantum view is to enabled/disabled
ds
The customer shipment data set
SetUPSQVShipStatus Parameters Name
Type
Description
ipShipStatus
String
Shipment status
ds
The customer shipment data set
StageWarning Parameters Name
Type
Description
iPackNum
Int32
Serial number to validate.
iWarning
String@
Serial Number Voided flag
UndoShipAll This method re-sets all the temp-table records shipped (Undo Ship all button selected) Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Customer Shipment data set
627
A-E
Business Object Reference Guide
UpdateManifestChargeAmts Parameters Name
Type
Description
ipAmountType
String
COD or DeclaredAmt
ipAction
Boolean
Yes = recalculate No = reset to zero
ds
Customer Shipment data set
UpdatePackCODWithCarton Parameters Name
Type
Description
ipPackNum
Int32
Pack Number to process
ipCaseNum
Int32
Case Number to set value to zero
ipOldCOD
Decimal
Previous COD
ipCOD
Decimal
Current Case COD
ipFlag
Boolean
Current COD flag value
ds
Customer Shipment data set
UpdatePackDeclaredWithCarton Parameters Name
Type
Description
ipPackNum
Int32
Pack Number to process
ipCaseNum
Int32
Case Number to set value to zero
ipOldDeclared
Decimal
Previous COD
ipDeclared
Decimal
Current Case COD
ipDeclaredFlag
Boolean
current setting of declared insurance
ds
Customer Shipment data set
ValidateCreditHold Parameters
628
Name
Type
Description
ipPackNum
Int32
Packing Slip Number
ipBTCustNum
Int32
Bill To Customer Number.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
creditMessage
String@
Credit Message.
cError
Boolean@
Error flag.
ValidateKitPart This method will validate the kit part when changing lines in the Sales Kit Component Issue grid Parameters Name
Type
Description
packLine
Int32
Detail Line Number to update
ds
Customer Shipment data set
ValidateSN Parameters Name
Type
Description
ipSerialNum
String
Serial number to validate.
ipPartNum
String
Part number
ipJobNum
String
Job number
ipOurJobshipQty
Decimal
Job Ship Quantity
ipOurInvShipQty
Decimal
Inventory Ship Quantity
ipOrderNum
Int32
Order number
ipOrderLine
Int32
Order Line number
ipOrderRelNum
Int32
OrderRelease number
ipShipFromWIP
Boolean
Flag to indicate shipping from WIP
isVoided
Boolean@
Serial Number Voided flag
VoidLegalNumber Voids the legal number. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
ipVoidedReason
String
Reason for the void
Returns The Customer Shipment data set
Epicor 9.05 | 9.05.605
629
A-E
Business Object Reference Guide
VoidPackSlip This method sets the void flag on the Pack Slip Parameters Name
Type
Description
packNum
Int32
Packing Slip Number
Returns Customer Shipment data set
CustXPrt Epicor.Mfg.BO.CustXPrt: This business object contains 9 methods.
GetNewCustXPrt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
630
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCustomerInfo This method defaults the customer information when the Customer ID is entered. Parameters Name
Type
Description
custID
String
Proposed Customer ID
ds
Customer Part Dataset
GetPartInfo This method populates the PartDescription field if the Part exists in the Part Master table Parameters Name ds
Type
Description Customer Part Dataset
CustXPrtSearch Epicor.Mfg.BO.CustXPrtSearch: This business object contains 7 methods.
GetNewCustXPrt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
631
A-E
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
632
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Chapter 4: D DashBoard Epicor.Mfg.BO.DashBoard: This business object contains 13 methods.
GetNewDashBdDef Inserts a new row in the DataSet with defaults populated.
GetNewDashBdBAQ Inserts a new row in the DataSet with defaults populated.
GetNewDashBdChunk Inserts a new row in the DataSet with defaults populated.
GetNewDashBdLike Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
633
A-E
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetDashboardsWithBAQ This methods returns a "list" dataset with possible DashBdDef records that match the current company, inputted productid and inputted queryid for each DashBdBAQ record. Parameters Name
Type
Description
ipProductId
String
The productid to return data for.
ipQueryID
String
The queryid to return data for.
Returns Dashboard definition list dataset
GetDashboardsWithLike This methods returns a "list" dataset with possible DashBdDef records that match the current company, inputted productid and inputted likefield for each DashBdLike record. Parameters Name
Type
Description
ipProductId
String
The productid to return data for.
ipLikeField
String
The likefield to return data for.
Returns Dashboard definition list dataset
634
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
StoreData This methods should be ran instead of the base Update method. This method will require the dataset to come in, next it will delete all DashBdChunk, DashBdBAQ, DashBdLike records associated with each ttDashBdDet in the dataset while also deleting the DashBdDef records in the database. Next the ttDashBdDef table will be the driving force behind the creation of new DashBdDef, DashBdChunk, DashBdBAQ, and DashBdLike records in the database. The values for the fields in these records will come from what is in the dataset. This 'StoreData' process is basically a complete 'overlay' of the DashBoard data. This method will require that all dataset records have a value of 'A' in the corresponding rowident field/column. Parameters Name
Type
ds
Description Dashboard dataset
DashboardMaint Epicor.Mfg.BO.DashboardMaint: This business object contains 8 methods.
GetNewDashboardMaint Inserts a new row in the DataSet with defaults populated.
GetNewDashBdBAQ Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
635
A-E
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DataDict Epicor.Mfg.BO.DataDict: This business object contains 3 methods.
GetByID This method returns the DataDict dataset. Returns DataDict dataset
GetList This method returns the Data Schema records Parameters Name
Type
Description
whereDBFile
String
Data Table Where Clause
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages flag
Returns DBFileList dataset
636
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetRows This method returns the Data Schema records Parameters Name
Type
Description
whereDBFile
String
Data Table Where Clause
whereDBField
String
Data Field Where Clause
whereDBIndex
String
Data Index Where Clause
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages flag
Returns DataDict dataset
DBFieldSearch Epicor.Mfg.BO.DBFieldSearch: This business object contains 3 methods.
GetByID This method returns the DBFieldSearchDataSet dataset. Returns DBFieldSearchDataSet dataset
GetList Returns DB Fields from _Field Parameters Name
Type
Description
whereClause
String
Data Table Where Clause
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages flag
Returns DBFieldListDataSet dataset
GetRows Returns DB Fields from the schema table _Field
Epicor 9.05 | 9.05.605
637
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClauseDBFile
String
Data Table Where Clause
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages flag
Returns DBFieldSearchDataSet dataset
DBTableSearch Epicor.Mfg.BO.DBTableSearch: This business object contains 3 methods.
GetByID This method returns the BusEntTableSearch dataset. Returns DBTableSearchDataSet dataset
GetList Returns DB Tables from _File where their primary index is composed of Company + Another Field Parameters Name
Type
Description
whereClause
String
Data Table Where Clause
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages flag
Returns DBFileList dataset
GetRows Returns DB Tables from _File where their primary index is composed of Company + Another Field Parameters
638
Name
Type
Description
whereClauseDBFile
String
Data Table Where Clause
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages flag
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns DBTableSearchDataSet dataset
DeliveryType Epicor.Mfg.BO.DeliveryType: This business object contains 8 methods.
GetNewDeliveryType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
639
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ValidateDeliveryType Validate that Delivery Type does not exists in the following Tables: Customer, CustShip, Masterpack, MiscShip, PlantConfCtrl, ShipTo, SubConShipEntry, TransOrderShip, Vendor Parameters Name
Type
Description
ipDeliveryType
String
DeliveryType Id
opFail
Boolean@
opFail
opMessage
String@
opMessage
DemandCntDtlSearch Epicor.Mfg.BO.DemandCntDtlSearch: This business object contains 7 methods.
GetNewDemandContractDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
640
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DemandContract Epicor.Mfg.BO.DemandContract: This business object contains 32 methods.
GetNewDmdCntHdr Inserts a new row in the DataSet with defaults populated.
GetNewDmdCntHdrAttch Inserts a new row in the DataSet with defaults populated.
GetNewDmdCntDtl Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
641
A-E
Business Object Reference Guide
GetNewDmdCntDtlAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
642
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
643
A-E
Business Object Reference Guide
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeCurrValue To change the currency value Parameters Name
Type
Description
ipReplaceValue
Decimal
ReplaceValue that was entered.
ipbaseordoc
String
The field type - base or doc
ds
The DemandContract data set
ChangeDCDtlSellingTotalContractQty Update DmdCntDtl infomation when Customer Part Number is changed. Parameters Name
Type
Description
iSellingTotalContractQty
Decimal
The Selling Total Contract Quantity
ds
The DemandContract data set
ChangeDCDtlTotalContractQtyUOM Update DmdCntDtl Totals UOM when TotalContract Quantity UOM is changed.
644
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
iTotalContractQtyUOM
String
The Total Contract Quantity
ds
The DemandContract data set
ChangeDmdCntDtlMktgCamp Update MktgCampaign on the DmdCntDtl. Parameters Name
Type
Description
iMktgCampaignID
String
The Marketing Campaign ID
ds
The DemandContract data set
ChangeDmdCntDtlMktgEvnt Update MktgEvnt on the DmdCntDtl. Parameters Name
Type
Description
iMktgEvntSeq
Int32
The Marketing Event
ds
The DemandContract data set
ChangeDmdCntDtlPartNum Update DmdCntDtl information when Part Number is changed. Parameters Name
Type
ds
Description The DemandContract data set
iPartNum
String@
The Part Number
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
Epicor 9.05 | 9.05.605
645
A-E
Business Object Reference Guide
ChangeDmdCntDtlProject Update ProjectID on the DmdCntDtl. Parameters Name
Type
Description
iProjectID
String
The ProjectID
ds
The DemandContract data set
ChangeDmdCntDtlXPartNum Update DmdCntDtl infomation when Customer Part Number is changed. Parameters Name
Type
Description
iPartNum
String
The Customer Part Number
iXPartNum
String
The Customer Part Number
ds
The DemandContract data set
ChangeDmdCntHdrBTCustNum Update DmdCntHdr information when Bill To Customer is changed. Parameters Name
Type
Description
iBTCustNum
Int32
The Bill To Customer Number
ds
The DemandContract data set
ChangeDmdCntHdrCustID Update Order Header information with values from the Sold To when the Sold To is changed. Parameters Name
Type
Description
iCustID
String
The Customer Number
ds
The DemandContract data set
ChangeDmdCntHdrProject Update ProjectID on the DmdCntHdr.
646
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
iProjectID
String
The ProjectID
ds
The DemandContract data set
CloseDmdCntHdr Closes the Demand Contract Header. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Contract Number
iOpenContract
Boolean
The Demand Contract Number
Returns The DemandContract data set
GetByDemandContractCustID Gets row by DemandContract. Parameters Name
Type
Description
demandContract
String
DemandContract
customerID
String
Customer ID
Returns The DemandContract data set
GetByDmdCntTradingPartner Gets row by DemandContract. Parameters Name
Type
Description
demandContract
String
DemandContract
tradingPartnerName
String
Trading Parner Name
Returns The DemandContract data set
GetContractNumByID Gets contract number by contract id.
Epicor 9.05 | 9.05.605
647
A-E
Business Object Reference Guide
Parameters Name
Type
Description
contractID
String
Demand Contract ID
contractNum
Int32@
Demand Contract Number
refreshPlant Update Plant on DemandDetail related records. Parameters Name
Type
Description
inputDMCNum
Int32
The Demand Contract Num
inputDMCLine
Int32
The Demand Contract Line
inputDMCPlant
String
The Demand Plant
DemandEntry Epicor.Mfg.BO.DemandEntry: This business object contains 76 methods.
GetNewDemandHead Inserts a new row in the DataSet with defaults populated.
GetNewDemandDetail Inserts a new row in the DataSet with defaults populated.
GetNewDemandMiscChg Inserts a new row in the DataSet with defaults populated.
GetNewDemandSchedule Inserts a new row in the DataSet with defaults populated.
GetNewDemandMiscChgDH Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
648
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
649
A-E
Business Object Reference Guide
Returns
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK
650
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
• QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeCreateNewOrder Update Demand Header information when the Bill To. Parameters Name
Type
Description
ipCreateNewSO
Boolean
Boolean value to enable/disable CreateNewOrder flag
ds
The DemandEntry data set
ChangeDemandDetailCustomerPrice Update UnitPrice Based on Customer Price. Parameters Name
Type
Description
iCustomerPrice
Decimal
The Customer Price
ds
The DemandEntry data set
ChangeDemandDetailDemandContractLine Update Demand Detail information when the Demand Contract Line is changed. Parameters Name
Type
Description
proposedDemandContractLine
Int32
The proposed Demand Contract Line
ds
The DemandEntry data set
ChangeDemandDetailInternalPrice Update UnitPrice Based on Internal Price. Parameters Name
Type
Description
iInternalPrice
Decimal
The Internal Price
ds
Epicor 9.05 | 9.05.605
The DemandEntry data set
651
A-E
Business Object Reference Guide
ChangeDemandDetailMktgCamp Update MktgCampaign on the DmdCntDtl. Parameters Name
Type
Description
iMktgCampaignID
String
The Marketing Campaign ID
ds
The DemandEntry data set
ChangeDemandDetailPartNum Update partnum on the DmdCntDtl. Parameters Name
Type
Description
iPartNum
String
The part
ds
The DemandEntry data set
ChangeDemandDetailRevisionNum Update Demand Detail information when the Part Revision Number is changed. Parameters Name
Type
Description
ds
The DemandEntry data set
ChangeDemandHeadBTCustID Update Demand Header information when the Bill To. Parameters Name
Type
Description
proposedBTCustID
String
The proposed Bill To Cust ID
ds
The DemandEntry data set
ChangeDemandHeadCancelPO Update Demand Header information when the Cancel PO flag changes.
652
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipCancelPO
Boolean
Boolean value to enable/disable Cancel PO flag
ds
The DemandEntry data set
ChangeDemandHeadDemandContract Update Demand Header information when the Demand Contract is changed. Parameters Name
Type
Description
proposedDemandContract
String
The proposed Demand Contract
ds
The DemandEntry data set
ChangeDemandHeadDemandContractNum Update Demand Header information when the Demand Contract is changed. Parameters Name
Type
Description
proposedDemandContractNum
Int32
The proposed Demand Contract Number
ds
The DemandEntry data set
ChangeDemandHeadERSOrder Update Demand Header information when the ERS Order changes. Parameters Name
Type
Description
proposedERSOrder
Boolean
The proposed ERS Order
ds
The DemandEntry data set
ChangeDemandHeadShipToCustID Method to call when changing the ShipTo Customer ID on the DemandHead record. Validates the ShipTo Customer ID and ressets the ShipToNum to the Customer default. Parameters Name
Type
Description
ipShipToCustID
String
The proposed ShipTo Customer ID
ds
Epicor 9.05 | 9.05.605
The DemandEntry data set
653
A-E
Business Object Reference Guide
ChangeDemandHeadShipToNum Update Demand Header information when the Ship To Num changes. Parameters Name
Type
Description
proposedShipToNum
String
The proposed Ship To Num
ds
The DemandEntry data set
ChangeDemandHeadUseOTS Method to call when changing the UseOTS field the DemandHead record. Refreshes the address list and contact info Parameters Name
Type
Description
ds
The DemandEntry data set
ChangeDemandScheduleCreateShipToNum Update DemandScheduleCreate information with values from the Ship To when the Ship To is changed. Parameters Name
Type
Description
proposedShipToNum
String
The Proposed ShipToNum
cCreateCycleList
String@
List of Cycle Types the user has to choose from.
ds
The DemandScheduleCreate data set
ChangeDemandScheduleMarkForNum Update DemandSchedule information with values from the Mark For when the Mark For is changed. Parameters Name
Type
Description
proposedMarkForNum
String
The Proposed ShipToNum
ds
The DemandEntry data set
ChangeDemandScheduleMFCustID Method to call when changing the Mark For Customer ID on the DemandSchedule record. Validates the Mark For Customer ID and ressets the ShipToNum to the Customer default.
654
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipMFCustID
String
The proposed Mark For Customer ID
ds
The DemandEntry data set
ChangeDemandScheduleNeedByDate Calculate the DemandSchedule Ship Date when the NeedByDate is changed. Parameters Name
Type
Description
proposedNeedByDate
Nullable{System.DateTime}
The Proposed NeedByDate
ds
The DemandEntry data set
ChangeDemandScheduleOTSDetails Method to call when changing the OTS fields the DemandSchedule record. Refreshes the address list and contact info Parameters Name
Type
ds
Description The DemandEntry data set
ChangeDemandSchedulePlant Update DemandSchedule information with values from the Plant when the Plant is changed. Parameters Name
Type
Description
proposedPlant
String
The Proposed Plant
ds
The DemandEntry data set
ChangeDemandScheduleReqDate Calculate the DemandSchedule NeedByDate when the Ship Date (ReqDate) is changed. Parameters Name
Type
Description
proposedReqDate
Nullable{System.DateTime}
The Proposed ReqDate
ds
Epicor 9.05 | 9.05.605
The DemandEntry data set
655
A-E
Business Object Reference Guide
ChangeDemandScheduleSellingReqQty Update Demand Schedule information when the Selling Req Qty is changed. Parameters Name
Type
Description
proposedSellingReqQty
Decimal
The proposed Selling Req Quantity
ds
The DemandEntry data set
ChangeDemandScheduleShipToCustID Method to call when changing the ShipTo Customer ID on the DemandSchedule record. Validates the ShipTo Customer ID and ressets the ShipToNum to the Customer default. Parameters Name
Type
Description
ipShipToCustID
String
The proposed ShipTo Customer ID
ds
The DemandEntry data set
ChangeDemandScheduleShipToNum Update DemandSchedule information with values from the Ship To when the Ship To is changed. Parameters Name
Type
Description
proposedShipToNum
String
The Proposed ShipToNum
ds
The DemandEntry data set
ChangeDemandScheduleUseOTMF Method to call when changing the UseOTMF field the DemandSchedule record. Refreshes the address list and contact info Parameters Name
Type
ds
Description The DemandEntry data set
ChangeDemandScheduleUseOTS Method to call when changing the UseOTS field the DemandSchedule record. Refreshes the address list and contact info
656
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The DemandEntry data set
ChangeMiscAmount Update Order Miscellaneous information when the amount changes. Parameters Name
Type
Description
tableName
String
name of table being passed in
ds
The DemandEntry data set
ChangeMiscCode This method returns default information for the MiscChrg. Method must use parameters instead of the dataset due to the problem with changing the primary key field. Also allows DemandMiscChgDH and DemandMiscChg to use the same code Parameters Name
Type
Description
tableName
String
name of table being passed in
ds
The DemandEntry data set
ChangeMiscPercent Update Order Miscellaneous information when the percentage was changed. Parameters Name
Type
Description
tableName
String
name of table being passed in
ds
The DemandEntry data set
CheckPartRevisionChange The method is to be run on leave of the PartNum and Revision fields before the ChangePart, ChangeRevision, or Update methods are run. When run before CreateOrderFromQuote, the Part Number expected is the part number from the quote. This returns all the questions that need to be asked before a part can be changed. Parameters Name
Type
Description
iDemandContractNum
Int32
The current DemandDetail.DemandContractNum field
Epicor 9.05 | 9.05.605
657
A-E
Business Object Reference Guide
Name
Type
Description
iDemandHeadSeq
Int32
The current DemandDetail.DemandHeadSeq field
iDemandDtlSeq
Int32
The current DemandDetail.DemandDtlSeq field
cFieldName
String
The name of the field you are leaving
cPartNum
String@
The new PartNum if a substitute part is found, partNum will be the substitute part
cConfigPartMessage
String@
If the part is configured, asks if it's okay to delete the configuration inputs. No means the part cannot be changed
CloseAllSchedules Close All Schedules. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Detail Contract Num
iDemandHeadSeq
Int32
The Demand Detail Header Sequence number
CloseDemandDetail Closes the Demand detail and sub-table (DemandSchedule). Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Detail Contract Num
iDemandHeadSeq
Int32
The Demand Detail Header Sequence number
iDemandDtlSeq
Int32
The Demand Detail Detail Sequence number
Returns The DemandEntry data set
CloseDemandHead Closes the Demand Header and sub-tables (DemandDetail and DemandSchedule). Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Num
iDemandHeadSeq
Int32
The Demand Header Sequence number
Returns The DemandEntry data set
658
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CloseDemandSchedule Closes the Demand Schedule record. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Schedule Contract Num
iDemandHeadSeq
Int32
The Demand Schedule Header Sequence number
iDemandDtlSeq
Int32
The Demand Schedule Detail Sequence number
iDemandScheduleSeq
Int32
The Demand Schedule Sequence number
Returns The DemandEntry data set
CreateDemandDetailFromContractLines Create DemandDetail records from the contract lines selected. This method will create a DemandDetail record for each contract line where SelectedForDemand is true. After this method is run the GetRows or GetByID method should be called so the dataset has the new DemandDetail records. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Number
iDemandHeadSeq
Int32
The Demand Header Sequence
ds
DeleteScheduleByScheduleNumber Deletes DemandSchedule records by Schedule Number. All DemandSchedule records where the Schedule Number equals the number passed in will be deleted. cReturnMessage will return a message of how many records were deleted. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Detail Contract Num
iDemandHeadSeq
Int32
The Demand Detail Header Sequence number
cScheduleNumber
String
The Schedule Number to delete
cReturnMessage
String@
The return message
Returns The DemandEntry data set
Epicor 9.05 | 9.05.605
659
A-E
Business Object Reference Guide
EDIHeaderValidate Calls the method Process Demand To create a Sales Order. Parameters Name
Type
Description
cReturnMessage
String@
Text to display to the user
dprocess
Boolean@
Flag that indicate if the Demand will be process it
matchDemand
Boolean@
Match Demand Flag
ds
The DemandEntry data set
GetDemandContractDtl Get Demand Contract Detail lines for Create Demand Detail from Demand Contract lines functionality. The contract lines returned can be selected by the user to indicate what contract lines to create Demand Detail records from. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Contract Number to get the lines from
Returns
GetDemandDtlReview Creates records in the DemandReview DataSet so the user can review the impact of the demand schedule prior to accepting or rejecting it. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Number
iDemandHeadSeq
Int32
The Demand Header Sequence Number
Returns
GetDemandMatching Creates records in the DemandMatching DataSet so the user can manually match DemandSchedule records to existing OrderRel records. Parameters
660
Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Number
iDemandHeadSeq
Int32
The Demand Header Sequence Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns
GetDemandScheduleCreate Creates a record in the DemandScheduleCreate datatable to store the parameters needed to mass-build DemandSchedule records for a DemandDetail line. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Number
iDemandHeadSeq
Int32
The Demand Header Sequence Number
iDemandDtlSeq
Int32
The Demand Detail Sequence Number
cCreateCycleList
String@
List of Cycle Types the user has to choose from.
Returns
GetListCustom Custom Search Parameters Name
Type
Description
whereClause
String
The search criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of Demands
GetPriceDiscrepancy Check if the differente between the UnitPrice and EDIUnitPrice is less than the value defined in the PriceTolerance field of the ShipTo or Customer tables. Parameters Name
Type
Description
ipCustNum
Int32
CustNum
ipPONum
String
PONum
ipUnitPrice
Decimal
UnitPrice
ipEDIUnitPrice
Decimal
EDIUnitPrice
ipDemandDtlSeq
Int32
DemandDtlSeq
opPriceDiscrepancy
Boolean@
PriceDiscrepancy
Epicor 9.05 | 9.05.605
661
A-E
Business Object Reference Guide
MassCreateDemandSchedule Creates DemandSchedule records based on user criteria entered in the DemandScheduleCreate datatable. At the end refresh the DemandHead/DemandDetail/DemandSchedule for a specific Demand Contract Line to avoid perform a GetByID that consumes a lot of time. Parameters Name
Type
Description
String@
Text to display to the user
ds cReturnText Returns
OpenDemandDetail Opens the Demand detail. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Detail Contract Num
iDemandHeadSeq
Int32
The Demand Detail Header Sequence number
iDemandDtlSeq
Int32
The Demand Detail Detail Sequence number
Returns The DemandEntry data set
OpenDemandHead Opens the Demand Header. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Num
iDemandHeadSeq
Int32
The Demand Header Sequence number
Returns The DemandEntry data set
OpenDemandSchedule Opens the Demand Schedule record. Parameters
662
Name
Type
Description
iDemandContractNum
Int32
The Demand Schedule Contract Num
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
iDemandHeadSeq
Int32
The Demand Schedule Header Sequence number
iDemandDtlSeq
Int32
The Demand Schedule Detail Sequence number
iDemandScheduleSeq
Int32
The Demand Schedule Sequence number
Returns The DemandEntry data set
PartValidation Contains all the logic to perform the part validation defined by the user on a hierarchical order when receiving an inbound file. oXRefPartType = {P=Part, C=Customer, U=UPC, M=Manufacturer, 2=UPC-12, 3=EAN-13, 4=EAN-14, 8=EAN-8, G=GTIN-14} Parameters Name
Type
Description
iContractNum
Int32
Demand Contract Number
iHeadSeq
Int32
Demand Head Seq
iDocName
String
Document Name
iPartNum
String@
Part Number entered or returned by this method
iXPartNum
String
X Part Number
oValidPart
Boolean@
Is it a Valid Part?
oPartDesc
String@
Part Description of the founded Part
oUOM
String@
UOM associated to the founded Part, blank if not product code
oXRefPartType
String@
Cross Reference Part Type
ProcessDemand Process the demand. This will accept or reject DemandHead, DemandDetail, and DemandSchedule records and create/update Forecasts or Orders. cReturnMessage contains an informational message that lets the user know the process has completed and if any errors were written to the DemandLog table. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Number
iDemandHeadSeq
Int32
The Demand Header Sequence Number
cReturnMessage
String@
Text to display to the user
cRejectFlag
Boolean@
Flag to disable the ready to process through workflow
Epicor 9.05 | 9.05.605
663
A-E
Business Object Reference Guide
ProcessMatching Updates the Order fields in DemandSchedule with the values from DemandScheduleToMatch. Parameters Name
Type
Description
ds
RejectDemandDetail Rejects the Demand detail and sub-table (DemandSchedule). Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Detail Contract Num
iDemandHeadSeq
Int32
The Demand Detail Header Sequence number
iDemandDtlSeq
Int32
The Demand Detail Detail Sequence number
Returns The DemandEntry data set
RejectDemandHead Rejects the Demand Header and sub-tables (DemandDetail and DemandSchedule). Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Num
iDemandHeadSeq
Int32
The Demand Header Sequence number
Returns The DemandEntry data set
RejectDemandSchedule Rejects the Demand Schedule record. Parameters
664
Name
Type
Description
iDemandContractNum
Int32
The Demand Schedule Contract Num
iDemandHeadSeq
Int32
The Demand Schedule Header Sequence number
iDemandDtlSeq
Int32
The Demand Schedule Detail Sequence number
iDemandScheduleSeq
Int32
The Demand Schedule Sequence number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The DemandEntry data set
SetReadyToProcess Set the Ready to Process flag on the Demand Header. This was created mainly for web services. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Number
iDemandHeadSeq
Int32
The Demand Header Sequence Number
lReady
Boolean
Indicates if the demand is ready to be processed
UnlockDemand Provide a way to unlock a demand entry for cases when ESC fails. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Num
iDemandHeadSeq
Int32
The Demand Header Sequence number
iDemandDtlSeq
Int32
The Demand Detail Detail Sequence number
Name
Type
Description
iDemandContractNum
Int32
The Demand Detail Contract Num
iDemandHeadSeq
Int32
The Demand Detail Header Sequence number
iDemandDtlSeq
Int32
The Demand Detail Detail Sequence number
Returns The DemandEntry data set
UnrejectDemandDetail Unrejects the Demand detail. Parameters
Returns The DemandEntry data set
UnrejectDemandHead UnReject the Demand Header.
Epicor 9.05 | 9.05.605
665
A-E
Business Object Reference Guide
Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Header Contract Num
iDemandHeadSeq
Int32
The Demand Header Sequence number
Returns The DemandEntry data set
UnrejectDemandSchedule Unrejects the Demand Schedule record. Parameters Name
Type
Description
iDemandContractNum
Int32
The Demand Schedule Contract Num
iDemandHeadSeq
Int32
The Demand Schedule Header Sequence number
iDemandDtlSeq
Int32
The Demand Schedule Detail Sequence number
iDemandScheduleSeq
Int32
The Demand Schedule Sequence number
Returns The DemandEntry data set
DemandFromOrders Epicor.Mfg.BO.DemandFromOrders: This business object contains 2 methods.
OnChangeDemandContract Procedure to validate Demand Contract Parameters Name
Type
Description
pOrderNum
Int32
Complete Message
pDcontract
String
Complete Message
UpdateOrders A List of orders to Create Demand. Parameters Name
Type
ds opcCompMsg
666
Description DemandFromOrdersDataSet
String@
Complete Message
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DemandLog Epicor.Mfg.BO.DemandLog: This business object contains 7 methods.
GetNewDemandLog Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
667
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DemandMassReview Epicor.Mfg.BO.DemandMassReview: This business object contains 19 methods.
CloseAll Parameters Name
Type
Description The Demand Mass Review Data Set
CloseAllPart Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
ds
The Demand Mass Review Data Set
CloseDemand Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
ds
The Demand Mass Review Data Set
CloseRejectedDemand Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
ds
668
The Demand Mass Review Data Set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
CloseWorkList Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
ds
The Demand Mass Review Data Set
DeleteDemand Delete the schedules related to the selected Part/Demand. Demand Mass Review summarize demands, on that case will we be deleting all schedules that were included on that selected record. If a schedule is selected for another Group different than the current, we'll check if it is not locked and if not we can delete the schedule. Parameters Name
Type
ds
Description The Demand Mass Review Data Set
ipGroupID
String
Demand Mass Review Current Group.
deleteGroup Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
cOutputMsg
String@
Message text to display to the user. Can be blank.
GetDemandMassReview Call this method when the user selects parts or demands to review. This method populates the Epicor.Mfg.BO.DemandMassReviewDataSet dataset for criteria selected. Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
ds cOutputMsg
Input dataset contains the parts or demands selected by the user. String@
Message text to display to the user. Can be blank.
Returns The Demand Mass Review Data Set
Epicor 9.05 | 9.05.605
669
A-E
Business Object Reference Guide
GetMassReviewDtl Call this method to get the demand details for a part when a different part is selected. Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
cPrimaryField
String
The primary field value of DemandMassReview
lFirm
Boolean
Include Firm Demand Schedules?
lUnfirm
Boolean
Include Unfirm Demand Schedules?
lForecast
Boolean
Include Forecast Demand Schedules?
ds
String@
The Demand Mass Review Data Set
cOutputMsg
Message text to display to the user. Can be blank.
MatchAllForDemand This method will perform the default matching of Demand Schedules to Order Releases for a demand. Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
iDemandContractNum
Int32
The Contract Number to process
iDemandHeadSeq
Int32
The Demand Head identifier to process
cOutputMessage
String@
Return message
MatchAllForPart This method will perform the default matching of Demand Schedules to Order Releases for a part. Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
cPartNum
String
The Part Number to process
cOutputMessage
String@
Return message
OnChangeUOM Updates the On Hand Quantity according to the UOM method populates the Epicor.Mfg.BO.DemandMassReviewDataSet dataset for criteria selected.
670
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
cPrimaryField
String
The primary field value of DemandMassReview
ds
The Demand Mass Review Data Set.
ProcessingSelectAll This method will set all demands that have not been posted to be ready for processing. Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
cSelectType
String
(S)elect or (U)nselect all
cOutputMessage
String@
Return messsage
ProcessingSelectAllForPart This method will mark all demands for a part to be ready for processing. Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
cPartNum
String
The Part Number to process
cSelectType
String
(S)elect or (U)nselect
cOutputMessage
String@
Return message
ProcessingSelectByDemand This method will mark a demand as be ready for processing. Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
iDemandContractNum
Int32
The Contract Number to process
iDemandHeadSeq
Int32
The Demand Head identifier to process
cSelectType
String
(S)elect or (U)nselect
cOutputMessage
String@
Return message
Epicor 9.05 | 9.05.605
671
A-E
Business Object Reference Guide
ProcessingSelectWorkList This method will mark all demands for the work list to be ready for processing. Parameters Name
Type
Description
ds
Input dataset contains the parts or demands selected by the user.
ipGroupID
String
Demand Mass Review Current Group.
cSelectType
String
(S)elect or (U)nselect
cOutputMessage
String@
Return message
RejectAllForDemand This method will mark a demand as rejected. Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
iDemandContractNum
Int32
The Contract Number to process
iDemandHeadSeq
Int32
The Demand Head identifier to process
cRejectType
String
(R)eject or (U)nreject
cOutputMessage
String@
Return message
RejectAllForPart This method will mark all demands for a part as rejected. Parameters Name
Type
Description
ipGroupID
String
Demand Mass Review Current Group.
cPartNum
String
The Part Number to process
cRejectType
String
(R)eject or (U)nreject
cOutputMessage
String@
Return message
UnmatchAll Unmatch all the demand entries previously loaded
672
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds cOutputMessage
Description The Demand Mass Review Data Set
String@
Return message
DemandPartSearch Epicor.Mfg.BO.DemandPartSearch: This business object contains 1 methods.
GetList List of parts that are on non-posted demands. Parameters Name
Type
Description
whereClause
String
Where condition
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The DemandMassPartsListDataSet Set
DemandReconcile Epicor.Mfg.BO.DemandReconcile: This business object contains 19 methods.
GetNewDemandReconcile Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
673
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
RestartCumInfo Restart the cumulative info stored for the company.
CalcTaxes Parameters
674
Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
ChangeDRAdjustmentQty Recalc Variance when the Adjustment Quantity changes. Parameters Name
Type
Description
proposedQty
Decimal
The proposed Adjustment Quantity
ds
The DemandReconcile data set
ChangeDRCustID Used when the CustID field is being changed to a new value. Parameters Name
Type
Description
proposedCustID
String
The proposed Customer ID
ds
The DemandReconcile data set
ChangeDRDemandContract Used when the DemandContract field is being changed to a new value. Parameters Name
Type
Description
proposedDemandContract
String
The proposed Demand Contract
ds
The DemandReconcile data set
ChangeDRPartNum Used when the PartNum field is being changed to a new value.
Epicor 9.05 | 9.05.605
675
A-E
Business Object Reference Guide
Parameters Name
Type
Description
proposedPartNum
String
The proposed Part Number
ds
The DemandReconcile data set
ChangeDRReconcileCUMMQty Recalc Adjust Quantity when the Reconcile Quantity changes. Parameters Name
Type
Description
proposedQty
Decimal
The proposed Reconcile Quantity
ds
The DemandReconcile data set
ChangeDRReconcileStartCumQty Recalc Adjust Quantity and set Company Cumulative Quantity when the Start Cumulative Quantity changes. Parameters Name
Type
Description
proposedQty
Decimal
The proposed Start Cumulative Quantity
ds
The DemandReconcile data set
ChangeDRShippedCUMMQty Changed event of Company Cumulative Quantity field. Parameters Name
Type
Description
proposedQty
Decimal
The proposed Shipped Cumulative Quantity
ds
The DemandReconcile data set
ChangeDRSReconcileQty Updates the Reconcile Qty for the selected PackNum. Parameters Name
Type
Description
proposedQty
Decimal
The proposed Reconcile Quantity
ds
676
The DemandReconcile data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangeDRTPCUMMQty Changed event of Trading Partner Quantity field. Parameters Name
Type
Description
proposedQty
Decimal
The proposed Trading Partner Cumulative Quantity
ds
The DemandReconcile data set
CreateAdjustmentCredit This method will create an AR Invoice from the DemandReconcile adjustment Parameters Name
Type
Description
iReconcileNum
Int32
The Reconcile number
iPackNum
Int32
The target pack number for which the invoice will be created
iTranNum
Int32
The adjustment tran number
iSysDate
Nullable{System.DateTime} The adjustment system date
iSysTime
Int32
The adjustment system time
iInvoiceNum
Int32@
The invoice number
iInvoiceLine
Int32@
The invoice line
opErrMsg
String@
Error message from invoice processing
DemandReconcileSearch Epicor.Mfg.BO.DemandReconcileSearch: This business object contains 1 methods.
GetRows List of Demand Reconciliation records by Demand Contract Name. Parameters Name
Type
Description
whereClauseDemandReconcileSearch
String
Where condition
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Epicor 9.05 | 9.05.605
Are there more pages ? Yes/No
677
A-E
Business Object Reference Guide
Returns The Demand Reconcile Search DataSet
DmdMassGrp Epicor.Mfg.BO.DmdMassGrp: This business object contains 9 methods.
GetNewDmdMassGrp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
678
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DeleteDemand Delete the schedules related to the selected Part/Demand. Demand Mass Review summarize demands, on that case will we be deleting all schedules that were included on that selected record. If a schedule is selected for another Group different than the current, we'll check if it is not locked and if not we can delete the schedule. Parameters Name
Type
ds
Description The Demand Mass Group Data Set
OnChangeLockStatus Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
DMRActnSearch Epicor.Mfg.BO.DMRActnSearch: This business object contains 6 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
679
A-E
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DMRProcessing Epicor.Mfg.BO.DMRProcessing: This business object contains 39 methods.
GetNewDMRHead Inserts a new row in the DataSet with defaults populated.
GetNewDMRHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewDMRActn Inserts a new row in the DataSet with defaults populated.
680
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
681
A-E
Business Object Reference Guide
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeCurrencyCode This method recalculates the exchange rate and base price when the currency code changes. Parameters Name
Type
Description
ds
The DMRProcessing data set
ChangeExchangeRate This method recalculates the base price when the exchange rate changes. Parameters Name
Type
Description
ds
The DMRProcessing data set
ChangeJobAsmSeq This method initializes the job material sequence and accepted quantity when the Job Assembly Sequence changes. Parameters Name
Type
ds iProposedAssemblySeq
Description The DMRProcessing data set
Int32
The proposed AssmeblySeq value
ChangeJobMtlSeq This method initializes the IssuedComplete check box and defaults Warehouse and Bin (if necessary) when the Job Material Sequence changes. Parameters Name ds
682
Type
Description The DMRProcessing data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
iProposedDMRSeqNum
Int32
The proposed material sequence number
ChangeJobNum This method initializes the job assembly/material sequences, accepted quantity and the comment text when the Job Number changes. Parameters Name
Type
ds
Description The DMRProcessing data set
cProposedJobNum
String
The proposed Job Number
ChangePackingSlip This method retrieves information related to the packing slip where this material was originally received. Parameters Name
Type
Description
ds
The DMRProcessing data set
ChangeRefInvoiceNum This method validates Ref Invoice Number. Parameters Name
Type
ds cProposedRefInvoiceNum
Description The DMRProcessing data set
String
The proposed Ref Invoice Number
ChangeStkWhs This method initializes the serial tracking data when the Accept to Stock warehoues changes, because a warehouse change might mean a "to" plant change which can affect serial process under some circumstances. Parameters Name
Type
ds cProposedWarehouseCode
Epicor 9.05 | 9.05.605
Description The DMRProcessing data set
String
The proposed Accept to Stock warehouse
683
A-E
Business Object Reference Guide
ChangeUnitCredit This method recalculates the base price when the doc price changes or recalculates the doc price when the base price changes. The CurrencySwitch flag in DMRActn is used to determine which value to calculate. Parameters Name
Type
Description
ds
The DMRProcessing data set
ChangeWarehouse This method will load the bin number only if one bin exists for the selected warehouse. Parameters Name
Type
Description
ds
The DMRProcessing data set
CheckIssueComplete This method returns text of a message to be asked of the user when changing the issue complete flag for Accepting to Job Materials. The purpose of the question is to verify the user wants to continue with the change. If the user answers yes, the change can occur; otherwise the change shouldn't occur. Parameters Name
Type
Description
iDMRNum
Int32
The DMR Number
cJobNum
String
The Job Number
iAssemblySeq
Int32
The Assembly Sequence Number
iDMRSeqNum
Int32
The DMR Action Sequence Number (Material Sequence)
dQuantity
Decimal
The DMRActn Quantity
cUOM
String
The DMRActn UOM
lProposedIssueComplete
Boolean
The proposed value for the Issue Complete flag
cMessageText
String@
The text of the message to ask the user
CheckJobMtlSeq This method returns a message for the user if the job material selected is already issued complete. The user would then have the option to continue with the selected job material or change the material sequence.
684
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
cJobNum
String
The job number
iAssemblySeq
Int32
The assembly sequence
iDMRSeqNum
Int32
The DMR sequequence number
cMessage
String@
The message text
CheckOperationComplete This method returns text of a message to be asked of the user when changing the operation complete flag for Accepting to Job Operations. The purpose of the question is to verify the user wants to continue with the change. If the user answers yes, the change can occur; otherwise the change shouldn't occur. Parameters Name
Type
Description
cJobNum
String
The Job Number
iAssemblySeq
Int32
The Assembly Sequence Number
iDMRSeqNum
Int32
The DMR Action Sequence Number (Operation Sequence)
lProposedOperationComplete
Boolean
The proposed value for the Operation Complete flag
cMessageText
String@
The text of the message to ask the user
CustomUpdate This is a custom version of the standard Update method. Parameters Name
Type
ds
Description The DMRProcessing data set
opLegalNumberMessage
String@
The legal number message to display
DefaultIssueComplete This method defaults the appropriate value for the Issue Complete check box whenever the quantity to be accepted to Job Material changes. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The DMRProcessing data set
685
A-E
Business Object Reference Guide
GetContactInfo This method updates the default Contact information when the ConNum field changes. Parameters Name
Type
Description
ds
The DMRProcessing data set
GetCurrencyBase This method returns the Base CurrencyCode Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
GetDMRHistory Get DMR history Parameters Name
Type
Description
ipDMRNum
Int32
DMR Number
Returns The DMRHistory data set
GetNewDMRActnAcceptMTL Call this method instead of GetNewDMRActn to assure that appropriate DMR Action (Accepting Material to Job Material) is created. This method requires the DMR Number as input parameter. In addition, this method sets the external fields to indicate whether certain fields are enabled or disabled for input. Parameters Name
Type
ds ipDMRNum
Description The DMRProcessing data set
Int32
The DMR Number being processed.
GetNewDMRActnAcceptOPR Call this method instead of GetNewDMRActn to assure that appropriate DMR Action (Accepting Material to Job Operation) is created. This method requires the DMR Number as input parameter. In addition, this method sets the external fields to indicate whether certain fields are enabled or disabled for input.
686
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds ipDMRNum
Description The DMRProcessing data set
Int32
The DMR Number being processed.
GetNewDMRActnAcceptSTK Call this method instead of GetNewDMRActn to assure that appropriate DMR Action (Accepting Material to Stock) is created. This method requires the DMR Number as the input parameter. In addition, this method sets the external fields to indicate whether certain fields are enabled or disabled for input. Parameters Name
Type
ds ipDMRNum
Description The DMRProcessing data set
Int32
The DMR Number being processed.
GetNewDMRActnDebitMemo Call this method instead of GetNewDMRActn to assure that appropriate DMR Action (Requesting Debit Memo) is created. This method requires the DMR Number as input parameter. In addition, this method sets the external fields to indicate whether certain fields are enabled or disabled for input. Parameters Name
Type
ds ipDMRNum
Description The DMRProcessing data set
Int32
The DMR Number being processed.
GetNewDMRActnReject Call this method instead of GetNewDMRActn to assure that appropriate DMR Action (Rejecting Material) is created. This method requires the DMR Number as input parameter. In addition, this method sets the external fields to indicate whether certain fields are enabled or disabled for input. Parameters Name
Type
ds ipDMRNum
Description The DMRProcessing data set
Int32
The DMR Number being processed.
GetPurPointInfo This method updates Purchase Point default information when the PurPoint field changes.
Epicor 9.05 | 9.05.605
687
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ds
The DMRProcessing data set
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
Description
ipPartNum
String
DMRActn Part Number
ipQuantity
Decimal
Serial Number quantity required
ipDestinationType
String
DMR Action destination
ipActionType
String
DMR Action action type
ipSerialControlPlant
String
Plant that is controlling serial entry rules
ipSerialControlPlantIsFromPlt
Boolean
Indicates if the from plant is the controllin plant for serial entry
ipDMRNum
Int32
DMR Number
ipJobNum
String
DMR Action Job Number
ipPartTrackSerialNum
Boolean
Indicates if Serial Numbers required on this DMR Action
ipActionNum
Int32
DMR Action Number
ipQtyIUM
String
UOM for the DMR quantity
Returns The SelectSerialNumbersParams dataset
GetVendorInfo This method updates the default Vendor information when the VendorNumVendorID field changes. Parameters Name ds
Type
Description The DMRProcessing data set
PreUpdate This method does one thing. 1 . This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information.
688
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
Boolean@
Indicates if the legal number requires user input
ds requiresUserInput
ReasonCodeWhereClause This method returns the reason code where clause for searching for Reason codes for DMR Rejections or Request of Debit Memos. Parameters Name
Type
Description
cAction
String
The reason the where clause is being built. Values are "REJ" for reject or "DM" for debit memo
iDMRNum
Int32
The DMR number. This is needed when cAction is "REJ". For cAction = "DM" the value can be 0 (zero)
cReasonWhereClause
String@
The reason where clause.
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
ds
Description DMR Processing data set
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
DOCAssoc Epicor.Mfg.BO.DOCAssoc: This business object contains 6 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
689
A-E
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DocType Epicor.Mfg.BO.DocType: This business object contains 7 methods.
GetNewDocType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
690
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
691
A-E
Business Object Reference Guide
Drawings Epicor.Mfg.BO.Drawings: This business object contains 12 methods.
GetNewDrawings Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
692
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetDrawingsList Get XFileAttch list Parameters Name
Type
Description
ipRelatedToFile
String
Related To file
ipKey1
String
Key1
ipKey2
String
Key2
ipKey3
String
Key3
ipKey4
String
Key4
ipKey5
String
Key5
Returns XFileAttch dataset
GetJobDocsTableName Get Job Documents Table Name Parameters Name
Type
Description
ipJobNum
String
Job number
ipAssemblySeq
Int32
Assembly sequence
ipOprSeq
Int32
Operation sequence
opTableName
String@
Table name
GetPrimaryIndexFields Get Primary index fields Parameters Name
Type
Description
ipTableName
String
Table name
opFieldList
String@
Field list
Epicor 9.05 | 9.05.605
693
A-E
Business Object Reference Guide
OnChangeOfDocType Call when DocTypeID is changed. Will reset the path portion of the file name with the BaseURL of the DocType. Note: It will not overlay a fully qualified filename. Parameters Name
Type
Description
ipDocTypeID
String
The Document Type ID (tablenameAttch.DocTypeID) that has been entered.
iOFileName
String@
The fully qualified file name that the user is referencing for this attachment.
OnChangeOfFileName Call when FileName is changed. The purpose of this method is to find out if a given FileName is already known in the database. That is, does a XFileRef record exist. Client program should pass the current values from the dataset for the given parameters. The returned parameter values should unconditionally moved to the corresponding fields in the dataset. Parameters Name
Type
Description
ipFileName
String
The fully qualified file name (tablenameAttch.FileName) that the user is referencing for this attachment.
iOXFileRefNum
Int32@
External File Reference Number (tablenameAttch.XFileRefNum).
iOXFileDesc
String@
File Descripttion (tablenameAttch.DrawDesc).
iODocTypeID
String@
Document Type ID (tablenameAttch.DocTypeID).
iOPDMDocID
String@
PDMDocID (tablenameAttch.PDMDocID).
DropShip Epicor.Mfg.BO.DropShip: This business object contains 35 methods.
GetNewDropShipHead Inserts a new row in the DataSet with defaults populated.
GetNewDropShipHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewDropShipDtl Inserts a new row in the DataSet with defaults populated.
694
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
695
A-E
Business Object Reference Guide
BuildCustomersToList If the Order has releases to multiple Customer, this will return the list of available Customers Parameters Name
Type
Description
poNum
Int32
PO Number
customersToList
String@
delimited list of available Customers
BuildShipToCustList Return a list of Ship To Customers. Customers Parameters Name
Type
Description
poNum
Int32
PO Number
shipToCustList
String@
Delimited list of available Ship To Customers
BuildShipToList If the Order has releases to multiple shipto's, this will return the list of available shiptos to select from Parameters Name
Type
Description
poNum
Int32
PO Number
custNum
Int32
Customer Number
shipToList
String@
delimited list of available ShipTo's
ChangeDropShipDtlComplete Updates the Complete of DropShipDtl. Parameters Name
Type
ds
Description The DropShip data set
ipComplete
Boolean
The Complete value
vMessage
String@
Question asking if the user is sure they want to set/clear the flag
ChangeDropShipDtlIUM Updates the IUM of DropShipDtl.
696
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The DropShip data set
ipIUM
String
The IUM value
warnMsg
String@
A warning message for users. Does not stop processing
ChangeDropShipDtlLotNum Updates the LotNum of DropShipDtl. Parameters Name
Type
ds
Description The DropShip data set
ipLotNum
String
The LotNum value
ChangeDropShipDtlOurQty Updates the OurQty of DropShipDtl. Parameters Name
Type
ds
Description The DropShip data set
ipOurQty
Decimal
The OurQty value
warnMsg
String@
A warning message for users. Does not stop processing
ChangeDropShipDtlPOLine Updates the POLine of DropShipDtl. Parameters Name
Type
ds
Description The DropShip data set
ipPOLine
Int32
The POLine value
serialWarning
String@
Warning message if the receipt line contains serial numbers
ChangeDropShipDtlPONum Updates the PONum of DropShipDtl.
Epicor 9.05 | 9.05.605
697
A-E
Business Object Reference Guide
Parameters Name
Type
ds ipPONum
Description The DropShip data set
Int32
The PONum value
ChangeDropShipDtlPORelNum Updates the PORelNum of DropShipDtl. Parameters Name
Type
ds ipPORelNum
Description The DropShip data set
Int32
The PORelNum value
ChangeDropShipDtlVendorQty Updates the VendorQty of DropShipDtl. Parameters Name
Type
Description
ds
The DropShip data set
ipVendorQty
Decimal
The VendorQty value
warnMsg
String@
A warning message for users. Does not stop processing
ChangeDropShipHeadPONum Call this method when the PONum changes on the DropShipHead. Parameters Name
Type
Description
ipPONum
Int32
New PONum
ds
The DropShip data set
ChangeDropShipHeadShipToCustNum Call this method when the ShipToCustNum changes on the DropShipHead. Parameters Name
Type
Description
ipShipToCustNum
Int32
New ShipToCustNum
ds
698
The DropShip data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangeDropShipHeadShipToNum Call this method when the ShipToCustNum changes on the DropShipHead. Parameters Name
Type
Description
ipShipToNum
String
New ShipToNum
ds
The DropShip data set
CreateMassDropShipDtl The Create Mass Drop Ship method. Parameters Name
Type
Description
ipVendorNum
Int32
The VendorNum value
ipPurPoint
String
The PurPoint value
ipPackSlip
String
The PackSlip value
ipPONum
Int32
The PONum value
warnMsg
String@
A warning message
ds
DropShip data set
GetOrderShipments This method creates the data for the tables ShipDtl and DropShipDtl Parameters Name
Type
ds
Description The OrderShipments data set
orderNum
Int32
Order Number
orderLine
Int32
Order Line
GetPendingDtl Updates PendingDropShipDtl. Parameters Name
Type
ds ipPONum
Epicor 9.05 | 9.05.605
Description The DropShip data set
Int32
The PO number
699
A-E
Business Object Reference Guide
GetPOInfo This method returns default information for the PO Number and the new Vendor ID information. Parameters Name
Type
Description
ds
The Receipt data set
poNum
Int32
Proposed Purchase Order Number
vendorNum
Int32@
Numeric Vendor ID assigned to the PO
purPoint
String@
Default Purchase Point assigned to the PO
GetPurPointInfo This method returns default information for the Vendor Purchase Point. Parameters Name
Type
Description
ds purPoint
The DropShip data set String
Proposed Purchase Point value
GetSelectSerialNumbersParams Parameters Name
Type
Description
ipPartNum
String
ipPartNum
ipQuantity
Decimal
ipQuantity
ipUOM
String
ipUOM
ipVendNum
Int32
ipVendNum
ipVendPP
String
ipVendPP
ipPackSlip
String
ipPackSlip
ipPackSlipLine
Int32
ipPackSlipLine
Returns
GetShipToAddressMultiKey This method builds the ShipTo Address
700
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
poNum
Int32
PO Num
custNum
Int32
Cust Num
shipToNum
String
Ship To Num
shipToListMult
String@
Addresses List
GetVendorInfo This method returns default information for the Vendor. Parameters Name
Type
ds
Description The DropShip data set
vendorID
String
Proposed Vendor ID value
vendorNum
Int32@
Numeric Vendor ID
purPoint
String@
default Purchase Point for Vendor
MarkShipmentLines This method sets all the temp-table records to be drop shipped (Ship all button selected) Parameters Name
Type
ds
Description DropShip data set
PreChangeDropShipDtlLotNum This method returns an error or question if the LotNum field does not exist depending upon the security of the user Parameters Name
Type
ds
Description The DropShip data set
ipLotNum
String
The LotNum value
questionMsg
String@
Asks if user want to create new lot
errorMsg
String@
Tells user if they can't create a new lot
PreCreateMassReceipt The Pre Create Mass Drop Ship method.
Epicor 9.05 | 9.05.605
701
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipVendorNum
Int32
The VendorNum value
ipPurPoint
String
The PurPoint value
ipPackSlip
String
The PackSlip value
ipPONum
Int32
The PONum value
warnMsg
String@
A warning message
ds
DropShip data set
PreUpdateDropShipDtl This method is to be called right before the update method is called. Parameters Name
Type
ds
Description The DropShip data set
qMessageStr
String@
Quantity Question to ask user before update. If no, update method is not run
sMessageStr
String@
Serial Number Question to ask users before update. If no, update method is not run
DropShipDtlSearch Epicor.Mfg.BO.DropShipDtlSearch: This business object contains 7 methods.
GetNewDropShipDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
702
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DynamicQuery Epicor.Mfg.BO.DynamicQuery: This business object contains 60 methods.
GetTableExecutionOrder This method returns comma delimited query table list in order of execution. Parameters Name
Type
ds tableList
Epicor 9.05 | 9.05.605
Description Query design dataset
String@
List of tables
703
A-E
Business Object Reference Guide
AddCalculatedField This method adds a calculated field to a query. The data type of a calculated field is always character. Parameters Name
Type
ds
Description Query design dataset
pcQueryID
String
The current Query(Exports) ID
pcName
String
The name of this calculated field
pcDataType
String
The data type of this calculated field
pcFormat
String
The format of this calculated field
pcLabel
String
The label of this calculated field
pcExpression
String
The expression
AddQueryField This method adds (selects) a field the list of a query's selected fields Parameters Name
Type
ds
Description Query design dataset
pcQueryID
String
The current Query(Exports) ID
pcTableID
String
The DataTable ID
pcField
String
The field name
AddQueryFields This method adds a list of QueryFields to a BAQ Parameters Name
Type
ds pcQueryID
Description The dataset representing the current query
String
The current Query(Exports) ID
AddQueryRelation This method adds a relation(a join) to a query If the pcKey is a valid key then a default matching of fields based on the field name is returned in the QueryRelationField table. If a matching field cannot be found in the child table then the ChildFieldName is left blank. If pcKey is blank, then no default matching is returned. The AddQueryRelationField method should be called in this case to compeletely define the relation.
704
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description Query design dataset
pcQueryID
String
The current Query(Exports) ID
pcRelationID
String
The name of the relation
pcParentAlias
String
The alias of parent DataTable ID
pcKey
String
The key(index) of the parent DataTable
pcChildAlias
String
The alias of the child table
pcWhichItem
String
Specify "each", "first" or "last"
isOuterJoin
Boolean
true if is an outer-join
AddQueryRelationField This method adds a relation field mapping (parentField = childField) to a query Parameters Name
Type
ds
Description Returns the updated dataset
pcQueryID
String
The current Query(Exports) ID
pcRelationID
String
The name of the relation
pcParentField
String
The parent field name
pcChildField
String
The child field name
AddQueryTable This method adds a valid table to the list of a query's selected tables Parameters Name
Type
ds
Description Returns the updated dataset
pcQueryID
String
The current Query(Exports) ID
pcTableID
String
The Table ID
pbIsSummary
Boolean
yes = this is a summary table
AddRelatedTable This method adds a related table to a query This method adds a new table to another table that is already in the query(pcMainTable). If a predefined relation can be found between these two tables then a relation and relation fields for that relation will be returned. The new relation ID is the combination of the MainTable and the relatedTable. Otherwise this method is the same as AddQueryTable. NOT IMPLEMENTED YET
Epicor 9.05 | 9.05.605
705
A-E
Business Object Reference Guide
Parameters Name
Type
ds
Description Returns the updated dataset
pcQueryID
String
The current Query(Exports) ID
pcMainTable
String
The name of the table that this new table relates to
pcRelatedTable
String
The related table
pcWhichItem
String
Specify "each", "first" or "last"
isSummary
Boolean
true if should add as a summary table
isOuterJoin
Boolean
true if is an outer-join
AddSortBy This method adds a sortby clause to a query. Parameters Name
Type
ds
Description Returns the updated dataset
pcQueryID
String
The current Query(Exports) ID
pcTable
String
The table of this sort by field
pcField
String
The field name of this sort by
pbAscending
Boolean
true = ascending, false = descending
AddWhereItem This method adds a QueryWhereItem to a query. Parameters Name
Type
ds
706
Description Returns the updated dataset
pcQueryID
String
The current Query(Exports) ID
pcTable
String
The table of this sort by field
pcField
String
The field name of this sort by
pcCondition
String
comparison operator
pbIsConst
Boolean
true = right side of comparison is a constant false = right side of comparison is another field
pcValue
String
The value to compare to
pcToTable
String
The table name of a field to compare to
pcToField
String
The field to compare to
pcLeftParentheses
String
number of left parentheses
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pcRightParentheses
String
number of right parentheses
pcAndOr
String
"and" or "or"
pbNeg
Boolean
apply "Not"
Analyze This method verifies a query and returns true if it is valid. False otherwise. Parameters Name
Type
ds
Description The dataset represents the current query
bSuccess
Boolean@
true = query syntax is correct, false = there is a syntax error
pcMessage
String@
Returns the error message if there is an error
AnalyzeEx This method verifies a query and returns true if it is valid. False otherwise. Parameters Name
Type
ds
Description The dataset represents the current query
cBOSource
String
Specifies whether the bo represents a business entity (BL) or a DB table
cBOName
String
Name of business object which defines the temp-tables used in the query
bSuccess
Boolean@
true if query syntax is correct, false if there is a syntax error
pcMessage
String@
Returns the error message if there is an error
CheckFields This method verifies a query and returns true if it is valid. False otherwise. Parameters Name
Type
ds
Description The dataset represents the current query
errFieldList String@ Returns the list of missed fields if there are any. format is DF:AbcCode:f1,AbcCode.f2;SF:AbcCode:f1,AbcCode.f2;RF:AbcCode:f1,AbcCode.f2;WF:AbcCode:f1,AbcC where DF - display fields, SF - sorting fields, RF - relation fields, WF - where clause fields, FF - fields, where f equal to db table field format).These formats also are fixed during check, so this list is for information pur
Epicor 9.05 | 9.05.605
707
A-E
Business Object Reference Guide
ChangeAuthor This method change the Author of a Dynamic Query to a different one Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
pcNewAuthor
String
The new author
Returns Returns the dataset representing the query
CopyQuery This method makes a copy of an existing query Parameters Name
Type
Description
pcSourceQueryID
String
The source Query(Exports) ID
pcDestQueryID
String
The target Query(Exports) ID
pbSucceed
Boolean@
yes = save secceeded, no = failed
DeleteByID This method deletes an existing query Parameters Name
Type
Description
pcQueryID
String
The current Query(Exports) ID
DeleteUnapprovedByID This method deletes an unapproved query Parameters Name
Type
Description
pcQueryID
String
The current Query(Exports) ID
Execute This method runs a query based on default settings.
708
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The dataset represents a Query
Returns Returns the result dataset
ExecuteByID This method run an existing query and returns an untyped dataset Parameters Name
Type
Description
pcQueryID
String
The current Query(Exports) ID
Returns Returns the result of the query
ExecuteByIDParametrized This method run an existing query and returns an untyped dataset Parameters Name
Type
Description
pcQueryID
String
The current Query(Exports) ID
ds
The Query execution parameters (named parameter values, filtering and etc.)
resultFieldList
String
Comma delimited list of fields in result dataset. List is subset of query's SelectedField table content
topNRecords
Int32
Number of first records in result set to be returned
hasMoreRecords
Boolean@
Flag indicating if there are more records
Returns Returns the result of the query
ExecuteDashBoardQuery This method runs a dash board query. Parameters Name ds
Type
Description The dataset represents a Dash Board Query
Returns Returns the result dataset
Epicor 9.05 | 9.05.605
709
A-E
Business Object Reference Guide
ExecuteDashBoardQueryPaged This method runs a dash board query. Parameters Name
Type
ds
Description The dataset represents a Dash Board Query
piPageSize
Int32
The size of page
pbMorePage
Boolean@
Flag indicating if there are more pages
Returns Returns the result dataset
GetDropDownListValues This method runs a query based on default settings and return lists of distinct values of specified fields. Parameters Name
Type
Description
queryID
String
The Query ID
distinctFields
String
Comma delimited list of query display fields distinct values of should be returned
Returns Returns the result dataset
GetDropDownListValuesParametrized This method runs a query based on default settings and passed execution parameters and return lists of distinct values of specified fields. Parameters Name
Type
Description
queryID
String
The Query ID
ds distinctFields
The Query execution parameters (named parameter values, filtering and etc.) String
Comma delimited list of query display fields distinct values of should be returned
Returns Returns the result dataset
BeginPagingParametrized This method prepare a query for paged access by using additional query's parameters.
710
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
The dataset represents a Query
ds1
The Query parameters dataset
pageSize
String
Size of first page of result set to be returned. Initially is null that means no query results should be returned
resultFieldList
Int32
Comma delimited list of fields in result dataset. List is subset of query's SelectedField table content
pagedQueryToken
String@
Paged query token which is used in subsequent calls. Can be null if pageSize is set to value and result set fits that page
totalRowCount
Int32@
Total count of result rows
Returns Returns the result dataset where Results table is filled with data only if pageSize parameter is not null
BeginPaging This method prepare a query for paged acess. Parameters Name
Type
ds
Description The dataset represents a Query
pageSize
Int32
Size of first page of result set to be returned. Initially is null that means no query results should be returned
pagedQueryToken
String@
Paged query token which is used in subsequent calls. Can be null if pageSize is set to value and result set fits that page
totalRowCount
Int32@
Total count of result rows
Returns Returns the result dataset where Results table is filled with data only if pageSize parameter is not null
BeginPagingForQueryID This method prepare a query for paged acess. Parameters Name
Type
Description
queryID
String
The Query ID
pageSize
Int32
Size of first page of result set to be returned. Initially is null that means no query results should be returned
pagedQueryToken
String@
Paged query token which is used in subsequent calls. Can be null if pageSize is set to value and result set fits that page
totalRowCount
Int32@
Total count of result rows
Epicor 9.05 | 9.05.605
711
A-E
Business Object Reference Guide
Returns Returns the result dataset where Results table is filled with data only if pageSize parameter is not null
BeginPagingForQueryIDParametrized This method prepare a query for paged access by using additional query parameters. Parameters Name
Type
Description
queryID
String
The Query ID
ds
The Query parameters dataset
resultFieldList
String
Comma delimited list of fields in result dataset. List is subset of query's SelectedField table content
pageSize
Int32
Size of first page of result set to be returned. Initially is null that means no query results should be returned
pagedQueryToken
String@
Paged query token
totalRowCount
Int32@
Total count of result rows
Returns Returns the result dataset where Results table is filled with data only if pageSize parameter is not null
GetPage This method returns a requested page of the query. Parameters Name
Type
Description
pagedQueryToken
String
The paged query token.
pageNumber
Int32
Number of the page
pageSize
Int32
Number of records in the page
hasMorePages
Boolean@
Whether is more pages left
Returns Returns the requested page of the query
EndPaging This method ends paged access to the query and discards all related temporary data. Parameters
712
Name
Type
Description
pagedQueryToken
String
The paged query token.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ExecuteParametrized This method runs a query based on selected tables, fields, joins, etc and on passed execution parameters. Parameters Name
Type
Description
ds
The dataset represents a Query
ds1
The dataset contains Query execution parameters
resultFieldList
String
Comma delimited list of fields in result dataset. List is subset of query's SelectedField table content
topNRecords
Int32
Number of first records in result set to be returned
hasMoreRecords
Boolean@
Flag indicating if there are more records
Returns Returns the result dataset
Export This method exports a query's result to a file. Parameters Name
Type
ds
Description The dataset represents a Query
pcFile
String
The file name
pcFileType
String
The type of export
pcTextDelim
String
The delimiter to use for delimited export formats. If blank the format in the query definition will be used. Ignored for XML exports.
pbOutputLabels
Boolean
Output results labels file. Ignored for XML exports.
pbSuccess
Boolean@
indicating if the method finished successfully
ExportByID This method export an existing query to a file Parameters Name
Type
Description
pcQueryID
String
The current Query(Exports) ID
pcExportFormatOverride
String
Type of export to perform. Currently only "XML" is supported and this parameter is ignored.
pcFilenameOverride
String
The filename to use for the export. If blank the filename in the query definition will be used.
Epicor 9.05 | 9.05.605
713
A-E
Business Object Reference Guide
Name
Type
Description
pcTextDelim
String
The delimiter to use for delimited export formats. If blank the format in the query definition will be used. Ignored for XML exports.
pbOutputLabels
Boolean
Output results labels file. Ignored for XML exports.
pcFile
String@
The file created
pbSuccess
Boolean@
indicating if the method finished successfully
pbMessage
String@
indicating if the method finished successfully
GenerateASP Generate an ASP file with the given . The ASP file is used in conjunction with an XML export to display exported information in a web browser. Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
pcFilename
String
File name
ds
ASP Export field dataset
GetASPFields Get the fields that would be used to generate an ASP file. The ASP file is used in conjunction with an XML export to display exported information in a web browser. Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
Returns Epicor.Mfg.BO.ASPExportFieldDataSet
GetAvailableTableList This method returns a list of available tables that can be added to a query Parameters
714
Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns Epicor.Mfg.BO.AvailableTableListDataSet
GetByID This method returns a dataset representing an existing query Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
Returns Returns the dataset representing the query
GetDashBoardQueries This method returns a dataset representing a list of dash board queries Parameters Name
Type
ds
Description The list of queries
Returns Returns the dataset representing the query
GetDashBoardQuery This method returns a dataset representing a list of dash board queries Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID List
Returns Epicor.Mfg.BO.QueryDesignDataSet
GetDBQueryByID This method returns the query procedure file which can be run outside the BAQ engine Parameters Name
Type
Description
pcQueryID
String
The current Query(Exports) ID
pbPrepareOnly
Boolean
When true, portions of the query will contain placeholders and caller must modify results to provide them before use.
pcProcedure
String@
Returns the procedure or SQL batch
Epicor 9.05 | 9.05.605
715
A-E
Business Object Reference Guide
GetFieldList This method returns a list of available tables that can be added to a query Parameters Name
Type
Description
pcTable
String
The TableID
Returns The list of fields that in the table
GetFiscalPeriods This method returns a list of fiscal periods between pdBeginDate and pdEndDate Parameters Name
Type
Description
pdBeginDate
Nullable{System.DateTime}
The begin date
pdEndDate
Nullable{System.DateTime}
The end date
Returns The list of fiscal periods
GetList This method returns a list of existing queries Parameters Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Epicor.Mfg.BO.DynamicQueryListDataSet
GetListFromLike This method returns a list of BAQs that have a specific like field Parameters
716
Name
Type
Description
pcLikeTable
String
The table name of the like field
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pcLikeField
String
The field name of the like field
Returns The list of queries that meet the criteria
GetNewQuery This method createa a new DynamicQuery object with a blank query ID. The query object is not saved until the Update method is called Parameters Name
Type
Description
ds
Returns the newly created query
GetNewQueryRelation This method creates a new query relation row Parameters Name
Type
ds pcQueryID
Description Returns the updated dataset
String
The current Query(Exports) ID
GetNewQueryRelationField This method creates a new query relation field row Parameters Name
Type
ds
Description Returns the updated dataset
pcQueryID
String
The current Query(Exports) ID
pcRelationID
String
The relation ID
GetNewWhereItem This method creates a new QueryWhereItemRow. Parameters Name
Type
ds pcQueryID
Epicor 9.05 | 9.05.605
Description Returns the updated dataset
String
The current Query(Exports) ID
717
A-E
Business Object Reference Guide
Name
Type
Description
pcTable
String
The table of this sort by field
GetProgressDBQueryByID This method run an existing query and returns an untyped dataset Parameters Name
Type
Description
pcQueryID
String
The current Query(Exports) ID
pcProcedure
String@
Returns the procedure or SQL batch
GetQueryByID This method returns a dataset representing an existing query Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
Returns Returns the dataset representing the query
GetQueryExecutionParameters This method returns a dataset representing an query's execution parameters information Parameters Name
Type
Description
ds
The query design dataset
Returns Returns the dataset representing the query execution parameters
GetQueryExecutionParametersByID This method returns a dataset representing an query's execution parameters information Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
Returns Returns the dataset representing the query execution parameters
718
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetRelatedTables This method returns a list of tables that are related to a list of tables Parameters Name
Type
Description
pcTable
String
The name of a table you want to get the related tables for
Returns The list of tables that are related to pcTable
GetRows This method returns a set of queries based on the criteria Parameters Name
Type
Description
whereClauseDynamicQuery
String
Criteria for the Query
whereClauseQueryTable
String
Criteria for the QueryTable
whereClauseQueryField
String
Criteria for the QueryField
whereClauseQueryWhereItem
String
Criteria for the QueryWhereItem
whereClauseQueryCalcFld
String
Criteria for the QueryCalcFld
whereClauseQueryRelation
String
Criteria for the QueryRelation
whereClauseQueryRelationField
String
Criteria for the QueryRelationField
whereClauseQuerySortBy
String
Criteria for the QuerySortBy
pageSize
Int32
size of page
absolutePage
Int32
absolutePage
morePages
Boolean@
true = more pages yet to be retrieved, false = end of result
Returns the returned set of wueries
GetUnapprovedByID This method returns a dataset representing an unapproved query Parameters Name
Type
Description
pcQueryID
String
The Query(Exports) ID
Returns Returns the dataset representing the query
Epicor 9.05 | 9.05.605
719
A-E
Business Object Reference Guide
ImportDynamicQuery This method imports a query from the passed in dataset. Parameters Name
Type
Description
ds bOK
The dataset represents a Query Boolean@
Import result
ParseTables This method parse a query string and return the list of tables in the query string and fields in those tables Parameters Name
Type
Description
pcQueryPhrase
String
The criteria
Returns The list of tables that are in the query string and available fields in those tables
RemoveQueryFields This method removes a list of QueryFields to a BAQ. The caller should also remove any QuerySortBy before this method is called Parameters Name
Type
ds pcQueryID
Description The dataset representing the current query
String
The current Query(Exports) ID
SaveQuery This method save a query to the database Parameters Name
Type
Description
pcQueryID
String
The current Query(Exports) ID
pbSucceed
Boolean@
yes = save secceeded, no = failed
Update This method persists a dataset that representing a query to the database
720
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The dataset representing the current query
DynamicReport Epicor.Mfg.BO.DynamicReport: This business object contains 16 methods.
GetNewBAQReport Inserts a new row in the DataSet with defaults populated.
GetNewBAQRptOptionFld Inserts a new row in the DataSet with defaults populated.
GetNewBAQRptFilter Inserts a new row in the DataSet with defaults populated.
GetNewBAQRptSort Inserts a new row in the DataSet with defaults populated.
GetNewBAQRptSortFld Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
721
A-E
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CopyReport This method makes a copy of an existing DynamicReport Parameters Name
Type
Description
pcSourceRptID
String
The source Report ID
pcDestRptID
String
The target Report ID
pbSucceed
Boolean@
yes = save secceeded, no = failed
GenReportTestData This method returns a BAQ report XML with sample data Parameters
722
Name
Type
Description
pcBAQRptID
String
The BAQ report ID
pcXmlDoc
String@
Returns the XML document string
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetListForBAQ This method returns a list of reports that use a given BAQ Parameters Name
Type
Description
pcBAQID
String
The BAQ ID
Returns The returned list
GetReportResultSchema This method returns a BAQ report XML schema as a string Parameters Name
Type
Description
pcBAQRptID
String
The BAQ report ID
pcXmlSched
String@
Returns the XML schema string
ImportDynamicReport This method imports a DynamicReport from the passed in dataset. Parameters Name
Type
ds bOK
Epicor 9.05 | 9.05.605
Description The dataset represents a DynamicReport
Boolean@
Import result
723
A-E
Business Object Reference Guide
Chapter 5: E EAD Epicor.Mfg.BO.EAD: This business object contains 14 methods.
GetNewEADComp Inserts a new row in the DataSet with defaults populated.
GetNewEADType Inserts a new row in the DataSet with defaults populated. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
724
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeEADCompEarliestApplyDate Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeEADCompFiscalPeriod Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK
Epicor 9.05 | 9.05.605
725
A-E
Business Object Reference Guide
• QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeEADTypeEarliestApplyDate Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeEADTypeFiscalPeriod Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ECORevSearch Epicor.Mfg.BO.ECORevSearch: This business object contains 7 methods.
GetNewECORev Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
726
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ECSalesReport Epicor.Mfg.BO.ECSalesReport: This business object contains 11 methods.
GetNewECSalesReport Inserts a new row in the DataSet with defaults populated.
GetNewECSLXMLHed Inserts a new row in the DataSet with defaults populated.
GetNewECSLXMLDtl Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
727
A-E
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
728
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ExportData Export EU Sales List. Parameters Name
Type
Description
ipECSalesReportID
String
ECSalesReportID
Returns
GenerateXMLData Generate XML DATA on XML Tables. Parameters Name
Type
Description
ipECSalesReportID
String
ECSalesReportID
ipManualXML
Boolean
ipManualXML
Returns
EDIExport Epicor.Mfg.BO.EDIExport: This business object contains 5 methods.
Export This method runs the export based on the document the user has entered. If the user wants to re export items, the ReExport flag should be set to true. Parameters Name
Type
Description
reExport
Boolean
Re-export flag.
ds
EDI Export dataset
This method should be called when the user enters the screen. It defaults the translator type, and from and to date. Returns EDI Export dataset
OnChangeofDocumentType This method should be called when the document type has changed.
Epicor 9.05 | 9.05.605
729
A-E
Business Object Reference Guide
Parameters Name
Type
Description
newDocType
String
New document type.
ds
EDI Export dataset
OnChangeofFromDate This method should be called when the from date has changed. Parameters Name
Type
Description
newFromDate
Nullable{System.DateTime}
From date.
ds
EDI Export dataset
OnChangeofToDate This method should be called when the to date has changed. Parameters Name
Type
Description
newToDate
Nullable{System.DateTime}
From date.
ds
EDI Export dataset
EDITrnsl Epicor.Mfg.BO.EDITrnsl: This business object contains 6 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
730
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
EduLicense Epicor.Mfg.BO.EduLicense: This business object contains 9 methods.
GetNewEduLicense Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
731
A-E
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AcquireLicense Acquire an education course license token Parameters
732
Name
Type
Description
eduLicenseID
Int32
Which license to use
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
sysRowID
String@
The license token identifier
ReleaseLicense Release an education course license token Parameters Name
Type
Description
sysRowID
String
The license token identifier
EKeyLog Epicor.Mfg.BO.EKeyLog: This business object contains 7 methods.
GetNewEKeyLog Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
733
A-E
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ElectronicInterface Epicor.Mfg.BO.ElectronicInterface: This business object contains 13 methods.
GetNewEFTHead Inserts a new row in the DataSet with defaults populated.
GetNewEFTProp Inserts a new row in the DataSet with defaults populated.
GetNewEFTPropVal Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
734
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetByName Returns dataset by the interface name. Parameters Name
Type
Description
name
String
interface name
Returns The full DataSet.
Epicor 9.05 | 9.05.605
735
A-E
Business Object Reference Guide
GetInterfaceTypes Returns list of interfaces types defined in TypeNames array Symbol | will be replaced by ~ on the client side. For using in combos Parameters Name
Type
Description
list
String@
list of interfaces types defined in TypeNames array
GetTypeByName Returns interfaces type by TypeName Parameters Name
Type
Description
typeName
String
TypeName for interfaces type
typeID
Int32@
interfaces type
InterfaceCanBeDeleted Parameters Name
Type
Description
headUID
Int32
electronic interface identifier
canbe
Boolean@
true if the interface can be deleted
ElectronicReport Epicor.Mfg.BO.ElectronicReport: This business object contains 13 methods.
GetNewElectronicReport Inserts a new row in the DataSet with defaults populated.
GetNewElectronicReportProp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
736
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GenerateEUSalesReport GenerateTaxTranReport. Parameters Name
Type
Description
lRound
Boolean
If yes then amounts are rounded
Epicor 9.05 | 9.05.605
737
A-E
Business Object Reference Guide
Name
Type
Description
reportIDList
String
List of the Tax Report IDs
taxCodeList
String
List of the Tax Codes
rangeOption
String
Date Range or VAT Report
startDate
Nullable{System.DateTime}
Start Date
endDate
Nullable{System.DateTime}
End Date
eftHeadUID
Int32
Electronic Interface unique ID
success
Boolean@
If the procedure hase done it's work without any errors then returns yes
GenerateIntrastatReport GenerateIntrastatReport. Parameters Name
Type
Description
filterFlow
String
sortByPeriod
Boolean
Sort By Date / Sort By Date
iYear
Int32
Year
iPeriod
Int32
EPeriod
startDate
Nullable{System.DateTime}
Start Date
endDate
Nullable{System.DateTime}
End Date
eftHeadUID
Int32
Electronic Interface unique ID
success
Boolean@
If the procedure hase done it's work without any errors then returns yes
GenerateTaxBoxReport GenerateTaxBoxReport. Parameters Name
Type
Description
eftHeadUID
Int32
Electronic Interface unique ID
success
Boolean@
If the procedure hase done it's work without any errors then returns yes
GenerateTaxTranReport GenerateTaxTranReport.
738
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
reportID
String
Tax Report ID
eftHeadUID
Int32
Electronic Interface unique ID
success
Boolean@
If the procedure hase done it's work without any errors then returns yes
OnChangeEFTHeadUID Call this method when the user changes the Electronic Interface. Parameters Name
Type
Description
pcEFTHeadUID
Int32
The proposed value of EFTHeadUID.
ds
Returns Epicor.Mfg.BO.APChkGrpDataSet
EmpBasic Epicor.Mfg.BO.EmpBasic: This business object contains 38 methods.
GetNewEmpBasic Inserts a new row in the DataSet with defaults populated.
GetNewEmpBasicAttch Inserts a new row in the DataSet with defaults populated.
GetNewEmpCal Inserts a new row in the DataSet with defaults populated.
GetNewResourceCal Inserts a new row in the DataSet with defaults populated.
GetNewEmpRole Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewEmpRoleRt Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
739
A-E
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
740
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CheckShift Check shift Parameters Name
Type
Description
ipEmpID
String
Employee ID
ipLaborShift
Int32
Labor Shift
opMessage
String@
Output Message
ClockIn Clock In Parameters Name
Type
Description
employeeID
String
Employee ID
shift
Int32
Labor Shift
ClockOut Clock Out Parameters Name
Type
Description
employeeID
String@
Employee ID
CustomizeResourceCal This method will get a current ResourceCal record or create a temporary ResourceCal record to be modified for a Employee. The ProdHours will be defaulted from the weekday of the selected date. If any changes are made
Epicor 9.05 | 9.05.605
741
A-E
Business Object Reference Guide
to the ttResourceCal record, the UpdateResourceCal method will have to be called to write the temporary ResourceCal record to the database. Parameters Name
Type
Description
ipEmpID
String
The current Employee ID
ipDate
Nullable{System.DateTime}
The selected date to be customized
ds
The Employee data set
GetByIDForTE Returns a DataSet given the primary key. Contains special processing for Time and Expense Entry. Returns The DataSet.
GetDefaultEmpID Get Defaults Emp ID Parameters Name
Type
Description
defaultEmpID
String@
default EmpID
GetListExpEmployees Called to retrieve employees that can have expenses entered for them Parameters Name
Type
Description
whereClause
String
Whereclause for EmpBasic table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.EmpBasicListDataSet
GetListForTE Called to retrieve employees for Time and Expense Entry
742
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
Whereclause for EmpBasic table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.EmpBasicListDataSet
GetPerConData Used to validate the PerCon. Parameters Name
Type
Description
perConID
Int32
Proposed PerConID.
ds
EmpBasic data set.
GetRowsFromList Get rows from list dataset Parameters Name
Type
Description
ds
Whereclause for EmpBasicAttch table.
Returns Epicor.Mfg.BO.EmpBasicDataSet
GetRowsWhoIsNotHere Calls the normal GetRows method and then screens out only those employees who should be here but are not. Parameters Name
Type
Description
whereClauseEmpBasic
String
Whereclause for EmpBasic table.
whereClauseEmpBasicAttch
String
Whereclause for EmpBasicAttch table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Epicor 9.05 | 9.05.605
743
A-E
Business Object Reference Guide
Returns Epicor.Mfg.BO.EmpBasicDataSet
OnChangeCalendarID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
onChangeCurrencyCode Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeExpenseAllowed Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeExpenseAutoApprove Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
onChangeExpenseVendor Remarks • QTableName - MANDATORY - Name of table to find
744
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
• QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
onChangeRateEffectiveDate Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
onChangeRateEndDate Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
onChangeResource Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
onChangeResourceGrp Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
745
A-E
Business Object Reference Guide
onChangeRoleCd Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeTimeAutoApprove Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
onChangeTimeTypeCode Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
UpdateResourceCal This method will check to see if the current ttResourceCal record was modified. If it is a special working day or non-working day then it save the ttResourceCal record to the database. Parameters Name ds
Type
Description The Employee data set
EmpCourse Epicor.Mfg.BO.EmpCourse: This business object contains 10 methods.
GetNewEmpCourse Inserts a new row in the DataSet with defaults populated.
746
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
747
A-E
Business Object Reference Guide
CreateMultiRequest Creates an Employee Course Request for multiple employees. Parameters Name
Type
Description
courseID
String
The course for which the employees are requesting.
revisionCode
String
The course's revision.
empIDs
String
A list of EmpIDs that represent the employees requesting the course.
OnCourseStatusChanging Call this method when the user changes the Course Status. Parameters Name
Type
Description
pcCompany
String
EmpCourse Company
pcEmpCourseID
Int32
EmpCourse ID
pcCourseStatus
String
New EmpCourse Status
pcDeleteCourseSchAttdResponse String
Response to the question pcDeleteCourseSchAttdResponse. ? means question has not been asked. Yes/No is considered a response.
pcQuestion
Question to be answered by the user in pcDeleteCourseSchAttdResponse.
String@
GetExpiresOn Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
EmpExpense Epicor.Mfg.BO.EmpExpense: This business object contains 33 methods.
GetNewEmpExpense Inserts a new row in the DataSet with defaults populated.
748
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
GetNewEmpExpenseComment Inserts a new row in the DataSet with defaults populated.
GetNewEmpExpenseTax Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
749
A-E
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
ApproveReject The procedure is called when the user selects EmpExpense records for reject or approve Parameters Name
Type
Description
ipSalesRepCode
String
The sales Rep Code of the approver.
ipAction
String
Action to take A = approver, R = reject.
ipComment
String
Comment text if comments are to be created.
ds outMessage
EmpExpense Entry Data set String@
Informational message returned to display to the user after the process has run
ChangeEmpExpenseClaimCurrencyCode Method to call when changing the Claim Currency Code. Exchange rate is reevaluted
750
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
proposedClaimCurrencyCode
String
The proposed claim currency code
ds
The EmpExpense data set
ChangeEmpExpenseClaimExchangeRate Method to call when changing the claim exchange rate. Parameters Name
Type
Description
proposedClaimExchangeRate
Decimal
The proposed claim exchange rate
ds
The EmpExpense data set
ChangeEmpExpenseClaimRateGrpCode Method to call when changing the Claim Rate Group Code. Exchange rate is reevaluted Parameters Name
Type
Description
proposedClaimRateGrpCode
String
The proposed expense currency code
ds
The EmpExpense data set
ChangeEmpExpenseDispClaimAmt Method to call when changing the Claim Amount. The field DispClaimAmt is the field that should trigger the call to this procedure. Parameters Name
Type
Description
proposedDispClaimAmt
Decimal
The proposed claim amount
ds
The EmpExpense data set
ChangeEmpExpenseDocExpenseAmt Method to call when changing the Doc Expense Amount. Parameters Name
Type
Description
proposedDocExpenseAmt
Decimal
The proposed doc expense amount
ds
Epicor 9.05 | 9.05.605
The EmpExpense data set
751
A-E
Business Object Reference Guide
ChangeEmpExpenseExpCurrencyCode Method to call when changing the Expense Currency Code. Exchange rate is reevaluted Parameters Name
Type
Description
proposedExpCurrencyCode
String
The proposed expense currency code
ds
The EmpExpense data set
ChangeEmpExpenseExpenseDate Method to call when changing the Expense Date. This can affect the exchange rate. Parameters Name
Type
Description
proposedExpenseDate
Nullable{System.DateTime}
The proposed expense date
ds
The EmpExpense data set
ChangeEmpExpenseIndirect Method to call when changing Indirect. Parameters Name
Type
Description
proposedIndirect
Boolean
The proposed indirect value
ds
The EmpExpense data set
ChangeEmpExpenseMiscCode Method to call when changing the Miscellaneous Code. Parameters Name
Type
Description
proposedMiscCode
String
The proposed miscellaneous code
ds
The EmpExpense data set
ChangeEmpExpensePayMethod Method to call when changing the Payment Method.
752
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
proposedPMUID
Int32
The proposed pay method id
ds
The EmpExpense data set
ChangeEmpExpensePhaseID Method to call when changing the WBS Phase ID. Parameters Name
Type
Description
proposedPhaseID
String
The proposed phase
ds
The EmpExpense data set
ChangeEmpExpenseProjectID Method to call when changing the Project ID. Parameters Name
Type
Description
proposedProjectID
String
The proposed project
ds
The EmpExpense data set
ChangeEmpExpenseQuickEntryCode Method to call when changing the quick entry code. Quick entry values are used for default values on the expense. Parameters Name
Type
Description
proposedQuickEntryCode
String
The proposed quick entry code
ds
The EmpExpense data set
ChangeEmpExpenseUnitRate Method to call when changing the Unit Rate. Parameters Name
Type
Description
proposedUnitRate
Decimal
The proposed unit rate
ds
Epicor 9.05 | 9.05.605
The EmpExpense data set
753
A-E
Business Object Reference Guide
ChangeEmpExpenseUnits Method to call when changing the Units. Parameters Name
Type
Description
proposedUnits
Decimal
The proposed units
ds
The EmpExpense data set
CheckRecallFromApproval The procedure is called prior to performing a recall. It will check if subsequent approvals have occurred. If they have the user will have the opportunity to cancel the recall. Parameters Name
Type
Description
ipSalesRepCode
String
The sales Rep Code of the approver.
ds
The EmpExpense data set
outRecallMsg
String@
Recall message
CopyEmpExpense Method to copy the vales from one EmpExpense record to a new EmpExpense record. Parameters Name
Type
Description
ds cMessageText
The EmpExpense data set String@
Message text to present to the user after the process is finished
GetListExpenses This method returns a list of Expenses to be viewed in the Time and Expense Entry screen based on Claim Reference, Invoice Num, Invoice Status and Expense Status. This method builds the where clause instead of having the UI build the where clause on their end. Parameters
754
Name
Type
Description
ipEmpID
String
Employee id
ipClaimRef
String
Claim Reference
ipExpenseStatus
String
Expense Status
ipInvoiceNum
String
Invoice Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipInvoiceStatus
String
Invoice Status
pageSize
Int32
The page size
absolutePage
Int32
the absolute page
morePages
Boolean@
The more pages
GetRowsTran Called from Aprrovals screen to get related task expense transactions Parameters Name
Type
Description
ds
TaskListDataSet
RecallEmpExpense Method to call when recalling submitted expense records Parameters Name
Type
Description
ds
The EmpExpense data set
RecallFromApproval Method to call when recalling from approval entry Parameters Name
Type
Description
ipSalesRepCode
String
The sales Rep Code of the approver.
ds outMessage
The EmpExpense data set String@
Informational message returned to display to the user after the process has run
SubmitSelected Method to call to submit selected expenses Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The EmpExpense data set
755
A-E
Business Object Reference Guide
Name
Type
Description
outMessage
String@
Informational message returned to display to the user after the process has run
EmpExpenseGroup Epicor.Mfg.BO.EmpExpenseGroup: This business object contains 8 methods.
GetNewEmpExpenseGroupAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
756
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
EmployeeExists A public method to test if a given Employee ID already exists in the EmpBasic table. Return True if it exists else returns False. Parameters Name
Type
empID
String
Description
Returns
EmpRoleSearch Epicor.Mfg.BO.EmpRoleSearch: This business object contains 7 methods.
GetNewEmpRole Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
757
A-E
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
EmpYTDLoad Epicor.Mfg.BO.EmpYTDLoad: This business object contains 4 methods.
DeleteEmpYTDLoad Deletes the PRCheck record. The delete trigger for PRCheck deletes the PRChkDtl, PRChkTax and PRChkDed records. Parameters Name
Type
Description
employeeID
String
Employee number
GetEmpYTDLoad Gets the data for the Deductions, Earnings and Tax temp tables based on the employee ID's from the Employee ID temp table.
758
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description List of employee ID's.
Returns EmpYTDLoad DataSet This method is only to be used in the BL Tester to get a EmployeeList record for employee 100. Returns List of employee ID's.
SetEmpYTDLoad Updates the appropriate tables with the data for the Deductions, Earnings and Tax temp tables. Parameters Name ds
Type
Description EmpYTDLoad DataSet
EngWorkBench Epicor.Mfg.BO.EngWorkBench: This business object contains 116 methods.
GetNewECOGroup Inserts a new row in the DataSet with defaults populated.
GetNewECOGroupAttch Inserts a new row in the DataSet with defaults populated.
GetNewECORev Inserts a new row in the DataSet with defaults populated.
GetNewECORevAttch Inserts a new row in the DataSet with defaults populated.
GetNewECOMtl Inserts a new row in the DataSet with defaults populated.
GetNewECOMtlInsp Inserts a new row in the DataSet with defaults populated.
GetNewECOMtlRefDes Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
759
A-E
Business Object Reference Guide
GetNewECOMtlRestriction Inserts a new row in the DataSet with defaults populated.
GetNewECOMtlRestrictSubst Inserts a new row in the DataSet with defaults populated.
GetNewECOOpr Inserts a new row in the DataSet with defaults populated.
GetNewECOOprInsp Inserts a new row in the DataSet with defaults populated.
GetNewECOOpDtl Inserts a new row in the DataSet with defaults populated.
GetNewECOOprRestriction Inserts a new row in the DataSet with defaults populated.
GetNewECOOprRestrictSubst Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
760
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
AddRefDesRange Creates new ECOMtlRefDes records based on the ECOMtl dataset fields. Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision
ipPartNum
String
The Part Number of ECO revision
ipRevisionNum
String
The ECO Revision Number
ipAltMethod
String
The ECO Alternate Method
ipMtlSeq
Int32
The ECO Material Seq
Epicor 9.05 | 9.05.605
761
A-E
Business Object Reference Guide
Name
Type
Description
ipPrefix
String
The Prefix to be used to create Reference Designators
ipStartNum
Int32
The Starting Number to create Reference Designators
ipEndNum
Int32
The Ending Number to create Reference Designators
ipSuffix
String
The Suffix to be used to create Reference Designators
ds
The Engineering Workbench data set
This method exists soley for the purpose of allowing security for approving a method to be defined This method exists soley for the purpose of allowing security for unapproving a method to be defined
ApproveAll This methods approves all revisions within an ECOGroup and returns a results string and returns an updated dataset if the user chooses to. This method runs the logic behind the Vantage 6.1 Group>Approve All menu option. Parameters
762
Name
Type
Description
ipGroupID
String
The ECOGroup.GroupID to approve all for
ipPartNum
String
Used for GetDatasetForTree, The Part Number to return data for.
ipRevisionNum
String
Used for GetDatasetForTree, The Revision Number to return data for.
ipAltMethod
String
Used for GetDatasetForTree, The Alternate Method to return data for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
ipValidPassword
Boolean
Did the user supply a valid password to run this functionality? The value for this parameter should come from running the ValidatePassword method in the UserFile BO.
opResultString
String@
A return list of statements from the Approve All process
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns EngWorkBench dataset
ChangeECOGroupGroupClosed This methods assigns fields associated with ECOGroup.GroupClosed changing. If ECOGroup.GroupClosed changes to true, ClosedBy, ClosedDate, and ClosedTime gets populated. This method should run before/at the time ECOGroup.GroupClosed field changes. Parameters Name
Type
Description
ipProposedGroupClosed
Boolean
The new proposed ECOGroup.GroupClosed value
ds
EngWorkBench dataset
ChangeECOGroupWorkflowGroup This methods assigns fields associated with ECOGroup.WFGroupID changing. If ECOGroup.WFGroupID changes, verify and check if there is a default TaskSetID associated with the WFGroupID and if so, populate ECOGroup.TaskSetID. This method should run before/at the time ECOGroup.WFGroupID field changes. Parameters Name
Type
Description
ipProposedWFGroupID
String
The new proposed ECOGroup.WFGroupID value
ds
EngWorkBench dataset
ChangeECOMtlFixedQty This methods assigns ECOMtl.EstScrap field when ECOMtl.FixedQty changes. This method should run when the ECOMtl.FixedQty changes. Parameters Name
Type
Description
ipProposedFixedQty
Boolean
The new proposed ECOMtl.FixedQty value
ds
EngWorkBench dataset
ChangeEcoMtlInspPlan Parameters Name
Type
Description
ipProposedInspPlan
String
The new proposed ECOMtl.InspPlanPartNum value
ipProposedSpecId
String
The new proposed ECOMtl.SpecID value
Epicor 9.05 | 9.05.605
763
A-E
Business Object Reference Guide
ChangeECOMtlMtlPartNum This method assigns the associated fields when the ECOMtl.MtlPartNum field changes. This method should run when changing the ECOMtl.MtlPartNum. Parameters Name
Type
ds
Description EngWorkBench dataset
ChangeECOMtlMtlSeq This method create a new ttECOMtl record and delete the existing one when changing this component of the primary unique index and update the ecomtl.mtlseq. This method should run before changing the ECOMtl.MtlSeq. Parameters Name
Type
Description
ipProposedMtlSeq
Int32
The new proposed ECOMtl.MtlSeq value
ds
EngWorkBench dataset
ChangeECOMtlPlanAsAsm This method assigns the associated fields when the ECOMtl.MtlPartNum field changes. This method should run when changing the ECOMtl.MtlPartNum. Parameters Name
Type
ds
Description EngWorkBench dataset
ChangeECOMtlPullAsAsm This method assigns the associated fields when the ECOMtl.MtlPartNum field changes. This method should run when changing the ECOMtl.MtlPartNum. Parameters Name ds
Type
Description EngWorkBench dataset
ChangeECOMtlQtyPer This methods assigns ECOMtl.ReqRefDes and ECOMtl.RDEndNum fields when ECOMtl.QtyPer changes. This method should run when the ECOMtl.QtyPer changes.
764
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
EngWorkBench dataset
ChangeECOMtlRelatedOperation This methods assigns associated fields when ECOMtl.RelatedOperation changes. This method should run when the ECOMtl.RelatedOperation changes. Parameters Name
Type
Description
ipProposedRelatedOperation
Int32
The new proposed ECOMtl.RFQNeeded value
ds
EngWorkBench dataset
ChangeECOMtlRelatedStage This methods assigns associated fields when ECOMtl.RelatedStage changes. This method should run when the ECOMtl.RelatedStage changes. Parameters Name
Type
Description
ipProposedRelatedStage
String
The new proposed ECOMtl.RFQNeeded value
ds
EngWorkBench dataset
ChangeECOMtlReqRefDes This methods assigns ECOMtl.RDEndNum field when ECOMtl.ReqRefDes changes. This method should run when the ECOMtl.ReqRefDes changes. Parameters Name
Type
ds
Description EngWorkBench dataset
ChangeECOMtlRestriction This methods assigns associated fields when ECOMtlRestriction.RestrictionTypeID changes. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description EngWorkBench dataset
765
A-E
Business Object Reference Guide
ChangeECOMtlRFQNeeded This methods assigns ECOMtl.RFQVendQuotes field when ECOMtl.RFQNeeded changes. This method should run when the ECOMtl.RFQNeeded changes. Parameters Name
Type
Description
ipProposedRFQNeeded
Boolean
The new proposed ECOMtl.RFQNeeded value
ds
EngWorkBench dataset
ChangeECOMtlSalvageMtlBurRate This methods assigns ECOMtl.SalvageEstMtlBurUnitCredit field when ECOMtl.SalvageMtlBurRate changes. This method should run when the ECOMtl.SalvageMtlBurRate changes. Parameters Name
Type
Description
ipProposedSalvageMtlBurRate
Decimal
The new proposed ECOMtl.SalvageMtlBurRate value
ds
EngWorkBench dataset
ChangeECOMtlSalvagePartNum This methods assigns associated fields when ECOMtl.SalvagePartNum changes. This method should run when the ECOMtl.SalvagePartNum changes. Parameters Name
Type
Description
ipProposedSalvagePartNum
String
The new proposed ECOMtl.SalvagePartNum value
ds
EngWorkBench dataset
ChangeECOMtlSalvageUnitCredit This methods assigns ECOMtl.SalvageEstMtlBurUnitCredit field when ECOMtl.SalvageUnitCredit changes. This method should run when the ECOMtl.SalvageMtlBurRate changes. Parameters Name
Type
Description
ipProposedSalvageUnitCredit
Decimal
The new proposed ECOMtl.SalvageUnitCredit value
ds
EngWorkBench dataset
ChangeECOMtlSubstance This methods assigns associated fields when ECOMtlRestrictSubst.SubstanceID changes.
766
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description EngWorkBench dataset
ChangeECOOpDtlCapability Method to call when changing the Capability ID. This method will update ECOOpDtl to see if the labor and burden rates need to be reset. Blank is a valid entry for Capability ID. Parameters Name
Type
Description
proposedCapID
String
The proposed Capability ID
ds
The Engineering Workbench data set
ChangeECOOpDtlResourceGrpID Method to call when changing the Resource Group ID. Blank is a valid entry for Resource Group ID. Parameters Name
Type
Description
proposedResGrpID
String
The proposed Resource Group ID
ds
The Engineering Workbench data set
ChangeECOOpDtlResourceID Method to call when changing the Resource ID. Blank is a valid entry for Resource ID. Parameters Name
Type
Description
proposedResourceID
String
The proposed Resource ID
ds
The Engineering Workbench data set
ChangeECOOprAutoReceive This method also returns a list of values/descriptions for the LaborEntryMethod dropdown based on the value of the ECOOpr.AutoReceive field. This does not change the actual value of the ECOOpr.LaborEntryMethod field, just returns values for its dropdown list. This method should run before/at the time ECOGroup.GroupClosed field changes. Parameters Name
Type
Description
opLaborEntryMethodList
String@
The returning value for the LaborEntryMethod
Epicor 9.05 | 9.05.605
767
A-E
Business Object Reference Guide
Name
Type
ds
Description The Engineering Workbench data set
ChangeECOOprLaborEntryMethod Verification when changing the LaborEntryMethod field Parameters Name
Type
Description
iLaborEntryMethod
String
Proposed value for LaborEntryMethod field
ds
The Engineering Workbench data set
ChangeECOOprOpCode This method defaults/resets specific fields related to the new operation code. This method should run when the ECOOpr.OpCode field changes. Parameters Name
Type
Description
proposedOpCode
String
The proposed Operation Code
refreshMessage
String@
The refresh message text
ds
The Engineering Workbench data set
ChangeECOOprOprSeq This method will update all of the associated records to the ECOOpr if the OprSeq field is changing. This method should run before changing the ECOOpr.OprSeq. Parameters Name
Type
Description
ipProposedOprSeq
Int32
The new proposed ECOOpr.OprSeq value
ds
The Engineering Workbench data set
ChangeECOOprOpStdID This method defaults/resets the production standards when selecting an Operation Standard This method should run when the ECOOpr.OpStdID field changes. Parameters Name ds
768
Type
Description The Engineering Workbench data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangeECOOprPrimaryProdOpDtl This method defaults/resets the production standards when selecting Primary Production Operation Detail. This method should run when the ECOOpr.PrimaryProdOpDtl field changes. Parameters Name
Type
Description
ds
The Engineering Workbench data set
ChangeECOOprPrimarySetupOpDtl This method defaults/resets the setup values when selecting Primary Setup Operation Detail. This method should run when the ECOOpr.PrimarySetupOpDtl field changes. Parameters Name
Type
Description
ds
The Engineering Workbench data set
ChangeECOOprRestriction This methods assigns associated fields when ECOOprRestriction.RestrictionTypeID changes. Parameters Name
Type
ds
Description EngWorkBench dataset
ChangeECOOprRFQNeeded This methods assigns ECOOpr.RFQVendQuotes field when ECOOpr.RFQNeeded changes. This method should run when the ECOOpr.RFQNeeded changes. Parameters Name
Type
Description
ipProposedRFQNeeded
Boolean
The new proposed ECOGroup.RFQNeeded value
ds
The Engineering Workbench data set
ChangeECOOprSNRequiredOpr Validates SNRequiredOpr flag to avoid to set it false if the prior operation has the flag set to true The flag cannot be set to true if the part is not serial tracked also.
Epicor 9.05 | 9.05.605
769
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipProposedSNRequired
Boolean
The new proposed ECOGroup.SNRequiredOpr value
ds
The Engineering Workbench data set
ChangeECOOprStdFormat This methods assigns ECOOpr.OpsPerPart a default value based on the StdFormat value. Parameters Name
Type
Description
ipProposedStdFormat
String
The new proposed ECOOpr.StdFormat value
ds
The Engineering Workbench data set
ChangeECOOprSubPartNum This methods assigns associated fields when ECOOpr.SubPartNum changes. This method should run when the ECOOpr.SubPartNum changes. Parameters Name
Type
Description
ipProposedSubPartNum
String
The new proposed ECOGroup.SubPartNum value
ds
The Engineering Workbench data set
ChangeECOOprSubstance This methods assigns associated fields when ECOOprRestrictSubst.SubstanceID changes. Parameters Name
Type
ds
Description EngWorkBench dataset
ChangeECOOprVendorNumVendorID This methods assigns associated fields when ECOOpr.VendorNumVendorID changes. This method should run when the ECOOpr.VendorNumVendorID changes. Parameters Name ds
770
Type
Description The Engineering Workbench data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ChangeECORevApproved This methods assigns fields associated with ECORev.Approved changing. This method should run before ECOGroup.Approved field changes. Parameters Name
Type
Description
ipProposedApproved
Boolean
The new proposed ipProposedApproved value
ds
The Engineering Workbench data set
ChangingECOOprAutoReceive Verification when changing the AutoReceive field Parameters Name
Type
Description
iAutoReceive
Boolean
Proposed value for AutoReceive field
ds
The Engineering Workbench data set
CheckECOMtlMtlPartNum This methods checks the ECOMtl.MtlPartNum when it changes to see if any messages when validating it arise. Messages could be from the analysis code or if the user is trying to use the parent part as a component of itself. This method should run before changing the ECOMtl.MtlPartNum. Parameters Name
Type
Description
ipProposedMtlPartNum
String
The new proposed ttECOMtl.PartNum value
opMessage
String@
The returning message.
opMsgType
String@
Type of message returned. Value is Question, with Yes/No as options
ds
The Engineering Workbench data set
CheckECOMtlMtlSeqRelatedOperation This methods checks to see if the ECOMtl.MtlSeq has changed from the original ECOMtl.MtlSeq or if the ECOMtl.RelatedOperation has changed from the original ECOMtl.RelatedOperation or the ECOMtl.RelatedStage has changed from the original ECOMMtl.RelatedStage and provides a message asking the user if they would like to set the current configuration to unapproved if the MtlSeq, RelatedOperation or RelatedStage did change. This method does not actually validate the ECOMtl.MtlSeq, ECOMtl.RelatedOperation or ECOMtl.RelatedStage. For RelatedOperation and RelatedStage, it is one or the other, i.e. both a RelatedOperation and a RelatedStage should not be passed in. The value to pass in is based on ECORev.UseStaging. If this value is true, RelatedStage is used, otherwise RelatedOperation is used. Actual validation is handle in the beforeupdate logic in a private method. This method should run before changing the ECOMtl.MtlSeq or ECOMtl.RelatedOperation
Epicor 9.05 | 9.05.605
771
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipProposedMtlSeq
Int32
The new proposed ECOMtl.MtlSeq value
ipProposedRelatedOperation
Int32
The new proposed ECOMtl.RelatedOperation value
ipProposedRelatedStage
String
The new proposed ECOMtl.RelatedStage value
opMessage
String@
The returning message value
opMsgType
String@
Type of message returned. Value is Warning, with OK as options
ds
The Engineering Workbench data set
CheckECOMtlPlanAsAsm This methods checks the ECOMtl.PlanAsAsm when it changes to see if any messages when validating it arise. Messages could be from the analysis code This method should run before changing the ECOMtl.PlanAsAsm. Parameters Name
Type
Description
ipProposedPlanAsAsm
Boolean
The new proposed ECOMtl.PlanAsAsm value
opMessage
String@
The returning message.
opMsgType
String@
Type of message returned. Value is Question, with Yes/No as options
ds
The Engineering Workbench data set
CheckECOMtlPullAsAsm This methods checks the ECOMtl.PullAsAsm when it changes to see if any messages when validating it arise. Messages could be from the analysis code This method should run before changing the ECOMtl.PullAsAsm. Parameters Name
Type
Description
ipProposedPullAsAsm
Boolean
The new proposed ECOMtl.PullAsAsm value
opMessage
String@
The returning message.
opMsgType
String@
Type of message returned. Value is Question, with Yes/No as options
ds
The Engineering Workbench data set
CheckECOMtlViewAsAsm This methods checks the ECOMtl.ViewAsAsm when it changes to see if any messages when validating it arise. This method should run before changing the ECOMtl.ViewAsAsm.
772
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipProposedViewAsAsm
Boolean
The new proposed ECOMtl.ViewAsAsm value
ds
The Engineering Workbench data set
CheckECOOprOprSeq This methods checks to see if the ECOOpr.OprSeq has changed from the original ECOOpr.OprSeq and provides a message asking the user if they would like to set the current configuration to unapproved if the OprSeq did change. This method does not actually validate the ECOOpr.OprSeq. Actual validation is handle in the beforeupdate logic in a private method. This method should run before changing the ECOOpr.OprSeq. Parameters Name
Type
Description
ipProposedOprSeq
Int32
The new proposed ECOOpr.OprSeq value
opMessage
String@
The returning message.
opMsgType
String@
Type of message returned. Value is Warning, with OK as options
ds
The Engineering Workbench data set
CheckECOOprPrimaryProdOpDtl This method validated the value of Primary Production Operation Detail. This method should run when the ECOOpr.PrimaryProdOpDtl field changes. Parameters Name
Type
ds ipPrimaryProdOpDtl
Description The Engineering Workbench data set
Int32
The new PrimaryProdOpDtl value to change to
CheckECOOprPrimarySetupOpDtl This method validated the value of Primary Setup Operation Detail. This method should run when the ECOOpr.PrimarySetupOpDtl field changes. Parameters Name
Type
ds ipPrimarySetupOpDtl
Epicor 9.05 | 9.05.605
Description The Engineering Workbench data set
Int32
The new PrimarySetupOpDtl value to change to
773
A-E
Business Object Reference Guide
CheckECOOprPurPoint This methods checks to see if the new ECOOpr.PurPoint has changed from the original ECOOpr.PurPoint and validates the value. This method should run before changing the ECOOpr.PurPoint. Parameters Name
Type
Description
ipProposedPurPoint
String
The new proposed ECOOpr.PurPoint value
ds
The Engineering Workbench data set
CheckECOOprVendorNumVendorID This methods checks to see if the new ECOOpr.VendorNumVendorID has changed from the original ECOOpr.VendorNumVendorID and validates the value. This method should run before changing the ECOOpr.VendorNumVendorID. Parameters Name
Type
Description
ipProposedVendorNumVendorID
String
The new proposed ECOOpr.VendorNumVendorID value
ds
The Engineering Workbench data set
CheckECORevApproved This methods checks if the BMSyst.VerifyPassword flag is set, and verifies a password before the user is able to approve this revision. This method should run before the ECORev.Approved field changes (ChangeECORevApproved). Parameters Name
Type
Description
ipProposedApproved
Boolean
The new proposed ECOGroup.Approved value
ipValidPassword
Boolean
Did the user supply a valid password to run this functionality? The value for this parameter should come from running the ValidatePassword method in the UserFile BO.
ds
The Engineering Workbench data set
CheckECORevValRefDes Verify that there are no other ECOMtlRefDes records in the revision having the same RefDes value if the ECORev.ValRefDes = true. This method should run before changing the ECORev.ValRefDes. Parameters
774
Name
Type
Description
ipProposedValResDes
Boolean
The new proposed ECORev.ValRefDes value
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
ds
Description The Engineering Workbench data set
CheckIn This method checks in a single revision. This method runs the logic behind the old Vantage 6.1 Revision>Check In menu option. Parameters Name
Type
Description
ipGroupID
String
The Group ID to return costs for.
ipPartNum
String
The Part Number to return costs for.
ipRevisionNum
String
The Revision Number to return costs for.
ipAltMethod
String
The Alternate Method to return costs for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipValidPassword
Boolean
Did the user supply a valid password to run this functionality? The value for this parameter should come from running the ValidatePassword method in the UserFile BO.
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
ipAuditText
String
The text to write to the audit record.
opMessage
String@
Outputted message if an 'Unapproved Configuration Exists'
Returns The Engineering Workbench data set
CheckInAll This methods checks in all revisions within an ECOGroup and returns a results string and returns an updated dataset if the user chooses to. This method runs the logic behind the Vantage 6.1 Group>Check In All menu option. Parameters Name
Type
Description
ipGroupID
String
The ECOGroup.GroupID to check in all for
Epicor 9.05 | 9.05.605
775
A-E
Business Object Reference Guide
Name
Type
Description
ipPartNum
String
Used for GetDatasetForTree, The Part Number to return data for.
ipRevisionNum
String
Used for GetDatasetForTree, The Revision Number to return data for.
ipAltMethod
String
Used for GetDatasetForTree, The Alternate Method to return data for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
ipValidPassword
Boolean
Did the user supply a valid password to run this functionality? The value for this parameter should come from running the ValidatePassword method in the UserFile BO.
ipAuditText
String
The text to write to the audit record(s).
opResultString
String@
A return list of statements from the Check In All process
Returns The Engineering Workbench data set
CheckOut This method checks out a single revision This method runs the logic behind the old Vantage 6.1 Revision>Check Out menu option. Parameters
776
Name
Type
Description
ipGroupID
String
The Group ID to check out for.
ipPartNum
String
The Part Number to check out for.
ipRevisionNum
String
The Revision Number to check out for.
ipAltMethod
String
The Alternate Method to check out for.
ipAsOfDate
Nullable{System.DateTime} The As Of Date to check out for.
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipValidPassword
Boolean
Did the user supply a valid password to run this functionality? The value for this parameter should come
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
A-E
Type
Description from running the ValidatePassword method in the UserFile BO.
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
opCheckedOutRevisionNum String@
The Revision Number that will be checked out.
altMethodMsg
String@
Message indicating that more than one alt method will be checked out.
altMethodFlg
Boolean@
A logical flag indicating the message should be displayed.
Returns The Engineering Workbench data set
ClearAll This method will delete all ECOMtl, ECOOpr and ECOOpDtl associated with the ECORev to clear all for. When the method is finished running, it will run a GetById based on the inputted Group ID. This will cause a refreshing of the dataset to reflect all of the changes. Parameters Name
Type
Description
ipGroupID
String
The Group ID to clear all for
ipPartNum
String
The Part Number to clear all for.
ipRevisionNum
String
The Revision Number to clear all for.
ipAltMethod
String
The Alternate Method to clear all for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
Epicor 9.05 | 9.05.605
777
A-E
Business Object Reference Guide
DeleteRefDesRange Deletes ECOMtlRefDes records based on the ECOMtl dataset fields. Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision
ipPartNum
String
The Part Number of ECO revision
ipRevisionNum
String
The ECO Revision Number
ipAltMethod
String
The ECO Alternate Method
ipMtlSeq
Int32
The ECO Material Seq
ipPrefix
String
The Prefix to be used to delete Reference Designators
ipStartNum
Int32
The Starting Number to delete Reference Designators
ipEndNum
Int32
The Ending Number to delete Reference Designators
ipSuffix
String
The Suffix to be used to delete Reference Designators
ds
The Engineering Workbench data set
ECOGroupExists This method accepts a ECOGroup.ECOGroupID and determines if the ECOGroupID exists as a valid record in the database. Parameters Name
Type
Description
ipGroupID
String
The Group ID to check if it exists in the database.
opECOGroupExists
Boolean@
Does the ECOGroup exist?
EcoOprInitSNReqSubConShip Method required to set the initial value of ECOOpr.SNRequiredSubConShip Parameters Name ds
Type
Description The Engineering Workbench data set
ExportToPLM This method accepts a ECOGroup.ECOGroupID and sends a xml message describing the ECO to PLM
778
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipGroupID
String
The GroupID of the ECOGroup to export.
ExpressPartCheckOut This method will generate an ECOGroup for the user to check out the part to if an ECOGroup doesn't already exist for the user. Once the ECOGroup is properly created, the inputted part information will be checked out to the ECOGroup that was created or to the one that already exists for the user. Parameters Name
Type
Description
ipPartNum
String
The Part Number to check out for.
ipRevisionNum
String
The Revision Number to check out for.
ipAltMethod
String
The Alternate Method to check out for.
ipAsOfDate
Nullable{System.DateTime} The As Of Date to check out for.
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipValidPassword
Boolean
Did the user supply a valid password to run this functionality? The value for this parameter should come from running the ValidatePassword method in the UserFile BO.
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
opCheckedOutRevisionNum String@
The Revision Number that will be checked out.
opGroupID
String@
The ECOGroup.GroupID the part was checked out to.
altMethodMsg
String@
Message indicating that more than one alt method will be checked out.
altMethodFlg
Boolean@
A logical flag indicating the message should be displayed.
Returns The Engineering Workbench data set
GetAvailTaskSets This method gets the available TaskSets for the TaskSet combo in the EngineeringWorkbenchEntry.
Epicor 9.05 | 9.05.605
779
A-E
Business Object Reference Guide
Parameters Name
Type
Description
newList
String@
(output) A delimited list of TaskSet IDs and descriptions
GetDatasetForTree This methods will return a dataset that will include PartRev, PartOpr, PartMtl and PartOpDtl if those records exist for a ECOMtl and there is no ECORev, ECOOpr, ECOMtl and ECOOpDtl associated with it. These added "Part" records will be able to be determined by the associated tables "IsPartRev", "IsPartOpr", "IsPartMtl" or "IsPartOpDtl" field. If this field is checked then the record in the dataset was copied from the associated "part" table. These "part" records will not be maintable as they will not be "real" database records, just a picture of the "part" record for display purposes. This method will also allow you to return the whole dataset or allow the user to specify how far down the tree they would like to return possible "part" records for. This method is different from the "GetRows" or "GetById" methods. Those methods only return maintainable "ECO" records. Parameters Name
Type
Description
ipGroupID
String
The Group Id to return data for.
ipPartNum
String
The Part Number to return data for.
ipRevisionNum
String
The Revision Number to return data for.
ipAltMethod
String
The Alternate Method to return data for.
ipAsOfDate
Nullable{System.DateTime} The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this group?
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
GetDetailsFromImport This method gets the details from an import file This method runs the logic behind the old Vantage 6.1 Revision>Get Details>Import menu option Parameters
780
Name
Type
Description
ipGroupID
String
The Group ID of revision to get details for
ipPartNum
String
The Part Number of revision to get details for
ipRevisionNum
String
The Revision Number to get details for
ipAltMethod
String
The Alternate Method to get details for
ipFileName
String
The filename to import from. This file should reside on the client side. Used for messages.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
ds
Description The Engineering Workbench data set
altMethodMsg
String@
Alternate Method Message.
altMethodFlg
Boolean@
Alternate Method Flag.
GetDetailsFromJob This method gets the details from a job assembly. This method runs the logic behind the old Vantage 6.1 Revision>Get Details> Get From Job menu option. Parameters Name
Type
Description
ipGroupID
String
The Group ID of revision to get details for
ipPartNum
String
The Part Number of revision to get details for
ipRevisionNum
String
The Revision Number to get details for
ipAltMethod
String
The Alternate Method to get details for
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipJobNum
String
The job number to get details from
ipAssemblySeq
Int32
The assembly sequence to get details from
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
GetDetailsFromMethods This method gets the details from a method. This method runs the logic behind the old Vantage 6.1 Revision>Get Details> Get From Methods menu option. Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to get details for
ipPartNum
String
The Part Number of ECO revision to get details for
ipRevisionNum
String
The ECO Revision Number to get details for
Epicor 9.05 | 9.05.605
781
A-E
Business Object Reference Guide
Name
Type
Description
ipAltMethod
String
The ECO Alternate Method to get details for
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipPartRevPartNum
String
The Part Number of part revision to get details from
ipPartRevRevisionNum
String
The Part Revision Number to get details from
ipPartRevAltMethod
String
The Part Alternate method to get details from
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
ipCopyConfiguration
Boolean
Logical to specify to copy the configuration
Returns The Engineering Workbench data set
GetDetailsFromQuotes This method gets the details from a quote assembly. This method runs the logic behind the old Vantage 6.1 Revision>Get Details> Get From Quote menu option. Parameters
782
Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to get details for
ipPartNum
String
The Part Number of ECO revision to get details for
ipRevisionNum
String
The ECO Revision Number to get details for
ipAltMethod
String
The ECO Alternate Method to get details for
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipQuoteNum
Int32
The quote number of the QuoteAsm to get details from
ipQuoteLine
Int32
The quote line of the QuoteAsm to get details from
ipAssemblySeq
Int32
The assemblyseq of the QuoteAsm to get details from
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
GetDetailsOperations This method gets the details from operations for a revision. This method runs the logic behind the old Vantage 6.1 Revision>Get Details> Get Operations Details menu option. Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to get details for
ipPartNum
String
The Part Number of ECO revision to get details for
ipRevisionNum
String
The ECO Revision Number to get details for
ipAltMethod
String
The ECO Alternate Method to get details for
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipPartRevPartNum
String
The Part Number of part revision to get details from
ipPartRevRevisionNum
String
The Part Revision Number to get details from
ipPartRevAltMethod
String
The Part Alternate method to get details from
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
GetECORevData This method returns the ECOGroup record and all associated ECORev records based on the inputted GroupID and ipCheckOutStatus (yes = checked out, no = not checked out). In some UI cases, this method will be used to replace the base GetByID. This method should improve the performance because it will not be bringing back a complete dataset.
Epicor 9.05 | 9.05.605
783
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipGroupID
String
The Group ID to return data for.
ipCheckOutStatus
Boolean
Return Checked Out ECORev?
Returns The Engineering Workbench data set
GroupLock This method checks if a group doesn't have a lock and locks a group Parameters Name
Type
Description
ipGroupID
String
The Group ID of ecogroup to lock
GroupUnLock This method deletes a lock on the group and revisions within a group. Parameters Name
Type
Description
ipGroupID
String
The Group ID of ecogroup to lock
ipPartNum
String
Used for GetDatasetForTree, The Part Number to return data for.
ipRevisionNum
String
Used for GetDatasetForTree, The Revision Number to return data for.
ipAltMethod
String
Used for GetDatasetForTree, The Alternate Method to return data for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
ds
784
The Engineering Workbench data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
InsertBOMMtl This methods allows for the insertion of an engineering material for drag/drop functionality, Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to drop materials to
ipPartNum
String
The Part Number of ECO revision to drop materials to
ipRevisionNum
String
The ECO Revision Number to drop materials to
ipAltMethod
String
The ECO Alternate Method to drop materials to
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipSourceRowid
String
The rowid of source record could be jobasmbl, jobmtl, or quotemtl, partmtl to be added to the parent ECORev
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipMtlSeq
Int32
The material seq to use
ipBeforeMtlRowid
String
The material rowid to insert material before
ipDroppedAs
String
The character value to determine where to drop and to drop as what. valid values: PartMtl, JobMtl, JobAsmbl, QuoteMtl, QuoteAsm
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
InsertBOMOpr This methods allows for the insertion of an engineering operation for drag/drop functionality, Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to drop operations to
ipPartNum
String
The Part Number of ECO revision to drop operations to
ipRevisionNum
String
The ECO Revision Number to drop operations to
ipAltMethod
String
The ECO Alternate Method to drop operations to
Epicor 9.05 | 9.05.605
785
A-E
Business Object Reference Guide
Name
Type
Description
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipSourceRowid
String
The rowid of source record could be partopr, joboper, or quoteopr to be added to the parent ECORev
ipNewOperSeq
Int32
The new operation sequence
ipBeforeOperRowid
String
The material rowid to insert material before
ipDroppedAs
String
The character value to determine where to drop and to drop as what. valid values: PartOpr, JobOper, QuoteOpr
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
InsertMaterial This methods allows for the insertion on a part for drag/drop functionality, validates a ECORev record exists and the part is valid. Parameters
786
Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to drop part to
ipPartNum
String
The Part Number of ECO revision to drop part to
ipRevisionNum
String
The ECO Revision Number to drop part to
ipAltMethod
String
The ECO Alternate Method to drop part to
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipPartPartNum
String
The part number being added from the part table
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipMtlSeq
Int32
The material seq to use
ipBeforeMtlRowid
String
The material rowid to insert part before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
InsertOpDtlCapability This method allows for the insertion of Capability on an operation to create ECOOpDtl for drag/drop functionality. Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to drop operation detail to
ipPartNum
String
The Part Number of ECO revision to drop operation detail to
ipRevisionNum
String
The ECO Revision Number to drop operation detail to
ipAltMethod
String
The ECO Alternate Method to drop operation detail to
ipOprSeq
Int32
The ECO Operation Sequence to drop operation detail to
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipCapabilityID
String
The Capability ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
InsertOpDtlResGroup This method allows for the insertion of Resource Group on an operation to create ECOOpDtl for drag/drop functionality.
Epicor 9.05 | 9.05.605
787
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to drop operation detail to
ipPartNum
String
The Part Number of ECO revision to drop operation detail to
ipRevisionNum
String
The ECO Revision Number to drop operation detail to
ipAltMethod
String
The ECO Alternate Method to drop operation detail to
ipOprSeq
Int32
The ECO Operation Sequence to drop operation detail to
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipResourceGrpID
String
The Resource Group ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
InsertOpDtlResource This method allows for the insertion of Resource on an operation to create ECOOpDtl for drag/drop functionality. Parameters
788
Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to drop operation detail to
ipPartNum
String
The Part Number of ECO revision to drop operation detail to
ipRevisionNum
String
The ECO Revision Number to drop operation detail to
ipAltMethod
String
The ECO Alternate Method to drop operation detail to
ipOprSeq
Int32
The ECO Operation Sequence to drop operation detail to
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipResourceID
String
The Resource ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
InsertOperationOP This methods allows for the insertion on an operation for drag/drop functionality Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to drop operations to
ipPartNum
String
The Part Number of ECO revision to drop operations to
ipRevisionNum
String
The ECO Revision Number to drop operations to
ipAltMethod
String
The ECO Alternate Method to drop operations to
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
ipOpCode
String
ipNewOperSeq
Int32
The new operation seq
ipBeforeOperRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Epicor 9.05 | 9.05.605
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
789
A-E
Business Object Reference Guide
Returns The Engineering Workbench data set
InsertOprCapability This method allows for the insertion of Capability on a revision to create ECOOpr/ECOOpDtl for drag/drop functionality. Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to drop operations to
ipPartNum
String
The Part Number of ECO revision to drop operations to
ipRevisionNum
String
The ECO Revision Number to drop operations to
ipAltMethod
String
The ECO Alternate Method to drop operations to
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipCapabilityID
String
The Capability ID being added
ipNewOperSeq
Int32
The new operation seq
ipBeforeOperRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Returns The Engineering Workbench data set
InsertOprResGroup This method allows for the insertion of ResourceGroup on a revision to create ECOOpr/ECOOpDtl for drag/drop functionality. Parameters
790
Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to drop operations to
ipPartNum
String
The Part Number of ECO revision to drop operations to
ipRevisionNum
String
The ECO Revision Number to drop operations to
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipAltMethod
String
The ECO Alternate Method to drop operations to
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipResourceGrpID
String
The Resource Group ID being added
ipNewOperSeq
Int32
The new operation seq
ipBeforeOperRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Returns The Engineering Workbench data set
InsertOprResource This method allows for the insertion of Resource on a revision to create ECOOpr/ECOOpDtl for drag/drop functionality. Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision to drop operations to
ipPartNum
String
The Part Number of ECO revision to drop operations to
ipRevisionNum
String
The ECO Revision Number to drop operations to
ipAltMethod
String
The ECO Alternate Method to drop operations to
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipResourceID
String
The Resource ID being added
ipNewOperSeq
Int32
The new operation seq
ipBeforeOperRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
Epicor 9.05 | 9.05.605
791
A-E
Business Object Reference Guide
Name
Type
Description
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Returns The Engineering Workbench data set
LockAll This method locks all the revisions in a group. This method runs the logic behind the old Vantage 6.1 Group>Lock All menu option. Parameters Name
Type
Description
ipGroupID
String
The Group ID to lock for.
ipPartNum
String
Used for GetDatasetForTree, The Part Number to return data for.
ipRevisionNum
String
Used for GetDatasetForTree, The Revision Number to return data for.
ipAltMethod
String
Used for GetDatasetForTree, The Alternate Method to return data for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
opResultString
String@
A return list of statements from the Check In All process
ds
The Engineering Workbench data set
MassAssign This method will mass assign ECOGroup.Description, ECOGroup.ECO, and ECOGRoup.EffectiveDate to associated ECORev records and their ECORev.RevShortDesc, ECORev.ECO, and ECORev.EffectiveDate fields respectively. This method will assign values based on external fields in the ECOGroup dataset. This method should run from the menu/task "Group>Mass Assign as it was in the old Vantage 6.1. When the method is finished running, it
792
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
will run a GetById based on the inputted Group ID. This will cause a refreshing of the dataset to reflect all of the changes. Parameters Name
Type
Description
ipGroupID
String
The Group ID to mass assign for.
ipPartNum
String
Used for GetDatasetForTree, The Part Number to return data for.
ipRevisionNum
String
Used for GetDatasetForTree, The Revision Number to return data for.
ipAltMethod
String
Used for GetDatasetForTree, The Alternate Method to return data for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipMassAssignDesc
Boolean
Do you want to mass assign Description? Value comes from external ECOGroup.MassAssignDesc
ipMassAssignECO
Boolean
Do you want to mass assign ECO? Value comes from external ECOGroup.MassAssignECO.
ipMassAssignEffectiveDate Boolean
Do you want to mass assign Effective Date? Value comes from external ECOGroup.MassAssignEffectiveDate.
ipMADescription
String
The value of the new description to be mass assigned.
ipMAECO
String
The value of the new ECO to be mass assigned.
ipMAEffectiveDate
Nullable{System.DateTime} The value fo the new Effective Date to be mass assigned.
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
ds
The Engineering Workbench data set
PromptForPassword This method checks the BMSyst record to see if a password should prompted for and then validated by the ValidatePassword method in UserFile BO. Run this before ApproveAll, CheckECORevApproved, CheckIn, CheckInAll, and CheckOut.
Epicor 9.05 | 9.05.605
793
A-E
Business Object Reference Guide
Parameters Name
Type
Description
opPromptForPassword
Boolean@
Logical value stating whether the UI should prompt to validate for a password.
ResequenceMaterials This method will resequence the operations, update theECOMtl records. This method should run from the menu/task "Material>Resequence" as it was in the old Vantage 6.1. When the method is finished running, it will run a GetById based on the inputted Group ID. This will cause a refreshing of the dataset to reflect all of the changes. Parameters Name
Type
Description
ipGroupID
String
The Group ID to resequence for.
ipPartNum
String
The Part Number to resequence for.
ipRevisionNum
String
The Revision Number to resequence for.
ipAltMethod
String
The Alternate Method to resequence for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipResequenceBy
String
The way the user wants the material resequenced by. Valid Values: Material, Part, Item
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
ResequenceOperations This method will resequence the operations, update the ECORev and ECOMtl records. This method should run from the menu/task "Operation>Resequence" as it was in the old Vantage 6.1. When the method is finished running, it will run a GetById based on the inputted Group ID. This will cause a refreshing of the dataset to reflect all of the changes. Parameters
794
Name
Type
Description
ipGroupID
String
The Group ID to resequence for.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipPartNum
String
The Part Number to resequence for.
ipRevisionNum
String
The Revision Number to resequence for.
ipAltMethod
String
The Alternate Method to resequence for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
Returns The Engineering Workbench data set
RevisionLock This method locks a single revision This method runs the logic behind the old Vantage 6.1 Revision>Lock Revision menu option. Parameters Name
Type
Description
ipGroupID
String
The Group ID of revision to lock
ipPartNum
String
The Part Number of revision to lock
ipRevisionNum
String
The Revision Number to lock
ipAltMethod
String
The Alternate Method to lock
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
ds
Epicor 9.05 | 9.05.605
The Engineering Workbench data set
795
A-E
Business Object Reference Guide
RevisionUnLock This method unlocks a single revision This method runs the logic behind the old Vantage 6.1 Revision>Unlock Revision menu option. Parameters Name
Type
Description
ipGroupID
String
The Group ID of revision to unlock
ipPartNum
String
The Part Number of revision to unlock
ipRevisionNum
String
The Revision Number to unlock
ipAltMethod
String
The Alternate Method to unlock
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
ds
The Engineering Workbench data set
UndoCheckOut This method undoes the check out of a revision This method runs the logic behind the old Vantage 6.1 Revision>Undo Check Out menu option. Parameters
796
Name
Type
Description
ipGroupID
String
The Group ID to check out for.
ipPartNum
String
The Part Number to check out for.
ipRevisionNum
String
The Revision Number to check out for.
ipAltMethod
String
The Alternate Method to check out for.
ipAsOfDate
Nullable{System.DateTime} The As Of Date to check out for.
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
ds
The Engineering Workbench data set
UnLockAll This method unlocks all the revisions in a group. This method runs the logic behind the old Vantage 6.1 Group>Lock All menu option. Parameters Name
Type
Description
ipGroupID
String
The Group ID to unlock for.
ipPartNum
String
Used for GetDatasetForTree, The Part Number to return data for.
ipRevisionNum
String
Used for GetDatasetForTree, The Revision Number to return data for.
ipAltMethod
String
Used for GetDatasetForTree, The Alternate Method to return data for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
opResultString
String@
A return list of statements from the UnLock All process
ds
The Engineering Workbench data set
ValidateBill This method validate the bill for the revision. This method runs the logic behind the old Vantage 6.1 Revision>Validate Bill menu option.
Epicor 9.05 | 9.05.605
797
A-E
Business Object Reference Guide
Parameters Name
Type
Description
ipGroupID
String
The Group ID to return costs for.
ipPartNum
String
The Part Number to return costs for.
ipRevisionNum
String
The Revision Number to return costs for.
ipAltMethod
String
The Alternate Method to return costs for.
ipAsOfDate
Nullable{System.DateTime} Used for GetDatasetForTree, The as of date for the revisions, what would this look as of this date
ipCompleteTree
Boolean
Used for GetDatasetForTree, Would you like to retun a complete dataset for this group?
ipReturn
Boolean
Logical to determine if you would like the dataset refreshed and brought back
ipGetDatasetForTree
Boolean
If ipReturn=True then Logical to determine if you would like the dataset refreshed by GetDatasetForTree? True = call GetDatasetFor, False = call GetByID
ipUseMethodForParts
Boolean
If true use the method passed in for all parts in the tree, if false use the part's default method.
opMessage
String@
If bill is valid, this will state that, otherwise if invalid, exceptions will be thrown. This is here so the UI can tell something happended.
Returns The Engineering Workbench data set
ValidateInspection Method to validate the Inspection control fields. (EQM) Parameters Name
Type
Description
ipProposedInspPlan
String
The new proposed InspPlanPartNum value
ipProposedSpecId
String
The new proposed SpecID value
iptable
String
table name
ds
The EWB Dataset.
ValidateRefDes Verify that there are no other ECOMtlRefDes records in the revision having the same RefDes value if the ECORev.ValRefDes = true. Check the number of reference designators are equal to the Required Ref Designators defined on ECOMtl.
798
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipGroupID
String
The Group ID of ECO revision
ipPartNum
String
The Part Number of ECO revision
ipRevisionNum
String
The ECO Revision Number
ipAltMethod
String
The ECO Alternate Method
ViewCosts This method will return the data need to display Part Rev costs. Parameters Name
Type
Description
ipGroupID
String
The Group ID to return costs for.
ipPartNum
String
The Part Number to return costs for.
ipRevisionNum
String
The Revision Number to return costs for.
ipAltMethod
String
The Alternate method to return costs for.
ipAsOfDate
Nullable{System.DateTime} The As of Date to return costs for.
ipQuantity
Decimal
The Quantity to return costs for.
ipMaxLevel
Int32
The Max Level to return costs for.
ipAssembliesOnly
Boolean
Assemblies only?
Returns The Engineering Workbench Costs data set
EpiSearch Epicor.Mfg.BO.EpiSearch: This business object contains 4 methods.
DoBAQSearch This method does a BAQ search Parameters Name
Type
Description
nswNamedSearch
String
Where clause for NamedSearch table
nswControlSetting
String
Where clause for ControlSetting table
nswWhereClause
String
Where clause for WhereClause table
ds
Returns the dashboards with the specified like field
pcProdID
String
Product ID
pcLike
String
Like field in format of (table).(field)
Epicor 9.05 | 9.05.605
799
A-E
Business Object Reference Guide
Name
Type
ds1
Description Returns the BAQs with the specified like field
piPage
Int32
Page number
piAbsolutePage
Int32
Absolute page number
pbMore
Boolean@
Flag indicating if there are more pages
Returns Returns the NamedSearch dataset
DoDashboardSearch This method does a dashboard search Parameters Name
Type
Description
nswNamedSearch
String
Where clause for NamedSearch table
nswControlSetting
String
Where clause for ControlSetting table
nswWhereClause
String
Where clause for WhereClause table
ds
Returns the dashboards with the specified like field
pcProdID
String
Product ID
pcLike
String
Like field in format of (table).(field)
ds1
Returns the BAQs with the specified like field
piPage
Int32
Page number
piAbsolutePage
Int32
Absolute page number
pbMore
Boolean@
Flag indicating if there are more pages
Returns Returns the NamedSearch dataset
DoNamedSearch This method does a named search Parameters Name
Type
Description
nswNamedSearch
String
Where clause for NamedSearch table
nswControlSetting
String
Where clause for ControlSetting table
nswWhereClause
String
Where clause for WhereClause table
ds
800
Returns the dashboards with the specified like field
pcProdID
String
Product ID
pcLike
String
Like field in format of (table).(field)
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
A-E
Type
ds1
Description Returns the BAQs with the specified like field
piPage
Int32
Page number
piAbsolutePage
Int32
Absolute page number
pbMore
Boolean@
Flag indicating if there are more pages
Returns Returns the NamedSearch dataset
DoSearch This method does a combined search Parameters Name
Type
Description
nswNamedSearch
String
Where clause for NamedSearch table
nswControlSetting
String
Where clause for ControlSetting table
nswWhereClause
String
Where clause for WhereClause table
ds
Returns the dashboards with the specified like field
pcProdID
String
Product ID
pcLike
String
Like field in format of (table).(field)
ds1
Returns the BAQs with the specified like field
piPage
Int32
Page number
piAbsolutePage
Int32
Absolute page number
pbMore
Boolean@
Flag indicating if there are more pages
Returns Returns the NamedSearch dataset
Equip Epicor.Mfg.BO.Equip: This business object contains 28 methods.
GetNewEquip Inserts a new row in the DataSet with defaults populated.
GetNewEquipAttch Inserts a new row in the DataSet with defaults populated.
GetNewEquipPlan Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
801
A-E
Business Object Reference Guide
GetNewEquipPlanAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
802
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The dataset with list of errors occured during update process.
CalcAvgUsage This method returns the Average Daily Usage Parameters Name
Type
Description
equipID
String
equipID
avgUsage
Int32@
avgUsage
ImportAssets This method should be called when Import Assets records. Parameters Name
Type
Description
ipAssetNum
String
Asset Num
vMsg
String@
Message AssetNums already created
ds
Equip data set
ImportResources This method should be called when Import Resources records. Parameters Name
Type
Description
ipResourceID
String
ResourceID
vMsg
String@
Message ResourceIDs already created
ds
Equip data set
IsMaintPlant Returns true if Current Plant is a Maintenance plant. Created to be called from EquipEntry. If not a Maintenance plan the form will be in "Read Only" mode Parameters Name
Type
Description
isMaintPlant
Boolean@
variable which is true if the current plant is a maintenance plant
Epicor 9.05 | 9.05.605
803
A-E
Business Object Reference Guide
OnChangeAssetNum This method should be called when AssetNum change. Parameters Name
Type
Description
assetNum
String
assetNum
ds
Equip data set
OnChangeEquipTemplateJobNum This method should be called when Equip.TemplateJobNum changes. Parameters Name
Type
Description
ipJobNum
String
Job Num
ds
Equip data set
OnChangeIssueTopics This method should be invoked when the IssueTopics changes. Validates and sets the individual IssueTopic fields. Parameters Name
Type
Description
topics
String
Proposed topics string id
ds
Equip data set
OnChangeMeterFreq This method should be called when MeterFreq change. Parameters Name
Type
Description
ipMeterFreq
Int32
Meter Freq
ds
Equip data set
OnChangeParentEquipID This method should be called when ParentEquipID change.
804
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
parentID
String
parentID
ds
Equip data set
OnChangeProjectID This method should be called when ProjectID change. Parameters Name
Type
Description
projectID
String
projectID
ds
Equip data set
OnChangeResourceID This method should be called when ResourceID change. Parameters Name
Type
Description
resourceID
String
resourceID
ds
Equip data set
OnChangeSellingPurPoint This method should be called when SellingPurPoint change. Parameters Name
Type
Description
sellingPurPoint
String
sellingPurPoint
ds
Equip data set
OnChangeSellingVendor This method should be called when SellingVendor change. Parameters Name
Type
Description
vendorID
String
vendorID
ds
Epicor 9.05 | 9.05.605
Equip data set
805
A-E
Business Object Reference Guide
OnChangeServicePurPoint This method should be called when ServicePurPoint change. Parameters Name
Type
Description
servicePurPoint
String
sellingPurPoint
ds
Equip data set
OnChangeServiceVendor This method should be called when ServiceVendor change. Parameters Name
Type
Description
vendorID
String
vendorID
ds
Equip data set
OnChangeTemplateJobNum This method should be called when EquipPlan.TemplateJobNum change. Parameters Name
Type
Description
ipJobNum
String
Job Num
ds
Equip data set
OnChangeTimeFreq This method should be called when TimeFreq change. Parameters Name
Type
Description
ipTimeFreq
Int32
Time Freq
ds
Equip data set
OnChangeTimeUOM This method should be called when TimeUOM change.
806
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ipTimeUOM
String
Time UOM
ds
Equip data set
EquipLoc Epicor.Mfg.BO.EquipLoc: This business object contains 7 methods.
GetNewEquipLoc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
807
A-E
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
EquipMeter Epicor.Mfg.BO.EquipMeter: This business object contains 6 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
808
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
EquipStatus Epicor.Mfg.BO.EquipStatus: This business object contains 7 methods.
GetNewEquipStatus Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
809
A-E
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
EquipType Epicor.Mfg.BO.EquipType: This business object contains 9 methods.
GetNewEquipType Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
810
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
811
A-E
Business Object Reference Guide
Returns
ESSearch Epicor.Mfg.BO.ESSearch: This business object contains 9 methods.
GetNewESSearch Inserts a new row in the DataSet with defaults populated.
GetNewESSearchFields Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
812
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BAQExists This method returns true if the BAQ exists and is approved. Parameters Name
Type
Description
pcGlbComp
String
The ID of the global company
pcSearchID
String
The ID of the Enterprise Search
pbExists
Boolean@
Returns true if the BAQ in this Enterprise Search exists
ETCAddrValidation Epicor.Mfg.BO.ETCAddrValidation: This business object contains 4 methods. Called when the user chooses a new valid address. Returns ETCAddrValidation data set
OnChangeofValidAddr Called when the user chooses a new valid address. Parameters Name
Type
Description
requestID
String
RequestID
ds
ETCAddrValidation data set
OnChangeofAddr Called when the user changes the address.
Epicor 9.05 | 9.05.605
813
A-E
Business Object Reference Guide
Parameters Name
Type
Description
requestID
String
RequestID
statusFlag
Boolean@
Set to true if the integration is up, false if down.
errorFlag
Boolean@
If true, an error occured.
errorMsg
String@
If Error Flag is true, this is the associated message.
ds
ETCAddrValidation data set
SetAddr Parameters Name
Type
Description
requestID
String
RequestID
ds
ETCAddrValidation data set
ExportPackage Epicor.Mfg.BO.ExportPackage: This business object contains 7 methods.
DeleteByID This method deletes an existing Export package Parameters Name
Type
Description
packageID
String
The current Package ID
GetByID This method returns a dataset representing a ExportPackage Parameters Name
Type
Description
packageID
String
The package ID code
Returns Returns the dataset representing the Export package
GetList This method returns a list of Security, including those with blank Company ID
814
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of Securities
GetNewEPFileContents This method creates a EPFileContents row Parameters Name
Type
ds packageID
Description Returns the updated dataset
String
The package ID
GetNewEPHistory This method creates a EPHistory row Parameters Name
Type
ds packageID
Description Returns the updated dataset
String
The package ID
GetNewExportPackage This method creates a new Export package Parameters Name
Type
Description
ds
Update Update Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Returns the list of Securities
815
A-E
Business Object Reference Guide
ExpressShip Epicor.Mfg.BO.ExpressShip: This business object contains 46 methods.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
AddCase Add case Parameters Name
Type
Description
caseType
String
Case Type
numberPcs
Int32
Number of pieces
casePrice
Decimal
Case Price
caseWeight
Decimal
Case Weight
ds
ExpressShip dataset
isError
Boolean@
Is Error?
errorMsg
String@
Error message
AddCustBilling Add Customer Billing Parameters Name
Type
ds
Description ExpressShip dataset
iNewBillingSeq
Int32@
New Billing Sequence
isError
Boolean@
Is Error?
CanChangeBilling Can change Billing?
816
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
ds canChange
Description ExpressShip dataset
Boolean@
Can Change?
Type
Description
CanUnship Can unship? Parameters Name ds okToUnShip
ExpressShip dataset Boolean@
Can unship?
DeleteCase Delete Case Parameters Name
Type
ds
Description ExpressShip dataset
caseNumber
String
Case Number
isError
Boolean@
Is Error?
errorMsg
String@
Error message
DeleteCustBilling Delete Customer Billing Parameters Name
Type
Description
billingSeq
Int32
Billing Sequence
ds isError
ExpressShip dataset Boolean@
Is Error?
DeleteQuantumEmail Delete Quantum Mail
Epicor 9.05 | 9.05.605
817
A-E
Business Object Reference Guide
Parameters Name
Type
Description
caseNumber
String
Case Number
billType
String
Bill Type
ds
ExpressShip dataset
isError
Boolean@
Is Error?
errorMsg
String@
Error message
DeleteShipment Delete Shipment Parameters Name
Type
Description
ds
ExpressShip dataset
isError
Boolean@
Is Error?
errorMsg
String@
Error message
DeleteUpsQuantumView Delete Ups Quantum View Parameters Name
Type
Description
caseNumber
String
Case Number
billType
String
Bill Type
ds
ExpressShip dataset
isError
Boolean@
Is Error?
errorMsg
String@
Error message
Express Ship after get rows
GetAccountNumberList Get Account Number List Parameters Name
Type
Description
pcBillType
String
Bill Type
ds
818
ExpressShip dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
pcAccountNumberList
String@
Account Number List
GetBillingOption Get Billing Option Parameters Name
Type
Description
ds
ExpressShip dataset
GetBillingOptionsList Get Billing option list Parameters Name
Type
Description
pcCompany
String
Company number
pcShipCode
String
Ship Code
billingOptionList
String@
Billing Option List
GetByID Get By ID Parameters Name
Type
Description
packNum
Int32
Pack Number
shipType
String
Ship Type
packLine
Int32
Pack Line
Returns ExpressShip dataset
GetCarrier Get Carrier Parameters Name
Type
Description
shipCode
String
Ship Code
carrier
String@
Carrier
Epicor 9.05 | 9.05.605
819
A-E
Business Object Reference Guide
GetCaseTypesList Get Case Types List Parameters Name
Type
Description
company
String
Company number
caseTypesList
String@
Case Types List
Name
Type
Description
pcCompany
String
Company number
pcService
String
Service number
pcCODOptions
String@
COD Options
GetCODOptions Get COD Options Parameters
GetCountries Get Countries Parameters Name
Type
Description
cCountryList
String@
Country List
GetCustBillingOptionsList Get Customer Billing options List Parameters Name
Type
Description
pcCarrier
String
Carrier
pcBillingOptionsList
String@
Billing Options List
GetFedxGroundCODCollectionTypes Get Fedx Ground COD Collection Type
820
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
gndColType
String@
Ground Collection Type
GetFedxHomeDeliveryTypes Get Fedx Home Delivery Type Parameters Name
Type
Description
homeDelTypes
String@
Home Delivery Types
GetList Get List Parameters Name
Type
Description
whereClause
String
Where conditions
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages?
Returns ExpressShipList DataSet
GetNewCase Get New Case Parameters Name
Type
ds
Description ExpressShip dataset
GetNewCustBilling Get New Customer Billing Parameters Name
Type
ds newBillingSeq
Epicor 9.05 | 9.05.605
Description ExpressShip dataset
Int32@
New Billing Sequence
821
A-E
Business Object Reference Guide
GetNewExpressShip Get New ExpressShip; Parameters Name
Type
Description
shipType
String
Ship Type
packNum
Int32
Pack Number
ds
ExpressShip dataset
GetNewUpsQV Get New Ups QV; Parameters Name
Type
Description
ds
ExpressShip dataset
viewType
String
View Type
caseNum
String
Case Number
GetRows Get Rows Parameters Name
Type
Description
whereClauseExpressShip
String
Where Clause ExpressShip
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages?
Returns ExpressShip dataset
GetScaleSettings Get Scale Settings Parameters Name
Type
ds getWeightFrom
822
Description ExpressShip dataset
String@
Get Weight From
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
scalePort
Int32@
Scale Port
scaleSettings
String@
Scale Settings
GetServiceOptions Get Scale Settings Note: pcService is the ttShipment.ShipCode entry Parameters Name
Type
Description
pcCompany
String
Company
pcService
String
Service
pcServiceOptions
String@
Service Options
GetShipCodeList Get Ship Code List Parameters Name
Type
Description
company
String
Company
shipCodeList
String@
Ship Code List
GetShipment Get New ExpressShip; Parameters Name
Type
Description
packNum
Int32
Pack Number
shipType
String
Ship Type
packLine
Int32
Pack Line
ds
ExpressShip dataset
GetStates Get States Parameters Name
Type
Description
pcCountry
String
Country
Epicor 9.05 | 9.05.605
823
A-E
Business Object Reference Guide
Name
Type
Description
pcStateList
String@
State List
GetTruckShipCodeList Get Truck Ship Code List Parameters Name
Type
Description
pcCompany
String
Company
pcTruckShipCodesList
String@
Truck Ship Codes List
GetUPSDelConfTypes Get UPS Delivery Confirmation Types Parameters Name
Type
Description
delConfTypes
String@
Delivery Confirmation Types
IsCustomerPickup Is Customer Pickup? Parameters Name
Type
ds isCustomerPickup
Description ExpressShip dataset
Boolean@
Customer Pickup
IsReferencePrintedOnLabel Is Reference Printed On Label Parameters Name
Type
ds
Description ExpressShip dataset
referenceField
Int32
Reference Field
isPrinted
Boolean@
Is Printed?
ProcessShipment Process shipment
824
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Parameters Name
Type
Description
ds
ExpressShip dataset
shipmentType
String
Shipment Type
isError
Boolean@
Is Error?
opMessage
String@
Text Message to display for informative messages
ReadyToShip Ready to ship Parameters Name
Type
ds readyToShip
Description ExpressShip dataset
Boolean@
Ready To Ship?
ReprintCarrierLabel Reprint Carrier Label Parameters Name
Type
Description
company
String
Company
caseNumber
String
Case Number
UnshipShipment Unship Shipment Parameters Name
Type
ds processComplete
Description ExpressShip dataset
Boolean@
Process Complete?
Update Update Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description ExpressShip dataset
825
A-E
Business Object Reference Guide
UpdateCase Update Case Parameters Name
Type
Description
caseNumber
String
Case Number
ds
ExpressShip dataset
isError
Boolean@
Is Error?
errorMsg
String@
Error Message
UpdateCustBilling Update Customer Billing Parameters Name
Type
Description
seq
Int32
Billing Sequence
ds isError
ExpressShip dataset Boolean@
Is Error?
UpdateShipment Update Shipment Parameters Name
Type
ds
Description ExpressShip dataset
isError
Boolean@
Is Error?
errorMsg
String@
Error Message
VersionCheck Version Check Parameters
826
Name
Type
Description
lInsync
Boolean@
In syncronize?
cErrorMsg
String@
Error Message
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
ExpressShipManifests Epicor.Mfg.BO.ExpressShipManifests: This business object contains 5 methods.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CloseCarrier Close Carrier Parameters Name
Type
Description
company
String
Company
cPrinterSettings
String
Printer Settings
cPageSettings
String
Page Settings
workStationID
String
Work Station ID
printDetail
Boolean
Print Detail (yes/no)
upsUploadProcessed
Boolean@
UPS Upload Processed?
upsUploadSuccessful
Boolean@
UPS Upload Successful?
upsUploadErrorMsg
String@
UPSUploadErrorMsg?
GetUPSManifests Get UPS manifest Parameters Name
Type
Description
company
String
Company
ds
ExpressShip Manifests DataSet
GetUSPSManifests Get USPS manifests
Epicor 9.05 | 9.05.605
827
A-E
Business Object Reference Guide
Parameters Name
Type
Description
company
String
Company
Returns ExpressShip USPS manifest DataSet
SendManifests Send manifests Parameters Name
Type
Description
company
String
Company
carrier
String
Carrier
manifestID
String
Manifest ID
workStationID
String
Work Station ID
cPrinterSettings
String
Printer Settings
cPageSettings
String
Page Settings
printDetail
Boolean
Print Detail (yes/no)
ExtCompany Epicor.Mfg.BO.ExtCompany: This business object contains 28 methods.
GetNewExtCompany Inserts a new row in the DataSet with defaults populated.
GetNewExtCompanyAttch Inserts a new row in the DataSet with defaults populated.
GetNewExtPlant Inserts a new row in the DataSet with defaults populated.
GetNewExtWarehouse Inserts a new row in the DataSet with defaults populated.
GetNewIntTransIn Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
828
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
829
A-E
Business Object Reference Guide
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CustomerConnect Customer Connect Parameters Name
Type
Description
disabledList
String@
Returns the list of fields to be disabled
checkedList
String@
Returns the list of fields to be checked
ConvertToMultiCompanyDirect Convert this ExtCompany record from Sonic to Direct Parameters Name
Type
Description
ipCompany
String
Input the ExtCompany.Company value to be converted
ipExtSystemID
String
Input the ExtCompany.ExtSystemID value to be converted
ipTransferMethod
String
Input the ExtCompany.TransferMethod value to be converted
ipExtCompanyID
String
Input the ExtCompany.ExtCompanyID value to be converted
ipSysRowID
String
Input the ExtCompany.SysRowID value to be converted
opSuccess
Boolean@
Indicates if the External Company was successfully converted
ConvertToMultiCompanySonic Convert this ExtCompany record from Direct to Sonic Parameters
830
Name
Type
Description
ipCompany
String
Input the ExtCompany.Company value to be converted
ipExtSystemID
String
Input the ExtCompany.ExtSystemID value to be converted
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Name
Type
Description
ipTransferMethod
String
Input the ExtCompany.TransferMethod value to be converted
ipExtCompanyID
String
Input the ExtCompany.ExtCompanyID value to be converted
ipSysRowID
String
Input the ExtCompany.SysRowID value to be converted
opSuccess
Boolean@
Indicates if the External Company was successfully converted
EntPrsConf Enterprise Configurator Parameters Name
Type
Description
disabledList
String@
Returns the list of fields to be disabled
checkedList
String@
Returns the list of fields to be checked
Name
Type
Description
disabledList
String@
Returns the list of fields to be disabled
checkedList
String@
Returns the list of fields to be checked
Generic Generic Parameters
GetFieldList Retrieves the fields for the given DB Table Parameters Name
Type
Description
tableName
String
The Table from wich you want to retrieve the Fields
ds
The dataset represents the table object
This method returns a table and field dataset for the system tables. Returns The dataset represents the table object
InitEntprsConf This method initializes/sends the enterprise configurator records for the specified ExtCompanyID
Epicor 9.05 | 9.05.605
831
A-E
Business Object Reference Guide
Parameters Name
Type
Description
extCompanyID
String
The External Company ID
errlog
String@
Error log resulting of the operation
InitMultiCompany This method initializes/sends the applicable GL data for the specified ExtCompanyID Parameters Name
Type
Description
extCompanyID
String
The External Company ID
errlog
String@
Error log resulting of the operation
InitMultiCompanyGL This method initializes/sends the applicable GL data for the specified ExtCompanyID Parameters Name
Type
Description
extCompanyID
String
The External Company ID
errlog
String@
Error log resulting of the operation
MobileConnect Mobile Connect Parameters Name
Type
Description
disabledList
String@
Returns the list of fields to be disabled
checkedList
String@
Returns the list of fields to be checked
Name
Type
Description
disabledList
String@
Returns the list of fields to be disabled
checkedList
String@
Returns the list of fields to be checked
MultiCompany Multi Company Parameters
832
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
PLM PLM Parameters Name
Type
Description
disabledList
String@
Returns the list of fields to be disabled
checkedList
String@
Returns the list of fields to be checked
Name
Type
Description
disabledList
String@
Returns the list of fields to be disabled
checkedList
String@
Returns the list of fields to be checked
SupplierConnect Supplier Connect Parameters
TestConnection Test Connection Parameters Name
Type
Description
extCompRowid
String
The RowIdent of the record of which to test connection
ExtPlantSearch Epicor.Mfg.BO.ExtPlantSearch: This business object contains 7 methods.
GetNewExtPlant Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
833
A-E
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ExtSystem Epicor.Mfg.BO.ExtSystem: This business object contains 9 methods.
GetNewExtSystem Inserts a new row in the DataSet with defaults populated.
GetNewExtCompany Inserts a new row in the DataSet with defaults populated.
834
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
835
A-E
Business Object Reference Guide
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ExtWarehouseSearch Epicor.Mfg.BO.ExtWarehouseSearch: This business object contains 7 methods.
GetNewExtWarehouse Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
836
Epicor 9.05 | 9.05.605
Business Object Reference Guide
A-E
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
837
F-L
Business Object Reference Guide
Part II: F-L Chapter 6: F FAClass Epicor.Mfg.BO.FAClass: This business object contains 8 methods.
GetNewFAClass Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
838
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FAGroup Epicor.Mfg.BO.FAGroup: This business object contains 8 methods.
GetNewFAGroup Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
839
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FAMethod Epicor.Mfg.BO.FAMethod: This business object contains 16 methods.
GetNewFAMethod Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
840
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AssignAnnualCharge Updates temp table depreciation method formulas.
Epicor 9.05 | 9.05.605
841
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipAnnualChargeType
String
annual charge type
ds
The FA Method data set
AssignPeriodCharge To be called after changing FAMethod.PeriodChargeType field Parameters Name
Type
ds
Description Asset Depreciation Method data set
ChangeAltMethod To be called on leave of FAMethod.AltAssetMethod field Parameters Name
Type
Description
ipAltMethod
String
alternative asset method that was entered.
ds
Asset Depreciation Method data set
ChangeDepChargeBasis To be called on leave of FAMethod.DepChargeBasis field Parameters Name
Type
Description
ipDepCharge
String
depreciation charge basis that was entered.
ds
Asset Depreciation Method data set
ChangeSwitchMethod To be called on leave of FAMethod.SwitchMethod field Parameters Name
Type
Description
ipSwitchMethod
String
switch method that was entered.
ds
842
Asset Depreciation Method data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
TestSyntax Test the formula syntax. Parameters Name
Type
Description
ipFormulaToCheck
String
Formula to check
ipDepChargeBasis
String
DepChargeBasis Annual or Period
ipCallFromButton
Boolean
Will only display Correct Syntax if Check Syntax button is pressed will only display error from save button.
opSyntaxIsCorrect
Boolean@
True if the syntax passes
opSyntaxMessage
String@
A message regarding the syntax to return to the user.
Returns variables to create depreciation method formulas. Used in annual formula context menu. Returns Returns operands to create depreciation method formulas. Returns Returns variables to create depreciation method period formulas. Used in period formula context menu. Returns
FASpreadCode Epicor.Mfg.BO.FASpreadCode: This business object contains 15 methods.
GetNewFASpread Inserts a new row in the DataSet with defaults populated.
GetNewFASprdDy Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
843
F-L
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
844
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns
DeleteFASprdDy This is to delete ttFASprdDy record based on the SpreadCode, Fiscal Year and Period. Parameters Name
Type
Description
spreadCode
String
SpreadCode of record that is being updated.
fiscalYear
Int32
FiscalYear of record that is being updated.
fiscalYearSuffix
String
FiscalYearSuffix of record that is being updated.
fiscalPeriod
Int32
FiscalPeriod of record that is being updated.
ds
Fixed Asset SpreadCode dataset
ExportSpreadCode Exports the Spread Code data to a CSV file. Parameters Name
Type
Description
inStartCode
String
Starting Spread Code
inEndCode
String
Ending Spread Code
inSelectBy
String
Select By option
inSelectType
String
Select Type option
Returns Asset SpreadCode dataset for Import and Export.
GenerateSprdDy This procedure is to generate ttFASprdDy records based on the Spread Type and the parameters entered by the user in the Generate Values form. Parameters Name
Type
Description
iPSpreadCode
String
SpreadCode of record that is being updated.
ds
Fixed Asset SpreadCode dataset
GetSelectList Get list of descriptions for the Export combos.
Epicor 9.05 | 9.05.605
845
F-L
Business Object Reference Guide
Parameters Name
Type
Description
inListType
String
The type of list that is going to be returned
selectList
String@
Output list of descriptions
ImportSpreadCode Imports the Spread Code data from a CSV file. Parameters Name
Type
Description
allImported
Boolean@
Shows if all records were imported successfully
ds
Asset SpreadCode dataset for Import and Export
Returns Fixed Asset SpreadCode dataset with the imported records.
SetDefaultsForGenerate This procedure sets the Defalut values of the Parameters in the Generate Values form. Parameters Name
Type
Description
inCalendarID
String
Fiscal Calendar ID
inSpreadType
String
Spread Code Type
outCurrYear
Int32@
Output value for Start Year
outLastYear
Int32@
Output value for End Year
FAsset Epicor.Mfg.BO.FAsset: This business object contains 34 methods.
GetNewFAsset Inserts a new row in the DataSet with defaults populated.
GetNewFAssetAttch Inserts a new row in the DataSet with defaults populated.
GetNewFAssetDtl Inserts a new row in the DataSet with defaults populated.
846
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetNewFAssetDtlAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
847
F-L
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CalcTaxAmtLine Called to calculate the Tax for the AP Invoice Line Parameters Name
Type
Description
ipSupplier
Int32
Supplier Invoice Line that was entered.
ipInvoiceNum
String
Invoice Num that was entered.
ipInvoiceLine
Int32
Invoice Line that was entered.
ipTaxCode
String
Tax Code Invoice Line that was entered.
ipRateCode
String
Rate Code Invoice Line that was entered.
opInvestAmount
Decimal@
Investment Amount.
opTaxAmount
Decimal@
Tax Amount.
ChangeAssetMethod Update AssetMethod when a different AssetMethod is selected. Parameters Name
Type
Description
ipAssetMethod
String
The Method proposed value
ds
848
The FAsset data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ChangeAssetRegister Update AssetRegister when a different AssetRegister is selected. Parameters Name
Type
Description
ipAssetRegister
String
The Register proposed value
ds
The FAsset data set
Duplicate Duplicate function of the fixed asset. Parameters Name
Type
Description
ipOldAssetNum
String
Old Asset Number
ipAssetNum
String
New Asset Number
ipAssetDesc
String
New Asset Description
ipDupCost
Boolean
Indicates if Asset Cost is to be copied as Addition Cost
Returns Results of the Duplicate The purpose of this code is to export the fixed assets. Returns FAssetImportExportDataSet Dataset of candidates for import.
GetChildAssets Get the ChildAsset records for a parent asset. Parameters Name
Type
ds parentAssetNum
Description Fixed Asset dataset
String
The Parent Asset Number
GetFAssetByID Get Fixed Asset by ID
Epicor 9.05 | 9.05.605
849
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipAssetNum
String
New Asset Number
Returns Results of the Duplicate
GetNewChildAsset To be called when a new ChildAssets row is needed. Parameters Name
Type
Description
ipParentAssetNum
String
AssetNum of the current asset.
ds
The FAsset data set
ImportFAssets Import Fixed Assets Function. Parameters Name
Type
Description
ds
FAssetImportExportDataSet Dataset of candidates for import.
Returns FAssetDataSet Dataset of records that are imported.
LeaveAcquiredDate The purpose of this code is to assign the commissioned date to the acquired date for a new fixed asset. (Only run this code on a new fixed asset) Called on leave of Acquired Date field. Parameters Name
Type
Description
ipAcquiredDate
Nullable{System.DateTime}
AcquiredDate was entered.
ds
The FAsset data set
LeaveChildAssetNum To be called on leave of (Child) AssetNum field.
850
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipChildAssetNum
String
AssetNum that was entered.
ipParentAssetNum
String
The current Asset AssetNum.
ds
The FAsset data set
LeaveInsPremium To be called on leave of FAsset.InsurancePremium field Parameters Name
Type
Description
ipInsPremium
Decimal
InsurancePremium that was entered.
ipbaseordoc
String
The field type - base or doc
ds
FAsset data set
LeaveInsValue To be called on leave of FAsset.InsuranceValue field Parameters Name
Type
Description
ipInsValue
Decimal
InsuranceValue that was entered.
ipbaseordoc
String
The field type - base or doc
ds
FAsset data set
LeaveInvoiceLine Called on the leave of Invoice Line Parameters Name
Type
Description
ipInvoiceLine
Int32
Invoice Line that was entered.
ds
The FAsset data set
LeaveInvoiceNum Called on the leave of Invoice Number
Epicor 9.05 | 9.05.605
851
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipInvoiceNum
String
Invoice Number that was entered.
ds
The FAsset data set
LeaveJobNum To be called on leave of Job Number field Parameters Name
Type
Description
ipJobNum
String
Job Number that was entered.
ds
The FAsset data set
LeaveLeaseValue To be called on leave of FAsset.LeaseValue field Parameters Name
Type
Description
ipLeaseValue
Decimal
LeaseValue that was entered.
ipbaseordoc
String
The field type - base or doc
ds
FAsset data set
LeavePONum To be called on leave of VendorID field Parameters Name
Type
Description
ipPONum
Int32
PO Number that is entered.
ds
The JobEntry data set
LeaveReplaceValue To be called on leave of ReplaceValue field Parameters
852
Name
Type
Description
ipReplaceValue
Decimal
ReplaceValue that was entered.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
ipbaseordoc
String
The field type - base or doc
ds
FAsset data set
LeaveResidualValue To be called on leave of ResidualValue field Parameters Name
Type
Description
ipResidualValue
Decimal
ResidualValue that was entered.
ipbaseordoc
String
The field type - base or doc
ds
FAsset data set
LeaveVendorID To be called on leave of VendorID field Parameters Name
Type
Description
ipVendorID
String
VendorID or SupplierID that was entered.
ds
The JobEntry data set
TestAllowDelete This procedure is to provide a check before deleting the records You can use this method to provide a message to the user of this fact and provide a confirmation dialog. This is intended to be called before the delete procedure. If there are existing records SureMsg will contain a translated text message which can be used to display in your message dialog. Otherwise it returns blanks and there is no need to provide a dialog. Parameters Name
Type
Description
assetNum
String
AssetNum of record that is being updated.
sureMsg
String@
Contains message text if records should be deleted.
TestParentChildIntegrity This procedure should be called to check for parent\child integrity. The procedure throws an exception if the relation is invalid.
Epicor 9.05 | 9.05.605
853
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipOrgAssetNum
String
Orig. Asset Number
ipAssetNum
String
New Asset Number
ippAssetType
String
Asset Type
FAssetReg Epicor.Mfg.BO.FAssetReg: This business object contains 9 methods.
GetNewFAssetReg Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
854
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeBookID This method is called when the BookID changes. This validates if the GL Book is valid and if book's calendar can be defaulted to asset register. Parameters Name
Type
Description
ipBookID
String
The proposed BookID
ds
The FAssetReg data set
OnChangeCalendarID This method is called when the CalendarID changes. This validates if the Calendar has an open Asset Fiscal Period that can be used as default. Parameters Name
Type
Description
ipCalendarID
String
The proposed CalendarID
ds
The FAssetReg data set
FATranSearch Epicor.Mfg.BO.FATranSearch: This business object contains 8 methods.
GetNewFASchedule Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
855
F-L
Business Object Reference Guide
GetNewFATran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
856
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Favorite Epicor.Mfg.BO.Favorite: This business object contains 9 methods.
GetNewFavFolder Inserts a new row in the DataSet with defaults populated.
GetNewFavItems Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
857
F-L
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CopyBeforeFavoriteItem Move or Copy one menu item (source) before another (Target) Parameters Name
Type
Description
theUserID
String
The user ID
folderSeq
Int32
The folder sequence number
sourceMenuId
String
Menu ID of the source
targetMenuId
String
The menu ID of the target
bSuccess
Boolean@
true = successful
FinCharge Epicor.Mfg.BO.FinCharge: This business object contains 15 methods.
GetNewFinCharge Inserts a new row in the DataSet with defaults populated.
GetNewFinChargeAttch Inserts a new row in the DataSet with defaults populated.
GetNewFinChargeRate Inserts a new row in the DataSet with defaults populated.
858
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetNewLangDesc Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
859
F-L
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeIncomeTaxCode Performs required logic when FinCharge.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
FinCharge data set
OnChangeFinChargeFinInvTerms Validate FinInvTerms value Parameters Name
Type
Description
ipFinInvTerms
String
The proposed FinInvTerms value
ds
The FinCharge data set
OnChangeFinChargeMiscCode Validate MiscCode value Parameters Name
Type
Description
ipMiscCode
String
The proposed Misc Charge Code value
ds
The FinCharge data set
OnChangeFinChargeTaxCatID Validate TaxCatID value Parameters Name
Type
Description
ipTaxCatID
String
The proposed TaxCatID value
ds
860
The FinCharge data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
FirstArt Epicor.Mfg.BO.FirstArt: This business object contains 13 methods.
GetNewFirstArt Inserts a new row in the DataSet with defaults populated.
GetNewFirstArtAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
861
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetHistory This method takes in the key field values for a First Article, and returns a FirstArtList dataset of the history of related inspections. Parameters Name
Type
Description
jobNum
String
The Job Number
assemblySeq
Int32
The Job Assembly Sequence
oprSeq
Int32
The Job Operation Sequence
resourceID
String
The Resource ID
Returns FirstArtList dataset.
OnChangeAssembly This method validates the ProposedAssemblySeq, then updates the following assembly-related fields: FirstArt.JobAsmPartNum FirstArt.JobAsmRevisionNum This method should be run when the FirstArt.AssemblySeq field changes. An exception is thrown if: - No Job Assembly exists with the given Assembly Sequence Number
862
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
piProposedAssemblySeq
Int32
The new proposed Job Assembly value
ds
FirstArt dataset.
OnChangeJobNum This method validates the pcProposedJobNum, then clears the job-related fields. FirstArt.JobAsmPartNum FirstArt.JobAsmRevisionNum This method should be run when the FirstArt.JobNum field changes. An exception is thrown if: - No Job exists with the given Job Number Parameters Name
Type
Description
pcProposedJobNum
String
The new proposed Job Number value
ds
FirstArt dataset.
OnChangeOprSeq This method validates the piProposedOprSeq, then updates the operation-related fields. This method should be run when the FirstArt.OprSeq field changes. An exception is thrown if: - No Job Operation exists with the given OprSeq Number A warning message is returned if there is no First Article quantity set on the Job Operation Parameters Name
Type
Description
piProposedOprSeq
Int32
The new proposed Job Operation Sequence value
pcWarningMsg
String@
Warning message
ds
FirstArt dataset.
FiscalCal Epicor.Mfg.BO.FiscalCal: This business object contains 18 methods.
GetNewFiscalCal Inserts a new row in the DataSet with defaults populated.
GetNewFiscalYr Inserts a new row in the DataSet with defaults populated.
GetNewFiscalPer Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
863
F-L
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
864
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CalculateITPeriodDflts Uses Income Tax Fiscal Year values to populate all its related fiscal Periods. Method only used for MX Localization. Parameters Name
Type
Description
ipFiscalCalendarID
String
current Fiscal Calendar ID
ipFiscalYear
Int32
current Fiscal Year
ipFiscalYearSuffix
String
current Fiscal Year Suffix.
ds
FiscalCal data set
GeneratePeriods Get dataset record for Generate Fiscal Periods functionality. Parameters Name
Type
Description
String@
Output message
ds cOutMessage Returns
GetFiscalPerGenerate Get dataset record for Generate Fiscal Periods functionality. Parameters Name
Type
Description
cFiscalCalendarID
String
The Fiscal Calendar ID
iFiscalYear
Int32
The Fiscal Year
cFiscalYearSuffix
String
The Fiscal Year Suffix
Epicor 9.05 | 9.05.605
865
F-L
Business Object Reference Guide
Returns
GetGLJrnDtlByPeriods Get first GL journal line entry by input params. This entry existence will need checking of Book Balances by 'Verify Balances' utility Parameters Name
Type
Description
cFiscalCalendarID
String
Fiscal Calendar
iFiscalYear
Int32
Fiscal Year
cFiscalYearSuffix
String
Fiscal Year Suffix
iFiscalPeriodFrom
Int32
Fiscal Period From
iWorkMode
Int32
Work Mode
lIsGetIt
Int32@
0 Is is correct to delete it. 1 There is reference in Assets Management 2 There is reference in GL journal line
cBookID
String@
GL Book
cJournalCode
String@
Journal Code
iJournalNum
Int32@
Journal Num
iJournalLine
Int32@
Journal Line
iFiscalYearOut
Int32@
Fiscal Year out
cFiscalYearSuffixOut
String@
Fiscal Year suffix out
iFiscalPeriodOut
Int32@
Fiscal Period
GetITFiscalCal Returns Income Tax Calendar defined in company Parameters Name
Type
Description
opFiscalCalID
String@
Income Tax Fiscal Calendar
ValidateClosedPer Validates that no update is done if the period if close. Parameters
866
Name
Type
Description
ipFiscalCalendarID
String
current Fiscal Calendar ID
ipFiscalYear
Int32
current Fiscal Year
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
ipFiscalYearSuffix
String
current Fiscal Year Suffix.
ipFiscalPeriod
Int32
current Fiscal Period
ds
FiscalCal data set
ValidateClosedYr Validates that no update is done if the year if close. Parameters Name
Type
Description
ipFiscalCalendarID
String
current Fiscal Calendar ID
ipFiscalYear
Int32
current Fiscal Year
ipFiscalYearSuffix
String
current Fiscal Year Suffix.
ds
FiscalCal data set
CheckDataInGLJrnDtl Get first GL journal line entry by input params. This entry existence will need checking of Book Balances by 'Verify Balances' utility Parameters Name
Type
Description
cFiscalCalendarID
String
Fiscal Calendar
iFiscalYear
Int32
Fiscal Year
cFiscalYearSuffix
String
Fiscal Year Suffix
iFiscalPeriod
Int32
Fiscal Period From
dStartDate
Nullable{System.DateTime}
Start Date
dEndDate
Nullable{System.DateTime}
End Date
iWorkMode
Int32
Work Mode
cBookID
String@
GL Book
cJournalCode
String@
Journal Code
iJournalNum
Int32@
Journal Num
iJournalLine
Int32@
Journal Line
Epicor 9.05 | 9.05.605
867
F-L
Business Object Reference Guide
FiscalPerSearch Epicor.Mfg.BO.FiscalPerSearch: This business object contains 7 methods.
GetNewFiscalPer Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
868
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FiscalYrSearch Epicor.Mfg.BO.FiscalYrSearch: This business object contains 7 methods.
GetNewFiscalYr Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
869
F-L
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Fob Epicor.Mfg.BO.Fob: This business object contains 9 methods.
GetNewFob Inserts a new row in the DataSet with defaults populated.
GetNewLangDesc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
870
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Forecast Epicor.Mfg.BO.Forecast: This business object contains 15 methods.
GetNewForecast Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
871
F-L
Business Object Reference Guide
GetNewForecastAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
872
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ClearForecasts This method deletes all Forecast records for the Current Plant, or all Plants, with two exceptions: - Forecasts for Global Parts are not deleted - Forecasts marked as autoTransfer are not deleted. Parameters Name
Type
Description
plAllPlants
Boolean
If TRUE, clear all plants; if FALSE, clear Current Plant.
pdFromDate
Nullable{System.DateTime}
Only Forecast records on or after the given date will be deleted.
ExportForecasts This method exports all Forecast records for the current company, after the given date. If ForecastImportExport records are present as input, they are used to build the following lists for selection of records: PlantList PartList CustNumList If a record in the input dataset: 1) has a value for Plant, PartNum, or CustID and blank values for the other two, and 2) blank values for the fields ImportErrorMsg and ForeQty, then the value in Plant, PartNum, or CustID will be added to the respective list. If a record has a value in more than one of these fields, it will be ignored. After the above lists have been constructed, the record selection will use the lists as follows: - if a list is non-empty, only records whose corresponding field value appears in the list will be a candidate for being included in the returned dataset, subject to the other conditions - if a list is empty, no filtering will occur on the values for that field, except possibly conditions in the "whereClauseForecast" parameter. Parameters Name
Type
ds
Description ForecastImportExport dataset.
whereClauseForecast
String
(optional)Additional Where conditions for Forecast table.
pdFromDate
Nullable{System.DateTime} (optional)Only records on or after the given date will be considered for import.
pageSize
Int32
For future use.
absolutePage
Int32
For future use.
morePages
Boolean@
For future use.
GetForecastDays To retrieve the ForecastDaysBefore and ForecastDaysAfter from the JC system settings.
Epicor 9.05 | 9.05.605
873
F-L
Business Object Reference Guide
Parameters Name
Type
Description
piDaysBefore
Int32@
Days before
piDaysAfter
Int32@
Days after
GetNewForecastImportExport This method creates a new ForecastImportExport dataset row. Parameters Name
Type
Description
ds
GetSalesHistory This method provides a ForecastSalesHistory dataset filled with Sales History data. This can be used as the basis of the External Forecast Export. Notes: taken from mre10-sm-ex-dg.w (PROCEDURE Export-Forecast) Parameters Name
Type
Description
pdBeginDate
Nullable{System.DateTime} Begin Date of Sales to extract.
pdEndDate
Nullable{System.DateTime} End Date of Sales to extract.
pcCustList
String
Tilde-delimited list of Customer Numbers for Sales extract. Blank means all.
pcCustGrpList
String
Tilde-delimited list of Customer Group Codes for Sales extract. Blank means all.
pcPartList
String
Tilde-delimited list of Part Numbers for Sales extract. Blank means all.
pcProdGrpList
String
Tilde-delimited list of Product Group Codes for Sales extract. Blank means all.
pcPlantList
String
Tilde-delimited list of Plants for Sales extract. Blank means all.
pcOutputFile
String
Export file path.
pcOutputFormat
String
Export output format.
Returns ForecastSalesHistory dataset; derived from invoice data.
ImportExternalForecast This method populates the ttForecastImportExport dataset with forecast data.
874
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
pcImportFormat
String
Import file format.
pcImportFile
String
Import file path.
Returns ForecastImportExport dataset
ImportForecasts This method conditionally adds/overwrites Forecast records using the same logic as the Vantage Forecast Import screen. Parameters Name
Type
Description
ds
ForecastImportExport Dataset of candidates for import.
pcImportOptions
String
Valid choices are "A"=Add+Replace, "C"=Clear+Reload, "N"=New.
plAllPlants
Boolean
If TRUE, clear all plants; if FALSE, clear Current Plant.
pdFromDate
Nullable{System.DateTime} Only records on or after the given date will be considered for import.
FreightService Epicor.Mfg.BO.FreightService: This business object contains 74 methods.
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
Epicor 9.05 | 9.05.605
875
F-L
Business Object Reference Guide
Name
Type
Description
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
BuildCustFreightRequest Parameters Name
Type
Description
packID
Int32
Pack Number
Returns freight data set
BuildMasterPackFreightRequest Parameters Name
Type
Description
packID
Int32
Pack Number
Name
Type
Description
packID
Int32
Pack Number
Name
Type
Description
packID
Int32
Pack Number
Returns freight data set
BuildMiscFreightRequest Parameters
Returns freight data set
BuildSubFreightRequest Parameters
Returns freight data set
876
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
BuildTransFreightRequest Parameters Name
Type
Description
packID
Int32
Pack Number
Returns freight data set
UpdateFreightedShipment Parameters Name
Type
Description
ipPackID
Int32
package code
ipShipmentType
String
shipment type
ds
Freight Response data set
UpdateUnFreightedShipment Parameters Name
Type
Description
ipPackID
Int32
package code
ipShipmentType
String
shipment type
ds
Freight Response data set
Call context dataset Constructor Parameters Name connPool
Type
Description Connection pool
Returns UnfreightInfoResponseDataSet
Epicor 9.05 | 9.05.605
877
F-L
Business Object Reference Guide
Returns FreightInfoResponseDataSet
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
878
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last
Epicor 9.05 | 9.05.605
879
F-L
Business Object Reference Guide
• Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
880
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Represents a strongly typed in-memory cache of data. Represents the strongly named DataTable class. Represents the strongly named DataTable class. Represents the strongly named DataTable class. Represents the strongly named DataTable class. Represents the strongly named DataTable class. Represents the strongly named DataTable class. Represents the strongly named DataTable class. Represents the strongly named DataTable class. Represents the strongly named DataTable class. Represents strongly named DataRow class. Represents strongly named DataRow class. Represents strongly named DataRow class. Represents strongly named DataRow class. Represents strongly named DataRow class. Represents strongly named DataRow class. Represents strongly named DataRow class. Represents strongly named DataRow class. Represents strongly named DataRow class. Row event argument class
Epicor 9.05 | 9.05.605
881
F-L
Business Object Reference Guide
Row event argument class Row event argument class Row event argument class Row event argument class Row event argument class Row event argument class Row event argument class Row event argument class Represents a strongly typed in-memory cache of data. Represents the strongly named DataTable class. Represents the strongly named DataTable class. Represents strongly named DataRow class. Represents strongly named DataRow class. Row event argument class Row event argument class Represents a strongly typed in-memory cache of data. Represents the strongly named DataTable class. Represents strongly named DataRow class. Row event argument class Represents a strongly typed in-memory cache of data.
882
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Represents the strongly named DataTable class. Represents strongly named DataRow class. Row event argument class
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
883
F-L
Business Object Reference Guide
FRxEx Epicor.Mfg.BO.FRxEx: This business object contains 6 methods.
ChangeEndFiscalPeriod Change End Fiscal Period Parameters Name
Type
ds
Description FRxEx DataSet
ChangeEndFiscalYear Change End Fiscal Year Parameters Name
Type
ds
Description FRxEx DataSet
ChangeStartFiscalPeriod Change Start Fiscal Period Parameters Name
Type
ds
Description FRxEx DataSet
ChangeStartFiscalYear Change Start Fiscal Year Parameters Name ds
Type
Description FRxEx DataSet
ExportFRx This is used for Exporting the Vantage/Vista data for FRx database.
884
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds procMsg
Description FRxEx DataSet
String@
Populated with completion message if buildFRxDb completed properly.
GetNewFRxEx This method creates a new FRxEX dataset row for storing the parameters needed for the export. Parameters Name
Type
ds
Description FRxEx DataSet
FSAssetClass Epicor.Mfg.BO.FSAssetClass: This business object contains 6 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
885
F-L
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FSAssetCondition Epicor.Mfg.BO.FSAssetCondition: This business object contains 6 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
886
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FSCallCd Epicor.Mfg.BO.FSCallCd: This business object contains 9 methods.
GetNewFSCallCd Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
887
F-L
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeIncomeTaxCode Performs required logic when FSCallCd.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
888
FSCallCd data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
FSCallDtSearch Epicor.Mfg.BO.FSCallDtSearch: This business object contains 6 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
889
F-L
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FSContCd Epicor.Mfg.BO.FSContCd: This business object contains 18 methods.
GetNewFSContCd Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
890
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeDeferredRev Performs required logic when FSContCd.DeferredRev is modified. Parameters Name
Type
Description
ipDeferredRev
Boolean
Proposed input value of Deferred Rev
ds
FSContCd data set
ChangeFiscalCal Performs required logic when FSContCd.FiscalCalendarID is modified. Parameters Name
Type
Description
ipFiscalCal
String
Proposed input value of FiscalCalendarID
Epicor 9.05 | 9.05.605
891
F-L
Business Object Reference Guide
Name
Type
ds
Description FSContCd data set
ChangeIncomeTaxCode Performs required logic when FSContCd.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
FSContCd data set
ChangeQuoted This method should be called to set Quoted. Parameters Name
Type
Description
ipQuoted
Boolean
Quoted.
ds
FSContCd data set
ChangeRACode Performs required logic when FSContCd.RACode is modified. Parameters Name
Type
Description
ipRACode
String
Proposed input value of RA Code
ds
FSContCd data set
ChangeRecurringInv This method should be called to set Recurring Inv. Parameters Name
Type
Description
ipRecurInv
Boolean
Recurring Invoice.
ds
892
FSContCd data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ChangeRenewable This method should be called to set RenewalCode and ShipRenewal when Renewable = false. Parameters Name
Type
Description
ipRenewable
Boolean
Renewal true or false code
ds
FSContCd data set
ChangeRenewalCode Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeTaskSet Performs required logic when FSContCd.TaskSetID is modified. Parameters Name
Type
Description
ipTaskSet
String
Proposed input value of TaskSetID
ds
FSContCd data set
FSContDtSearch Epicor.Mfg.BO.FSContDtSearch: This business object contains 7 methods.
GetNewFSContDtSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
893
F-L
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FSContSNSearch Epicor.Mfg.BO.FSContSNSearch: This business object contains 8 methods.
GetNewFSContSN Inserts a new row in the DataSet with defaults populated.
894
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
895
F-L
Business Object Reference Guide
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FSTechSearch Epicor.Mfg.BO.FSTechSearch: This business object contains 7 methods.
GetNewFsTech Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
896
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FSWarrCd Epicor.Mfg.BO.FSWarrCd: This business object contains 11 methods.
GetNewFSWarrCd Inserts a new row in the DataSet with defaults populated.
GetNewLangDesc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
897
F-L
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK
898
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
• QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
899
F-L
Business Object Reference Guide
Chapter 7: G GenXData Epicor.Mfg.BO.GenXData: This business object contains 14 methods.
GetNewXXXDef Inserts a new row in the DataSet with defaults populated.
GetNewXXXChunk Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
900
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DeleteByIDEx This method deletes a XXXDef record and possibly XXXChunk records for a specific Company Parameters Name
Type
Description
ipCompany
String
The Company.
ipProductID
String
The Product id.
ipTypeCode
String
The type code.
ipCGCCode
String
The CSF Code.
ipKey1
String
The Key1.
ipKey2
String
The Key2.
ipKey3
String
The Key3.
GetByIDEx This method returns a dataset representing a XXXDEF with a blank CompanyID Parameters Name
Type
Description
ipProductID
String
The company id.
ipTypeCode
String
The type code.
ipCGCCode
String
The CSF Code.
ipKey1
String
The Key1.
ipKey2
String
The Key2.
ipKey3
String
The Key3.
Epicor 9.05 | 9.05.605
901
F-L
Business Object Reference Guide
Returns GenXData DataSet.
GetListEx This method returns a list of XXXDef, including those with blank Company ID Parameters Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of XXXDef
GetRowsEx This method returns XXXDef, including those with blank Company ID Parameters Name
Type
Description
whereClauseXXXDef
String
The criteria XXX Def
whereClauseXXXChunk
String
The criteria XXX Chunk
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns GenXData DataSet.
GetVersion This method will require the primary unique index fields locate the xxxdef record and return the "version" field value. Parameters
902
Name
Type
Description
ipCompanyID
String
The company id value to return version for.
ipProductID
String
The product id value to return version for.
ipTypeCode
String
The type code value to return version for.
ipCGCCode
String
The CSF Code.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
ipKey1
String
The key1 value to return version for.
ipKey2
String
The key2 value to return version for.
ipKey3
String
The key3 value to return version for.
opVersion
String@
The returned version value.
opRecordExists
Boolean@
Logical to state whether the XXXDef record exists.
StoreData This methods should be ran instead of the base Update method. This method will require the dataset to come in, next it will delete all XXXChunk records associated with each ttXXXDef in the dataset while also deleting the XXXDef records in the database. Next the ttXXXDef table will be the driving force behind the creation of new XXXDef and XXXChunk records in the database. The values for the fields in these records will come from what is in the dataset. This 'StoreData' process is basically a complete 'overlay' of the Generic Large Data data. This method will require that all dataset records have a value of 'A' in the corresponding rowident field/column. Parameters Name
Type
ds
Description GenXData DataSet.
GetAmortization Epicor.Mfg.BO.GetAmortization: This business object contains 10 methods.
GetNewInvcDtlRasch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
903
F-L
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BuildAmortizationsLists This method returns four possible lists of selected Deferred Revenue Amortization Schedules (ttInvcDtlRASch). This should be called to return a list containing the key fields of selected InvcDtlRASch records. Since each record has three key fields the list could potentially exceed the maximum allowed length of characters. To avoid this runtime error, the list will be split into four lists if needed. Parameters Name
Type
Description
opInvRASchList1
String@
The first list of selected InvcDtlRASch records
opInvRASchList2
String@
The second list of selected InvcDtlRASch records
opInvRASchList3
String@
The third list of selected InvcDtlRASch records
opInvRASchList4
String@
The fourth list of selected InvcDtlRASch records
opReasonMsg
String@
Warning message to indicate if Hold Reason is required
ds
904
GetAmortization Dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetAmortizations This method returns the ttInvcDtlRASch dataset of Deferred Revenue Amortization Schedule with some calculated columns added. Parameters Name
Type
Description
ipCustList
String
The Customer Number list to filter the records with
ipInvList
String
The Invoice Number list to filter the records with
ipContList
String
The Service Contract Number list to filter the records with
ipApplyDate
Nullable{System.DateTime} The Apply Date filter
ipShowStatus
String
If value is 'H', show records marked as On Hold; if 'U', show records Not On Hold; if 'B', show all.
ds
GetAmortization Dataset
GetCurrencyBase This method returns the Base Currency Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
GetContractRenewal Epicor.Mfg.BO.GetContractRenewal: This business object contains 8 methods. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
905
F-L
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BuildContractRenewalList This method returns three possible lists of selected Contract (FSContHd) and/or Renewal (FSRenewal) records. This should be called to return a list containing the key fields of selected records. Since each record has two key fields the list could potentially exceed the maximum allowed length of characters. To avoid this runtime error, the list will be split into three lists if needed. Parameters Name
Type
Description
opContRenewList1
String@
The first list of selected Contract/Renewal records
opContRenewList2
String@
The second list of selected Contract/Renewal records
opContRenewList3
String@
The third list of selected Contract/Renewal records
ds
906
GetContractRenewal Dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetRenewals This method returns the ttContractRenewal dataset consisting of expired or soon to expire contracts (FSContHd) and renewals (FSRenewal) mixed records with some calculated columns added. Parameters Name
Type
Description
ipCustList
String
The Customer Number list to filter the records with
ipTypeList
String
The Contract Type list to filter the records with
ipExpireDate
Nullable{System.DateTime} The Expire Date filter
ds
GetContractRenewal Dataset
getodbcnp Epicor.Mfg.BO.getodbcnp: This business object contains 1 methods.
GetODBCNP Get ODBC NP Parameters Name
Type
Description
opName
String@
OP Name
opPassword
String@
OP Password
GetRequest Epicor.Mfg.BO.GetRequest: This business object contains 10 methods.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CheckEmployee This method needs to be called from the main menu only. if the object is being called from the shop floor menu then the employee id has already been determined and validated and is passed in
Epicor 9.05 | 9.05.605
907
F-L
Business Object Reference Guide
Parameters Name
Type
Description
empID
String
Employee ID
empName
String@
Employee Name
GetNewEmpInfo Call this method to create a new Epicor.Mfg.BO.GetRequestDataSet with Job# Parameters Name
Type
Description
empID
String
Employee ID
ds
GetRequest Dataset
OnChangeAssembly Call this method to update the dataset when the GetRequest.AssemblySeq is changed RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
assemblySeq
Int32
AssemblySeq
ds
GetRequest Dataset
OnChangeCalcHours Call this method to update the dataset when the GetRequest.CalcHours is changed RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
hours
Decimal
Hours
ds
GetRequest DataSet
OnChangeCalcOption Call this method to update the dataset when the GetRequest.CalcOption is changed Valid values are "O" Outstanding, "P" - Pieces, "H" - hours CalcHours only enabled for "H" and CalcPieces only enabled for "P" RowMod must be "A" or "U" for this method to work
908
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
calcOption
String
calcOption
ds
GetRequest DataSet
OnChangeCalcPieces Call this method to update the dataset when the GetRequest.CalcPieces is changed RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
pieces
Decimal
Pieces
ds
GetRequest DataSet
OnChangeJobNum Call this method to update the dataset when the GetRequest.JobNum is changed RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
jobNum
String
JobNum
ds
GetRequest DataSet
OnChangeOpr Call this method to update the dataset when the GetRequest.OprSeq is changed RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
oprSeq
Int32
OprSeq
ds
GetRequest DataSet
ProcessLines Run this method when done updating all the detail lines (currently OK button in 6.1) clear screen when done Must set the GetRequest RowMod to "U" for this method to work
Epicor 9.05 | 9.05.605
909
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description GetRequest DataSet
GLAccount Epicor.Mfg.BO.GLAccount: This business object contains 13 methods.
GetNewGLAccount Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
910
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckActive Parameters Name
Type
Description
ipActive
Boolean
Proposed value of active
ds
The GLAccount data set
CheckEffFrom Parameters Name
Type
Description
ipEffFrom
Nullable{System.DateTime}
Effective From Date to validate
ds
The GLAccount data set
CheckEffTo Parameters Name
Type
Description
ipEffTo
String
Effective To Date to validate
ds
The GLAccount data set
DefaultsOnAdd Parameters Name
Type
Description
ipGLAccount
String
GL Account being added
ds
Epicor 9.05 | 9.05.605
The GLAccount data set
911
F-L
Business Object Reference Guide
GLAccountSearch Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ValidateAccount Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
glaccountmassadd Epicor.Mfg.BO.glaccountmassadd: This business object contains 8 methods.
GetNewglaccountmassadd Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
912
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MassAdd Parameters Name
Type
Description
coacode
String
COA Code for used chart of accounts
generationmode
Int32
Generation mode
overrideoption
Int32
Override option
ds createdcombinationnumber
glaccountmassadd dataset Int32@
Created Combination Number
GLAcctDisp Epicor.Mfg.BO.GLAcctDisp: This business object contains 7 methods.
GetNewGLAcctDisp Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
913
F-L
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
914
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GLAlcHed Epicor.Mfg.BO.GLAlcHed: This business object contains 10 methods.
GetNewGLAlcHed Inserts a new row in the DataSet with defaults populated.
GetNewGLAlcDtl Inserts a new row in the DataSet with defaults populated.
GetNewGLAlcDtlTGLC Inserts a new row in the DataSet with defaults populated.
GetNewGLAlcHedTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
915
F-L
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GlbAlert Epicor.Mfg.BO.GlbAlert: This business object contains 7 methods.
GetNewGlbAlert Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
916
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLBCOA Epicor.Mfg.BO.GLBCOA: This business object contains 9 methods.
GetNewGLBCOA Inserts a new row in the DataSet with defaults populated.
GetNewGLBCOASegment Inserts a new row in the DataSet with defaults populated.
GetNewGLBCOASegValues Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
917
F-L
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLBCOASegmentSearch Epicor.Mfg.BO.GLBCOASegmentSearch: This business object contains 7 methods.
GetNewGLBCOASegmentSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
918
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
919
F-L
Business Object Reference Guide
GLBCOASegValues Epicor.Mfg.BO.GLBCOASegValues: This business object contains 8 methods.
GetNewGLBCOASegValues Inserts a new row in the DataSet with defaults populated.
GetNewGLBCOASegOpt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
920
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLBCurrency Epicor.Mfg.BO.GLBCurrency: This business object contains 7 methods.
GetNewGlbCurrency Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
921
F-L
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLBCurrRateGrp Epicor.Mfg.BO.GLBCurrRateGrp: This business object contains 10 methods.
GetNewGlbCurrRateGrp Inserts a new row in the DataSet with defaults populated.
GetNewGlbCurrConvRule Inserts a new row in the DataSet with defaults populated.
GetNewGlbCurrExRate Inserts a new row in the DataSet with defaults populated.
GetNewGlbCurrRateDisp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
922
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GlbCustomerSearch Epicor.Mfg.BO.GlbCustomerSearch: This business object contains 7 methods.
GetNewGlbCustomer Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
923
F-L
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLBFiscalCalSearch Epicor.Mfg.BO.GLBFiscalCalSearch: This business object contains 7 methods.
GetNewGLBFiscalCalSearch Inserts a new row in the DataSet with defaults populated.
924
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
925
F-L
Business Object Reference Guide
GlbForecast Epicor.Mfg.BO.GlbForecast: This business object contains 10 methods.
GetNewGlbForecast Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
926
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AcceptGlbForecasts This method conditionally adds/overwrites Forecast records by copying the data out of GlbForecast records. Similar to the ImportForecasts routine, which takes in a dataset derived from a spreadsheet file. Parameters Name
Type
ds
Description GlbForecast Dataset of candidates for import.
pcImportOptions
String
Valid choices are "A"=Add+Replace, "C"=Clear+Reload, "N"=New.
plAllPlants
Boolean
If TRUE, clear all plants; if FALSE, clear Current Plant.
pdFromDate
Nullable{System.DateTime} Only records on or after the given date will be considered for import.
ClearGlbForecasts This method deletes all GlbForecast records for the Current Plant, or all Plants, on or after the given date. Parameters Name
Type
Description
plAllPlants
Boolean
If TRUE, clear all plants; if FALSE, clear Current Plant.
pdFromDate
Nullable{System.DateTime}
Only GlbForecast records on or after the given date will be deleted.
IsConfigurable Returns TRUE If any revision, or any revision of any child part in BOM, is/was configurable.
GlbGLAccount Epicor.Mfg.BO.GlbGLAccount: This business object contains 7 methods.
GetNewGlbGLAccount Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
927
F-L
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
928
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GlbGLAcctDisp Epicor.Mfg.BO.GlbGLAcctDisp: This business object contains 7 methods.
GetNewGlbGLAcctDisp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
929
F-L
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLBGLBook Epicor.Mfg.BO.GLBGLBook: This business object contains 7 methods.
GetNewGLBGLBook Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
930
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLBGLCOARefAcct Epicor.Mfg.BO.GLBGLCOARefAcct: This business object contains 7 methods.
GetNewGLBGLCOARefAcct Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
931
F-L
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLBGLCOARefType Epicor.Mfg.BO.GLBGLCOARefType: This business object contains 7 methods.
GetNewGLBGLCOARefType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
932
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GlbGLSyst Epicor.Mfg.BO.GlbGLSyst: This business object contains 7 methods.
GetNewGlbGLSyst Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
933
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLBJrnlCode Epicor.Mfg.BO.GLBJrnlCode: This business object contains 7 methods.
GetNewGLBJrnlCode Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
934
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLBook Epicor.Mfg.BO.GLBook: This business object contains 20 methods.
GetNewGLBook Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
935
F-L
Business Object Reference Guide
GetNewGLBookAttch Inserts a new row in the DataSet with defaults populated.
GetNewGLAccountMasks Inserts a new row in the DataSet with defaults populated.
GetNewBVRule Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
936
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeMainBook Re-set MainBook and MainBookID Parameters Name
Type
Description
ipNewMainBook
String
The new book Id flagged as Main
ds
The GLBook data set
CheckBookType Check value Parameters Name
Type
Description
ipBookType
Int32
The proposed Book
ipMainBook
Boolean
The flag for Main Book
CheckMainBook Check PartNum value
Epicor 9.05 | 9.05.605
937
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipBookType
Int32
The Book Type
ipMainBook
Boolean
The proposed flag for Main Book
FillACTTypes Create new MapBook. Parameters Name
Type
Description
trgBook
String
Target Book
srcBook
String
Source Book
linkID
Int32
linkID
ds
glBookDataSet
FillMapList Check value Parameters Name
Type
Description
srcBook
String
The proposed Source Book
trgBook
String
The proposed Source Book
mapList
String@
List of COA maps
GetNewLink Create new MapBook. Parameters Name
Type
Description
trgBook
String
Target Book
linkID
Int32
linkID
ds
glBookDataSet
OnChangeCurrencyCode Check to see if Currency can be changed
938
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipCurrencyCode
String
The Currency Code entered
ds
The GLBook data set
ValidateStdAccount Validate RE Account entered and define RE Account Description Parameters Name
Type
Description
ipCOACode
String
The COACode entered
ipGLAccount
String
The GL Account entered
ipSegValue1
String
Segment 1 value
ipSegValue2
String
Segment 2 value
ipSegValue3
String
Segment 3 value
ipSegValue4
String
Segment 4 value
ipSegValue5
String
Segment 5 value
ipSegValue6
String
Segment 6 value
ipSegValue7
String
Segment 7 value
ipSegValue8
String
Segment 8 value
ipSegValue9
String
Segment 9 value
ipSegValue10
String
Segment 10 value
ipSegValue11
String
Segment 11 value
ipSegValue12
String
Segment 12 value
ipSegValue13
String
Segment 13 value
ipSegValue14
String
Segment 14 value
ipSegValue15
String
Segment 15 value
ipSegValue16
String
Segment 16 value
ipSegValue17
String
Segment 17 value
ipSegValue18
String
Segment 18 value
ipSegValue19
String
Segment 19 value
ipSegValue20
String
Segment 20 value
upDescription
String@
Description of GL Account
upWarnMsg
String@
Warning message for self-balancing segments
Epicor 9.05 | 9.05.605
939
F-L
Business Object Reference Guide
WriteChgLog Write change log then book mapping is doing something with GL transaction types.. Parameters Name
Type
Description
actTypeUID
Int32
ACTType UID
oldRevUID
Int32
Old Revision
newRevUID
Int32
New revision
GLBookPerSearch Epicor.Mfg.BO.GLBookPerSearch: This business object contains 7 methods.
GetNewGLBookPer Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
940
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GlbPartSearch Epicor.Mfg.BO.GlbPartSearch: This business object contains 7 methods.
GetNewGlbPart Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
941
F-L
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GlbPerConSearch Epicor.Mfg.BO.GlbPerConSearch: This business object contains 7 methods.
GetNewGlbPerCon Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
942
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GlbTable Epicor.Mfg.BO.GlbTable: This business object contains 10 methods.
GetNewGlbTable Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
943
F-L
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
944
Name
Type
tableName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
fieldName
String
Description
Returns
GetAvailFields This method returns a delimited list of available fields for the specified table Parameters Name
Type
Description
cTableName
String
Table Name
cFieldList
String@
List of delimited fields for the selected table
OnChangeCompany This method automatically creates the GlbTable records once a company has been selected Parameters Name
Type
Description
cExtSystemID
String
System ID
cExtCompanyID
String
Company ID
ds
GlbTable DataSet
GlbVendorSearch Epicor.Mfg.BO.GlbVendorSearch: This business object contains 7 methods.
GetNewGlbVendor Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
945
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLCntrl Epicor.Mfg.BO.GLCntrl: This business object contains 11 methods.
GetNewGLCntrl Inserts a new row in the DataSet with defaults populated.
GetNewGLCntrlAcct Inserts a new row in the DataSet with defaults populated.
GetNewGLCntrlJrnl Inserts a new row in the DataSet with defaults populated.
946
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
947
F-L
Business Object Reference Guide
GetGLControlCodeDesc Method to call to retrieve the GL Control Code description. Parameters Name
Type
Description
inGLControlType
String
GL Control Type
inGLControlCode
String
GL Control Code
outDescription
String@
Description
ValidateAcctsJrnlCodes Validates an account has been entered for account contexts that are required. Validate all journal contexts have a journal code selected. Parameters Name
Type
Description
inGLControlType
String
GL Control Type
inGLControlCode
String
GL Control Code
outShowMsg
Boolean@
Show the message to the user
outMessage
String@
Message text
GLCntrlType Epicor.Mfg.BO.GLCntrlType: This business object contains 13 methods.
GetNewGLCntrlType Inserts a new row in the DataSet with defaults populated.
GetNewGLCTAcctCntxt Inserts a new row in the DataSet with defaults populated.
GetNewGLCTEntity Inserts a new row in the DataSet with defaults populated.
GetNewGLCTJrnlCntxt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
948
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeAllBooks Method to call when changing the AllBooks.
Epicor 9.05 | 9.05.605
949
F-L
Business Object Reference Guide
Parameters Name
Type
Description
proposedAllBooks
Boolean
AllBooks
ds
The GLCntrlType DataSet to update the AllBooks related data.
ChangeRequired Method to call when changing the Required. Parameters Name
Type
Description
proposedRequired
Boolean
Reguired
vGLControlType
String
GLControlType
vGLCTAcctNum
Int32
GLCTAcctNum
wmessage
String@
out put warning message.
ChangeUseMasterChart Method to call when changing the UseMasterChart. Parameters Name
Type
Description
proposedUseMasterChart
Boolean
UseMasterChart
ds
The GLCntrlType DataSet to update the UseMasterChart related data.
GLCntrlTypeSys Epicor.Mfg.BO.GLCntrlTypeSys: This business object contains 8 methods.
GetNewSysGLCntrlType Inserts a new row in the DataSet with defaults populated.
GetNewSysGLCTAcctCntxt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
950
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLCOARefAcct Epicor.Mfg.BO.GLCOARefAcct: This business object contains 10 methods.
GetNewGLCOARefAcct Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
951
F-L
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
952
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
CheckCOACode Checks COACode entered Parameters Name
Type
Description
ipCoaCode
String
COA code entered
ValidateCOACode returns a description and Master COA flag of the entered COA code Parameters Name
Type
Description
coaCode
String
COA code entered
coaDescription
String@
The description of the COA code entered.
coaMaster
Boolean@
list of available parent categories
GetDefaultCoa returns a COA code, Master flag and description of default COA code Parameters Name
Type
Description
defaultCoaCode
String@
default COA code
defaultCoaDescription
String@
The description of the default COA code .
isDefaultCoaMaster
Boolean@
the flaf to indicate if it is master COA code
GLCOARefType Epicor.Mfg.BO.GLCOARefType: This business object contains 10 methods.
GetNewGLCOARefType Inserts a new row in the DataSet with defaults populated.
GetNewGLCOARefAcct Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
953
F-L
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
954
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
DefaultCOACodeSegments Parameters Name
Type
Description
opCOACode
String@
COA to set combo box
opCOADesc
String@
COA Description to display in the combo box
opSegmentNbr
Int32@
Segment Number to set combo box
opSegmentName
String@
Segment Name to display in the combo box
opMasterCOA
String@
Indentifies the master coa
Name
Type
Description
ipCOACode
String
COA Code - Chart of Accounts
LookForRefEntities Parameters
GLCostTrans Epicor.Mfg.BO.GLCostTrans: This business object contains 1 methods.
GetRowsCustom Custom GetRows method. Parameters Name
Type
Description
glJrnDtlRowid
String
The GLJrnDtl Rowid
pageSize
Int32
Page size
absolutePage
Int32
Absolute page
morePages
Boolean@
More Pages?
Returns The GL Journal Detail data set
GLCTEntitySearch Epicor.Mfg.BO.GLCTEntitySearch: This business object contains 8 methods.
GetNewGLCTEntity Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
955
F-L
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
956
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ChangeTypeOnEntity Method to call to retrieve the GL Control Type description for an entity. This method is called when adding types to entities to validate the type does not already exist for the entity and to return the description for display purposes. Parameters Name
Type
Description
inGLControlType
String
GL Control Type
inRelatedToFile
String
Related To File
inKey1
String
Key1
inKey2
String
Key2
inKey3
String
Key3
inKey4
String
Key4
inKey5
String
Key5
inKey6
String
Key6
outDescription
String@
Description
GLDailyBalance Epicor.Mfg.BO.GLDailyBalance: This business object contains 11 methods.
GetNewGLAccountMasks Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
957
F-L
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CopyMasks This method copies all masks for a given COACode and Book to a list of Books. Parameters Name
Type
Description
ipCOACode
String
Chart Of Account Code
ipSourceBookID
String
Source Book ID
ipTargetBookIDList
String
Delimeter separated list of target Book IDs
Returns Returns all GLAccountMasks record for a given COACode
DeleteMasksByBook This method deletes all masks for a given COACode and Book.
958
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipCOACode
String
Chart Of Account Code
ipBookID
String
Book ID
Returns Returns all GLAccountMasks record for a given COACode
GetBooksForCOACode This method retrieves all records for table GLAccountMasks for a given COACode. Parameters Name
Type
Description
ipCOACode
String
Chart Of Account Code
Returns Returns all GLAccountMasks record for a given COACode
ValidateCOACode Validate the COA code against the COA table. If it is valid, retrieve all GLBooks with the specified COA code. Parameters Name
Type
Description
ipCOACode
String
COA Code to validate
GLJournalEntry Epicor.Mfg.BO.GLJournalEntry: This business object contains 28 methods.
GetNewGLJrnHed Inserts a new row in the DataSet with defaults populated.
GetNewGLJrnDtlMnl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
959
F-L
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AutoBalance This method will create a new line with the balancing figure defaulted into the appropriate debit or credit column if the current line has a non-zero balance. If the current line has zero debit/credit values then the debit/credit values of that line are updated with the balancing entry. Parameters
960
Name
Type
Description
groupID
String
The current group ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
journalNum
Int32
The current Journal Number
journalLine
Int32
The current Journal Line
ds
The GL Journal Entry data set
ChangeAllocID This method populates ttGlalocation table Parameters Name
Type
Description
ipAllocID
String
The proposed Allocation"
ipBookID
String
The proposed BookIK"
ds
The GL Journal Entry data set
ChangeExtCompanyID This method resets the regular and Multi-Company G/L Accounts and the Reference Codes when the External Company ID changes. Parameters Name
Type
Description
proposedExtCompID
String
The proposed External Company ID
ds
The GL Journal Entry data set
ChangeExtGLAcct This method resets the Multi-Company G/L Reference Type and Code when the Multi-Company G/L Account changes. Depending on the new Multi-Company GL account, the Multi-Company Reference Type/Code can become mandatory or optional. Make sure to call the GetMaskRefCodes method of the GLRefTypBusiness Object to get the new list of all GL Reference Codes related to the entered Account number. This method will also return values for GlJrnDtl.ExtRefCodeStatus and GlJrnDtl.ExtRefAcctDiv/ExtRefAcctDept/ExtRefAcctChart. Enable update of GlJrnDtl.ExtRefCode if the value returned for ExtRefCodeStatus is either "M" for Mandatory or "O" for Optional. Parameters Name ds
Type
Description The GL Journal Entry data set
ChangeExtGLRefCode This method updates the Multi-Company G/L Reference Type and Code Description when the Multi-Company GL Reference Code changes.
Epicor 9.05 | 9.05.605
961
F-L
Business Object Reference Guide
Parameters Name
Type
Description
proposedRefCode
String
The proposed Multi-Company G/L Reference Code
ds
The GL Journal Entry data set
ChangeGlAcct This method resets the G/L Reference Type and Code when the G/L Account changes. Depending on the new GL account, the Reference Type/Code can become mandatory or optional. Make sure to call the GetMaskRefCodes method of the GLRefTypBusiness Object to get the new list of all GL Reference Codes related to the entered Account number. This method will also return values for GlJrnDtl.RefCodeStatus and GlJrnDtl.RefAcctDiv/RefAcctDept/RefAcctChart. Enable update of GlJrnDtl.GLRefCode if the value returned for RefCodeStatus is either "M" for Mandatory or "O" for Optional. Parameters Name
Type
Description
ds
The GL Journal Entry data set
ChangeGlRefCode This method updates the G/L Reference Type and Code Description when the GL Reference Code changes. Parameters Name
Type
Description
proposedRefCode
String
The proposed G/L Reference Code
ds
The GL Journal Entry data set
ChangeMultiCompany This method resets the External Company ID, regular and Multi-Company G/L Accounts and the Reference Codes when the Multi-Company flag changes. Parameters Name
Type
Description
proposedMulti
Boolean
The proposed Multi-Company flag
ds
The GL Journal Entry data set
ChangeReverse This method defaults the Reverse Date when the Reverse flag is checked.
962
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
proposedReverse
Boolean
The proposed Reverse value
ds
The GL Journal Entry data set
CheckAllocations This procudura validata if there is Allocations for the Journal Book Parameters Name
Type
Description
ipBookID
String
The current COACode
opAlloc
Boolean@
The Allocation Flag
CheckCurrencyAccount This procudura validata if the Account is a currency Account Parameters Name
Type
Description
ipCOACode
String
The current COACode
ipSegValue
String
The current segment value one
opCurr
Boolean@
The Currency accont Flag
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
GroupID
keyValue2
String
BookID
keyValue3
String
FiscalYear
keyValue4
String
JournalCode
keyValue5
String
JournalNum
CheckDtlBeforeUpdate Before updating the GlJrnDtl record, CheckDtlBeforeUpdate will have to be called. The GroupID, JournalNum and JournalLine from the current GlJrnDtl record will have to be passed to this method. The CheckDtlBeforeUpdate method will pass back opMessage. - If opMessage is not equal to null then a Yes/No question will have to be
Epicor 9.05 | 9.05.605
963
F-L
Business Object Reference Guide
asked to the user displaying the message in opMessage. - If the user answers "Yes", then call the Update method to continue else stop update. Parameters Name
Type
Description
ds opMessage
The GL Journal Entry data set String@
The Message to ask the user if the changes for the linked Journal are okay.
ConvertCreditAmount This method convert the document currency to the journal currency. Parameters Name
Type
Description
proposedAmount
Decimal
The proposed Amount
ds
The GL Journal Entry data set
ConvertDebitAmount This method convert the document currency to the journal currency. Parameters Name
Type
Description
proposedAmount
Decimal
The proposed Amount
ds
The GL Journal Entry data set
CreateDetailLineFromAllocation Call this method when the user clicks OK on the allocation sheet. It will create journal entries using the allocation information entered. Parameters Name
Type
ds
Description The GL Journal Entry data set
journalNum
Int32
Current Journal Number
groupID
String
Current Group ID
allocID
String
Selected Allocation ID
GetByGroupID This method is called in place of the GetByID method, requiring only the the GL Group ID.
964
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
groupID
String
Current Group ID
Returns The GL Journal Entry data set
GetNewGlJrnHedTran This method is called in place of the GetNewGlJrnHed method. It allows the input of the Current Group so that certian fields on the header record can be defaulted from the group record. Parameters Name
Type
ds groupID
Description The GL Journal Entry data set
String
Current Group ID
PreUpdate This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
Boolean@
Indicates if the legal number requires user input
ds requiresUserInput
ValidateCurrencyAccount This procedure validate it the currency is allowed. Parameters Name
Type
Description
ipCOACode
String
The current COACode
ipSegValue
String
The current segment value one
ipCurrency
String
The proposed Currency value
Epicor 9.05 | 9.05.605
965
F-L
Business Object Reference Guide
GLJrnDtl Epicor.Mfg.BO.GLJrnDtl: This business object contains 8 methods.
GetNewGLJrnDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
966
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsFilterGLAcct Filter journals by gl acct. Calls normal getRows method and filters the GLJrnDtl table by the contents of the GLAccountList table. Parameters Name
Type
Description
balType
String
Balance Type B or T
whereClause
String
Whereclause.
ds
Epicor.Mfg.BO.GLAccountTrackerDataSet
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.GLJrnDtlDataSet
GLJrnGrp Epicor.Mfg.BO.GLJrnGrp: This business object contains 19 methods.
GetNewGLJrnGrp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
967
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeBookID Method to call when changing the Book.
968
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
proposeBookID
String
The proposed Book ID
ds
The GL Journal Group DataSet to update the Group related data.
ChangeEntryMode Method to call when changing the Entry Mode. Parameters Name
Type
Description
proposedBookMode
String
The proposed Entry Mode
ds
The GL Journal Group DataSet to update the Group related data.
ChangeFiscalPeriod Method to call when changing the Fiscal Period. Parameters Name
Type
Description
proposedFiscalPeriod
Int32
The proposed Fiscal Period
ds
The GL Journal Group DataSet to update the Group related data.
ChangeFiscalPeriodType Method to call when changing the Fiscal Period Type. Parameters Name
Type
Description
proposedPeriodType
String
The proposed Fiscal Period Type
ds opMessage
The GL Journal Group DataSet to update the Group related data. String@
Informational message indicating if the default fiscal year does not have any open closing periods
ChangeFiscalYear Method to call when changing the Fiscal Year.
Epicor 9.05 | 9.05.605
969
F-L
Business Object Reference Guide
Parameters Name
Type
Description
proposedFiscalYear
Int32
The proposed Fiscal Year
ds
The GL Journal Group DataSet to update the Group related data.
ChangeFiscalYearSuffix Method to call when changing the Fiscal Year Suffix. Parameters Name
Type
Description
proposedFiscalYearSuffix
String
The proposed Fiscal Year Suffix
ds
The GL Journal Group DataSet to update the Group related data.
ChangeRateType Method to call when changing the Rate Type. Parameters Name
Type
Description
proposedRateType
String
The proposed Rate Type
ds
The GL Journal Group DataSet to update the Group related data.
CheckFiscalYear Method to call before updating the journal group. This method will check the date that the user entered to verify it is in the current fiscal year and period. If it is not then opMessage will be assigned with message text. If it is then the Fiscal Period and Year will be updated. Parameters Name
Type
ds
Description General Ledger Journal Entry Data Entry Group control file.
cGroupID
String
Group Id field
cJEDate
Nullable{System.DateTime} JEDate proposed value
opMessage
String@
Contains text to present to the user of the date entered is not within the current fiscal year or period
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth.
970
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
keyValue
String
keyValue
PostGroupJournals Method to call when posting journal for a specific group. Posting of a group causes the GlJrnGrp to be deleted from the database if all the records in the group posted correctly. It will also cause the GlJrnHed record to be deleted after the specific journal is posted. Parameters Name
Type
Description
postGroupID
String
The group id of the group of journals to be posted
notAllPostedMessage
String@
Contains message text if not all journals in group were posted. The error message text is assigned to the GlJrnGrp.PostErrorLog
UnlockGroup Method to call to unlock a group record. This method should be called whenever the group no longer needs to be locked. The group no longer needs to be locked when the journal object is closed, or when a different group is selected. Parameters Name
Type
Description
inGroupID
String
The group id of the group record to unlock
GLJrnSrcSearch Epicor.Mfg.BO.GLJrnSrcSearch: This business object contains 7 methods.
GetNewTranGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
971
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GlobalInputVars Epicor.Mfg.BO.GlobalInputVars: This business object contains 7 methods.
GetNewPcInputs Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
972
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GLPeriodBalSearch Epicor.Mfg.BO.GLPeriodBalSearch: This business object contains 7 methods.
GetNewGLPeriodBal Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
973
F-L
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
974
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GLPurch Epicor.Mfg.BO.GLPurch: This business object contains 9 methods.
GetNewGLPurch Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
975
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetFinIntegStatus This method returns Financial Integration Status. Parameters Name
Type
Description
vItegStatus
Boolean@
Financial Integration Status
GLRptColSetSearch Epicor.Mfg.BO.GLRptColSetSearch: This business object contains 2 methods.
GetList This method returns the Data Schema records Parameters Name
Type
Description
whereClause
String
Where clause
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages
Returns GL dataset for Rpt report
GetRows This method returns the Data Schema records Parameters
976
Name
Type
Description
whereClause
String
Where clause
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages
Returns GL dataset for Rpt report
GlRptMas Epicor.Mfg.BO.GlRptMas: This business object contains 31 methods.
GetNewGlRptMas Inserts a new row in the DataSet with defaults populated.
GetNewGLRptCol Inserts a new row in the DataSet with defaults populated.
GetNewGlRptRow Inserts a new row in the DataSet with defaults populated.
GetNewGLRptRowAcct Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
977
F-L
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CategoryOrAccountsList Method to call to get the list for Category or Accounts option. The list is returned in code1`code desc1~code2`code desc2 format. Parameters
978
Name
Type
Description
categoryOrAccountsList
String@
The list of options for Category or Accounts
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ChangeGLRptColColSetID Method to call when the GLRptCol.ColSetID value changes. The ColSetID can only be changed for a new record. This method will reassign the ColSetID of the GLRptColSet record. Prior to calling this method, the GLRptColSet record that exists for the GLRptCol record needs to have the RowMod field set to 'U'. Parameters Name
Type
Description
proposedColSetID
String
The proposed column set id
ds
The GlRptMas data set
ChangeGLRptColColumnType Method to call to reset values in a GLRptCol record when the column type changes. Parameters Name
Type
Description
proposedColumnType
String
The proposed column type
ds
The GlRptMas data set
ChangeGLRptColIntervalType Method to call when the GLRptCol.IntervalType value changes. Parameters Name
Type
Description
proposedIntervalType
String
The proposed interval type value
ds
The GlRptMas data set
ChangeGLRptMasBookID Method to call when the GLRptMas.BookID value changes. Parameters Name
Type
Description
proposedBookID
String
The proposed book id
ds
The GlRptMas data set
ChangeGLRptRowCategoryOrAccounts Method to call to reset values in a GLRptRow record when the category or accounts option changes. Prior to calling this method, any GLRptRow subrecords that exist for the GLRptRow record need to have the RowMod
Epicor 9.05 | 9.05.605
979
F-L
Business Object Reference Guide
field set to 'U'. The subtables for GLRptRow are: GLRptRowAccounts, GLRptRowCharts, GLRptRowDepts, GLRptRowDivisions. Parameters Name
Type
Description
proposedCategoryOrAccounts
String
The proposed value
ds
The GlRptMas data set
ChangeGLRptRowLineType Method to call to reset values in a GLRptRow record when the line type changes. Prior to calling this method, any GLRptRow subrecords that exist for the GLRptRow record need to have the RowMod field set to 'U'. The subtables for GLRptRow are: GLRptRowAccounts, GLRptRowCharts, GLRptRowDepts, GLRptRowDivisions. Parameters Name
Type
Description
proposedLineType
String
The proposed column type
ds
The GlRptMas data set
ColumnTypeList Method to call to get the list of valid column types. The list is returned in code1`code desc1~code2`code desc2 format. Parameters Name
Type
Description
columnTypeList
String@
The list of valid column types
DeleteColSet Method to call to delete a column set for a financial report. This method delete the records in the column set and return the GlRptMas dataset. Parameters Name
Type
Description
deleteFromReportID
String
The report id to delete from
deleteColSetID
String
The column set to delete
ds
The GlRptMas data set
DuplicateFinancialReport Method to call to duplicate a financial report. This method will return the newly created records in the GlRptMas dataset.
980
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
duplicateFromReportID
String
The report id to duplicate from
newReportID
String
The new report id
newReportDesc
String
The new report description
newReportTitle
String
The new report title
ds
The GlRptMas data set
GetNewGLRptRowAcctForType Creates a new GLRptRowAcct record based on type. Parameters Name
Type
Description
reportID
String
Report ID
lineNum
Int32
Line number
rowAcctType
String
Row account type. Valid types are S - Single segment. A - Account.
ds
GLRptMas data set.
LineTypeList Method to call to get the list of valid line types. The list is returned in code1`code desc1~code2`code desc2 format. Parameters Name
Type
Description
lineTypeList
String@
The list of valid line types
MoveGLRptColDown Method to call to move a report column down within a column set. This method resequences the columns as appropriate and returns the updated dataset. Parameters Name
Type
Description
colReportID
String
The report id of the column to move down
colColSetID
String
The column set id of the column to move down
colColumnNum
Int32
The column number of the column to move down
colColSetSeq
Int32
The column sequence number of the column to move down
ds
Epicor 9.05 | 9.05.605
The GlRptMas data set
981
F-L
Business Object Reference Guide
MoveGLRptColUp Method to call to move a report column up within a column set. This method resequences the columns as appropriate and returns the updated dataset. Parameters Name
Type
Description
colReportID
String
The report id of the column to move up
colColSetID
String
The column set id of the column to move up
colColumnNum
Int32
The column number of the column to move up
colColSetSeq
Int32
The column sequence number of the column to move up
ds
The GlRptMas data set
ReportWizard Method to call to create a financial report using a wizard. The wizard will create a template report that be modified via the GlRptMas dataset. Parameters Name
Type
Description
reportID
String
The report id to create the template for
reportType
String
The type of report to create. Valid values are: B (Balance Sheet) or I (Income Statement)
ds
The GlRptMas data set
ReportWizardOptionsList Method to call to get the list of valid options for the report wizard. The list is returned in code1`code desc1~code2`code desc2 format. Parameters Name
Type
Description
reportWizardOptionsList
String@
The list of valid options
SyntaxCheck Method to call to check the syntax of a report. Syntax errors that occured will be stored in datatable GLRptSyntaxErrors. Parameters
982
Name
Type
Description
checkReportID
String
The report id to check the syntax of
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
syntaxCheckType
String
The type of syntax check to perform. Values are: I (Income Statment), B (Balance Sheet), or O (Other)
Returns The GlRptSyntaxErrors data set
SyntaxCheckOptionsList Method to call to get the list of valid options for the syntax check. The list is returned in code1`code desc1~code2`code desc2 format. Parameters Name
Type
Description
syntaxCheckOptionsList
String@
The list of valid options
ValidateGLRptRow Method to call to validate that accounts or charts have been added to a row. if applicable. If accounts or charts are required, an exception will be thrown. This method should be called prior to leaving the row for a different row. Parameters Name
Type
Description
reportID
String
The ReportID of the row
lineNum
Int32
The LineNum of the row
categoryOrAccounts
String
The CategoryOrAccounts option of the row
YesNoDefaultList Method to call to get the list of valid entries for Yes/No/Default options. The list is returned in code1`code desc1~code2`code desc2 format. Parameters Name
Type
Description
yesNoDefaultList
String@
The list of valid options
GLSyst Epicor.Mfg.BO.GLSyst: This business object contains 7 methods.
GetNewGLSyst Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
983
F-L
Business Object Reference Guide
Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
984
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GLTracker Epicor.Mfg.BO.GLTracker: This business object contains 5 methods.
GetFiscalPeriods Returns the Fiscal Year periods Parameters Name
Type
Description
ipBookID
String
Book ID if not specified values will be based on Company.FiscalCalendarID"
ipFiscalYear
Int32
Current Fiscal Year
ipFiscalYearSuffix
String
Current Fiscal Year Suffix
opFiscalPerStart
Int32@
start Fiscal Period
opFiscalPerEnd
Int32@
ending Fiscal Period
GetFiscalYear Returns the Current Fiscal Year Parameters Name
Type
Description
vBookID
String
Book ID if not specified values will be based on Company.FiscalCalendarID"
outFiscalYear
Int32@
Current Fiscal Year
outFiscalYearSuffix
String@
Current Fiscal Year Suffix
outFiscalPeriod
Int32@
Current Fiscal Period
GetRows This method replaces the standard GetRows method Parameters Name
Type
Description
vBookID
String
Book ID
vBalanceType
String
Balance Type P or T
vUseCarryFwdBal
Boolean
Use Carry Forward Balance
sBalanceAcct
String
Balance Account
fiscalYear
Int32
Fiscal Year
fiscalYearSuffix
String
Fiscal Year Suffix
Epicor 9.05 | 9.05.605
985
F-L
Business Object Reference Guide
Name
Type
Description
openBalance
Decimal@
Open Balance
Returns This table is used to document the temp table that is used with the G/L Account Tracker program.
GetRowsCurrBal Get currency balance rows for specifid balance account. Parameters Name
Type
Description
vBookID
String
Book ID
vTransCurrencyCode
String
Transactional CurrencyCode
vUseCarryFwdBal
Boolean
Use Carry Forward Balance
sBalanceAcct
String
Balance Account
fiscalYear
Int32
Fiscal Year
fiscalYearSuffix
String
Fiscal Year Suffix
Returns This table is used to document the temp table that is used with the G/L Account Tracker program.
GetRowsMultiple This method gets all the rows for a group of glaccounts specified GLAccount table Parameters Name
Type
Description
vBookID
String
Book ID
vBalanceType
String
Balance Type
vUseCarryFwdBal
Boolean
Use Carry Forward Balance
fiscalYear
Int32
Fiscal Year
fiscalYearSuffix
String
Fiscal Year Suffix
ds
Epicor.Mfg.BO.GLAccountTrackerDataSet
Returns Epicor.Mfg.BO.GLTrackerDataSet
GLTransMatch Epicor.Mfg.BO.GLTransMatch: This business object contains 11 methods.
GetNewGLJrnDtlMatching Inserts a new row in the DataSet with defaults populated.
986
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
987
F-L
Business Object Reference Guide
GetMatchCodes This method allows users to search for previously used Match Codes. Parameters Name
Type
Description
ipMatchCode
String
The MatchCode used to select transactions
ipMatchDate
Nullable{System.DateTime}
The MatchDate used to select transactions
ipBookID
String
The BookID used to select transactions
Returns GLTransMatch dataset
GetMatchingTransactions This method fills the GLTransMatch dataset with all transactions with a particular MatchCode/Date/BookID. Parameters Name
Type
Description
ipMatchCode
String
The MatchCode used to select transactions
ipMatchDate
Nullable{System.DateTime}
The MatchDate used to select transactions
ipBookID
String
The BookID used to select transactions
Returns GLTransMatch dataset
GetNextMatchCode This method gets the next Match Code. Parameters Name
Type
Description
opMatchCode
String@
The next MatchCode
RemoveMatchCode This method removes the match code from GLJrnDtl records. Returns GLTransMatch dataset
988
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Chapter 8: H HelpDesk Epicor.Mfg.BO.HelpDesk: This business object contains 75 methods.
GetNewHDCase Inserts a new row in the DataSet with defaults populated.
GetNewHDCaseAttch Inserts a new row in the DataSet with defaults populated.
GetNewHDCaseLink Inserts a new row in the DataSet with defaults populated.
GetNewHDContact Inserts a new row in the DataSet with defaults populated.
GetNewHDCaseMaintReq Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
989
F-L
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
990
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CreateFSCall Create a Field Service call from this Help Desk Case. Parameters Name
Type
Description
helpDeskCaseNum
Int32
The Help Desk case number to use as a source
callCode
String
The call code to be used for the Field Service call
newCallNum
Int32@
The created call's call number
validPackingSlip
Boolean@
Is the Packing Slip Valid
ds
Epicor 9.05 | 9.05.605
Help Desk data set
991
F-L
Business Object Reference Guide
CreateJob Create a Job from this Help Desk Case. PartNum must be populated before calling this method, as it is required on a Job The HDCase in the database will be used for this call. Parameters Name
Type
Description
helpDeskCaseNum
Int32
The Help Desk case number to use as a source
optionTool
String
Action Menu Option
newJobNum
String@
The created Job's job number
ds
Help Desk data set
CreateMaintReq Create a Request from this Help Desk Case. Parameters Name
Type
Description
helpDeskCaseNum
Int32
The Help Desk case number to use as a source
newReqID
String@
The created Request ID
ds
Help Desk data set
CreateOrder Create a quote from this Help Desk Case. CustNum must be populated before calling this method, as it is required on a quote The HDCase in the database will be used for this call. Parameters Name
Type
Description
helpDeskCaseNum
Int32
The Help Desk case number to use as a source
orderPONum
String
The PO number to use on the order. (This may be required by the customer)
newOrderNum
Int32@
The created order's order number
ds
Help Desk data set
CreateQuote Create a quote from this Help Desk Case. CustNum must be populated before calling this method, as it is required on a quote The HDCase in the database will be used for this call.
992
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
helpDeskCaseNum
Int32
The Help Desk case number to use as a source
newQuoteNum
Int32@
The created quote's quote number
ds
Help Desk data set
CreateRMA Create an RMA from this Help Desk Case. CustNum must be populated before calling this method, as it is required on an RMA The HDCase in the database will be used for this call. Parameters Name
Type
Description
helpDeskCaseNum
Int32
The Help Desk case number to use as a source
newRMANum
Int32@
The created RMA's RMA number
ds
Help Desk data set
GetAvailTaskSets Get the topics to make available as children to a given topic. For top level topics, pass in a blank parentTopicID For all topics pass in "ReturnFullTopicList" Parameters Name
Type
Description
whereClause
String@
Where clause to be built for the use of TaskSetCombo
ds
Help Desk data set
GetChildTopics Get the topics to make available as children to a given topic. For top level topics, pass in a blank parentTopicID For all topics pass in "ReturnFullTopicList" Parameters Name
Type
Description
parentTopicID
String
The parent topic or "" for top level topics.
childList
String@
A delimited list of topics
GetNewHDCaseSearch Get a blank set of search parameters
Epicor 9.05 | 9.05.605
993
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ds
Epicor.Mfg.BO.HDCaseSearchDataSet
GetRowsContactTracker Called from Contact tracker instead of GetRows for better performance Parameters Name
Type
Description
whereClauseHDCase
String
Whereclause for HDCase table.
contactName
String
The contact to return data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Help Desk Contact Trk DataSet
HelpDeskSearch Perform a search of the helpdesk and/or knowledgebase cases Parameters Name
Type
Description
ds
Epicor.Mfg.BO.HDCaseSearchDataSet
Returns Epicor.Mfg.BO.HDCaseListDataSet
OnChangeAttrCodeList Get the defaults from the AttrCodeList field on the HDCase record. Parameters Name
Type
ds proposedAttrCodeList
Description Help Desk data set
String
The proposed AttrCodeList
OnChangeBuyerID This method should be called when BuyerID change.
994
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
buyerID
String
BuyerID
ds
Help Desk data set
OnChangeCallLine Get the defaults from the CallLine field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedCallLine
Int32
The proposed CallLine
getDefaults
Boolean
Assign any fields related to CallLine
OnChangeCallNum Get the defaults from the CallNum field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedCallNum
Int32
The proposed CallNum
getDefaults
Boolean
Assign any fields related to CallNum
OnChangeCaseOwner Get the defaults from the CaseOwner field on the HDCase record. Parameters Name
Type
ds proposedCaseOwner
Description Help Desk data set
String
The proposed CaseOwner
OnChangeCaseTopics Get the defaults 10 Topics fields
Epicor 9.05 | 9.05.605
995
F-L
Business Object Reference Guide
Parameters Name
Type
ds proposedCaseTopics
Description Help Desk data set
String
The proposed case topics delimited with spaces
OnChangeCaseTypeID Get the defaults for the Case Type on HDCase. Parameters Name
Type
ds proposedCaseTypeID
Description Help Desk data set
String
The proposed CaseTypeID
OnChangeContractNum Get the defaults from the ContractNum field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedContractNum
Int32
The proposed ContractNum
getDefaults
Boolean
Assign any fields related to ContractNum
OnChangeCustID Get the defaults from the CustID field on the HDCase record. This will set: The Customer Contact Parameters Name
Type
ds
Description Help Desk data set
proposedCustID
String
The proposed Customer ID
getDefaults
Boolean
Assign any fields related to CustID
OnChangeEmpID This method should be called when EmpID change.
996
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
empID
String
EmpID
ds
Help Desk data set
OnChangeEquipID This method should be called when EquipID change. Parameters Name
Type
Description
equipID
String
equipID
ds
Help Desk data set
OnChangeHDCaseSearch Validates the search fields Parameters Name
Type
Description
ds
Epicor.Mfg.BO.HDCaseSearchDataSet
OnChangeInvoiceLine Get the defaults from the InvoiceLine field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedInvoiceLine
Int32
The proposed InvoiceLine
getDefaults
Boolean
Assign any fields related to InvoiceLine
OnChangeInvoiceNum Get the defaults from the InvoiceNum field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedInvoiceNum
Int32
The proposed InvoiceNum
getDefaults
Boolean
Assign any fields related to InvoiceNum
Epicor 9.05 | 9.05.605
997
F-L
Business Object Reference Guide
OnChangeMktgCampaignID Get the defaults from the MktgCampaignID field on the HDCase record. Parameters Name
Type
ds proposedMktgCampaignID
Description Help Desk data set
String
The proposed MktgCampaignID
OnChangeMktgEvntSeq Get the defaults from the MktgEvntSeq field on the HDCase record. Parameters Name
Type
ds proposedMktgEvntSeq
Description Help Desk data set
Int32
The proposed MktgEvntSeq
OnChangeName This method should be called when Name change. Parameters Name
Type
Description
ipName
String
Name
ds
Help Desk data set
OnChangeOrderLine Get the defaults from the OrderLine field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedOrderLine
Int32
The proposed OrderLine
getDefaults
Boolean
Assign any fields related to OrderLine
OnChangeOrderNum Get the defaults from the OrderNum field on the HDCase record.
998
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Help Desk data set
proposedOrderNum
Int32
The proposed OrderNum
getDefaults
Boolean
Assign any fields related to OrderNum
OnChangeOrderRelNum Get the defaults from the OrderRelNum field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedOrderRelNum
Int32
The proposed OrderRelNum
OnChangePartNum Get the defaults from the PartNum field on the HDCase record. Parameters Name
Type
Description
ds
Help Desk data set
proposedPartNum
String@
The proposed PartNum
getDefaults
Boolean
Assign any fields related to PartNum
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
OnChangePerConLnkRowID This method should be called when PerConLnkRowID change. Parameters Name
Type
Description
ipPerConLnkRowID
String
PerConLnkRowID
Epicor 9.05 | 9.05.605
999
F-L
Business Object Reference Guide
Name
Type
ds
Description Help Desk data set
OnChangePrcConNum Get the defaults from the PrcConNum field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedPrcConNum
Int32
The proposed PrcConNum
proposedPrcCustNum
Int32
The proposed PrcCustNum
proposedPrcShipToNum
String
The proposed PrcShipToNum
OnChangeProjectID Validate the ProjectID record. Parameters Name
Type
ds proposedProjectID
Description Help Desk data set
String
The proposed ProjectID
OnChangePurPoint Get the defaults from the PurPoint field on the HDCase record. Parameters Name
Type
ds proposedPurPoint
Description Help Desk data set
String
The proposed PurPoint
OnChangePurPointConNum Get the defaults from the PurPointConNum field on the HDCase record. Parameters Name
Type
ds
1000
Description Help Desk data set
proposedPurPointConNum
Int32
The proposed PurPointConNum
proposedPurPoint
String
The proposed PurPoint
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
proposedVendorNum
Int32
The proposed VendorNum
OnChangeQuantity Calculate de Ext Price when Quantity Change Parameters Name
Type
Description
proposedQuantity
Decimal
The proposed UnitPrice
ds
Help Desk data set
OnChangeQuantityUOM Calculate de Unit Price when change Parameters Name
Type
Description
proposedQuantityUOM
String
The proposed QuantityUOM
ds
Help Desk data set
OnChangeQuoteLine Get the defaults from the QuoteLine field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedQuoteLine
Int32
The proposed QuoteLine
getDefaults
Boolean
Assign any fields related to QuoteLine
OnChangeQuoteNum Get the defaults from the QuoteNum field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedQuoteNum
Int32
The proposed QuoteNum
getDefaults
Boolean
Assign any fields related to QuoteNum
Epicor 9.05 | 9.05.605
1001
F-L
Business Object Reference Guide
OnChangeReqPerConID Get the defaults from the ReqPerConID field on the HDCase record. Parameters Name
Type
ds proposedReqPerConID
Description Help Desk data set
Int32
The proposed Person Contact ID
OnChangeReqPerConLnkRowID Get the defaults from the ReqPerConLnkRowID field on the HDCase record. Parameters Name
Type
ds proposedReqPerConLnkRowID
Description Help Desk data set
String
The proposed Person Contact Link ID
OnChangeRevisionNum Get the defaults from the RevisionNum field on the HDCase record. Parameters Name
Type
ds proposedRevisionNum
Description Help Desk data set
String
The proposed RevisionNum
OnChangeRMALine Get the defaults from the RMALine field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedRMALine
Int32
The proposed RMALine
getDefaults
Boolean
Defaults
OnChangeRMANum Get the defaults from the RMANum field on the HDCase record.
1002
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Help Desk data set
proposedRMANum
Int32
The proposed RMANum
getDefaults
Boolean
Defaults
OnChangeSearchCaseTopics Get the defaults 10 Topics fields Parameters Name
Type
Description
ds proposedCaseTopics
The Help Desk search data set String
The proposed case topics delimited with spaces
OnChangeSearchTopics Get the defaults 10 Topics fields Parameters Name
Type
ds
Description The Help Desk search data set
proposedTopicID1
String
The proposed TopicID1
proposedTopicID2
String
The proposed TopicID2
proposedTopicID3
String
The proposed TopicID3
proposedTopicID4
String
The proposed TopicID4
proposedTopicID5
String
The proposed TopicID5
proposedTopicID6
String
The proposed TopicID6
proposedTopicID7
String
The proposed TopicID7
proposedTopicID8
String
The proposed TopicID8
proposedTopicID9
String
The proposed TopicID9
proposedTopicID10
String
The proposed TopicID10
OnChangeSerialNumber Get the defaults from the SerialNumber field on the HDCase record.
Epicor 9.05 | 9.05.605
1003
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description Help Desk data set
proposedSerialNumber
String
The proposed SerialNumber
getDefaults
Boolean
Assign any fields related to SerialNumber
proposedPartNum
String
The proposed PartNum
opMessage
String@
The error message
OnChangeShipToNum Get the defaults from the ShipToNum field on the HDCase record. Parameters Name
Type
ds proposedShipToNum
Description Help Desk data set
String
The proposed ShipToNum
OnChangeShpConNum Get the defaults from the ShpConNum field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedShpConNum
Int32
The proposed ShpConNum
proposedShipToNum
String
The proposed ShipToNum
proposedShpCustNum
Int32
The proposed ShpCustNum
OnChangeTopics Get the defaults 10 Topics fields Parameters Name
Type
ds
1004
Description Help Desk data set
proposedTopicID1
String
The proposed TopicID1
proposedTopicID2
String
The proposed TopicID2
proposedTopicID3
String
The proposed TopicID3
proposedTopicID4
String
The proposed TopicID4
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
proposedTopicID5
String
The proposed TopicID5
proposedTopicID6
String
The proposed TopicID6
proposedTopicID7
String
The proposed TopicID7
proposedTopicID8
String
The proposed TopicID8
proposedTopicID9
String
The proposed TopicID9
proposedTopicID10
String
The proposed TopicID10
OnChangeUnitPrice Calculate de Ext Price Parameters Name
Type
Description
proposedUnitPrice
Decimal
The proposed UnitPrice
ds
Help Desk data set
OnChangeVenConNum Get the defaults from the PrcConNum field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedVenConNum
Int32
The proposed VenConNum
proposedVendorNum
Int32
The proposed CustNum
proposedPurPoint
String
The proposed PurPoint
OnChangeVendorID Get the defaults from the VendorID field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedVendorID
String
The proposed VendorID
getDefaults
Boolean
Assign any fields related to VendorID
OnChangeWarrantyCode Get the defaults from the WarrantyCode field on the HDCase record.
Epicor 9.05 | 9.05.605
1005
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description Help Desk data set
helpDeskCaseNum
Int32
Current Help Desk Case Number
proposedPackNum
Int32
The proposed PackNum
proposedPackLine
Int32
The proposed PackLine
proposedDropShipPackSlip
String
The proposed Drop Shipment Pack Slip
proposedDropShipPackLine
Int32
The proposed Drop Shipment Pack Line
getDefaults
Boolean
Assign any fields related to Packing Slip
OnChangeWFGroupID Get the defaults from the WFGroupID field on the HDCase record. Parameters Name
Type
ds
Description Help Desk data set
proposedWFGroupID
String
The proposed WFGroupID
OpenCloseCase This method either opens or closes a Case and returns the updated object Parameters Name
Type
Description
hdCaseNum
Int32
HDCaseNum to be opened or closed
closeCase
Boolean
Yes to close Case, no to open Case
Returns Returns the newly opened/closed Case
PreOpenCloseCase This method is to be run befor the OpenCloseCase method so that any questions that need to be asked before the OpenCloseCase method can run can be asked Parameters
1006
Name
Type
Description
hdCaseNum
Int32
The current HDCase.HDCaseNum field
closeCase
Boolean
Yes to close Case, no to open Case
vMessage
String@
Returns a string containing the question to be asked
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
HelpDeskTopic Epicor.Mfg.BO.HelpDeskTopic: This business object contains 9 methods.
GetNewHDTopic Inserts a new row in the DataSet with defaults populated.
GetNewHDTopicParent Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1007
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeTopicParentID Validate that the ParentTopicID isn't a duplicate. Parameters Name
Type
ds parentTopicID
Description The HelpDeskTopic data set
String
Parent Topic ID to be validated
HXProjectSearch Epicor.Mfg.BO.HXProjectSearch: This business object contains 7 methods.
GetNewHXProject Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1008
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1009
F-L
Business Object Reference Guide
Chapter 9: I ICommCode Epicor.Mfg.BO.ICommCode: This business object contains 7 methods.
GetNewICommCode Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1010
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ICReceiptSearch Epicor.Mfg.BO.ICReceiptSearch: This business object contains 8 methods.
GetNewIMRcvHead Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1011
F-L
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsCustom This overload of AfterGetRows filters the Dataset for the criteria Parameters Name
Type
Description
whereClause
String
The criteria
poNum
Int32
PONum - Purchase Order Number
poLine
Int32
POLine - Line
poRel
Int32
PORel - Release
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the Receipts list
IMAPInvoice Epicor.Mfg.BO.IMAPInvoice: This business object contains 13 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMAPInvHed Inserts a new row in the DataSet with defaults populated.
1012
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetNewIMAPInvDtl Inserts a new row in the DataSet with defaults populated.
GetNewIMAPInvMsc Inserts a new row in the DataSet with defaults populated.
GetNewIMAPIHAPInvMsc Inserts a new row in the DataSet with defaults populated.
GetNewIMAPInvTax Inserts a new row in the DataSet with defaults populated.
GetNewIMEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1013
F-L
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMAPPayment Epicor.Mfg.BO.IMAPPayment: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMAPTran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1014
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMARInvoice Epicor.Mfg.BO.IMARInvoice: This business object contains 11 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMInvcHead Inserts a new row in the DataSet with defaults populated.
GetNewIMInvcDtl Inserts a new row in the DataSet with defaults populated.
GetNewIMInvcMisc Inserts a new row in the DataSet with defaults populated.
GetNewIMInvcTax Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1015
F-L
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
1016
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
IMARPayment Epicor.Mfg.BO.IMARPayment: This business object contains 9 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMCashHead Inserts a new row in the DataSet with defaults populated.
GetNewIMCashDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1017
F-L
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMCurrConvRule Epicor.Mfg.BO.IMCurrConvRule: This business object contains 7 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMCurrConvRule Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1018
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
IMCurrency Epicor.Mfg.BO.IMCurrency: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMCurrency Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1019
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMCurrExRate Epicor.Mfg.BO.IMCurrExRate: This business object contains 7 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMCurrExRate Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
1020
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
IMCurrRateDisp Epicor.Mfg.BO.IMCurrRateDisp: This business object contains 7 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMCurrRateDisp Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1021
F-L
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
IMCurrRateGrp Epicor.Mfg.BO.IMCurrRateGrp: This business object contains 7 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
1022
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetNewIMCurrRateGrp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1023
F-L
Business Object Reference Guide
IMCustCnt Epicor.Mfg.BO.IMCustCnt: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMCustCnt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1024
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMCustomer Epicor.Mfg.BO.IMCustomer: This business object contains 9 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMCustomer Inserts a new row in the DataSet with defaults populated.
GetNewIMEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
1025
F-L
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMGLJournal Epicor.Mfg.BO.IMGLJournal: This business object contains 10 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMGLJrnHed Inserts a new row in the DataSet with defaults populated.
GetNewIMGLJrnDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
1026
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
1027
F-L
Business Object Reference Guide
Returns
IMPart Epicor.Mfg.BO.IMPart: This business object contains 10 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMPart Inserts a new row in the DataSet with defaults populated.
GetNewIMEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1028
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
IMPerCon Epicor.Mfg.BO.IMPerCon: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMPerCon Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
1029
F-L
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMPO Epicor.Mfg.BO.IMPO: This business object contains 10 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMPOHeader Inserts a new row in the DataSet with defaults populated.
1030
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetNewIMPODetail Inserts a new row in the DataSet with defaults populated.
GetNewIMPORel Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1031
F-L
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMPOChangeSuggestion Epicor.Mfg.BO.IMPOChangeSuggestion: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMSugPOChg Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1032
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMPORequisition Epicor.Mfg.BO.IMPORequisition: This business object contains 9 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMReqHead Inserts a new row in the DataSet with defaults populated.
GetNewIMReqDetail Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1033
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ImportEDIDocs Epicor.Mfg.BO.ImportEDIDocs: This business object contains 10 methods.
CalcTaxes Parameters
1034
Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
AddAllOrderRels Invoke this procedure to mark the OrderRels for creating during the posting proceess Parameters Name
Type
ds
Description The ImportEDI data set
AddNoneOrderRels Invoke this procedure to mark the Order Releases NOT to be created during the Posting process. Parameters Name
Type
ds
Description The ImportEDI data set
AfterReviewDocs Invoke this procedure to re-count the number of Orders to Import after reviewing. Parameters Name
Type
ds
Description The ImportEDI data set
GetEDINetChange Use this method after the user has imported the data. To populate the EDINetChange report table Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Epicor.Mfg.BO.ImportEDIDocsDataSet
1035
F-L
Business Object Reference Guide
Returns Epicor.Mfg.BO.EDINetChgDataSet
GetExternalFile Call this procedure to read external EDI file. Parameters Name
Type
Description
translatorID
String
Input EDI Translator
ds
Output ImportEDI data set
Use this method when the user enters the screen. It defaults the EDI Translator and EDI Document type. Returns Output ImportEDI data set
ImportEDIDocs Import EDI documents. Parameters Name
Type
ds
Description Output ImportEDI data set
OnChangeofDocumentType Execute or call this method when the EDI Document Type has changed. Parameters Name
Type
Description
newDocType
String
New document type.
ds
The ImportEDI data set
PostingEDIDocs Posting EDI Documents. Parameters Name ds
1036
Type
Description The ImportEDI data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ImportSubsid Epicor.Mfg.BO.ImportSubsid: This business object contains 13 methods.
GetNewConsImport Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1037
F-L
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GroupChangeWarning Parameters Name
Type
Description
ipBook
String
book id
ds warnMsg
ImportSubsid dataset row String@
A warning message is returned if the book changes and the gljrngrp exists.
GetBookCalendar Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckGroupID Parameters Name
Type
Description
ipGroupID
String
Journal Group to Create for this import
ds opCreateGroup
ImportSubsid dataset row String@
prompt asking if it is okay to create the group
CheckFiscalYear Method to call when validating fiscal year Parameters
1038
Name
Type
Description
proposedFiscalYear
Int32
The proposed Fiscal Year
proposedSuffix
String
The proposed Fiscal Year suffix
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
ipCalendar
String
Calendar ID
CheckFiscalPeriod This method provides a warning message to present to the user if the given Fiscal Year/Period has already been imported. The user should be given the choice to import it again. The user's answer to the question "This fiscal period has previously been imported. Do you want to import it again?" should be stored in MCConGen.OkToRegenerate. In v6.10 Vantage, the user was never warned of a duplicate import--the system just quietly did as it was told. An exception is thrown if: - no MCConGen dataset row is found - the given Fiscal Year/Period is not valid Parameters Name
Type
Description
ipFiscalPeriod
Int32
fiscal period to validate
ds pcMsg
ImportSubsid dataset row String@
A warning message is returned if the given Fiscal Year/Period has already been imported.
GenerateJournal This method generates Journal Entries from a MCConsolImport dataset. It is expected that the UI will first read a file from disk to create the MCConsolImport dataset. Each row in the MCConsolImport dataset that fails to "import" gets updated with the reason for the failure in MCConsolImport.ImportErrorMsg, and these are returned to the client; if there are any technical failures, such as improper datatypes in the input, all the non-failing rows are backed out, and an exception is thrown. Less serious failures, such as "Account not found", prevent only the import of the problematic line--the remainder can still be accepted. When successful, a MCConGen record is created in the database to indicate the consolidation was performed. An exception is thrown if: - the GLJrnGrp indicated by the GroupId is nto found - the fiscal period indicated by the GLJrnGrp is invalid - the filename is blank Parameters Name
Type
Description
ds
ImportSubsid dataset row
ds1
MCConsolImport dataset
IMPOSuggestion Epicor.Mfg.BO.IMPOSuggestion: This business object contains 9 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMSugPODtl Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1039
F-L
Business Object Reference Guide
GetNewIMSugPOMsc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
1040
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The dataset with list of errors occured during update process.
IMPurPoint Epicor.Mfg.BO.IMPurPoint: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMVendorPP Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1041
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMPurTerms Epicor.Mfg.BO.IMPurTerms: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMPurTerms Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
1042
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMReceipt Epicor.Mfg.BO.IMReceipt: This business object contains 10 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMRcvHead Inserts a new row in the DataSet with defaults populated.
GetNewIMRcvDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1043
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
1044
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns
IMReceiptLine Epicor.Mfg.BO.IMReceiptLine: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMReceiptLine Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1045
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMRFQSuggestion Epicor.Mfg.BO.IMRFQSuggestion: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMRFQSugg Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
1046
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMShipment Epicor.Mfg.BO.IMShipment: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMShipHead Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1047
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMShipTo Epicor.Mfg.BO.IMShipTo: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMShipTo Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
1048
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1049
F-L
Business Object Reference Guide
IMSupplier Epicor.Mfg.BO.IMSupplier: This business object contains 9 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMVendor Inserts a new row in the DataSet with defaults populated.
GetNewIMEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1050
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMSupplierContact Epicor.Mfg.BO.IMSupplierContact: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMVendCnt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
1051
F-L
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IMTerms Epicor.Mfg.BO.IMTerms: This business object contains 8 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
GetNewIMTerms Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
1052
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
IncomeTax Epicor.Mfg.BO.IncomeTax: This business object contains 8 methods.
GetNewIncomeTax Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
1053
F-L
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeIncomeTaxType BL performed when user propose a new IncomeTaxType value
1054
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipIncomeTaxType
String
Proposed Income Tax Type
ds
IncomeTax Dataset
IncomeTaxRate Epicor.Mfg.BO.IncomeTaxRate: This business object contains 7 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1055
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetNewIncomeTaxRateCustom Create a New ttIncomeTaxRate record with a given Effective Date Parameters Name
Type
Description
ipEffectiveDate
Nullable{System.DateTime}
Effective Date
ds
IncomeTaxRate Dataset
IncomeTaxYr Epicor.Mfg.BO.IncomeTaxYr: This business object contains 28 methods.
GetNewIncomeTaxYr Inserts a new row in the DataSet with defaults populated.
GetNewIncomeTaxYrAttch Inserts a new row in the DataSet with defaults populated.
GetNewIncomeTaxPer Inserts a new row in the DataSet with defaults populated.
GetNewIncomeTaxPerAttch Inserts a new row in the DataSet with defaults populated.
GetNewIncomeTaxPerCalc Inserts a new row in the DataSet with defaults populated.
GetNewIncomeTaxPerTran Inserts a new row in the DataSet with defaults populated.
GetNewIncomeTaxYrCalc Inserts a new row in the DataSet with defaults populated.
1056
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetNewIncomeTaxYrTran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
1057
F-L
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
Calculate Performs all necessary operations in order to get a Income Tax Calculation for a given period/year. Parameters Name
Type
Description
ipFiscalCalendarID
String
Fiscal Calendar ID
ipFiscalYear
Int32
Fiscal Year
ipFiscalYearSuffix
String
Fiscal Year Suffix
ipFiscalPeriod
Int32
Fiscal Period, this value is zero when it is about a Fiscal Year
ChangeCalculatedAmount Updates the amounts that should by the change of one. Parameters Name
Type
Description
ipFiscalCalendarID
String
Fiscal Calendar ID
ipFiscalYear
Int32
Fiscal Year
ipFiscalYearSuffix
String
Fiscal Year Suffix
ipFiscalPeriod
Int32
Fiscal Period, this value is zero when it is about a Fiscal Year
ipSeq
Int32
Sequence
ipAmount
Decimal
Proposed Amount
ChangeIncomeTaxPerFiscalPeriod Verifies whether the proposed Fiscal Period is a valid one Parameters Name
Type
Description
ipFiscalPeriod
Int32
Proposed Fiscal Period
ds
IncomeTaxYr data set
ChangeIncomeTaxPerUpdateRate Verifies whether the proposed Update Rate overrides the Fiscal Calendar Period Update Rate.
1058
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipUpdateRate
Decimal
Proposed UpdateRate
opOverrideFiscalCal
Boolean@
Returns a value of true or false
ds
IncomeTaxPer data set
ChangeIncomeTaxYrFiscalYear Verifies whether the proposed Fiscal Year is a valid one. Parameters Name
Type
Description
ipFiscalYear
Int32
Proposed Fiscal Year
ds
IncomeTaxYr data set
ChangeIncomeTaxYrFiscalYearSuffix Verifies whether the proposed Fiscal Year suffix is a valid one. Parameters Name
Type
Description
ipFiscalYearSuffix
String
Proposed Fiscal Year Suffix
ds
IncomeTaxYr data set
ChangeIncomeTaxYrUpdateRate Verifies whether the proposed Update Rate overrides the Fiscal Calendar Year Update Rate. Parameters Name
Type
Description
ipUpdateRate
Decimal
Proposed UpdateRate
opOverrideFiscalCal
Boolean@
Returns a value of true or false
ds
IncomeTaxYr data set
ClosePeriod Close Income Tax Period for update, validate first that previous period it's closed.
Epicor 9.05 | 9.05.605
1059
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipFiscalCalendarID
String
Fiscal Calendar ID
ipFiscalYear
Int32
Fiscal Year
ipFiscalYearSuffix
String
Fiscal Year Suffix
ipFiscalPeriod
Int32
Fiscal Period, this value is zero when it is about a Fiscal Year
ds
The Income Tax Workbench data set
CloseYear Close Income Tax Year for update, validate first that previous period it's closed. Parameters Name
Type
Description
ipFiscalCalendarID
String
Fiscal Calendar ID
ipFiscalYear
Int32
Fiscal Year
ipFiscalYearSuffix
String
Fiscal Year Suffix
ds
The Income Tax Workbench data set
GetFiscalCalendar Returns data according to the Fiscal Calendar defined in Company for Income Taxes Returns Fiscal Calendar IDFiscal YearFiscal Year SuffixFiscal Period
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
RecalcFromTransactions Recalculates the Income Taxes when after existing IT transactions are updated by the user. Parameters
1060
Name
Type
Description
ipFiscalCalendarID
String
Fiscal Calendar ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
ipFiscalYear
Int32
Fiscal Year
ipFiscalYearSuffix
String
Fiscal Year Suffix
ipFiscalPeriod
Int32
Fiscal Period, this value is zero when it is about a Fiscal Year
ReopenPeriod Reopen Income Tax Period for update, validate first that later period it's open. Parameters Name
Type
Description
ipFiscalCalendarID
String
Fiscal Calendar ID
ipFiscalYear
Int32
Fiscal Year
ipFiscalYearSuffix
String
Fiscal Year Suffix
ipFiscalPeriod
Int32
Fiscal Period, this value is zero when it is about a Fiscal Year
ds
The Income Tax Workbench data set
ReopenYear Reopen Income Tax Year for update, validate first that later period it's open. Parameters Name
Type
Description
ipFiscalCalendarID
String
Fiscal Calendar ID
ipFiscalYear
Int32
Fiscal Year
ipFiscalYearSuffix
String
Fiscal Year Suffix
ds
The Income Tax Workbench data set
IndClassCodeSearch Epicor.Mfg.BO.IndClassCodeSearch: This business object contains 7 methods.
GetNewICCode Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
1061
F-L
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
1062
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Indirect Epicor.Mfg.BO.Indirect: This business object contains 8 methods.
GetNewIndirect Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1063
F-L
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ValidateIndirectCode This method validates the Indirect Labor code to ensure it's not in use by an active labor detail record. Parameters Name
Type
Description
newExpenseCode
String
Expense Code.
ds
Indirect Data set
IndustryClass Epicor.Mfg.BO.IndustryClass: This business object contains 8 methods.
GetNewICType Inserts a new row in the DataSet with defaults populated.
GetNewICCode Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1064
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
InfoPromptForm Epicor.Mfg.BO.InfoPromptForm: This business object contains 10 methods.
GetNewIPForm Inserts a new row in the DataSet with defaults populated.
GetNewIPFormBPAction Inserts a new row in the DataSet with defaults populated.
GetNewIPFormCtrl Inserts a new row in the DataSet with defaults populated.
GetNewIPFormCtrlValues Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
1065
F-L
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
1066
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
InspAttr Epicor.Mfg.BO.InspAttr: This business object contains 8 methods.
GetNewInspAttr Inserts a new row in the DataSet with defaults populated.
GetNewInspAttrAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1067
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
InspDataTracker Epicor.Mfg.BO.InspDataTracker: This business object contains 32 methods.
GetNewInspResults Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsChar Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsCharAttch Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsCheckBox Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsCheckBoxAttch Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsDate Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsDateAttch Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsNum Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsNumAttch Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsShortChar Inserts a new row in the DataSet with defaults populated.
1068
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetNewInspResultsShortCharAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
1069
F-L
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetDisplayColumns Generate Columns that will be displayed in the grid Parameters Name
Type
Description
inSpecID
String
The specification ID
inSpecRevNum
String
The specification revision number
inInspPlanPartNum
String
The inspection plan part number
inInspPlanRevNum
String
The inspection plan revision number
Returns
Returns
OnChangeInspType This method wil assign values depending the inspection type selection This method should be run when the InspDataParam.InspType field changes. Parameters Name
Type
Description
pcProposedInspType
String
The new proposed inspection type value
ds
The InspDataParam data set
OnChangeJobAsm This method validates the ProposedAssemblySeq, then updates related fields: This method should be run when the InspDataParam.AssemblySeq field changes.
1070
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
piProposedAssemblySeq
Int32
The new proposed Job Assembly value
ds
The InspDataParam data set
OnChangeJobNum This method validates the JobNum, then updates related fields: This method should be run when the InspDataParam.JobNum field changes. Parameters Name
Type
Description
pcProposedJobNum
String
The new proposed JobNum value
ds
The InspDataParam data set
OnChangeJobOpr This method validates the piProposedOprSeq, then updates related fields: This method should be run when the InspDataParam.OprSeq field changes. Parameters Name
Type
Description
piProposedOprSeq
Int32
The new proposed Job Operation Sequence value
ds
The InspDataParam data set
OnChangeNCMID This method validates the non conformance transaction ID, then updates related fields This method should be run when the InspDataParam.NCMTranID field changes. Parameters Name
Type
Description
pcProposedNCMTranID
Int32
The new proposed NCMTranID value
ds
The InspDataParam data set
OnChangePackSlip This method validates the piProposedPackSlip, then updates related fields. This method should be run when the InspDataParam.PackSlip field changes.
Epicor 9.05 | 9.05.605
1071
F-L
Business Object Reference Guide
Parameters Name
Type
Description
piProposedPackSlip
String
The new proposed PackSlip value
ds
The InspDataParam data set
OnChangePartNum This method validates the piProposedPartNum, then updates related fields. This method should be run when the InspDataParam.PartNum field changes. Parameters Name
Type
Description
piProposedPartNum
String
The new proposed PartNum value
ds
The InspDataParam data set
RetrieveValues Retrieve records that will be displayed in the grid. Parameters Name
Type
Description
ds
The InspDataParam data set
Returns
GetCurrentPlanRev To return the default inspection plan revision Parameters Name
Type
ipInspPlan
String
Description
Returns
GetCurrentSpecRev To return the default specification revision Parameters
1072
Name
Type
ipSpecID
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns
GetInspPlanRevs To return the revList values of a given inspection plan Parameters Name
Type
ipPartNum
String
Description
Returns
GetSpecRevs To return the revList values of a given specification Parameters Name
Type
ipSpecID
String
Description
Returns
Inspectr Epicor.Mfg.BO.Inspectr: This business object contains 7 methods.
GetNewInspectr Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
1073
F-L
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
InspPlan Epicor.Mfg.BO.InspPlan: This business object contains 12 methods.
GetNewInspPlan Inserts a new row in the DataSet with defaults populated.
GetNewInspPlanRev Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1074
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
Epicor 9.05 | 9.05.605
Description
1075
F-L
Business Object Reference Guide
Name
Type
fieldName
String
Description
Returns
DuplicateRevision To create a new InspPlaRev by duplicating from another. Parameters Name
Type
Description
sourcePartNum
String
Existing Part number that will be duplicated.
sourceRevNum
String
Existing Revision number that will be duplicated.
targetRevNum
String
New Revision number that will be duplicated.
Returns The InspPlan Data Set
OnChangeFromRev To set if duplicate option is allowed. Parameters Name
Type
Description
sourcePartNum
String
Existing Part number that will be duplicated.
sourceRevNum
String
Existing Revision number that will be duplicated.
oKToDuplicate
Boolean@
OKToDuplicate.
ValidatePlanNum Parameters Name
Type
Description
ipProposedPlanNum
String
The new proposed InspPlanNum value
ds
The Inspection Plan Dataset.
InspPlanRevSearch Epicor.Mfg.BO.InspPlanRevSearch: This business object contains 7 methods.
GetNewInspPlanRev Inserts a new row in the DataSet with defaults populated.
1076
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1077
F-L
Business Object Reference Guide
InspProcessing Epicor.Mfg.BO.InspProcessing: This business object contains 35 methods.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AssignInspectorFar To assign an Inspector to the First Article. Validates the Inspector against the database and assigns it to the ttTable Parameters Name
Type
Description
pcInspectorID
String
(optional) The Inspector ID typed in by the user.
ds
Inspection Processing dataset.
AssignInspectorNonConf To assign an Inspector to the non conformance(s). Validates the Inspector against the database and assigns it to the ttTable Parameters Name
Type
Description
pcInspectorID
String
(optional) The Inspector ID typed in by the user.
ds
1078
Inspection Processing dataset.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
AssignInspectorReceipt To assign an Inspector to the PO Recipt(s). Validates the Inspector against the database and assigns it to the ttTable Parameters Name
Type
Description
pcInspectorID
String
(optional) The Inspector ID typed in by the user.
ds
Inspection Processing dataset.
CheckSerialNumCount This method provides a message suitable for prompting the user to approve a mismatch between the number of serial numbers selected and the quantity being inspected. Note that this mismatch is not always allowed; the prompt is only offered when: 1) there is a quantity mismatch AND 2) the situation is one that permits the mismatch, if the user approves. This method should be run just before any of the following: InspectMaterial InspectOperation InspectInventory InspectReceipt If the pcMsg parameter comes back non-empty, present its contents to the user as a Yes or No question. Example: "Number of selected Serial Numbers does not match passed quantity. Serial Numbers selected: num_1 Total Serial Numbers required: num_2 Continue with quantity discrepancy?" ***** Important ***** Important ***** The user is answering the question "Continue with quantity discrepancy?". Therefore, if the user answers "NO", set the EnforceSerialNumCount field to YES. and if the user answers "YES", set the EnforceSerialNumCount field to NO An exception is thrown if: - the InspNonConf or InspRcpt row with a RowMod of "A" or "U" is not found Parameters Name
Type
Description
ds
Inspection Processing dataset.
pcSource
String
"NonConf" or "Receipt"
pcMsg
String@
A message suitable for prompting the user
ConvQtysToBase Convert Quantities to base qtys for serial number processing Parameters Name
Type
Description
pcPartNum
String
AcceptUM.
piQuantity
Int32
dimQuantity.
piPassedQty
Int32
dimPassedQty.
piFailedQty
Int32
dimFailedQty.
pcAcceptUM
String
AcceptUM.
piBaseQty
Int32@
dimQuantity converted to Part.IUM.
piBasePassQty
Int32@
dimPassedQty converted to Part.IUM.
Epicor 9.05 | 9.05.605
1079
F-L
Business Object Reference Guide
Name
Type
Description
piBaseFailQty
Int32@
dimFailedQty converted to Part.IUM.
GetByID To retrieve the Inspection non conformance (InspProcessing dataset) corresponding to the given TranID and the Operations tab or the Materials tab of the Inspections Processing screen in Vantage v6.10. Parameters Name
Type
Description
pcTranID
Int32
The TranID of the NonConformance.
Returns Inspection Processing dataset.
GetDateUser This method puts a date/time/user stamp in the text value for the user Parameters Name
Type
Description
pText
String@
Text
GetFailedLegalNumGenOpts This method will return a record in the LegalNumGenOpts datatable if a legal number is required for the failed transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds
Description Inspection Processing dataset.
inspectionType
String
The type of inspection: Inventory, Material, Operation, Receipt
requiresUserInput
Boolean@
Indicates if the legal number requires user input
GetFirstArtByID To retrieve the Inspection FirstArt (InspProcessing dataset) corresponding to the given JobNum, AssemblySeq, OprSeq, ResourceID, and SeqNum and the First Article tab of the Inspections Processing screen in Vantage v6.10.
1080
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
pcJobNum
String
The JobNum of the First Article.
piAssemblySeq
Int32
The AssemblySeq of the First Article.
piOprSeq
Int32
The OprSeq of the First Article.
pcResourceID
String
The ResourceID of the First Article.
piSeqNum
Int32
The SeqNum of the First Article.
Returns Inspection Processing dataset.
GetInspRcptSelectedSerialNumbers This method will populate the SelectedSerialNumber datatable for the InspRcpt RowIdent. Parameters Name
Type
Description
pcInspRcptRowIdent
String
Input RowIdent field of InspRcpt datatable
ds
Inspection Processing dataset.
GetInspResultsPassFail This method will get the passed/failed quantity from InspResults for Non Conformance Parameters Name
Type
Description
ds
Inspection Processing dataset.
ipSource
String
"NonConf", "Receipt", "FirstArt"
totPassed
Int32@
Total Passed Quantity.
totFailed
Int32@
Total Failed Quantity.
inspDataEntered
Boolean@
Inspection Data Found.
GetNonConfPartTranPKs Return Primary Keys for generated PartTran records. Parameters Name
Type
Description
ipNonConfID
Int32
ipNonConfID
ipDMRNum
Int32
DMR number
ipPassedIssueTo
String
PassedIssueTo
Epicor 9.05 | 9.05.605
1081
F-L
Business Object Reference Guide
Name
Type
Description
partTranPKs
String@
The PartTranPKs number
GetPassedLegalNumGenOpts This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
ds
Inspection Processing dataset.
inspectionType
String
The type of inspection: Inventory, Material, Operation, Receipt
requiresUserInput
Boolean@
Indicates if the legal number requires user input
GetReceiptByID To retrieve the Inspection Receipt (InspProcessing dataset) corresponding to the given VendorNum, PurPoint, PackSlip, and PackLine and the Receipts tab of the Inspections Processing screen in Vantage v6.10. Parameters Name
Type
Description
piVendorNum
Int32
The VendorNum of the Receipt.
pcPurPoint
String
The PurPoint of the Receipt.
pcPackSlip
String
The PackSlip of the Receipt.
piPackLine
Int32
The PackLine of the Receipt.
Returns Inspection Processing dataset.
GetReceiptPartTranPKs Return Primary Keys for generated PartTran records. Parameters
1082
Name
Type
Description
ipVendorNum
Int32
Vendor number
ipPurPoint
String
PurPoint
ipPackSlip
String
PackSlip
ipPackLine
Int32
PackLine
ipDMRNum
Int32
DMR number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
ipPassedIssueTo
String
PassedIssueTo
partTranPKs
String@
The PartTranPKs number
GetRows To retrieve the list of items waiting to be inspected (InspProcList dataset). This combines onto one screen the browses shown on the various tabs of Inspection Processing screen in Vantage v6.10. Note that three of the six tabs are NonConformances, one is First Articles, one is Receipts (from either POs or SubContracted operations) and one is for RMAs. In Vantage v6.10, the columns showing for each tab are different from those in the other tabs; an attempt has been made here to include "identifying" columns. This should allow a GetByID() call to load the appropriate sheet for any of the different types. There is an input parameter for each of these types, for which there should be a corresponding checkbox. The rows for a given type will only be fetched if its corresponding input is TRUE. Parameters Name
Type
Description
plOperation
Boolean
If TRUE, include items that were sent to Inspection from a Job Operation.
plMaterial
Boolean
If TRUE, include items that were sent to Inspection from a Job Material.
plInventory
Boolean
If TRUE, include items that were sent to Inspection from Inventory.
plFirstArt
Boolean
If TRUE, include items that were sent to Inspection from a First Article.
plReceipt
Boolean
If TRUE, include items that were sent to Inspection from a PO or SubContract receipt.
plRMA
Boolean
If TRUE, include items that were sent to Inspection from an RMA.
pcInspectorID
String
(optional) The Inspector ID typed in by the user.
whereClauseNonConf
String
(optional)Additional Where conditions for NonConf table.
whereClauseFirstArt
String
(optional)Additional Where conditions for FirstArt table.
whereClauseRcvDtl
String
(optional)Additional Where conditions for RcvDtl table.
whereClauseRMA
String
(optional)Additional Where conditions for RMAHead table.
whereClauseSelectedSerialNumbers String
(optional)Additional Where conditions for SelectedSerialNumbers table.
whereClauseSNFormat
String
(optional)Additional Where conditions for SNFormat table.
whereClauseInspProcList
String
(optional)Additional Where conditions to be applied to result set.
pageSize
Int32
Page Size
absolutePage
Int32
Absolute page
Epicor 9.05 | 9.05.605
1083
F-L
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Returns TRUE if there are more pages.
Returns Inspection Processing dataset.
GetSelectedSerialNumbers This method will populate the SelectedSerialNumber datatable for the InspNonConf RowIdent. Parameters Name
Type
Description
pcInspNonConfRowIdent
String
Input RowIdent field of InspNonConf datatable
ds
Inspection Processing dataset.
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
Description
ds
Inspection Processing data set
Returns The SelectSerialNumbersParams dataset
InspectFirstArt To process an inspection of First Article (InspFirstArt datatable). Corresponds to the First Articles tab of the Inspections Processing screen in Vantage v6.10. Use this method where you would typically use the Update() method, when the item being inspected is a First Article. Parameters Name
Type
Description
ds
Inspection Processing dataset.
InspectInventory To process an inspection of Inventory-related non conformances (NonConf dataset). Corresponds to the Inventory tab of the Inspections Processing screen in Vantage v6.10. Use this method where you would typically use the Update() method, when the item being inspected is an Inventory Material. Parameters
1084
Name
Type
Description
legalNumberMessage
String@
The legal number message
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
iDMRNum
Int32@
The DMR number for the new DMR.
ds
Inspection Processing dataset.
InspectMaterial To process an inspection of JobMaterial-related non conformances (NonConf dataset). Corresponds to the Material tab of the Inspections Processing screen in Vantage v6.10. Use this method where you would typically use the Update() method, when the item being inspected is an Inventory Material. Parameters Name
Type
Description
legalNumberMessage
String@
The legal number message
iDMRNum
Int32@
The DMR number for the new DMR.
ds
Inspection Processing dataset.
InspectOperation To process an inspection of Operations-related non conformances (NonConf dataset). Corresponds to the Operations tab of the Inspections Processing screen in Vantage v6.10. Use this method where you would typically use the Update() method, when the item being inspected is a Job Assembly / Job Operation. Parameters Name
Type
Description
legalNumberMessage
String@
The legal number message
iDMRNum
Int32@
The DMR number for the new DMR.
ds
Inspection Processing dataset.
InspectReceipt To process an inspection of Receipt, either a PO or SubContract. Corresponds to the PO Receipts tab of the Inspections Processing screen in Vantage v6.10. Use this method where you would typically use the Update() method, when the item being inspected is a PO Receipt. Parameters Name
Type
Description
legalNumberMessage
String@
The legal number message
iDMRNum
Int32@
The DMR number for the new DMR.
iNonConfID
Int32@
The new Nonconformance number created for the new DMR.
ds
Epicor 9.05 | 9.05.605
Inspection Processing dataset.
1085
F-L
Business Object Reference Guide
OnChangeAssemblySeq This method validates the piProposedAssemblySeq, then clears the related fields. This method should be run when the Assembly Seq field changes. An exception is thrown if: - the proposed Assembly Seq does not exist for the given Assembly Parameters Name
Type
ds
Description Inspection Processing dataset.
pcSource
String
"NonConf" or "Receipt"
piProposedAssemblySeq
Int32
The new proposed Assembly Seq value
OnChangeFailedQty This method validates the pdProposedFailedQty, then if zero, clears the related fields. This method should be run when the FailedQty field changes. An exception is thrown if: - Passed Quantity + Failed Quantity greater than the original quantity Parameters Name
Type
ds
Description Inspection Processing dataset.
pcSource
String
"NonConf" or "Receipt"
pdProposedFailedQty
Decimal
The new proposed Failed Quantity value
OnChangeFAInspectedQty This routine is for First Article inspections only. Gives a warning message if the proposed Inspected Quantity is less than the Expected Quantity. This method should be run when the ttInspFirstArt.InspectedQuantity field changes. An exception is thrown if: - No added or modified row is found in the dataset. Parameters Name
Type
ds
Description Inspection Processing dataset.
pdInspectedQuantity
Decimal
The new proposed Inspected Quantity value
pcWarningMsg
String@
If the Quantity is less than the Expected Quantity, a warning message will be present here.
OnChangeIssueComplete For use only with Receipt Inspections This method checks for a conflict among: - the quantity passing inspection, - the remaining quantity needed, - the IssuedComplete field in the dataset (aka a checkbox on the screen), - the IssuedComplete flag stored on the JobMtl or JobOper record If a conflict is found, this routine returns: - text intended for prompting the user to give their okay - the name of the field in the dataset in which to put the user's Okay/NotOkay response. There are four possible scenarios where the user may be asked to confirm an
1086
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
unusual action: 1) Issuing to a JobMtl that had been marked complete, and now the user indicates it is no longer considered complete. Text for prompt returned (may be translated): "The Job Material requirement is Closed... do you really want it reopened?" Field in which to record the user's response: IsOkToReopenJobMtl 2) Issuing to a JobMtl that would still need more quantity, but the user indicates it is considered complete. Text for prompt returned (may be translated): "Quantity issued is less than requirement... Are you sure you want to close this material requirement?" Field in which to record the user's response: IsOkToCloseJobMtl 3) Issuing to a SubContract that had been marked complete, and now the user indicates it is no longer considered complete. Text for prompt returned (may be translated): "The Subcontract operation is complete... do you really want it reopened?" Field in which to record the user's response: IsOkToReopenSubContract 4) Issuing to a SubContract that would still need more quantity, but the user indicates it is considered complete. Text for prompt returned (may be translated): "Quantity issued is less than requirement... Are you sure you want to close this subcontract operation?" Field in which to record the user's response: IsOkToCloseSubContract This method should be run when the InspRcpt.IssuedComplete field changes. An exception is thrown if: Parameters Name
Type
ds
Description Inspection Processing dataset.
pcSource
String
"NonConf" or "Receipt"
plProposedIssuedComplete
Boolean
The new proposed Issued Complete value
pcWarningMsg
String@
If there is a conflict, a warning message will be present here.
pcResponseField
String@
If the Job is closed, a warning message will be present here.
OnChangeJobNum This method validates the pcProposedJobNum, then clears the job-related fields. This method should be run when the InspRcpt.JobNum field changes. An exception is thrown if: - No Job exists with the given Job Number Parameters Name
Type
ds
Description Inspection Processing dataset.
pcSource
String
"NonConf" or "Receipt"
pcProposedJobNum
String
The new proposed Job Number value
pcWarningMsg
String@
If the Job is closed, a warning message will be present here.
OnChangeJobSeq For use only with Receipt Inspections. For Inventory Inspections, see OnChangeMtlSeq(). This method validates the piProposedJobSeq, then clears the job-related fields. The JobSeq field holds a JobMtl.MtlSeq when passing inspection to a Job Material. The JobSeq field holds a JobOper.OprSeq when passing inspection to a Job Operation. This method should be run when the InspRcpt.JobSeq field changes. An exception is thrown if: - No related JobMtl or JobOper exists with the given Job sequence number.
Epicor 9.05 | 9.05.605
1087
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description Inspection Processing dataset.
piProposedJobSeq
Int32
The new proposed Job Sequence Number value
pcWarningMsg
String@
If the user needs to be informed of some condition, a warning message will be present here.
OnChangeMtlSeq For use only with Inventory Inspections. For Receipt Inspections, see OnChangeJobSeq(). This method validates the pcProposedMtlSeq, then provides the defaults for the material-related fields. This method should be run when the InsNonConf.MtlSeq field changes. An exception is thrown if: - No related JobMtl exists with the given sequence number. Parameters Name
Type
ds
Description Inspection Processing dataset.
piProposedMtlSeq
Int32
The new proposed Material Sequence Number value
pcWarningMsg
String@
If the user needs to be informed of some condition, a warning message will be present here.
OnChangePassedIssueTo This method validates the pcProposedIssueTo, then sets the default values of the related fields. This method should be run when the PassedIssueTo field changes. Only Inventory and Receipt Inspections offer a choice of where to send items passing inspection--so the others have no need for this routine. An exception is thrown if: - the proposed PassedIssueTo is not valid. If this is a radio set as in v6.10, only a programming error could ever lead to an exception. Parameters Name
Type
ds
Description Inspection Processing dataset.
pcSource
String
"NonConf" or "Receipt"
pcProposedIssueTo
String
The new proposed PassedIssueTo value
OnChangePassedQty This method validates the pdProposedPassedQty, then if zero, clears the related fields. This method should be run when the PassedQty field changes. An exception is thrown if: - Passed Quantity + Failed Quantity greater than the original quantity
1088
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Inspection Processing dataset.
pcSource
String
"NonConf" or "Receipt"
pdProposedPassedQty
Decimal
The new proposed Passed Quantity value
OnChangePassedWhse This method validates the WarehouseCode, then, if valid, calls for the procedure to to bring a primary bin for this Warehose (if defined). This method should be run when the PassedWarehouseCode field or FailedWarehouseCode field are changed by the user. An exception is thrown if: - WarehouseCode entered is not valid Parameters Name
Type
ds
Description Inspection Processing dataset.
pcSource
String
"NonConf" or "Receipt"
pcWhseType
String
"Passed" or "Failed"
pdProposedWhse
String
The new proposed Passed Warehouse
InspResults Epicor.Mfg.BO.InspResults: This business object contains 46 methods.
GetNewInspResults Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsAttch Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsChar Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsCharAttch Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsCheckBox Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsCheckBoxAttch Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1089
F-L
Business Object Reference Guide
GetNewInspResultsDate Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsDateAttch Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsNum Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsNumAttch Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsShortChar Inserts a new row in the DataSet with defaults populated.
GetNewInspResultsShortCharAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
1090
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GenerateResults Generate Sample List Parameters Name
Type
ds
Description The InspParam data set
callProgram
String
The calling program
key1
String
Key1 of existing records
key2
String
Key2 of existing records
key3
String
Key3 of existing records
key4
String
Key4 of existing records
Epicor 9.05 | 9.05.605
1091
F-L
Business Object Reference Guide
Name
Type
Description
key5
String
Key5 of existing records
dateStamp
String
DateStamp of existing records
timeStamp
Int32
TimeStamp of existing records
inspPlanNum
String
Inspection Plan Number.
inspRevNum
String
Inspection Revision Number.
specID
String
Specification ID.
specRevNum
String
Specification revision number.
inspectQty
Int32
Inspection Quantity.
ds1
The InspSampleLst data set
GetInspParams Parameters
1092
Name
Type
Description
callProgram
String
The calling program
callInspType
String
The calling inspection type
tgtRowID
String
The rowid of the calling inspection record
inNCMTranID
Int32
The calling program
inNCMTranType
String
The calling program
inJobNum
String
The calling program
inAsmSeq
Int32
The calling program
inOprSeq
Int32
The calling program
inPartNum
String
The calling program
inRevisionNum
String
The calling program
inRMANum
Int32
The calling program
inRMALine
Int32
The calling program
inRMAReceipt
Int32
The calling program
inRMADisp
Int32
The calling program
inRMADispType
String
The calling program
inWhseCode
String
The calling program
inVendorNum
Int32
The calling program
inPurPoint
String
The calling program
inPackSlip
String
The calling program
inPackLine
Int32
The calling program
inSerialNum
String
The calling program
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
inLotNum
String
The calling program
inQty
Decimal
The calling program
inResourceID
String
ResourceID from the calling program
inSeqNum
Int32
SeqNum from the calling program
Returns
ValidateSerialAfterSelect Validates after calling SN selection screen Parameters Name
Type
Description
ds
InspParam data set
ConvQtysToBase Convert Quantities to base qtys for serial number processing Parameters Name
Type
Description
pcPartNum
String
AcceptUM.
piQuantity
Int32
dimQuantity.
piPassedQty
Int32
dimPassedQty.
piFailedQty
Int32
dimFailedQty.
pcAcceptUM
String
AcceptUM.
piBaseQty
Int32@
dimQuantity converted to Part.IUM.
piBasePassQty
Int32@
dimPassedQty converted to Part.IUM.
piBaseFailQty
Int32@
dimFailedQty converted to Part.IUM.
GetInspPlanPartNum Parameters Name
Type
ds
Description The InspParam data set
GetInspQty Get the inspection quantity for the given quantity
Epicor 9.05 | 9.05.605
1093
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The InspParam data set
GetPassedFailed Parameters Name
Type
Description
relatedRowID
String
RowID of the InspResults record
inspType
String
inspection Type
passedSetting
Boolean@
Returns InspResults.Passed value
GetLaborSelectedSerialNumbers This method will populate the SelectedSerialNumber datatable for the InspNonConf RowIdent. Parameters Name
Type
Description
pcLaborRowIdent
String
Input RowIdent field of InspNonConf datatable
ds
Inspection Param dataset.
GetRMASelectedSerialNumbers This method will populate the SelectedSerialNumber datatable Parameters Name
Type
Description
pcRowIdent
String
Input RowIdent field of InspNonConf datatable
ds
Inspection Param dataset.
ValidateSerialBeforeSelect Call before allowing the select of serial numbers Parameters Name
Type
ds
1094
Description InspParam data set
notEnoughSerials
String@
Not enough serials for labor entry
totSNReq
Decimal@
Total number of serials required for labor entry
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds enableCreate
Description Inspection Param data set
Boolean
Enable create serial numbers
Returns The SelectSerialNumbersParams dataset
GetRMASelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds
Description RMADisp data set
Returns The SelectSerialNumbersParams dataset
GetSpecID Parameters Name
Type
ds
Description The InspParam data set
OnChangeInspPlan This method validates the Proposed InspPlanPartNum, then updates related fields: This method should be run when the InspPlanSampleLst.InspPlanNum field changes. Parameters Name
Type
Description
piProposedInspPlan
String
The new proposed inspection plan part num value
ds
The InspParam data set
UpdateSelectedSN This method updates passed/failed value on selectedserialnumbers.
Epicor 9.05 | 9.05.605
1095
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ds
The InspPlanSampleLst data set
ds1
The InspParam data set
OnChangeInspType This method wil assign values depending the inspection type selection This method should be run when the InspParam.InspType field changes. Parameters Name
Type
Description
pcProposedInspType
String
The new proposed inspection type value
ds
The InspParam data set
OnChangeJobAsm This method validates the ProposedAssemblySeq, then updates related fields: This method should be run when the InspParam.AssemblySeq field changes. Parameters Name
Type
Description
piProposedAssemblySeq
Int32
The new proposed Job Assembly value
ds
The InspParam data set
OnChangeJobNum This method validates the JobNum, then updates related fields: This method should be run when the InspParam.JobNum field changes. Parameters Name
Type
Description
pcProposedJobNum
String
The new proposed JobNum value
ds
The InspParam data set
OnChangeJobOpr This method validates the piProposedOprSeq, then updates related fields: This method should be run when the InspParam.OprSeq field changes.
1096
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
piProposedOprSeq
Int32
The new proposed Job Operation Sequence value
ds
The InspParam data set
OnChangeNCMID This method validates the non conformance transaction ID, then updates related fields This method should be run when the InspParam.NCMTranID field changes. Parameters Name
Type
Description
pcProposedNCMTranID
Int32
The new proposed NCMTranID value
ds
The InspParam data set
OnChangePartNum This method validates the piProposedPartNum, then updates related fields. This method should be run when the InspParam.PartNum field changes. Parameters Name
Type
Description
piProposedPartNum
String
The new proposed PartNum value
ds
The InspParam data set
OnChangeSpecID This method validates the Proposed Specification ID, then updates related fields: This method should be run when the InspPlanSampleLst.SpecID field changes. Parameters Name
Type
Description
piProposedSpecID
String
The new proposed specification id value
ds
The InspParam data set
OnChangeSpecRev This method processes the Proposed Specification Revision, then updates related fields: This method should be run when the InspParam.SpecRev field changes.
Epicor 9.05 | 9.05.605
1097
F-L
Business Object Reference Guide
Parameters Name
Type
Description
piProposedSpecRev
String
The new proposed specification revision value
ds
The InspParam data set
PreGenerateResults This method should be called prior to calling the GenerateResults method. It will validate InspParam data and check for existing InspResults records. Parameters Name
Type
Description
ds
The InspParam data set
inspPlanNum
String
Inspection Plan Number.
inspRevNum
String
Inspection Revision Number.
specID
String
Specification ID.
specRevNum
String
Specification revision number.
inspectQty
Int32
Inspection Quantity.
existsMessage
String@
Message to be displayed to user.
key1
String@
Key1 value to use for InspResults retrieval
key2
String@
Key2 value to use for InspResults retrieval
key3
String@
Key3 value to use for InspResults retrieval
key4
String@
Key4 value to use for InspResults retrieval
key5
String@
Key5 value to use for InspResults retrieval
dateStamp
String@
InspectDate to use for InspResults retrieval
timeStamp
Int32@
InspectTime to use for InspResults retrieval.
GetDisplayColumns Generate Columns that will be displayed in the grid Parameters
1098
Name
Type
Description
inSpecID
String
The specification ID
inSpecRevNum
String
The specification revision number
inInspPlanPartNum
String
The inspection plan part number
inInspPlanRevNum
String
The inspection plan revision number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns
RetrieveValues Retrieve records that will be displayed in the grid. Parameters Name
Type
ds relatedRowID
Description The InspParam data set
String
RowID of the InspResults record.
Returns
GetNewLbrScrapSerialNumbers Gets a new LbrScrapSerialNumbers record for current InspParam Parameters Name
Type
ds
Description Labor data set
InternalPartCrossRef Epicor.Mfg.BO.InternalPartCrossRef: This business object contains 18 methods.
GetNewPartRef Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
1099
F-L
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
1100
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeMaskPrefixSuffix When Changing PartRef.MaskPrefix or Suffix field. Parameters Name
Type
Description
icValue
String
MaskPrefix or MaskSuffix value
icPorC
String
Which one to check
ds
The InternalPartCrossRef dataset
ChangePartRefPartNum When Changing PartRef.PartNum field.
Epicor 9.05 | 9.05.605
1101
F-L
Business Object Reference Guide
Parameters Name
Type
Description
iPartNum
String@
Part Number Reference
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
ChangePartRefSNMask When Changing PartRef.SNMask field. Parameters Name
Type
Description
iSNMask
String
Serial Mask ID
ds
The InternalPartCrossRef dataset
ChangePartRefSNOverride When Changing PartRef.SNOverride field. Parameters Name
Type
Description
iSNOverride
String
Override Mask
ds
The InternalPartCrossRef dataset
ChangePartRefXRefPartNum When Changing PartRef.XRefPartNum field. Parameters Name
Type
Description
iXRefPartNum
String
Part Number Reference
ds
The InternalPartCrossRef dataset
GetInternalPartXRef Get all Internal Part References for a given Part 1102
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
iPartNum
String
Part Number
ds
The CustomerPartXRef dataset
IntgWorkbench Epicor.Mfg.BO.IntgWorkbench: This business object contains 10 methods.
GetNewIntQueIn Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1103
F-L
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
DeleteByObject Given a list of Groups/Objects we will delete the IntQueIn and all the IM records related to each one of them. Parameters Name
Type Description
ipRelatedToFile String List of Groups/Objects (suing the RelatedToFile field as code) to be deleted. Valid Values = APInvHed,InvcHead,Customer,Supplier,Vendor,Part,CustCnt,POHeader,RcvHead,GLJrnHed,Currency,Cur
GetErrorRows To retrieve the list of errors from failed attempts to import data from external systems. This allows a UI to combine onto one screen the 18 browses of the separate maintenance programs in the External Systems Integration / Operations menu in Vantage v6.10. Note that separate BOs are used for viewing / updating the details of each type (table); this BO only provides the list of rows needing attention, with minimal description intended to be sufficient for labeling nodes in a tree view. It should be possible for the UI to construct calls to GetByID() in the appropriate BO to load the appropriate sheet for any of the different types. There is an input parameter for each of these types, for which there should be a corresponding checkbox. The rows for a given type will only be fetched if its corresponding input is TRUE.
1104
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
pcRelatedToList
String
(optional)A tilde-delimited list of values for the RelatedTo field to match.
whereClauseIntQueIn
String
(optional)Where conditions for the IntQueIn* tables.
pageSize
Int32
absolutePage
Int32
morePages
Boolean@
Returns TRUE if there are more pages.
Returns IntgWorkbench dataset.
InvcGrp Epicor.Mfg.BO.InvcGrp: This business object contains 15 methods.
GetNewInvcGrp Inserts a new row in the DataSet with defaults populated.
GetNewInvcGrpAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
1105
F-L
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetInvcGrp Sets the user lock on the Current group. This method also run GetByID.. Parameters Name
Type
Description
groupID
String
Group ID.
ds
Invoice Entry data set.
This method should ONLY be called for RMA processing. It creates a group with a groupid of RMACRREQ. This group cannot be updated. Returns Invoice Entry data set.
OnChangeofApplyDate This methods should be called to validate the new apply date entered by the user. Parameters
1106
Name
Type
Description
groupID
String
Group ID.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
newApplyDate
Nullable{System.DateTime}
New Apply Date.
ds
Invoice Entry data set.
OnChangeofInvoiceDate This methods should be called to validate the new invoice date entered by the user. Parameters Name
Type
Description
groupID
String
Group ID.
newInvoiceDate
Nullable{System.DateTime}
New invoice date.
ds
Invoice Entry data set.
PostInvoices Posts the invoices for a group. Parameters Name
Type
Description
groupID
String
Group ID.
invoicesGenerated
String@
Invoices and legal numbers generated.
errorMessage
String@
Error messages generated.
legalNumberMessage
String@
Legal number messages generated.
PrePostInvoices This method should be called before Invoices for a group are posted. If the GL is not interfaced the user will be asked to continue Y/N. If they choose N, the PostInvoices method should not be called. Parameters Name
Type
Description
ipTCOnline
Boolean
Tax Connect status.
glMessage
String@
Error messages generated.
glWarning
String@
Warning message.
ds
Invoice Entry data set.
UnlockGroup Resets the user lock on the old group. Needs to be called on a change of group and when the screen closes. This method does not affect the temp table, only the database table.
Epicor 9.05 | 9.05.605
1107
F-L
Business Object Reference Guide
Parameters Name
Type
Description
priorGroupID
String
Prior Group ID.
ds
Invoice Entry data set.
InventoryQtyAdj Epicor.Mfg.BO.InventoryQtyAdj: This business object contains 16 methods.
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
1108
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
Epicor 9.05 | 9.05.605
1109
F-L
Business Object Reference Guide
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckSN Determines if serial numbers are required for this transaction Parameters Name
Type
Description
partNum
String
Part Number
warehouseCode
String
Warehouse Code
serialNumbersRequired
Boolean@
Serial Numbers Required Flag
GetInventoryQtyAdj Gets the default values for the InventoryQtyAdj data table based on the part number entered. Parameters Name
Type
Description
partnumber
String
Part number to adjust.
uomCode
String
UOM Code (only used for Product Codes)
Returns Inventory qty adj data set
GetInventoryQtyAdjBrw Gets the default values for the browse section of the adjustment screen Parameters Name
Type
Description
partNum
String
Part number for the adjustment.
wareHouseCode
String
Warehouse code used to get bin information.
primaryBin
String@
Part Warehouse's Primary Bin.
Returns Browse for inventory qty adj data set
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes
1110
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
uomCode
String@
UOM Code (only used for Product Codes)
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds
Description Inventory qty adj data set
Returns The SelectSerialNumbersParams dataset
KitPartStatus Checks Part's type and returns warning message if the part is a Sales Kit. Parameters Name
Type
Description
partNum
String
Part number.
kitMessage
String@
Message to warn that Kits shouldn't have stock quantities.
PreSetInventoryQtyAdj This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called.
Epicor 9.05 | 9.05.605
1111
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ds requiresUserInput
Inventory qty adj data set Boolean@
Indicates if the legal number requires user input
SetInventoryQtyAdj Create Part Tran records from the Inventory QtyAdj dataset. If Serial numbers are entered, SerialNo records and SNTran records are created. If the Serial number format is changed, the Part table will be updated with the information provided in the SNFormat data table. Parameters Name
Type
Description
ds partTranPKs
Inventory qty adj data set String@
Inventory qty adj data set
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
Description
ds
Inventory qty adj data set
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
InvoiceIStatTrn Epicor.Mfg.BO.InvoiceIStatTrn: This business object contains 6 methods.
APGetInvoiceIStatTrn Gets the InvoiceIStatTrn record for an APInvDtl record. Parameters
1112
Name
Type
Description
inVendorNum
Int32
The vendor number of the invoice detail line
inInvoiceNum
String
The invoice number of the invoice detail line
inInvoiceLine
Int32
The line number of the invoice detail line
forTracker
Boolean
This flag indicates that this function is called for Tracker
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The InvoiceIStatTrn data set
ARGetInvoiceIStatTrn Gets the InvoiceIStatTrn record for an AR InvcDtl record. Parameters Name
Type
Description
inInvoiceNum
Int32
The invoice number of the invoice detail line
inInvoiceLine
Int32
The line number of the invoice detail line
forTracker
Boolean
This flag indicates that this function is called for Tracker
Returns The InvoiceIStatTrn data set
ChangeCommodityCode Method to call when changing the commodity code. Validates the code and updates CommodityCodeDescription field for the code. Parameters Name
Type
Description
proposedCommodityCode
String
The proposed commodity code
ds
The InvoiceIStatTrn data set
ChangeFOB Method to call when changing the FOB code. Validates the code and updates FOBDescription field for the code. Parameters Name
Type
Description
proposedFOB
String
The proposed FOB code
ds
The InvoiceIStatTrn data set
ChangeShipVia Method to call when changing the ship via code. Validates the code and updates ShipViaDescription field for the code. Parameters Name
Type
Description
proposedShipViaCode
String
The proposed ship via code
ds
Epicor 9.05 | 9.05.605
The InvoiceIStatTrn data set
1113
F-L
Business Object Reference Guide
UpdateIStatTrn Updates/creates the IStatTrn record. Parameters Name
Type
Description
ds
The InvoiceIStatTrn data set
InvoiceReceiptMatch Epicor.Mfg.BO.InvoiceReceiptMatch: This business object contains 9 methods.
CheckGLInterfaceForPost Checks to see if GL interface is available before posting. Is run before the PostMatches method. A question is returned to ask the user if they want to continue with the post or not if the interface is not available. If the answer is no, the PostMatches method is not run. Parameters Name
Type
Description
cContinuePostMsg
String@
The text of the question to ask of the user
GetAPIRMtch Get the APIRMtch records. Parameters Name
Type
Description
pageSize
Int32
The pageSize parameter
absolutePage
Int32
The absolutePage parameter
morePages
Boolean@
The morePages parameter
Returns A/P Invoice to Receipt matching data set
GetInvoiceReceiptMatch Get the InvoiceReceipt records from the list dataset. Parameters Name
Type
Description
ds
1114
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns Invoice to Receipt matching data set
GetList This method returns the Data Schema records Parameters Name
Type
Description
whereClause
String
Where clause
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages
Returns AP Invoice Match List data set
GetSupplierXRefParts This method gets the XRef information for a given supplier part Parameters Name
Type
Description
partNum
String
Receipt Part Number
vendorNum
Int32
Receipt Supplier Number
poNum
Int32
PO Number
poLine
Int32
PO Line
purPoint
String
Purchase Point
packSlip
String
packing Slip
packLine
Int32
packing Line
Returns The Supplier XRef data set
MatchInvoiceReceipt Match an invoice and a receipt. Parameters Name
Type
Description
cInvoiceNum
String
The Invoice Number of the APInvoiceMatch record
iInvoiceLine
Int32
The Invoice Line Number of the APInvoiceMatch record
iVendorNum
Int32
The Vendor Number of the APInvcRcptDtlMatch record
cPurPoint
String
The Purchase Point of the APInvcRcptDtlMatch record
Epicor 9.05 | 9.05.605
1115
F-L
Business Object Reference Guide
Name
Type
Description
cPackSlip
String
The Pack Slip of the APInvcRcptDtlMatch record
iPackLine
Int32
The Pack Slip Line of the APInvcRcptDtlMatch record
ds
Invoice to Receipt matching data set
Returns A/P Invoice to Receipt matching data set
PostMatches Post the Invoice/Receipt matches. Parameters Name
Type
Description
ds
AP Invoice matching list data set
cPostErrorLog
String@
The specific errors that occurred when posting
cErrorLogMsg
String@
If errors occurred, message to present the user to inform them
Returns AP Invoice matching list data set
SetSupplierXRefParts This method sets the XRef fields for a supplier part Parameters Name
Type
ds
Description The Supplier XRef data set
UnMatchInvoiceReceipt Unmatch an invoice and a receipt. Parameters Name
Type
Description
cInvoiceNum
String
The Invoice Number of the APInvcRcptDtlMatch record
iInvoiceLine
Int32
The Invoice Line of the APInvcRcptDtlMatch record
iVendorNum
Int32
The Vendor Number of the APInvcRcptDtlMatch record
cPurPoint
String
The Purchase Point of the APInvcRcptDtlMatch record
cPackSlip
String
The Pack Slip of the APInvcRcptDtlMatch record
iPackLine
Int32
The Pack Slip Line of the APInvcRcptDtlMatch record
ds
1116
Invoice to Receipt matching data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns A/P Invoice to Receipt matching data set
InvTransfer Epicor.Mfg.BO.InvTransfer: This business object contains 21 methods.
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last
Epicor 9.05 | 9.05.605
1117
F-L
Business Object Reference Guide
• Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeFromBin This method will pull qty for the bin.
1118
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Inventory Transfer data set
ChangeFromWhse This method validate from warehouse. Parameters Name
Type
ds
Description Inventory Transfer data set
ChangeLot Recalculates on hand qty when lot number changes. Parameters Name
Type
ds
Description Inventory Transfer data set
ChangeToBin This method will pull qty for the TO bin. Parameters Name
Type
ds
Description Inventory Transfer data set
ChangeToWhse This method validate to warehouse. Parameters Name ds
Type
Description Inventory Transfer data set
ChangeUOM Recalculates on hand qty when the inventory transfer UOM changes.
Epicor 9.05 | 9.05.605
1119
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description Inventory Transfer data set
CommitTransfer This method will commit the inventory transfer . Serial numbers are passed from the serial number object through the ttSelectedSerialNumbers temptable. Parameters Name
Type
ds
Description Inventory Transfer data set
legalNumberMessage
String@
The legal number message to display to the user. Can be blank
partTranPKs
String@
PartTran primary keys.
GetAvailBins Based on the parameter AllBins, either all bins or only current bins will be returned in the Bins Data table. Parameters Name
Type
Description
partNum
String
Part Number (current only).
allBins
String
A for all bins or C for current warehouse.
warehouseCode
String
Warehouse code.
lotNum
String
Lot number (current only).
dimCode
String
UNIT OF MEASURE (old Dimension Code)
binList
String@
List of bins and descriptions. The bins and descriptions are ` delimited, while the set of bins and descriptions are delimited by a ~.
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters
1120
Name
Type
Description
partNum
String@
Proposed PartNumber change
uomCode
String@
UOM Code (only used for Product Codes)
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetPrimaryBin Note: This method should be called when either the From or To Warehouse code changes. Purpose: Get the Part (From or To) Warehouse's Primary Bin when the Warehouse is changed. Parameters Name
Type
Description
iPartNum
String
Part Number
iWarehouseCode
String
WarehouseCode
primaryBin
String@
Ouput parameter which contains the Part Warehouse's Primary Bin
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds
Description Inventory Transfer data set
Returns The SelectSerialNumbersParams dataset
GetTransferRecord This method creates a template transfer record . Gets defaults for the part to be transfered . Parameters Name
Type
Description
iPartNum
String
Part Number
uomCode
String
UOM Code (only used for Product Codes)
Returns Inventory Transfer data set
Epicor 9.05 | 9.05.605
1121
F-L
Business Object Reference Guide
PreCommitTransfer This method will return a record in the LegalNumberGenerate datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds requiresUserInput
Description Inventory Transfer data set
Boolean@
Indicates if the legal number requires user input
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
ds
Description Inventory Transfer data set
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
IRWarehseSearch Epicor.Mfg.BO.IRWarehseSearch: This business object contains 1 methods.
GetWarehseList This method returns a list of warehouses. In a STK type of transaction this search looks into PlantWhse table and returns the warehouses where the pcPartNum is defined. For other transaction types it looks into PlantShare table and returns the shared warehouses. Parameters Name
Type
Description
pcTranType
String
IssueReturn Transaction type
pcPartNum
String
PartNum involved in Issue / Return
pcWarehseType
String
Valid values are From or To.
Returns List of warehouses - IRWarehseSearchDataSet
1122
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
IssueReturn Epicor.Mfg.BO.IssueReturn: This business object contains 38 methods.
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetList List of jobs that can be selected for Mass Issue. Parameters Name
Type
Description
whereClauseJobHead
String
Where condition without the where word
whereClauseJobAsmbl
String
Where condition without the where word
Epicor 9.05 | 9.05.605
1123
F-L
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns Returns Epicor.Mfg.BO.IssueReturnJobAsmblDataSet
GetListJobs List of jobs that can be selected for Mass Issue. Parameters Name
Type
Description
whereClauseJobHead
String
Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns Returns Epicor.Mfg.BO.IssueReturnJobListDataSet
GetNewIssueReturn Call this method to create a new Epicor.Mfg.BO.IssueReturnDataSet with default values. Parameters Name
Type
Description
pcTranType
String
Material movement type XXX-XXX e.g STK-MTL. It can be blank when a valid MtlQueue RowIdent is passed.
pcMtlQueueRowID
String
Progress database RowId of MtlQueue record
pCallProcess
String
Calling Process
ds
IssueReturnDataSet
GetNewIssueReturnFromJob Call this method to create a new Epicor.Mfg.BO.IssueReturnDataSet with default values. Parameters
1124
Name
Type
Description
pcFromJobNum
String
From Job number.
piFromAssemblySeq
Int32
From Assembly Seq.
pcTranType
String
Material movement type XXX-XXX e.g STK-MTL
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
pcMtlQueueRowID
String
Progress database rowid for MtlQueue record
ds
IssueReturnDataSet
GetNewIssueReturnToJob Call this method to create a new Epicor.Mfg.BO.IssueReturnDataSet with default values. Parameters Name
Type
Description
pcToJobNum
String
To Job number.
piToAssemblySeq
Int32
To Assembly Seq.
pcTranType
String
Material movement type XXX-XXX e.g STK-MTL
pcMtlQueueRowID
String
Progress database rowid for MtlQueue record
pcMessage
String@
Non-Error, informational message
ds
IssueReturnDataSet
GetNewJobAsmblMultiple This method creates multiple IssueReturnJobs rows using IssueReturnJobSearch dataset. Parameters Name
Type
Description
pcTranType
String
Material movement type XXX-XXX e.g STK-MTL
pcMtlQueueRowID
String
Progress database rowid for MtlQueue record
pCallProcess
String
Calling Process
ds
SelectedJobAsmblDataSet
pcMessage
String@
Non-Error, informational message
Returns IssueReturnDataSet
GetNewJobAsmblSearch This method creates a new ttSelectedJobAsmbl row entry. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description SelectedJobAsmblDataSet
1125
F-L
Business Object Reference Guide
GetNewPartMultiple This method creates multiple IssueReturnJobs rows using IssueReturnJobSearch dataset. Parameters Name
Type
Description
pcTranType
String
Material movement type XXX-XXX e.g STK-MTL
pcMtlQueueRowID
String
Progress database rowid for MtlQueue record
ds pcMessage
SelectedPartDataSet String@
Non-Error, informational message
Returns IssueReturnDataSet
GetNewPartNum Call this method to create a new Epicor.Mfg.BO.IssueReturnDataSet with Part#. Parameters Name
Type
Description
pcPartNum
String
Part number
pcTranType
String
Material movement type XXX-XXX e.g STK-UKN
pcMtlQueueRowID
String
Progress database rowid for MtlQueue record
ds
IssueReturnDataSet
GetNewPartSearch This method creates a new ttSelectedParts row entry. Parameters Name
Type
Description
ds
SelectedPartDataSet
GetRows List of jobs that can be selected for Mass Issue. Parameters
1126
Name
Type
Description
whereClauseJobHead
String
Where condition without the where word
whereClauseJobAsmbl
String
Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
absolutePage
Int32
morePages
Boolean@
Description
Are there more pages ? Yes/No
Returns Returns Epicor.Mfg.BO.IssueReturnJobAsmblDataSet
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds
Description Issue Return data set
Returns The SelectSerialNumbersParams dataset
GetUnissuedQty Call this method to set the Qty to the remaining unissued amount. Parameters Name
Type
ds
Description IssueReturnDataSet
GetUnpickSettings Sets ttIssueReturn fields for Unpick Parameters Name
Type
ds
Description Issue Return data set
IsValidAssembly Validate if an assembly is valid for a job. if not returns false, otherwise returns true. Parameters Name
Type
Description
pcJobNum
String
Job Number
piAssemblySeq
Int32
A sequence number that uniquely identifies the JobAsmbl record within the JobNum.
plFound
Boolean@
Found or not
Epicor 9.05 | 9.05.605
1127
F-L
Business Object Reference Guide
JobExists Check JobNum and return JobRelease and JobClosed Parameters Name
Type
Description
ipJobNum
String
JobNum which should check
opJobReleased
Boolean@
Job Released
opJobClosed
Boolean@
Job Closed
opJobExists
Boolean@
Job exists
OnChangeFromAssemblySeq Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.FromAssemblySeq changes. Parameters Name
Type
Description
piFromAssemblySeq
Int32
From Assembly Seq
ds pCallProcess
IssueReturnDataSet String
Calling Process value
OnChangeFromBinNum Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.FromBinNum changes. Parameters Name
Type
Description
plOverrideBinChange
Boolean
User said yes to bin changing msg
ds
IssueReturnDataSet
OnChangeFromJobNum Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.FromJobNum changes. Parameters Name
Type
Description
pcFromJobNum
String
From Job Number
ds pCallProcess
1128
IssueReturnDataSet String
Calling Process value
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
OnChangeFromJobSeq Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.FromJobNum changes. Parameters Name
Type
ds
Description IssueReturnDataSet
pCallProcess
String
Calling Process value
pcMessage
String@
Non-error, informational message
onChangeFromWarehouse Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.PartNum changes. Parameters Name
Type
ds pCallProcess
Description IssueReturnDataSet
String
Calling Process value
OnChangeLotNum Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.LotNum changes. Parameters Name
Type
Description
pcLotNum
String
Proposed LotNum value
ds
IssueReturnDataSet
OnChangePartNum Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.PartNum changes. Parameters Name
Type
ds pCallProcess
Description IssueReturnDataSet
String
Calling Process value
OnChangeToAssemblySeq Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.ToAssemblySeq changes.
Epicor 9.05 | 9.05.605
1129
F-L
Business Object Reference Guide
Parameters Name
Type
ds pCallProcess
Description IssueReturnDataSet
String
Calling Process value
OnChangeToJobNum Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.ToJobNum changes. Parameters Name
Type
ds
Description IssueReturnDataSet
pCallProcess
String
Calling Process value
pcMessage
String@
Non-Error, informational message
OnChangeToJobSeq Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.ToJobSeq changes. Parameters Name
Type
ds
Description IssueReturnDataSet
pCallProcess
String
Calling Process value
pcMessage
String@
Non-Error, informational message
onChangeToWarehouse Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.PartNum changes. Parameters Name
Type
ds pCallProcess
Description IssueReturnDataSet
String
Calling Process value
OnChangeTranQty Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.TranQty changes. This method performs validation on TranQty and sets the Issued Complete flag.
1130
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
pdTranQty
Decimal
Transaction Qty
ds
IssueReturnDataSet
OnChangeUM Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.UM changes. Parameters Name
Type
Description
pUM
String
Transaction UOM
ds
IssueReturnDataSet
OnChangingFromBinNum Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.FromBinNum is changing. Parameters Name
Type
Description
ds pcMessage
IssueReturnDataSet String@
Warning if serial numbers have already been selected for another bin.
OnChangingJobSeq Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSetjobseq (either to or from is changing) Parameters Name
Type
Description
piJobSeq
Int32
JobSeq
pcDirection
String
Direction
pCallProcess
String
Calling Process value
ds
IssueReturnDataSet
PerformMaterialMovement Perform Material Movement.
Epicor 9.05 | 9.05.605
1131
F-L
Business Object Reference Guide
Parameters Name
Type
Description
plNegQtyAction
Boolean
when TranQty changes, perform NegativeInventoryTest. Provide the answer of that test here.
ds
IssueReturnDataSet
legalNumberMessage
String@
The legal number message. Can be blank.
partTranPKs
String@
The PartTran primary keys.
PrePerformMaterialMovement This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds requiresUserInput
Description Issue Return data set
Boolean@
Indicates if the legal number requires user input
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
ds
1132
Description Issue Return data set
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
validUOM Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
IStatTrn Epicor.Mfg.BO.IStatTrn: This business object contains 12 methods.
GetNewIStatTrn Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1133
F-L
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ExportParamValidation Method to call to get validate the IStatTrnExportParam record for the generic or Iris export. May return a warning message to inform the user that there are unposted entries outside the fiscal period/date range or that there aren't any posted entries in the given fiscal period/date range. This is informational only and does not prevent the user from continuing. Parameters Name
Type
ds warningText
Description IStat Transaction Export data set
String@
The warning text. May be blank.
Method to call to get an IStatTrnExportParam record to obtain export parameters for the Generic Export. Returns IStat Transaction Export data set Method to call to get an IStatTrnExportParam record to obtain export parameters for the Iris Export. Returns IStat Transaction Export data set
ProcessExport Method to call to perform the export process for the generic or Iris export. Returns a dataset containing all the records that are to be exported.
1134
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ds Returns IStat Transaction Export data set
SortByData Return a list of the export sort by options. Only needs to be called for generic exports. Parameters Name
Type
Description
cSortByList
String@
The Sort By List.
Epicor 9.05 | 9.05.605
1135
F-L
Business Object Reference Guide
Chapter 10: J JCDept Epicor.Mfg.BO.JCDept: This business object contains 9 methods.
GetNewJCDept Inserts a new row in the DataSet with defaults populated.
GetNewJCDeptAttch Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1136
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
JCShift Epicor.Mfg.BO.JCShift: This business object contains 11 methods.
GetNewJCShift Inserts a new row in the DataSet with defaults populated.
GetNewJCShiftAttch Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewShiftBrk Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1137
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetTimeLength Calculate the length between the times in JCShift. Parameters Name ds
1138
Type
Description The JCShift data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
JobAddlInfo Epicor.Mfg.BO.JobAddlInfo: This business object contains 10 methods. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
1139
F-L
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
GetJobInfo Returns Job Add Info details Parameters Name
Type
Description
ipJobNum
String
Job number
ipAssemblySeq
Int32
Assembly Seq
ipOprSeq
Int32
Opr Seq
ipCrewCount
Int32
Crew Count
Returns Job Add Info data set Returns Operations data set Returns Operations data set Returns Resource Groups data set Returns Resource Groups data set
JobAdjustment Epicor.Mfg.BO.JobAdjustment: This business object contains 25 methods.
CalcUnitCost This method should be run when any of the follwing fields change on the job material adustment sheet to recalcuate the extended unit cost; ttJATrans.MtlUnitCost ttJATrans.BurUnitCost ttJATrans.LbrUnitCost ttJATrans.SubUnitCost ttJATrans.MtlBurUnitCost Parameters Name ds
Type
Description Job Adjustment data set
ChangeLaborAssemSeq This method needs to be called when the Assembly changes on the material sheet.
1140
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
laborAssmSeq
Int32
LaborDtl.AssemblySeq
ds
Job Adjustment data set
ChangeLaborComplete This method should be invoked when the complete flag changes . Parameters Name
Type
Description
laborDtlComplete
Boolean
LaborDtl.complete
ds
Job Adjustment data set
ChangeLaborEmployeeNum This method changes the name of the employee when the employee number changes. Parameters Name
Type
Description
laborDtlEmployeeNum
String
LaborDtl.EmployeeNum
ds
Job Adjustment data set
ChangeLaborJobNum This method validates the job number and resets the assembly and operation . This validation is also performed when the transaction is committed. Parameters Name
Type
Description
laborDtlJobNum
String
LaborDtl.JobNum
ds
Job Adjustment data set
ChangeLaborOprSeq This method needs to be called when the operation on the Labor sheet changes. It validates the sequences and pulls in some defaults . Parameters Name
Type
Description
laborDtlOprSeq
Int32
LaborDtl.OprSeq
Epicor 9.05 | 9.05.605
1141
F-L
Business Object Reference Guide
Name
Type
ds
Description Job Adjustment data set
ChangeLaborType Run this method when the labor type changes. Valid labor types are 's' setup or 'p' production. This method will also set the ' complete ' flag appropiately. Parameters Name
Type
Description
ttJALaborDtlLaborType
String
ttJALaborDtl.LaborType
ds
Job Adjustment data set
ChangeMtlAssemSeq This method needs to be called when the Assembly changes on the material sheet. Parameters Name
Type
Description
mtlAssmSeq
Int32
PartTran.AssemblySeq
ds
Job Adjustment data set
ChangeMtlExtCost This method should be run when the extended cost changes on the adjust material sheet. Parameters Name
Type
Description
ttJATransExtCost
Decimal
PartTran.ExtCost
ds
Job Adjustment data set
ChangeMtlJobMtl This method should be invoked when the material changes. This method will find the associated JobMtl record and reset the defaults. Parameters Name
Type
Description
partTranJobSeq
Int32
PartTran.JobSeq
ds
1142
Job Adjustment data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ChangeMtlJobNum This method should be invoked when the material changes. This method will find Parameters Name
Type
Description
partTranJobNum
String
parttran.JobNum
ds
Job Adjustment data set
ChangeMtlTranQty Run this method after the TranQty on the JobMaterial sheet is changed. This method will recalculate totals for the new tran amount. Parameters Name
Type
Description
ttJATransTranQty
Decimal
ttJATrans.TranQty
ds
Job Adjustment data set
ChangeSubAssemSeq This method needs to be called when the Assembly changes on the subcontract sheet. It clears out the JobSeq. Parameters Name
Type
Description
ttJATransAssemblySeq
Int32
PartTran.AssemblySeq
ds
Job Adjustment data set
ChangeSubExtCost Run this method after the ExtCost is changed on the Subcontract sheet. This method will recalculate the total for SubUnitCost. Parameters Name
Type
Description
ttJATransExtCost
Decimal
parttran.ExtCost
ds
Job Adjustment data set
ChangeSubJobNum This method validates the job number and resets the assembly and operation . This validation is also performed when the transaction is committed.
Epicor 9.05 | 9.05.605
1143
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ttJATransJobNum
String
PartTran.JobNum
ds
Job Adjustment data set
ChangeSubOper This method should be invoked when the Job Operation (JobSeq) on the SubContract sheet changes. This method will find . Parameters Name
Type
Description
ttJATransJobSeq
Int32
PartTran.JobSeq
ds
Job Adjustment data set
ChangeSubTranQty Run this method after the TranQty is changed on the Subcontract sheet. This method will recalculate totals for the new Unit Cost. Parameters Name
Type
Description
ttJATransTranQty
Decimal
PartTran.TranQty
ds
Job Adjustment data set
ChangeSubUnitCost Run this method after the SubUnitCost is changed on the Subcontract sheet. This method will recalculate the ExtCost. Parameters Name
Type
Description
ttJATransSubUnitCost
Decimal
PartTran.SubUnitCost
ds
Job Adjustment data set
CommitLaborAdj This method will validate and commit the Labor record . Parameters Name ds
1144
Type
Description Job Adjustment data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
CommitMaterialAdj This method will validate and commit the Material adjustment record . Before this is run, it is assumed that the ChangeMtlTranQty, ChangeMtlJobNum, ChangeMtlJobMtl, ChangeMtlExtCost or CalcUnitCost were invoked on leave of a the related field. Parameters Name
Type
ds legalNumberMessage
Description Job Adjustment data set
String@
The generated legal number message
CommitSubcontractAdj This method should be run to commit the SubContract adjustoment. Parameters Name
Type
ds legalNumberMessage
Description Job Adjustment data set
String@
The generated legal number message
PreCommitMaterialAdj This method will return a record in the LegalNumberGenerate datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds requiresUserInput
Description Job Adjustment data set
Boolean@
Indicates if the legal number requires user input
PreCommitSubcontractAdj This method will return a record in the LegalNumberGenerate datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds requiresUserInput
Epicor 9.05 | 9.05.605
Description Job Adjustment data set
Boolean@
Indicates if the legal number requires user input
1145
F-L
Business Object Reference Guide
StartAdjustments Use this method to start the Adjusment process . Parameters Name
Type
Description
ds
Job Adjustment data set
ReportPartQtyAllowed Returns TRUE if Part Quantity Reporting is allowed for a given operation. Notes: In order to be allowed the following conditions must be meet. 1. Must be final assembly (AssemblySeq = 0) 2. Must be the final operation. 3. Job must have more that one end part defined or has one or more Parts with PartPerOp > 1 Parameters Name
Type
Description
ipJobNum
String
Job number
ipAssemblySeq
Int32
Assembly Sequence number
ipOprSeq
Int32
Operation Sequence number
JobAsmblCosts Epicor.Mfg.BO.JobAsmblCosts: This business object contains 1 methods.
GetJobAsmblCosts Retrieves the Hours and Costs for a Job Assembly Parameters Name
Type
Description
ipJobNum
String
Job Number
ipAssemblySeq
Int32
Assembly Sequence
Returns JobAsmblCosts data set
JobAsmSearch Epicor.Mfg.BO.JobAsmSearch: This business object contains 7 methods.
GetNewJobAsmbl Inserts a new row in the DataSet with defaults populated.
1146
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1147
F-L
Business Object Reference Guide
JobClosing Epicor.Mfg.BO.JobClosing: This business object contains 13 methods.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage This method exists soley for the purpose of allowing security for availability of the close job field to be defined.
CloseJob Call this method to close or complete the job. The Job database is not updated till this method is successfully executed.
1148
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Epicor.Mfg.BO.JobClosingDataSet
pcMessage
String@
non error, informational message returned from the server
EnableSerialMatching Call this method when it is necessary to know in UI if the Serial Matching option should be enabled. Parameters Name
Type
ds plEnable
Description Contains Job closing data.
Boolean@
To indicate if Serial Matching option in UI should or should not be enabled
GetNewJobClosing Returns a new , empty Call JobClosingDataSet row. Parameters Name
Type
ds
Description Epicor.Mfg.BO.JobClosingDataSet
GetNewJobClosingList This method creates a new JobClosingListDataSet row entry. Parameters Name
Type
ds
Description Input dataset contains the jobs selected by the user.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeJobClosed Call this method when the value of Epicor.Mfg.BO.JobClosingDataSet.JobClosed changes.
Epicor 9.05 | 9.05.605
1149
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description Contains Job closing data.
OnChangeJobCompletion Call this method when the value of Epicor.Mfg.BO.JobClosingDataSet.JobComplete changes. Parameters Name
Type
ds
Description Contains Job closing data.
OnChangeJobNum Call this method when the user selects a job. This method populates the Epicor.Mfg.BO.JobClosingDataSet dataset with Job , JobOper and JobMtl information. Parameters Name
Type
Description
pcJobNum
String
Job # selected
ds pcMessage
Epicor.Mfg.BO.JobClosingDataSet String@
informational message returned to the user to let him or her know why the job cannot be closed.
PreCloseJob This method will return a record in the LegalNumberGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds requiresUserInput
Description Contains Job closing data.
Boolean@
Indicates if the legal number requires user input
SelectMultipleJob Call this method when the user selects multiple jobs. This method populates the Epicor.Mfg.BO.JobClosingDataSet dataset with Job , JobOper and JobMtl information.
1150
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Input dataset contains the jobs selected by the user.
Returns Epicor.Mfg.BO.JobClosingDataSet
JobClosingCd Epicor.Mfg.BO.JobClosingCd: This business object contains 7 methods.
GetNewJobClosingCd Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1151
F-L
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
JobEntry Epicor.Mfg.BO.JobEntry: This business object contains 219 methods.
GetNewJobHead Inserts a new row in the DataSet with defaults populated.
GetNewJobHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewJobAsmbl Inserts a new row in the DataSet with defaults populated.
GetNewJobAsmblAttch Inserts a new row in the DataSet with defaults populated.
GetNewJobAsmblInsp Inserts a new row in the DataSet with defaults populated.
GetNewJobMtl Inserts a new row in the DataSet with defaults populated.
GetNewJobMtlAttch Inserts a new row in the DataSet with defaults populated.
GetNewJobMtlInsp Inserts a new row in the DataSet with defaults populated.
1152
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetNewJobMtlRefDes Inserts a new row in the DataSet with defaults populated.
GetNewJobMtlRestriction Inserts a new row in the DataSet with defaults populated.
GetNewJobMtlRestrictSubst Inserts a new row in the DataSet with defaults populated.
GetNewJobOper Inserts a new row in the DataSet with defaults populated.
GetNewJobOperAttch Inserts a new row in the DataSet with defaults populated.
GetNewJobOperInsp Inserts a new row in the DataSet with defaults populated.
GetNewJobOpDtl Inserts a new row in the DataSet with defaults populated.
GetNewJobOperRestriction Inserts a new row in the DataSet with defaults populated.
GetNewJobOperRestrictSubst Inserts a new row in the DataSet with defaults populated.
GetNewJobAsmblRestriction Inserts a new row in the DataSet with defaults populated.
GetNewJobAsmblRestrictSubst Inserts a new row in the DataSet with defaults populated.
GetNewJobAsmRefDes Inserts a new row in the DataSet with defaults populated.
GetNewJobAudit Inserts a new row in the DataSet with defaults populated.
GetNewJobPart Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1153
F-L
Business Object Reference Guide
GetNewJobProd Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
1154
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
1155
F-L
Business Object Reference Guide
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AddOperation THIS METHOD NEEDS TO BE PUBLIC - CALLED FROM bo/Project/Project.p
1156
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ipJobAsmblRowID
String
ipOPCode
String
ipNewOprSeq
Int32
ipReturn
Boolean
opShowmsg
Boolean@
Description
AddRefDesRange Creates new JobMtlRefDes records based on the JobMtl dataset fields. Parameters Name
Type
Description
ipJobNum
String
The Job Number
ipAsmSeq
Int32
The Job Assembly
ipMtlSeq
Int32
The Job Material Seq
ipPrefix
String
The Prefix to be used to create Reference Designators
ipStartNum
Int32
The Starting Number to create Reference Designators
ipEndNum
Int32
The Ending Number to create Reference Designators
ipSuffix
String
The Suffix to be used to create Reference Designators
ds
The Job Entry data set
This method exists solely for the purpose of allowing security for unchecking the AllowJobCosts flag
AppendDetails This method takes the records built in BuildAppendDetails that are marked as append and writes them to the database. It will return the updated dataset. Parameters Name
Type
ds
Description Temporary tables for Append details
targetJob
String
Target Job Number
targetAsm
Int32
Target Job AssemblySeq
sourceFile
String
Indicates where the details are being appended from. Either Quote, Job or Method
keyOne
String
Unique key field one for Quote or Method source
keyTwo
String
Unique key field two for Quote or Method source
Epicor 9.05 | 9.05.605
1157
F-L
Business Object Reference Guide
Name
Type
Description
keyThree
String
Unique key field three for Method source (is blank for quote source)
errorList
String@
Returns a message listing any parts in error
Returns Job Entry data set
BuildAppendDetails This method returns the information that can be appened for approval Parameters Name
Type
Description
sourceFile
String
Source of the append details, Quote, Job or Method
keyOne
String
First key field of source
keyTwo
String
Second key field of source
keyThree
String
Third key field of source
targetJob
String
Target Job Num
targetAsm
Int32
Target Assembly
Returns Temporary tables for Append details
BuildWhseLinkList This methods builds a list of linked warehouses for the jobprod records. Parameters Name
Type
Description
ipJobProdRowid
String
The rowid of the JobProd record to build the warehouses for
opWhseList
String@
The resulting warehouse list
ds
Job Entry data set
CalcJobMtlEstMtlBurUnitCost This method updates the calculation for the Estimated Material Burden Unit Cost, (JobMtl.EstMtlBurUnitCost) field. Parameters Name ds
1158
Type
Description Job Entry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ChangeEquipID This method should be invoked when the Equip ID changes. Validates the EQUIPID and refreshes linked fields. Parameters Name
Type
Description
equipID
String
Proposed equipment id
ds
The Job Entry data set
ChangeIssueTopics This method should be invoked when the IssueTopics changes. Validates and sets the individual IssueTopic fields. Parameters Name
Type
Description
topics
String
Proposed topics string id
ds
The Job Entry data set
ChangeJobAsmblDirect This method is called when the user has changed the JobAsmbl.Direct field. This methods is currently not working. This method needs to check for a remote warehouse, if errors then set the JobAsmbl.Direct flag to true and then set the warehouse. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobAsmblEstSplitCosts This method calculates the Estimated Unit Cost and Material Burden Unit Cost. This method is called when the user has changed one of the Unit Cost Breakdown fields: JobAsmbl.EstMtlUnitCost/EstLbrUnitCost/EstBurUnitCost/EstSubUnitCost. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobAsmblEstUnitCost This method calculates the Estimated Material Burden Unit Cost. This method is called when the user has changed the JobAsmbl.EstUnitCost field.
Epicor 9.05 | 9.05.605
1159
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ds
Job Entry data set
ChangeJobAsmblMtlBurRate This methods updates the JobAsmbl Material Burden Rate. This method should run when the JobAsmbl.MtlBurRate changes. Parameters Name
Type
Description
ds
Job Entry data set
ChangeJobAsmblOpr This methods updates the JobAsmbl Related Operation Description. This method should run when the JobAsmbl.RelatedOperation field changes. Parameters Name
Type
Description
iProposedRelatedOperation
Int32
The new proposed JobAsmbl.RelatedOperation value
ds
Job Entry data set
ChangeJobAsmblOverRunQty This methods updates the JobAsmbl Required Quantity. This method should run when the JobAsmbl.OverRunQty field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobAsmblParent This method validates the new Parent field and populates defaults assoicated witht the Parent. This method should run when the JobAsmbl.Parent field changes. Parameters Name ds
1160
Type
Description Job Entry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ChangeJobAsmblPartNum This method validates the JobAsmbl.PartNum and defaults fields associated with the partnum. This method should run when the JobAsmbl.PartNum field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobAsmblQtyPer This methods updates the JobAsmbl Required Quantity. This method should run when the JobAsmbl.QtyPer field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobAsmblRevisionNum This methods updates the JobAsmbl Drawing Number and creates drawing records. This method should run when the JobAsmbl.OverRunQty field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobAsmblValRefDes Verify that there are no other JobMtlRefDes records in the assembly having the same RefDes value if the JobAsmbl.ValRefDes = true. This method should run before changing the JobAsmbl.ValRefDes. Parameters Name
Type
Description
ipProposedValResDes
Boolean
The new proposed JobAsmbl.ValRefDes value
ds
The Job Entry data set
ChangeJobAsmblWarehouseCode This methods updates the JobAsmbl Available Quantity. This method should run when the JobAsmbl.WarehouseCode field changes.
Epicor 9.05 | 9.05.605
1161
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description Job Entry data set
ChangeJobAsmReqRefDes This methods assigns JobAsmbl.RDEndNum field when JobAsmbl.ReqRefDes changes. This method should run when the JobAsmbl.ReqRefDes changes. Parameters Name
Type
ds
Description Job Entry dataset
ChangeJobAsmRestriction This methods assigns associated fields when JobAsmblRestriction.RestrictionTypeID changes. Parameters Name
Type
ds
Description JobEntry dataset
ChangeJobAsmRestrictManual Called when the user changes the Manual field at the Job Assembly Restriction. Parameters Name
Type
Description
checkManual
Boolean
Indicates if the Restriction is Manual Compliant
ds
JobEntry dataset.
ChangeJobAsmSubstance This methods assigns associated fields when JobAsmblRestrictSubst.SubstanceID changes. Parameters Name
Type
ds
Description JobEntry dataset
ChangeJobHeadJobEngineered This method potentially updates the JobHead.JobReleased field and the ttJobHead.EnableJobFirm This method should run when the JobHead.JobEngineered field changes.
1162
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Job Entry data set
ChangeJobHeadJobReleased This method potentially updates the JobHead.JobEngineered field and the ttJobHead.EnableJobFirm This method should run when the JobHead.JobReleased field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobHeadPartNum This method validates the JobHead.PartNum and defaults fields associated with the partnum. This method should run when the JobHead.PartNum field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobHeadPersonID This method should run when the JobHead.PersonID field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobHeadPhaseID This method updates the JobHead Required Due Date field This method should run when the JobHead.PhaseID field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobHeadProdCode This method should run when the JobHead.ProdCode field changes.
Epicor 9.05 | 9.05.605
1163
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description Job Entry data set
ChangeJobHeadProdTeamID This method should run when the JobHead.ProdTeamID field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobHeadProjectID This method should run when the JobHead.ProjectID field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobHeadRevisionNum This method updates the JobHead Drawing number and creates drawing records. This method should run when the JobHead.RevisionNum field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlBackflush This method updates fields associated with the JobMtl.Backflush field This method should run when the JobMtl.Backflush field changes. Parameters Name ds
Type
Description Job Entry data set
ChangeJobMtlBillable This method updates the JobMtl Unit Price. This method should run when the JobMtl.Billable field changes.
1164
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlBuyIt This method updates numerous fields associated with the JobMtl.BuyIt field This method should run when the JobMtl.BuyIt field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlCurrencySwitch This method changes the display unit prices based on the flipping of the JobMtl.CurrencySwitch field This method should run when the JobMtl.CurrencySwitch external field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlDirect This method updates fields associated with the JobMtl direct flag. This method should run when the JobMtl.Direct field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlDisplayUnitPrice This method calculates the db unit price fields when the external display unit price changes. This method should run when the JobMtl.DisplayUnitPrice field changes. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Job Entry data set
1165
F-L
Business Object Reference Guide
ChangeJobMtlEstSalSplitCosts This method calculates the Estimated Salvage Unit Credit and Salvage Material Burden Unit Credit. This method is called when the user has changed one of the Salvage Unit Credit Breakdown fields: JobMtl.SalvageEstMtlUnitCredit/SalvageEstLbrUnitCredit/ SalvageEstBurUnitCredit/SalvageEstSubUnitCredit. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlEstScrap This method updates the JobMtl Required Quantity and price breaks This method should run when the JobMtl.EstScrap field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlEstScrapType This method updates the JobMtl Required Quantity and price breaks This method should run when the JobMtl.EstScrapType field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlEstSplitCosts This method calculates the Estimated Unit Cost and Material Burden Unit Cost. This method is called when the user has changed one of the Unit Cost Breakdown fields: JobMtl.EstMtlUnitCost/EstLbrUnitCost/EstBurUnitCost/EstSubUnitCost. Parameters Name ds
Type
Description Job Entry data set
ChangeJobMtlFixedQty This method updates the JobMtl Required Quantity and price breaks and if FixedQty is true then JobMtl.EstScrap = 0 This method should run when the JobMtl.FixedQty field changes.
1166
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlIUM procedure for changing JobMtl.IUM field Parameters Name
Type
Description
ipProposedIUM
String
The proposed IUM.
ds
Job Entry data set
ChangeJobMtlMiscCharge This method validates if transaction exists and updates fields based on value of Misc. Charge flag. This method should run when the JobMtl.MiscCharge field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlMtlBurRate This method updates the JobMtl.EstMtlBurUnitCost This method should run when the JobMtl.MtlBurRate field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlPartNum This method validates the JobMtl.PartNum and defaults fields associated with the partnum. This method should run when the JobMtl.PartNum field changes. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Job Entry data set
1167
F-L
Business Object Reference Guide
ChangeJobMtlPlant This method should run when the JobMtl.Plant field changes. This method determines the default JobMtl.WarehouseCode associated with the new JobMtl.Plant. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlPricePerCode This method recalculates the JobMtl Display Extended Price This method should run when the JobMtl.PricePerCode field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlPurPoint This method runs vendor price break logic and sets RcvInspectionReq when JobMtl.PurPoint changes This method should run when the JobMtl.PurPoint field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlQtyPer This method calculates the JobMtl Required Quantity when the JobMtl Quantity Per changes. This method should run when the JobMtl.QtyPer field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlRcvInspectionReq This method checks the vendor and partclass to see if inspection is required This method should run when the JobMtl.RcvInspectionReq field changes.
1168
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ds
Job Entry data set
ChangeJobMtlRelatedOperation This method validates the JobMtl Related Operation field, sets the Estimated Scrap, and calculates the Required Quantity. This method should run when the JobMtl.RelatedOperation field changes. Parameters Name
Type
Description
iProposedRelatedOperation
Int32
The new proposed JobMtl.RelatedOperation value
ds
Job Entry data set
ChangeJobMtlReqRefDes This methods assigns JobMtl.RDEndNum field when JobMtl.ReqRefDes changes. This method should run when the JobMtl.ReqRefDes changes. Parameters Name
Type
ds
Description Job Entry dataset
ChangeJobMtlRestriction This methods assigns associated fields when JobMtlRestriction.RestrictionTypeID changes. Parameters Name
Type
ds
Description JobEntry dataset
ChangeJobMtlRFQNeeded This method sets the RFQVendQuotes field to zero if RFQNeeded flag is false. This method should run when the JobMtl.RFQNeeded field changes. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Job Entry data set
1169
F-L
Business Object Reference Guide
ChangeJobMtlSalvageMtlBurRate This methods updates the JobMtl Salvage Est Material Burden Unit Credit. This method should run when the JobMtl.SalvageMtlBurRate changes. Parameters Name
Type
Description
ds
Job Entry data set
ChangeJobMtlSalvagePartNum This methods assigns associated fields when ECOMtl.SalvagePartNum changes. This method should run when the ECOMtl.SalvagePartNum changes. Parameters Name
Type
Description
ipProposedSalvagePartNum
String
The new proposed ECOMtl.SalvagePartNum value
ds
Job Entry data set
ChangeJobMtlSalvageUnitCredit This method calculates the Salvage Estimated Material Burden Unit Credit. This method is called when the user has changed the JobMtl.SalvageUnitCredit field. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobMtlSubstance This methods assigns associated fields when JobMtlRestrictSubst.SubstanceID changes. Parameters Name
Type
ds
Description JobEntry dataset
ChangeJobMtlVendorNumVendorID This method runs vendor price break logic and sets RcvInspectionReq when JobMtl.VendorNumVendorID changes and validates the jobmtl.vendornumvendorid and assigns the associated fields. This method should run when the JobMtl.VendorNumVendorID field changes.
1170
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipProposedVendorNumVendorID
String
The proposed supplier id.
ds
Job Entry data set
ChangeJobOpDtlCapability Method to call when changing the Capability ID. This method will update JobOpDtl to see if the labor and burden rates need to be reset. Blank is a valid entry for Capability ID. Parameters Name
Type
Description
proposedCapID
String
The proposed Capability ID
ds
The JobEntry data set
ChangeJobOpDtlEstSetHoursPerMch This method recalculates the Estimated Setup Hours when Estimated Setup Hours Per Machine changes. This method should run when the JobOpDtl.EstSetHoursPerMch field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOpDtlOpsPerPart This method calculates Estimated Production Hours when the OpsPerPart field changes. This method should run when the JobOpDtl.OpsPerPart field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOpDtlOverrideRates Method to call when changing the Override Rates Flag. This method will update JobOpDtl with the default labor and burden rates from the appropriate resource or resource group if the JobOpDtl.OverrideRates is set to false. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The JobEntry data set
1171
F-L
Business Object Reference Guide
ChangeJobOpDtlProdStandard This method recalculates the Estimated Production Hours when ProdStandard changes. This method should run when the JobOpDtl.ProdStandard field changes. Parameters Name
Type
Description
ds
Job Entry data set
ChangeJobOpDtlResourceGrpID Method to call when changing the Resource Group ID. This method will update JobOpDtl with the default labor and burden rates from the new resource group. Blank is a valid entry for Resource Group ID. Parameters Name
Type
Description
proposedResGrpID
String
The proposed Resource Group ID
ds
The Job Entry data set
ChangeJobOpDtlResourceID Method to call when changing the Resource ID. This method will update JobOpDtl with the default labor and burden rates from the new resource. Blank is a valid entry for Resource ID. Parameters Name
Type
Description
proposedResourceID
String
The proposed Resource ID
ds
The JobEntry data set
ChangeJobOpDtlStdBasis This method recalculates the Estimated Production Hours when StdBasis changes. This method should run when the JobOpDtl.StdBasis field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOpDtlStdFormat This method recalculates the Estimated Production Hours when StdFormat changes. This method should run when the JobOpDtl.StdFormat field changes.
1172
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOperBillable This method calculates the Labor Rate and Unit Price when the Billable flag changes. This method should run when the JobOper.Billable field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOperCurrencySwitch This method changes the display unit prices based on the flipping of the JobOPer.CurrencySwitch field This method should run when the JobOper.CurrencySwitch external field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOperDisplayUnitPrice This method runs logic to calculate the doc price fields and the display extended price. This method should run when the JobOper.UnitPrice field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperDocUnitPrice This method calculates Unit Price and Billable Unit Price when Doc Unit Price changes. This method should run when the JobOper.DocUnitPrice field changes. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Job Entry data set
1173
F-L
Business Object Reference Guide
ChangeJobOperEstLabHours This method updates the Estimated Production Hours, rate fields, and Production Standard along with others. This method should run when the JobOper.EstLabHours field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOperEstScrap This method calculates Production and Scrap Quantities and estimate producition hours. This method should run when the JobOper.EstScrap field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOperEstScrapType This method calculates Production and Scrap Quantities and estimate producition hours. This method should run when the JobOper.EstScrapType field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOperEstSetHoursPerMch This method calculates the estimated labor hours when Job Type = "SRV" and update the display fields for service amount and labor amount. This method should run when the JobOper.EstSetHoursPerMch field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOperIUM procedure for changing JobOper.IUM field Parameters
1174
Name
Type
Description
ipProposedIUM
String
The proposed IUM.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
ds
Description Job Entry data set
ChangeJobOperLaborEntryMethod Will default the necessary fields when changing the LaborEntryMethod field Parameters Name
Type
Description
iLaborEntryMethod
String
Proposed value for LaborEntryMethod field
ds
The Job entry data set
ChangeJobOperMachines This method updates the fields associated with the changing of the machines, EstLabHours should change. This method should run when the JobOper.Machines field changes. Parameters Name
Type
ds
Description Job Entry data set
ChangeJobOperOpCode This method sets Labor Rates when the JobOper.OpCode changes. This method should run when the JobOper.OpCode field changes. Parameters Name
Type
Description
proposedOpCode
String
The proposed Operation Code
refreshMessage
String@
The refresh message text
ds
The Job entry data set
ChangeJobOperOprSeq Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperOpsPerPart This method calculates Estimated Production Hours when the OpsPerPart field changes. This method should run when the JobOper.OpsPerPart field changes.
Epicor 9.05 | 9.05.605
1175
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperOpStdID This method defaults the new setup and production values when the Operation Standard ID changes. This method should run when the JobOper.OpStdID field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperPartNum This method validates the JobOper.PartNum and defaults fields associated with the partnum. This method should run when the JobOper.PartNum field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperPricePerCode This method recalculates the JobOper Display Extended Price when PricePerCode changes. This method should run when the JobOper.PricePerCode field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperPrimaryProdOpDtl This method defaults/resets the production standards when selecting Primary Production Operation Detail. This method should run when the JobOper.PrimaryProdOpDtl field changes. Parameters Name ds
1176
Type
Description The Job entry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ChangeJobOperPrimarySetupOpDtl This method defaults/resets the setup values when selecting Primary Setup Operation Detail. This method should run when the JobOper.PrimarySetupOpDtl field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperProdStandard This method recalculates teh Estimated Production Hours when ProdStandard changes. This method should run when the JobOper.ProdStandard field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperPurPoint This method determines price breaks and check if inspection is required. This method should run when the JobOper.PurPoint field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperQtyPer This method calculates the production scrap, determines vendor price breaks, and updates the display extended price. This method should run when the JobOper.QtyPer field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperRcvInspection This method runs logic to determine if inspection is required. This method should run when the JobOper.RcvInspection field changes.
Epicor 9.05 | 9.05.605
1177
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ds
The Job entry data set
ChangeJobOperSNRequired Parameters Name
Type
Description
ipProposedSNRequired
Boolean
The new proposed JobOper.SNRequiredOpr value
ds
The Job entry data set
ChangeJobOperSNRequiredSubConShip Parameters Name
Type
Description
ipProposedSNRequiredSubConShip Boolean
The new proposed JobOper.SNRequiredOprSubConShip value
ds
The Job entry data set
ChangeJobOperStdBasis This method runs logic to calculate the estimated production hours. This method should run when the JobOper.StdBasis field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperStdFormat This method runs logic to calculate the estimated production hours. This method should run when the JobOper.StdFormat field changes. Parameters Name ds
Type
Description The Job entry data set
ChangeJobOperUnitPrice This method runs logic to calculate the doc price fields and the display extended price. This method should run when the JobOper.UnitPrice field changes.
1178
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOperVendorNumVendorID This method runs logic to set the purchase points, calculate the price breaks, and checks to see if inspection is required. This method should run when the JobOper.VendorNumVendorID field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobOprRestriction This methods assigns associated fields when JobOperRestriction.RestrictionTypeID changes. Parameters Name
Type
ds
Description JobEntry dataset
ChangeJobOprSubstance This methods assigns associated fields when JobOperRestrictSubst.SubstanceID changes. Parameters Name
Type
ds
Description JobEntry dataset
ChangeJobPartPartNum This method validates the JobPart.PartNum and defaults fields associated with the partnum. This method should run when the JobPart.PartNum field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobProdMakeToJobQty This method runs public method CheckJobProdQtyJob to validate quantities. This method should run when the JobProd.MakeToJobQty field changes.
Epicor 9.05 | 9.05.605
1179
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The Job entry data set
ChangeJobProdMakeToStockQty This method runs logic to set the stock and order WIP quantities This method should run when the JobProd.MakeToStockQty field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobProdMakeToType This method runs logic determine what fields can have value based on the MakeToType and runs logic to set the stock and order WIP quantities. This method should run when the JobProd.MakeToType field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobProdOrderLine This method runs sets the OrderRelNum to zero when OrderLine changes. This method should run when the JobProd.OrderLine field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobProdOrderNum This method runs logic to numerous associated fields to blank or zero based on a new OrderNum. This method should run when the JobProd.OrderNum field changes. Parameters Name ds
1180
Type
Description The Job entry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ChangeJobProdOrderRelNum This method runs logic to validate if a link exists, update the Production Quantity, set stock and order WIP quantities, and validate if direct has been selected. This method should run when the JobProd.OrderRelNum field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobProdOurStockQty This method runs public method CheckJobProdProdQty to validate quantities. This method should run when the JobProd.OurStockQty field changes. Parameters Name
Type
Description
oMessage
String@
Checking message
ds
The Job entry data set
ChangeJobProdProdQty This method runs public method CheckJobProdProdQty to validate quantities and set stock and order WIP quantities. This method should run when the JobProd.ProdQty field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobProdTargetAssemblySeq This method runs logic to clear detail sequence and populate the MakeToJobQty field. This method should run when the JobProd.TargetAssemblySeq field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeJobProdTargetJobNum This method should run when the JobProd.TargetJobNum field changes.
Epicor 9.05 | 9.05.605
1181
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The Job entry data set
ChangeJobProdTargetMtlSeq This method runs validation for links, assign values, and populate MakeToJobQty field This method should run when the JobProd.TargetMtlSeq field changes. Parameters Name
Type
ds
Description The Job entry data set
ChangeResTopics This method should be invoked when the ResTopics changes. Validates and sets the individual ResTopic fields. Parameters Name
Type
Description
topics
String
Proposed topics string id
ds
The Job Entry data set
CheckApprovedSupplier This method runs logic to verify if supplier is approved. This should be called after adding/updating a demand link or adding/updating a subcontract operation. This method always needs a jobnumber inputted. However, ipJobOperRowid or ipJobProdRowid can either be blank. If ipJobOperRowid has value then this method will ignore any value in ipJobProdRowid. This method will output warning messages that may or may not exist. Parameters Name
Type
Description
ipJobNum
String
The job number to check for approved suppliers.
ipJobOperRowid
String
The rowid of subcontract operation to check.
ipJobProdRowid
String
The rowid of the demand link to check.
opWarningMsg
String@
The potential warning message.
CheckChangeJobAsmblParent This method validates validates the new Parent field
1182
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipNewParent
Int32
New Parent value to check against
ds
Job Entry data set
CheckChangeJobMtlMiscCharge This method validates if transaction exists Parameters Name
Type
Description
ipMiscCharge
Boolean
New Misc Charge
ds
Job Entry data set
CheckChangeJobOperPartNum This method validates the JobOper.PartNum This method should run when the JobOper.PartNum field changes. Parameters Name
Type
Description
ipJobNum
String
The Job Number
ipPartNum
String
The New PartNum to validate against.
ipAssemblySeq
Int32
The inputted Assembly Sequence to validate
CheckChangeJobProdOrderRelNum This method runs logic to validate if a link exists, and validate if direct has been selected. Parameters Name
Type
Description
ipNewOrderRelNum
Int32
New OrderRelNum value to check against
ds
Job Entry data set
CheckChangeJobProdTargetAssemblySeq This method checks if a record to make the assembly direct already exists. Parameters Name
Type
Description
ipNewTargetAssemblySeq
Int32
New Target Assembly Number
ds
Epicor 9.05 | 9.05.605
Job Entry data set
1183
F-L
Business Object Reference Guide
CheckChangeJobProdTargetJobNum This method checks to see if the target job is closed or not and returns a message if job is closed, also validates the jobnum Parameters Name
Type
Description
ipNewTargetJobNum
String
The New TargetJobNum to validate against.
vMessage
String@
The returned message
ds
Job Entry data set
CheckChangeJobProdTargetMtlSeq This method runs validation for links, assign values, and populate MakeToJobQty field This method should run when the JobProd.TargetMtlSeq field changes. Parameters Name
Type
Description
ipNewTargetMtlSeq
Int32
The New TargetMtlSeq to validate against.
ds
Job Entry data set
CheckConfiguration This method checks if a part must be configured prior to a GetDetails. Parameters
1184
Name
Type
Description
jobNum
String
Job Number of the target Assembly
sourcePart
String
Part Num to get details from (populated when sourceFile = "Method")
sourceRev
String
Revision number to get details from (populated when sourceFile = "Method")
targetAssembly
Int32
Target Assembly
findRevision
Boolean
If true the revision number will be looked up rather than using the sourceRev
configurationExists
Boolean@
If true the configurator should be run on the Job for the Part/Rev
canGetDetails
Boolean@
If false, GetDetails will fail for a configuration reason that can't be resolve by reconfiguring now
needsConfiguration
Boolean@
If true the configurator should be run on the Job for the Part/Rev
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
configureRevision
String@
The revision that should be configured (if configuration is needed)
reasonMessage
String@
The reason or for the failure or need for configuration. This should be displayed to the user.
CheckExistingConfiguration This method will check to see if an existing configuration exists for a configured part. This method should be called prior to calling the CheckConfiguration method. If the configurationExists is set to "true", then the reasonMessage should be displayed to the user. Parameters Name
Type
Description
jobNum
String
Job Number of the target Assembly
sourcePart
String
Part Num to get details from (populated when sourceFile = "Method")
sourceRev
String
Revision number to get details from (populated when sourceFile = "Method")
targetAssembly
Int32
Target Assembly
findRevision
Boolean
If true the revision number will be looked up rather than using the sourceRev
configurationExists
Boolean@
If true the configurator should be run on the Job for the Part/Rev
configureRevision
String@
The revision that should be configured (if configuration is needed)
reasonMessage
String@
The reason or for the failure or need for configuration. This should be displayed to the user.
CheckForChanges This method determines if a job audit description needs to be entered into ttjobhead.changedescription to be stored in the jobaudit record. Call this before the update of the JobHead record. Parameters Name
Type
Description
cCompany
String
Should the user to be prompted for change description?
cJobNum
String
Should the user to be prompted for change description?
lJobEng
Boolean
Should the user to be prompted for change description?
lJobRel
Boolean
Should the user to be prompted for change description?
lInCopy
Boolean
Should the user to be prompted for change description?
lSchedL
Boolean
Should the user to be prompted for change description?
Epicor 9.05 | 9.05.605
1185
F-L
Business Object Reference Guide
Name
Type
Description
lChkOff1
Boolean
Should the user to be prompted for change description?
lChkOff2
Boolean
Should the user to be prompted for change description?
lChkOff3
Boolean
Should the user to be prompted for change description?
lChkOff4
Boolean
Should the user to be prompted for change description?
lChkOff5
Boolean
Should the user to be prompted for change description?
opChangeDescription
Boolean@
Should the user to be prompted for change description?
CheckJobMtlBuyIt This method should run when the JobMtl.BuyIt field is changing. Parameters Name
Type
ds
Description Job Entry data set
CheckJobMtlPartNumFixQty This method validates the Fixed Qty checkbox control on screen, according to Serial Numbers rules. Parameters Name
Type
Description
ipProposedMtlPartNum
String
The new proposed ttJobMtl.PartNum value
ds
The JobEntry DataSet
CheckJobOperOprSeq This method validates for an invalid sequence for Operation of Subcontract Parameters Name
Type
Description
ipJobNum
String
The inputted Job Number to validate
ipAssemblySeq
Int32
The inputted Assembly Sequence to validate
ipOprSeq
Int32
The inputted Operation Sequence to validate
vMessage
String@
The value of the message if invalid subcontract or operation sequence
CheckJobOperPrimaryProdOpDtl This method validated the value of Primary Production Operation Detail. This method should run when the JobOper.PrimaryProdOpDtl is changing.
1186
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds ipPrimaryProdOpDtl
Description The Job entry data set
Int32
The new PrimaryProdOpDtl value to change to
CheckJobOperPrimarySetupOpDtl This method validated the value of Primary Setup Operation Detail. This method should run when the JobOper.PrimarySetupOpDtl is changing. Parameters Name
Type
ds ipPrimarySetupOpDtl
Description The Job entry data set
Int32
The new PrimarySetupOpDtl value to change to
CheckJobPartPartNumIsSerTra This method validates the JobPart.PartNum is not serial tracked. The rule is that additional JobPart records are not allowed to be serial tracked. Parameters Name
Type
Description
ipProposedPartNum
String
The new proposed JobPart.PartNum value
ds
The Job entry data set
CheckJobProdMakeToType This method validates for an invalid if you can change the JobProd.MakeToType to the provided new value. Parameters Name
Type
Description
ipChangeToType
String
The new maketotype value to change to
ds
Job Entry data set
CheckJobProdProdQty This method validates the JobProd.ProdQty field and returns a message. Parameters Name
Type
Description
dProposedProdQty
Decimal
The new proposed JobProd.ProdQty value
Epicor 9.05 | 9.05.605
1187
F-L
Business Object Reference Guide
Name
Type
Description
vMessage
String@
The returned message
ds
Job Entry data set
CheckJobProdQtyJob This method checks the allocated material/assembly to see if short/over requested quantity and returns a message. Parameters Name
Type
Description
vMessage
String@
The returned message
ds
Job Entry data set
CheckLink Parameters Name
Type
Description
targetJob
String
Target Job Number
targetAsm
Int32
Target Job AssemblySeq
targetMtl
Int32
Target Job Mtl
isEnabled
Boolean@
Make Direct Is Enabled
CheckPrePartInfo This method checks to see if there are any questions or issues with the part entered and returns a message, a part number and if any substitutes exist. Parameters Name
Type
ds
1188
Description JobEntryDataSet
partNum
String@
The input-output part number to validate and it gets returned
sysRowID
String
SysRowID (used only after multiple match resolved)
skipXRefUpdate
Boolean
Skip part xref jobhead field update logic (true for asm and mtl)
xrefPartNum
String
XRef Part Number (used only after multiple match resolved)
xrefPartType
String
XRef Part Type (used only after multiple match resolved)
vMsgText
String@
Potential message to return, will be blank
vSubAvail
Boolean@
Returned flag stating if substitutes exist for this part
vMsgType
String@
Type of message returned. Values can be; "Question" (asking if they want to use the substitute part) "Warning" (Warns them
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
F-L
Type
Description that a part is onhold or runout). "Error" (Part in Inactive, or Onhold/Runout parts are not accepted in this case) . "Question" is asking if they want to use the substitute part.
multipleMatch
Boolean@
Multiple matches were found.
CheckPreProjectID This method validates the project id and returns a question if you would like to proceed message. Parameters Name
Type
Description
ipJobProdRowid
String
The character rowid value of the JobProd to validate
vMessage
String@
The returned message
ds
Job Entry data set
CheckResourcePlants This method validates that the Plant of the job operation resources are the same as the job Maintenance Jobs are and exception, they can have resources of the Job Plant or Equipments Plant or the Plant Maintenance Plant Parameters Name
Type
Description
cjobnum
String
Job number
runOutWarning
String@
Warning Message about RunOut Parts on Job. Client to display this as a warning only
CheckToReschedule This method checks the required due date and production quantity and returns a message asking if you would like to schedule if the conditions are met. Parameters Name
Type
Description
cCompany
String
The returned message
cJobNum
String
The returned message
reqDueDate
Nullable{System.DateTime}
The returned message
prodQty
Decimal
The returned message
dueDate
Nullable{System.DateTime}
The returned message
startDate
Nullable{System.DateTime}
The returned message
jobEngineered
Boolean
The returned message
Epicor 9.05 | 9.05.605
1189
F-L
Business Object Reference Guide
Name
Type
Description
vMessage
String@
The returned message
CheckTotProdQty This method checks the total production quantity and returns messages if conditions exist and the returned message will contain 'do you want to continue?'. Depending on how/where it is called, the ipJobNum may be blank and the ipQuantity may be zero. Job Entry calls this on "changing" of the Engineered flag to true. In this case it passes the ipQuantity is zero since the jobs production demands are already known. During Job Manager, Create Job the ipJobNum is blank, but the ipQuantity of the demand is passed since this demand is yet in the job. Parameters Name
Type
Description
ipJobNum
String
The job number to validate
ipPartNum
String
The part number to validate
ipQuantity
Decimal
The quantity of the new Demand being added.
vMessage
String@
The returned message
ChooseUnlink This method unlinks and deletes a jobprod record and returns the updated dataset Parameters Name
Type
Description
ipJobProdRowid
String
The character rowid value of the JobProd to unlink
Returns Results of dataset with the jobprod record removed
CreateJobPWB The method will create a job when properly called from Planning Workbench. Parameters
1190
Name
Type
Description
ipNewJobNum
String
The next/new job number to use.
ipPartSugRowid
String
The rowid of the partsug record to create job for.
ipGetDetails
Boolean
The flag to get details.
ipScheduleAll
Boolean
The flag to schedule all.
ipReleaseAll
Boolean
The flag to release all.
ipTravelerReadyToPrint
Boolean
Indicates if the Traveler can be printed
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
opCreatedJobNum
String@
The value of the created job number. If ipNewJobNum was blank then this would show the value of the generated job number.
opErrMsg
String@
Potential error messages that did not cause processing to terminate.
DeleteAll The method deletes all assemblys and their subassemblys, materials and operations while leaving the base assembly sequence alone however removing the base assembly's material and operations. Parameters Name
Type
Description
ipJobHeadRowid
String
The JobHead rowid of to delete all of the assemblies for
Returns Job Entry data set
DeleteRefDesRange Deletes JobMtlRefDes records based on the JobMtl dataset fields. Parameters Name
Type
Description
ipJobNum
String
The Job Number
ipAsmSeq
Int32
The Job Assembly
ipMtlSeq
Int32
The Job Material Seq
ipPrefix
String
The Prefix to be used to delete Reference Designators
ipStartNum
Int32
The Starting Number to delete Reference Designators
ipEndNum
Int32
The Ending Number to delete Reference Designators
ipSuffix
String
The Suffix to be used to delete Reference Designators
ds
The Job Entry data set
FindAssembly This method will locate a JobAsmbl record in the tree based on the inputted parameters. Parameters Name
Type
Description
ipJobNum
String
The job number to search from.
ipStartAssemblySeq
Int32
The starting assembly sequence to search from.
Epicor 9.05 | 9.05.605
1191
F-L
Business Object Reference Guide
Name
Type
Description
ipPartNum
String
The part number or part number string to search for.
opAssemblySeq
Int32@
The assembly sequence that was located by the search.
opRowid
String@
The character representation of rowid of the JobAsmbl record located.
GetAssemblyCosts Returns the costs of Assemblies and Materials. Parameters Name
Type
Description
ipJobNum
String
Job Number of the target Assembly
ipAssemblySeq
Int32
Assembly Sequence
Returns Results JobCostsDataSet
GetBasePartForConfig This method will retrieve the base configured part number to be passed to configuration entry Parameters Name
Type
Description
targetJobNum
String
Indicates the target job number
targetAssembly
Int32
Indicates the target job assembly sequence
sourcePartNum
String
Indicates the source part number to get details from
sourceRevisionNum
String
Indicates the source revision number to get details from
basePartNum
String@
Returns the Base Part Number to use for configuration
baseRevisionNum
String@
Returns the Base Revision Number to use for configuration
curPartNum
String@
Returns the Current Part Number to use for configuration
curRevNum
String@
Returns the Current Revision Number to use for configuration
siValues
Boolean@
Returns whether the configuration is set to save input values
GetByIdandJobType A variation of the standard GetByID. Besides JobNum also has parameter for JobType(s). Note JobType is a comma separated list of types to be considered valid for this Get. Used as a predecessor to calling GetByID.
1192
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
jobNum
String
JobHead.JobNum
jobType
String
JobHead.JobType
GetDatasetForTree This methods will return the dataset for Job Entry. The method will return the records related to the assembly provided and the first child level assemblies related to the input inputted assembly. Parameters Name
Type
Description
ipJobNum
String
The Job Number to return data for.
ipStartAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCurrentAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this job number?
ipJobTypeMode
String
Job must be one of these types else it is an error. ipJobTypeMode can be blank, no constraint
Returns Job Entry data set
GetDetails This method retrieves the manufacturing details from a source file. The source file will either be a Quote, a Job, or a Method (Part). The assembly records will be created regardless if the part is in error or not. Parameters Name
Type
Description
jobNum
String
Job Number of the target Assembly
targetAsm
Int32
Sequence of the target Assembly
sourceFile
String
Source (Quote, Job, or Method) of the details to copy
sourceQuote
Int32
Quote Number to get details from (populated when sourceFile = "Quote")
sourceLine
Int32
Quote Line to get details from (populated when sourceFile = "Quote")
sourceJob
String
Job Number to get details from (populated when sourceFile = "Job")
sourceAsm
Int32
Quote Assembly to get details from (populated when sourceFile = "Quote" or "Job")
sourcePart
String
Part Num to get details from (populated when sourceFile = "Method")
Epicor 9.05 | 9.05.605
1193
F-L
Business Object Reference Guide
Name
Type
Description
sourceRev
String
Revision number to get details from (populated when sourceFile = "Method")
sourceAltMethod
String
Alternate Method to get details from (populated when sourceFile = "Method")
resequence
Boolean
Indicates if assemblys should be resequenced
useMethodForParts
Boolean
If true use the method passed in for all parts in assemblies, if false use the assembly part's default method.
Returns Results of the get details
GetJMtlStat This method returns the JMtlStat dataset. This dataset is used for the Job Material Status view. Prior to running this method, the RowMod field in JMtlStatFilters must be set to U if it does not alreay have this value. Parameters Name
Type
Description
ds
Job Tracker Material Status filters data set
Returns Job Tracker Material Status data set
GetJMtlStatFilters This method returns a record in the JMtlStatFilters dataset. This record is used to capture the filters to retrieve the JMtlStat data for the Job Material Status view. Parameters Name
Type
Description
jobNum
String
Job Number for the Job Material Status view
Returns Job Tracker Material Status filters data set
GetLinkedQuoteLineList This method returns a list of QuoteNum and QuoteLine values for a JobProd record whose OrderNum is greater than 0. Parameters
1194
Name
Type
Description
ipJobNum
String
The JobNum to return values for
opQuoteLineList
String@
The returned values in list form
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetNextJobNum This methods generates the next available job number from the JCSyst table. Parameters Name
Type
Description
opNextJobNum
String@
The outputted string of the next available job number
GetNextJobNumOrderRelease This methods generates the job number based off of the OrderRel record related to the input PartSug. Parameters Name
Type
Description
ipPartSugRowid
String
The rowid of the partsug record to create job for.
opNextJobNum
String@
The outputted string of the job number
GetNextMntJobNum Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Returns list of Project Roles
InitJobOperSNReqSubConShip Parameters Name
Type
ds
Description The Job entry data set
InsertBOMAsm This methods allows for the insertion of an engineering assembly for drag/drop functionality, Parameters Name
Type
Description
ipParentJobAsmblRowid
String
The rowid of the parent jobasmbl to add to
Epicor 9.05 | 9.05.605
1195
F-L
Business Object Reference Guide
Name
Type
Description
ipSourceRowid
String
The rowid of source record could be jobasmbl, jobmtl, or quotemtl to be added to the parent jobasmbl
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipDroppedAs
String
The character value to determine where to drop and to drop as what. valid values: JobAsmbl, JobAsmbl-AsMtl, QuoteAsm, QuoteAsm-AsMtl
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipStartAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCurrentAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this job number?
Returns Job Entry data set
InsertBOMMtl This methods allows for the insertion of an engineering material for drag/drop functionality, Parameters Name
Type
Description
ipParentJobAsmblRowid
String
The rowid of the JobAsmbl record to add the material to
ipSourceRowid
String
The rowid of source record could be jobasmbl, jobmtl, or quotemtl to be added to the parent jobasmbl
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipMtlSeq
Int32
The material seq to use
ipBeforeMtlRowid
String
The material rowid to insert material before
ipDroppedAs
String
The character value to determine where to drop and to drop as what. valid values: PartMtl-AsMtl, PartMtl-AsAsm, JobMtl-AsAsm, JobMtl, QuoteMtl-AsAsm, QuoteMtl
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipStartAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCurrentAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this job number?
Returns Job Entry data set
InsertBOMOper This methods allows for the insertion of an engineering operation for drag/drop functionality,
1196
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipParentJobAsmblRowid
String
The rowid of the parent jobasmbl to add to
ipSourceRowid
String
The rowid of source record could be joboper, partopr, or quoteopr to be added to the parent jobasmbl
ipNewOperSeq
Int32
The new operation seq
ipBeforeOperRowid
String
The operation rowid to insert operation before
ipDroppedAs
String
The character value to determine where to drop and to drop as what. valid values: PartOpr, JobOper, QuoteOpr
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipStartAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCurrentAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this job number?
Returns Job Entry data set
InsertMaterial This methods allows for the insertion on a material for drag/drop functionality, validates a JobAsmbl record exists and the part is valid. Parameters Name
Type
Description
ipJobAsmblRowID
String
The rowid of the JobAsmbl record to add the material to
ipPartNum
String
The part number being added
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipMtlSeq
Int32
The material seq to use
ipBeforeMtlRowid
String
The material rowid to insert material before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipStartAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCurrentAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this job number?
Returns Job Entry data set
Epicor 9.05 | 9.05.605
1197
F-L
Business Object Reference Guide
InsertNewJobAsmbl This method creates a new Assembly after prompting for the AsemblySeq and BOMLevel as well as the JobNum field. This is to replace the standard GetNewJobAsmbl when needing to insert a new record between two existing records. Parameters Name
Type
Description
ds
Job Entry data set
jobNum
String
Assembly's parent Job
assemblySeq
Int32
Assembly's parent assembly Seq
bomLevel
Int32
Assembly's parent BOMLevel
priorAssemblySeq
Int32
If adding a sub-assembly record, this value is 0. If insterting after a specific assembly then use that record's assembly seq (must be different from the parent assembly seq)
InsertNewJobMtl This methods allows for the insertion on a material for drag/drop functionality, validates a JobAsmbl record exists and the part is valid. Parameters Name
Type
Description
ipJobAsmblRowID
String
The rowid of the JobAsmbl record to add the material to
ipPartNum
String
The part number being added
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipMtlSeq
Int32
The material seq to use
ipBeforeMtlRowid
String
The material rowid to insert material before
ds
Job Entry data set
InsertNewJobOper This methods allows for the insertion on a new operation between two records Parameters Name
Type
Description
ipJobAsmblRowID
String
The rowid of the JobAsmbl record to add the operation to
ipNewOprSeq
Int32
The new operation seq
ipBeforeOperRowid
String
The operation rowid to insert operation before
ds
1198
Job Entry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
InsertOpDtlCapability This method allows for the insertion of Capability on an operation to create operation detail for drag/drop functionality. Parameters Name
Type
Description
ipJobOperRowID
String
The rowid of the JobOper record to add the operation detail to
ipCapabilityID
String
The Capability ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
Returns Job Entry data set
InsertOpDtlResGroup This method allows for the insertion of Resource Group on an operation to create operation detail for drag/drop functionality. Parameters Name
Type
Description
ipJobOperRowID
String
The rowid of the JobOper record to add the operation detail to
ipResourceGrpID
String
The Resource Group ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
Returns Job Entry data set
InsertOpDtlResource This method allows for the insertion of Resource on an operation to create operation detail for drag/drop functionality. Parameters Name
Type
Description
ipJobOperRowID
String
The rowid of the JobOper record to add the operation detail to
Epicor 9.05 | 9.05.605
1199
F-L
Business Object Reference Guide
Name
Type
Description
ipResourceID
String
The Resource ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
Returns Job Entry data set
InsertOperationOP This methods allows for the insertion on an operation for drag/drop functionality Parameters Name
Type
Description
ipJobAsmblRowID
String
The rowid of the JobAsmbl record to add the operation to
ipOpCode
String
The operation code being added
ipNewOprSeq
Int32
The new operation seq
ipBeforeOperRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Returns Job Entry data set
InsertOperCapability This method allows for the insertion of Capability on an assembly to create JobOper/JobOpDtl for drag/drop functionality. Parameters
1200
Name
Type
Description
ipJobAsmblRowID
String
The rowid of the JobAsmbl record to add the operation detail to
ipCapabilityID
String
The Capability ID being added
ipNewOprSeq
Int32
The new operation seq
ipBeforeOprRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns Job Entry data set
InsertOperResGroup This method allows for the insertion of ResourceGroup on an assembly to create JobOper/JobOpDtl for drag/drop functionality. Parameters Name
Type
Description
ipJobAsmblRowID
String
The rowid of the JobAsmbl record to add the operation detail to
ipResourceGrpID
String
The Resource Group ID being added
ipNewOprSeq
Int32
The new operation seq
ipBeforeOprRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Returns Job Entry data set
InsertOperResource This method allows for the insertion of Resource on an assembly to create JobOper/JobOpDtl for drag/drop functionality. Parameters Name
Type
Description
ipJobAsmblRowID
String
The rowid of the JobAsmbl record to add the operation detail to
ipResourceID
String
The Resource ID being added
ipNewOprSeq
Int32
The new operation seq
ipBeforeOprRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Returns Job Entry data set
InsertSubAssembly This methods allows for the insertion of a subassembly for drag/drop functionality, validates the part.
Epicor 9.05 | 9.05.605
1201
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipJobAsmblRowID
String
The rowid of the JobAsmbl record to add the material to
ipPartNum
String
The part number being added
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipStartAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCurrentAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this job number?
Returns Job Entry data set
JobScheduling Calls jc/jcshded.p and performs the job scheduling without an interface like in Sales Order Parameters Name
Type
Description
ipJobNum
String
The Job to schedule
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipStartAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCurrentAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this job number?
Returns Job Entry data set
PreCheckNewJobProd This method is ran before GetNewJobProd. It will determine if you can create a demand link with a Make To Type of Stock. It will validate that you aren't creating a Stock demand link with a non-stock part. Parameters
1202
Name
Type
Description
ipJobNum
String
The job number to create the jobprod for
ipPartNum
String
The part number to create the jobprod for
ipMakeToType
String
The new maketotype value to create the jobprod with. Valid Values: STOCK, ORDER, JOB
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
PreGetDetails This method should be called right before the GetDetails method. It necessasry, it'll return a question on resequencing assembly's while getting details. The answer will be sent as a parameter to the GetDetails method. This method will also return a BasePartNum and BaseRevisionNum. If the BasePartNum isn't null then use this as the default part number for GetDetails. Parameters Name
Type
Description
sourcePartNum
String
Indicates the source part number to get details from
sourceRevisionNum
String
Indicates the source revision number to get details from
sourceFile
String
Indicates where the details are being appended from. Either Quote, Job or Method
targetJobNum
String
Target Job Number
targetAsm
Int32
Sequence of the target Assembly
vMessage
String@
Returns resequence question
basePartNum
String@
Returns the Base Part Number to use for get details
baseRevisionNum
String@
Returns the Base Revision Number to use for get details
PreInsertSubAssembly This method should be called right before the InsertMaterial. It necessasry, it'll return a warning if there is no source method. Parameters Name
Type
Description
ipPartNum
String
The inputted part number
vMessage
String@
Returns warning
Name
Type
Description
ipJobNum
String
Job number
RemoveFromSchedule Removes job from schedule Parameters
ValidateInspection Method to validate the Inspection control fields. (EQM)
Epicor 9.05 | 9.05.605
1203
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipProposedInspPlan
String
The new proposed InspPlanPartNum value
ipProposedSpecId
String
The new proposed SpecID value
iptable
String
table name
setRev
Boolean
if set default revision
ds
The Job entry Dataset.
ValidateJobNum This method will validate that the job number entered not through a search will be a valid job number for the entered plant. Parameters Name
Type
Description
ipJobNum
String
The entered job number.
ValidateRefDes Check the number of reference designators are equal to the Required Ref Designators defined on JobMtl. Parameters Name
Type
Description
ipJobNum
String
Job Number to validate
ipAsmSeq
Int32
Assembly Seq of the Job Number to validate or -1 to validate all of them
JobManager Epicor.Mfg.BO.JobManager: This business object contains 18 methods.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
1204
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckPartStatus This method checks to see if there are any questions or issues with the part entered and returns a message, if any substitutes exist and Message type. Intended to be called prior to calling the CreateJob method.
Epicor 9.05 | 9.05.605
1205
F-L
Business Object Reference Guide
Parameters Name
Type
Description
partNum
String
The part number to validate
vMsgText
String@
Potential message to return, will be blank
vSubAvail
Boolean@
Returned flag stating if substitutes exist for this part
vMsgType
String@
Type of message returned. Values can be; "Question" (asking if they want to use the substitute part) "Warning" (Warns them that a part is onhold or runout). "Error" (Part in Inactive, or Onhold/Runout parts are not accepted in this case) . "Question" is asking if they want to use the substitute part. Note: In this case, we do not give option to accept a substitute part. Therefore a Question type will never be returned.
CreateJob To create a new Job for production demand. You pass this method the Reckey of the demand record for which a job will be created. The job will be created and this demand record will be linked to it. You must also pass the Job Number you wish to use. This should have been determined using the standard object to assign job numbers. IMPORTANT: Your logic should have also called the CheckPartStatus method and provided the appropriate user interaction before calling this mehtod. Parameters Name
Type
Description
demandReckey
String
The JMDemand.RecKey field value of row for which a new job will be created.
newJobNum
String
Job number to be assigned to the newly created job
Returns Job Manager data set
DeleteJob To delete the Job of a specific JMSupply record. Parameters Name
Type
Description
jmSupply_RecKey
String
The JMSupply.Reckey field is the physical rowid of the JobPart record. Therefore it can be used to indicate the job that you wish deleted.
Returns Job Manager data set
DeletePartSug Deletes Part Suggestion
1206
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
partSug_RowID
String
Part Suggestions Row id
Returns Job Manager data set
GetMatrix To retrieve the JobManager dataset for a given part number. This dataset is a Demand/Supply matrix for the part. Note: Part numbers may not exist in the Part table. Therefore, this method allows you to pass in the part description. Depending on where you are calling from, you might use OrderDtl.LineDesc, JobMtl.Description, etc. Parameters Name
Type
Description
ipPartNum
String
Part number to be retrieved.
ipPartDescription
String
Description of the Part. Optional, used only if the the given part does not exist in the Part table.
uomCode
String
UOM Code (only used for Product Codes)
Returns Job Manager data set
GetNextJobNumOrderRelease This methods generates the job number based off of the OrderRel record related to the input PartDtl. Parameters Name
Type
Description
ipPartDtlRowid
String
The rowid of the partdtl record to create job for.
opNextJobNum
String@
The outputted string of the job number
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
uomCode
String@
UOM Code (only used for Product Codes)
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
Epicor 9.05 | 9.05.605
1207
F-L
Business Object Reference Guide
Name
Type
Description
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
LinkToJob To link a production demand (JMDemand record) with an existing job. This validates the following: 1. The demand record still exists in the database. 2. That it is not already linked to a source of supply (job, warehouse) 3. Target job exists. 4. Target job is not a Field Service Job. 5. System configuration allows changes to engineered Jobs. 6. Job is not Closed. Parameters Name
Type
Description
demandReckey
String
The JMDemand.RecKey field value of row to be linked.
targetJobNum
String
Job number that you want to link the demand to.
Returns Job Manager data set
PreGetDetails This method checks to see if the part is a valid part in the part master. Configured parts have the option to create part numbers without create a part record. If this is the case, then use the OrderDtl.BasePartNum and OrderDtl.BaseRevisionNum or QuoteDtl.BasePartNum and QuoteDtl.BaseRevisionNum to get details. If the basePartNum isn't equal to null then use it to Get Details Parameters Name
Type
Description
partNum
String
The part number to validate
revisionNum
String
The revision number to validate
targetJobNum
String
Target Job Number
targetAsm
Int32
Sequence of the target Assembly
basePartNum
String@
Base Part Number to use for Get Details
baseRevisionNum
String@
Base Revision Num to use for Get Details
PullFromStock To link a demand with to a warehouse that will supply the demand.
1208
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
demandReckey
String
JMDemand.RecKey of the record to be pulled from stock.
linkToWareHouseCode
String
Warehouse to be pulled from (allocated against).
Returns Job Manager data set
TransferDemand To transfer a demand on one job to another job. Parameters Name
Type
Description
transferRecKey
String
TransferRecKey (either DemandSupply or SupplyDemand.RecKey) of the record to be transferred.
targetJobNum
String
Job Number that the demand will be transfered to.
Returns Job Manager data set
UnlinkDemand To unlink a demand from the related Job. Parameters Name
Type
Description
supplyDemandReckey
String
JMttJMSupplyDemand.RecKey of the record to be unlinked.
Returns Job Manager data set
UnlinkSupply To unlink a supply from it's related demand. Parameters Name
Type
Description
demandSupplyReckey
String
JMttJMDemandSupply.RecKey of the record to be unlinked.
demandSupplySourceTable
String
ttJMDemandSupply.SourceTable of the record to be unlinked.
Epicor 9.05 | 9.05.605
1209
F-L
Business Object Reference Guide
Returns Job Manager data set
JobMtlSearch Epicor.Mfg.BO.JobMtlSearch: This business object contains 7 methods.
GetNewJobMtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1210
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
JobOperSearch Epicor.Mfg.BO.JobOperSearch: This business object contains 7 methods.
GetNewJobOper Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1211
F-L
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
JobPart Epicor.Mfg.BO.JobPart: This business object contains 7 methods.
GetNewJobPart Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1212
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
JobProdSearch Epicor.Mfg.BO.JobProdSearch: This business object contains 7 methods.
GetNewJobProd Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1213
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
JobSched Epicor.Mfg.BO.JobSched: This business object contains 8 methods.
GetNewJobSched Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1214
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetByDesc Retrieve a record by the description Parameters Name
Type
Description
jobSchedDescription
String
The description of the record to retrieve
Epicor 9.05 | 9.05.605
1215
F-L
Business Object Reference Guide
Returns The RMAProc data set
JobStatus Epicor.Mfg.BO.JobStatus: This business object contains 14 methods.
GetNewJobHead Inserts a new row in the DataSet with defaults populated.
GetNewJobAsmbl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1216
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeJobHeadFirm This method validates the JobHead.JobFirm and potentially changes the jobreleased fields. This method should run when the JobHead.JobFirm field changes. Parameters Name
Type
Description
ipProposedJobFirm
Boolean
The new proposed JobFirm value
jobNum
String
The job number to search appropriate record
ds
The dataset for the Job Status Maintenance
ChangeJobHeadJobEngineered This method validates the JobHead.JobEngineered and potentially changes the jobreleased field. This method should run when the JobHead.JobEngineered field changes. Parameters Name
Type
Description
ipProposedJobEngineered
Boolean
The new proposed JobEngineered value
jobNum
String
The job number to search appropriate record
ds
The dataset for the Job Status Maintenance
ChangeJobHeadJobReleased This method validates the JobHead.JobReleased and potentially changes the jobengineered and/or jobfirm fields. This method should run when the JobHead.JobReleased field changes. Parameters Name
Type
Description
ipProposedJobReleased
Boolean
The new proposed JobReleased value
jobNum
String
The job number to search appropriate record
ds
Epicor 9.05 | 9.05.605
The dataset for the Job Status Maintenance
1217
F-L
Business Object Reference Guide
GetListFromSelectedKeys This methods will return all of the JobHeadSearch records which will be a subset of the JobHead records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table we need our own public method. Parameters Name
Type
ds
Description The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
GetRowsFromSelectedKeys This methods will return all of the JobHeadSearch records which will be a subset of the JobHead records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table we need our own public method. Parameters Name
Type
ds
Description The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
MassUpdate Call this method to update multiple JobHead records. Parameters Name ds
Type
Description The dataset for the Job Status Maintenance
JournalTrackerDetail Epicor.Mfg.BO.JournalTrackerDetail: This business object contains 10 methods.
GetNewGLJrnDtl Inserts a new row in the DataSet with defaults populated.
1218
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetNewTranGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
1219
F-L
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
GetJournalDetail Filter journals by Journal Code and Journal Number. Parameters Name
Type
Description
opMessage
String@
returns informational messages to the user when no records are found.
ds
Epicor.Mfg.BO.JournalTrackerDetailDataSet
GetTranGLCHead This method replaces the standard GetRows method Parameters Name
Type
Description
vJournalCode
String
Journal Code
vBookID
String
Book ID
Returns JournalTracker
JPPerBill Epicor.Mfg.BO.JPPerBill: This business object contains 11 methods.
GetNewPerBillHead Inserts a new row in the DataSet with defaults populated.
GetNewPerBillDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
1220
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCustNum Receives CustId, returns CustNum Parameters Name
Type
Description
ipCustID
String
Customer ID
opCustNum
Int32@
Returns Customer Num
Epicor 9.05 | 9.05.605
1221
F-L
Business Object Reference Guide
ValidateEndOfMonth Validates that only one "end of month" record exist per customer. Parameters Name
Type
Description
ipEndOfMonth
Boolean
Proposed EndofMonth value
ds
Periodic Billing data set
ValidateSummDay Validates that the Summarization Day is unique. Parameters Name
Type
Description
ipSummDay
Int32
Proposed Summarization Day value
ds
Periodic Billing data set
JPPerBillStmt Epicor.Mfg.BO.JPPerBillStmt: This business object contains 17 methods.
GetNewPerBillStmtGrp Inserts a new row in the DataSet with defaults populated.
GetNewPerBillStmtHead Inserts a new row in the DataSet with defaults populated.
GetNewPerBillStmtDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1222
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCustNum Receives CustId, returns CustNum Parameters Name
Type
Description
ipCustID
String
Customer ID
opCustNum
Int32@
Returns Customer Num
GetCustomers Syncronize the DueDate and Billing date HeadInvoice with the values of the PerBillStmtDtl table.
Epicor 9.05 | 9.05.605
1223
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipGrpID
String
Group ID
ds
Periodic Billing Statement data set
SynchronizeInvoices Syncronize the DueDate and Billing date HeadInvoice with the values of the PerBillStmtDtl table. Parameters Name
Type
Description
ipGrpID
String
Group ID
ipCustNum
Int32
Customer Num
ds
Periodic Billing Statement data set
UpdateDueDateOnDtl Updates the table PerBillStmtDtl with the new due date from PerBillStmtHead Parameters Name
Type
Description
ipGrp
String
Billing Statement Group ID.
ipBillingDate
Nullable{System.DateTime}
Billing Date
ipCustNum
Int32
Customer number
ipDueDate
Nullable{System.DateTime}
Billing Date
ds
Periodic Billing Statement data set
ValidateBillingDate Validate that the Billing date is not higer than the due date. Parameters Name
Type
Description
ipBillingDate
Nullable{System.DateTime}
Proposed Billing Date
ds
Periodic Billing Statement data set
ValidateCustID Receives CustId, returns CustNum
1224
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipCustID
String
Customer ID
opCustNum
Int32@
Returns Customer Num
ds
Periodic Billing Statement data set
ValidateDueDate Validate that the due date is not lower than the billing date. Parameters Name
Type
Description
ipDueDate
Nullable{System.DateTime}
Proposed DueDate
ds
Periodic Billing Statement data set
ValidateReadyToBill Validate that all the invoices are syncronized before setting the customer to "ready to bill. Parameters Name
Type
Description
ipReadyToBill
Boolean
Proposed Ready To Bill status
ds
Periodic Billing Statement data set
JrnlCode Epicor.Mfg.BO.JrnlCode: This business object contains 8 methods.
GetNewJrnlCode Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1225
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
SystemJournal returns TRUE if the JournalCode is being used in a System Table. Parameters
1226
Name
Type
Description
cJournalCode
String
Journal Code
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Chapter 11: K KanbanPartSearch Epicor.Mfg.BO.KanbanPartSearch: This business object contains 7 methods.
GetNewKanbanPartSearch Inserts a new row in the DataSet with defaults populated. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1227
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
KanbanReceipts Epicor.Mfg.BO.KanbanReceipts: This business object contains 23 methods.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
1228
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeBin Update default information based on the bin changing Parameters Name
Type
ds lValidBin
Description The KanbanReceipts data set
Boolean@
Is the Bin Number valid
ChangeEmployee Update default information based on the employee changing Parameters Name
Type
ds lValidEmployee
Description The KanbanReceipts data set
Boolean@
Is the Employee valid
ChangeLotNum Update default information based on the lot changing
Epicor 9.05 | 9.05.605
1229
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ds
The KanbanReceipts data set
lValidLot
Boolean@
Is the Lot Number valid
ChangeNonConfReason Update default information based on the bin changing Parameters Name
Type
ds
Description The KanbanReceipts data set
lValidNonConfReason
Boolean@
Is the Non Conformance reason valid
ChangePart Update default information based on the part number changing Parameters Name
Type
ds
Description The KanbanReceipts data set
lValidPart
Boolean@
Is the Part valid
uomCode
String
UOM Code (only used for Product Codes)
ChangeRevision Update default information based on the revision number changing Parameters Name
Type
Description
ds
The KanbanReceipts data set
ChangeScrapReason Update default information based on the scrap reason changing Parameters Name
Type
ds lValidScrapReason
1230
Description The KanbanReceipts data set
Boolean@
Is the Scrap Reason valid
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
ChangeUsePartNumForLot Update lot number and description if the value is changed to true. Parameters Name
Type
ds
Description The KanbanReceipts data set
ChangeWarehouse Update default information based on the warehouse changing Parameters Name
Type
Description
ds
The KanbanReceipts data set
lValidWarehouse
Boolean@
Is the Warehouse valid
CheckProcessRunning Verify if a similar process is running for the same part. Parameters Name
Type
Description
ip_partnum
String
The required PartNum to run the Kanban Receipt.
oMsgText
String@
Return message if Process is Running, blank if not.
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
uomCode
String@
UOM Code (only used for Product Codes)
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
Epicor 9.05 | 9.05.605
1231
F-L
Business Object Reference Guide
Name
Type
Description
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
Description
ds
The KanbanReceipts data set
Returns The SelectSerialNumbersParams dataset Creates a temporary record to store information needed for the receipt process. Returns The KanbanReceipts data set
PreProcessKanbanReceipts This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
Boolean@
Indicates if the legal number requires user input
ds requiresUserInput
ProcessKanbanReceipts Processes the Kanban Receipt. Parameters Name
Type
ds
1232
Description The KanbanReceipts data set
dSerialNoQty
Decimal
The quantity of Serialized parts. This value is returned by Serial # selector object.
cMessageText
String@
Contains non-error processing information the user may need to see
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
SetActionToSelSerNum Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds
Description The Kanban receipts dataSet
ipInventory
Int32
Is the quantity of serial numbers to inventory
ipScrapped
Int32
Is quantity of serial numbers to scrapped
ipNonconformance
Int32
Is the quantity of serial numbers nonconformance
Submit Submit the Kanban Receipt Process. Parameters Name
Type
ds dSerialNoQty
Description The KanbanReceipts data set
Decimal
The quantity of Serialized parts. This value is returned by Serial # selector object.
ValidateSelectedSerNum Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds
Description The Kanban receipts dataSet
ipInventory
Int32
Is the quantity of serial numbers to inventory
ipScrapped
Int32
Is quantity of serial numbers to scrapped
ipNonconf
Int32
Is the quantity of serial numbers nonconformance
KanBanType Epicor.Mfg.BO.KanBanType: This business object contains 8 methods.
GetNewKanBanType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
1233
F-L
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field.
1234
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
KeyMgmt Epicor.Mfg.BO.KeyMgmt: This business object contains 3 methods.
GetByID This method will return a record for updating. Parameters Name
Type
Description
company
String
Current company
Returns Key Mgmgt Dataset
SetPassword This method takes the entered Password value, validates and saves it to the database. Parameters Name
Type
ds
Description Key Management Dataset
SetSalt This method takes the entered salt value, validates and saves it to the database. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Key Mgmt Dataset
1235
F-L
Business Object Reference Guide
Chapter 12: L LabExpCd Epicor.Mfg.BO.LabExpCd: This business object contains 8 methods.
GetNewLabExpCd Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1236
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Labor Epicor.Mfg.BO.Labor: This business object contains 89 methods.
GetNewLaborHed Inserts a new row in the DataSet with defaults populated.
GetNewLaborDtl Inserts a new row in the DataSet with defaults populated.
GetNewLaborDtlComment Inserts a new row in the DataSet with defaults populated.
GetNewLaborEquip Inserts a new row in the DataSet with defaults populated.
GetNewLaborPart Inserts a new row in the DataSet with defaults populated.
GetNewLaborDtlGroup Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
1237
F-L
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
1238
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns
BuildJobOperPrjRoleList This proc will return the whereclause for the role code combo Customers Parameters Name
Type
Description
ipJobNum
String
JobNum
ipAssemblySeq
Int32
AssemblySeq
ipOprSeq
Int32
OprSeq
ipEmpID
String
EmpID
whereClause
String@
Where Clause to use for role code combo
ChangeEquipID This method should call when EquipID is changed Parameters Name
Type
Description
equipID
String
equipID
ds
Labor Entry Data set
ChangeIndirectCode This method clears the JobNumber and Quantity fields when the LaborType changes to Indirect leaves the values as is if changed between Production and Setup Parameters Name
Type
ds
Description Labor Entry Data set
ChangeLaborType This method clears the JobNumber and Quantity fields when the LaborType changes to Indirect leaves the values as is if changed between Production and Setup Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Labor Entry Data set
1239
F-L
Business Object Reference Guide
ChangeResourceId For use with MES (ShopFloor) only. This method checks the Resource Group of the proposed Resource, and if it is different than the current Resource Group, provides a warning question suitable for presenting to the user. The UI code should place the user's answer to the question in the ttLaborDtl.OkToChangeResourceGrpID. This method should be called prior to calling the DefaultResourceID method. Parameters Name
Type
Description
ds
Labor Entry Data set
pcResourceID
String
The ID of the machine that was used to do the work.
pcMsg
String@
The message sent as output for the user
CheckEmployeeActivity This method checks if the current employee is already working on a Job/Asm/Opr/Resource combination If he/she is already working on it, the opMessage will be populated with an error message Parameters Name
Type
Description
ipEmpID
String
The current Employee ID
ipLaborHedSeq
Int32
LaborHed Sequence
ipJobNum
String
Job Number
ipAsmSeq
Int32
Assembly Sequence
ipOprSeq
Int32
Operation Sequence
ipResourceID
String
Resource ID
opMessage
String@
Error Message
CheckFirstArticleWarning Performs all First Article Validations Parameters Name
Type
ds pcMsg
Description The Labor data set
String@
The message sent as output for the user
CheckInspResults This method validates if InspResults has been entered when the Inspection Data is allowed for the current OprSeq.
1240
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipJobNum
String
Current Job
ipAssemblySeq
Int32
Current AssembleSeq
ipOprSeq
Int32
Current OprSeq
inspectionOK
Boolean@
Returns true if InspResults records are found
CheckResourceGroup This method checks to see if the new resource is in the current resource group. This needs to be run right before the DefaultResourceID. If the user answers okay then the group will be changed in the DefaultResourceID method. Parameters Name
Type
ds
Description Labor Entry Data set
proposedResourceID
String
Proposed Resource ID
vMessage
String@
List of error warnings for user
CheckWarnings This method runs the labor warning routine and returns any warnings the user needs to be aware of. This needs to be run right before the update method. If the user answers okay to all of the questions, then the update method can be run. Otherwise the labor record needs to be corrected Parameters Name
Type
ds vMessage
Description Labor Entry Data set
String@
List of error warnings for user
CopyLaborDetail Method to copy the vales from one Labor record to a new Labor record. Parameters Name
Type
ds cMessageText
Description The Labor data set
String@
Message text to present to the user after the process is finished
CopyTimeWeeklyView Method to copy the vales from one Weekly Time record to a new Weekly Time record.
Epicor 9.05 | 9.05.605
1241
F-L
Business Object Reference Guide
Parameters Name
Type
ds cMessageText
Description The Labor data set
String@
Message text to present to the user after the process is finished
DefaultAssemblySeq This method sets dataset fields when the AssemblySeq field changes Parameters Name
Type
Description
ds assemblySeq
Labor Entry Data set Int32
Proposed AssemblySeq change
DefaultComplete This method updates the dataset after complete flag is set Parameters Name
Type
ds
Description Labor Entry Data set
cmplete
Boolean
Proposed change to the Complete field
vMessage
String@
Returns a string of warnings user needs to know
DefaultDate This method updates the clock in and clock out dates for the LaborHed and LaborDtl tables when the payroll date has changed. Parameters Name
Type
ds payrollDate
Description Labor Entry Data set
Nullable{System.DateTime}
Proposed Payroll Date change
DefaultDiscrpRsnCode This method defaults fields when the discrepancy reason code field changes. Also checks for any warnings the user needs to be aware of
1242
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ds
Labor Entry Data set
proposedDiscrpRsnCode
String
Proposed discrepancy reason
DefaultDtlTime This method updates the hours when a time field changes Parameters Name
Type
ds
Description Labor Entry Data set
DefaultIndirect This method defaults the expense code when the indirect code has changed Parameters Name
Type
ds indirectCode
Description Labor Entry Data set
String
Proposed change to the indirect code
DefaultJobNum This method defaults dataset fields when the JobNum field changes Parameters Name
Type
ds jobNum
Description Labor Entry Data set
String
Proposed change to the JobNum field
DefaultLaborHrs This method updates the tot hours display field when the labor hours clock in/out time changes Parameters Name
Type
ds laborHrs
Epicor 9.05 | 9.05.605
Description Labor Entry Data set
Decimal
Proposed Labor Hrs change
1243
F-L
Business Object Reference Guide
DefaultLaborQty This method defaults fields when the labor qty fields changes. Also checks for any labor warnings the user needs to be aware of Parameters Name
Type
Description
ds
Labor Entry Data set
laborQty
Decimal
Proposed change to LaborQty field
vMessage
String@
Returns a string of warnings user needs to know
DefaultLaborType This method defaults dataset fields when the LaborType field changes. Parameters Name
Type
ds ipLaborType
Description Labor Entry Data set
String
Proposed LaborType change
DefaultLunchBreak This method defaults the Lunch Time fields when the Lunch Break field changes. Parameters Name
Type
Description
ds
Labor Entry Data set
DefaultNextOprSeq This method updates the dataset after next operation seq is set Parameters Name
Type
ds proposedNextOprSeq
Description Labor Entry Data set
Int32
Proposed next operation sequence
DefaultOpCode This method checks for any warnings user needs to know on change of OpCode
1244
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
ds
Description Labor Entry Data set
opCode
String
Proposed OpCode field change
vMessage
String@
Returns list of warnings for user's review
DefaultOprSeq This method defaults fields when Operation sequence changes. Also returns any warnings user needs to know. Parameters Name
Type
oprSeq
Description Proposed oprSeq change
vMessage
Int32
Returns warnings for user's review
ds
String@
Labor Entry Data set
DefaultPhaseID This method defaults dataset fields when the PhaseID field changes. Parameters Name
Type
ds ipPhaseID
Description Labor Entry Data set
String
Proposed PhaseID change
DefaultPhaseOprSeq This method defaults dataset fields when the PhaseOprSeq field changes. Parameters Name
Type
ds
Description Labor Entry Data set
ipPhaseOprSeq
Int32
Proposed PhaseOprSeq change
vMessage
String@
Returns warnings for user's review
DefaultProjectID This method defaults dataset fields when the ProjectID field changes.
Epicor 9.05 | 9.05.605
1245
F-L
Business Object Reference Guide
Parameters Name
Type
ds ipProjectID
Description Labor Entry Data set
String
Proposed ProjectID change
DefaultResourceID This method updates dataset fields when the ResourceID field changes. Parameters Name
Type
ds
Description The Labor data set
proposedResourceID
String
The proposed resource id
DefaultRoleCd This method defaults dataset fields when the RoleCd field changes. Parameters Name
Type
ds ipRoleCd
Description Labor Entry Data set
String
Proposed RoleCd change
DefaultScrapReasonCode This method defaults fields when the scrap reason code fields changes. Also checks for any labor warnings the user needs to be aware of Parameters Name
Type
ds
Description Labor Entry Data set
proposedScrapReasonCode
String
Proposed scrap reason
vMessage
String@
Returns a string of warnings user needs to know
DefaultSetupPctComplete This method validates and reassigns the setup percent complete field. Parameters Name ds
1246
Type
Description Labor Entry Data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
percentComplete
Decimal
Proposed percent complete
DefaultShift This method updates clock in/out and lunch in/out fields after shift field changes Parameters Name
Type
ds shift
Description Labor Entry Data set
Int32
Proposed Shift field change
DefaultTime This method updates time and pay hours when a time field changes Parameters Name
Type
ds
Description Labor Entry Data set
cFieldName
String
name of field being changed
timeValue
Decimal
proposed time change
DefaultTimeTypCd This method defaults dataset fields when the TimeTypCd field changes. Parameters Name
Type
ds ipTimeTypCd
Description Labor Entry Data set
String
Proposed TimeTypCd change
DefaultWCCode This method updates dataset fields when the ResourceGroup field changes. Also checks for any warning the user needs to know Parameters Name
Type
ds
Description Labor Entry Data set
wcCode
String
Proposed WorkCenter Code change
vMessage
String@
Returns any warnings the user needs to review
Epicor 9.05 | 9.05.605
1247
F-L
Business Object Reference Guide
EndActivity Method to call to end an activity in Shop Floor. This method will mark the EndActivity flag in LaborDtl so when the Update method is run, special end activity processing can occur. It will also default values in other fields that apply to the end activity. Before this method is called, the LaborDtl.RowMod value needs to be set to 'U'. Parameters Name
Type
ds
Description The Labor data set
EndActivityComplete This method checks for any necessary labor warning when the complete flag is checked in MES End Activity Parameters Name
Type
ds
Description Labor Entry Data set
cmplete
Boolean
Proposed change to the Complete field
vMessage
String@
Returns a string of warnings user needs to know
GetDetail Method to call to retrieve the Labor dataset with just the header and a specific detail record. Parameters Name
Type
Description
iLaborHedSeq
Int32
The LaborHedSeq of the LaborHed record to retrieve
iLaborDtlSeq
Int32
The LaborDtlSeq of the LaborDtl record to retrieve
Returns The Labor data set
GetNewLaborDtlNoHdr This method is called to add a new labor detail without having a labor header record available Parameters Name
Type
ds
1248
Description Labor Entry Data set
employeeNum
String
The employee id for this labor record
shopFloor
Boolean
Indicates whether this is being called from the shop floor labor entry program
clockInDate
Nullable{System.DateTime}
The clock in date
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
clockInTime
Decimal
The clock in time
clockOutDate
Nullable{System.DateTime}
The clock out date
clockOutTime
Decimal
The clock out time
GetNewLaborDtlWithHdr This method is called to add a new labor detail without having a labor header record available Parameters Name
Type
Description
ds
Labor Entry Data set
ipClockInDate
Nullable{System.DateTime}
The clock in date
ipClockInTime
Decimal
The clock in time
ipClockOutDate
Nullable{System.DateTime}
The clock out date
ipClockOutTime
Decimal
The clock out time
ipLaborHedSeq
Int32
Unique identifier of the LaborHed
GetNewLaborHed1 This method to be used in place of GetNewLaborHed. This method asks for an employee number to default fields based on the employee. Parameters Name
Type
ds
Description Labor Entry Data set
employeeNum
String
The employee id for this labor record
shopFloor
Boolean
Indicates whether this is being called from the shop floor labor entry program
GetNewLbrScrapSerialNumbers Gets a new LbrScrapSerialNumbers record for current LaborDtl Parameters Name ds
Type
Description Labor data set
GetNewTimeWeeklyView Gets a new TimeWeeklyView record for the current week
Epicor 9.05 | 9.05.605
1249
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ds
Labor data set
ipEmployeeNum
String
The employee id for this labor record
ipDateInWeek
Nullable{System.DateTime} Date within the week for which a new TimeWeeklyView record is to be created
GetRowsCalendarView Calls the normal GetRows method and then if a supervisor search criteria has been passed, it screens out only the appropriate rows. Used by Shop Tracker Parameters Name
Type
Description
whereClauseLaborHed
String
Whereclause for LaborHed table.
whereClauseLaborDtl
String
Whereclause for LaborDtl table.
whereClauseLaborDtlCom
String
Whereclause for LaborDtlCom table.
whereClauseLaborEquip
String
Whereclause for LaborDtlEquip table.
whereClauseLaborPart
String
Whereclause for LaborPart table.
whereClauseLbrScrapSerialNumbers
String
Whereclause for LbrScrapSerialNumbers table.
whereClauseTimeWorkHours
String
Whereclause for TimeWorkHours table.
whereClauseTimeWeeklyView
String
Whereclause for TimeWeeklyView table.
whereClauseLaborDtlGroup
String
Whereclause for LaborDtlGroup table.
whereClauseSelectedSerialNumbers
String
Whereclause for SelectedSerialNumbers table.
whereClauseSNFormat
String
Whereclause for SNFormat table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
ipEmployeeNum
String
The employee id for this labor record
ipCalendarStartDate
Nullable{System.DateTime} The first date visible on the calendar
ipCalendarEndDate
Nullable{System.DateTime} The last date visible on the calendar
morePages
Boolean@
More pages.
Returns Labor Dataset
GetRowsWhoIsHere Calls the normal GetRows method and then if a supervisor search criteria has been passed, it screens out only the appropriate rows. Used by Shop Tracker
1250
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
whereClauseLaborHed
String
Whereclause for LaborHed table.
whereClauseLaborDtl
String
Whereclause for LaborDtl table.
whereClauseLaborDtlCom
String
Whereclause for LaborDtlCom table.
whereClauseLaborEquip
String
Whereclause for LaborDtlEquip table.
whereClauseLaborPart
String
Whereclause for LaborPart table.
whereClauseLbrScrapSerialNumbers
String
Whereclause for LbrScrapSerialNumbers table.
whereClauseTimeWorkHours
String
Whereclause for TimeWorkHours table.
whereClauseTimeWeeklyView
String
Whereclause for TimeWeeklyView table.
whereClauseLaborDtlGroup
String
Whereclause for LaborDtlGroup table.
whereClauseSelectedSerialNumbers
String
Whereclause for SelectedSerialNumbers table.
whereClauseSNFormat
String
Whereclause for SNFormat table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
ipSupervisorID
String
Supervisor ID from search criteria.
morePages
Boolean@
More pages.
Returns Labor Dataset
GetTERetrieveApproved Method to get the value UserFile.TERetrieveApproved Parameters Name
Type
Description
opTERetrieveApproved
Boolean@
Should Approved records be retrieved on search? Yes/No
GetTERetrieveByOption Method to get retrieve by options Parameters Name
Type
Description
opTERetrieveByDay
Boolean@
Should records be retrieve one day at a time? Yes/No
opTERetrieveByWeek
Boolean@
Should records be retrieve a week at a time? Yes/No
opTERetrieveByMonth
Boolean@
Should records be retrieve a month at a time? Yes/No
Epicor 9.05 | 9.05.605
1251
F-L
Business Object Reference Guide
GetTERetrieveEntered Method to get the value UserFile.TERetrieveEntered Parameters Name
Type
Description
opTERetrieveEntered
Boolean@
Should Entered records be retrieved on search? Yes/No
GetTERetrievePartiallyApproved Method to get the value UserFile.TERetrievePartiallyApproved Parameters Name
Type
Description
opTERetrievePartiallyApproved
Boolean@
Should Partially Approved records be retrieved on search? Yes/No
GetTERetrieveRejected Method to get the value UserFile.TERetrieveRejected Parameters Name
Type
Description
opTERetrieveRejected
Boolean@
Should Rejected records be retrieved on search? Yes/No
GetTERetrieveSubmitted Method to get the value UserFile.TERetrieveSubmitted Parameters Name
Type
Description
opTERetrieveSubmitted
Boolean@
Should Submitted records be retrieved on search? Yes/No
IsValidAssembly Validate if an assembly is valid for a job. if not returns false, otherwise returns true. Parameters
1252
Name
Type
Description
pcJobNum
String
Job number to which this labor transaction applies.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
piAssemblySeq
Int32
The Assembly Sequence of the Job that the labor transaction applies to.
plFound
Boolean@
Found YES/NO
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeQuickEntryCode This method validates field QuickEntryCode, and if it is valid, uses the values from the QuickEntry record to populate the LaborDtl values. Parameters Name
Type
Description
ipEmpID
String
Proposed EmpID value
ipQuickEntryCode
String
Proposed QuickEntryCode value
ds
The Labor data set
OnChangeResourceGrpID Call this procedure when TimeWeeklyView.ResourceGrpID changes Parameters Name
Type
ds ipResourceGrpID
Description Epicor.Mfg.BO.LaborDataSet
String
Proposed Resource Group
Overrides Call this procedure to override the Resource Group and Operation Code in a job. Parameters Name
Type
ds inOpCode
Epicor 9.05 | 9.05.605
Description Epicor.Mfg.BO.LaborDataSet
String
OpCode to override
1253
F-L
Business Object Reference Guide
Name
Type
Description
inResGrpID
String
Resource Group OD to override
OverridesResource Call this procedure to override the Resource in a LaborDtl record Parameters Name
Type
ds
Description The Labor data set
proposedResourceID
String
The proposed resource id
RecallFromApproval Method to recall Labor for Approval. Parameters Name
Type
ds
Description The Labor data set
lWeeklyView
Boolean
Is this method being called with WeeklyView records?
cMessageText
String@
Message text to present to the user after the process is finished
SelectForWork This method is intended to be used when the MES/ShopFloor user selects an operation from the WorkQueue to work on. Use this method in place of the Update method in this situation. This method expects a LaborDataSet containing a single LaborHed with a RowMod indicating a changed row, and a LaborDtl row with a RowMod indicating a changed row. This can be obtained with a call to Labor.GetRows() with a whereClauseLaborHed of ActiveTrans = YES and EmployeeNum = xxxx substituting the desired employeeNum for the xxxx. followed by a call to LaborDtlGetNew. After validating the given Job, Assembly, Operation, ResourceID, ResourceGrpID and LaborType, and additional validations are applied, the LaborDtl is updated. An exception is thrown if: - a changed Laborhed row is not found. - the given Job, Assembly and Operation is not valid - the LaborHed.ActiveTrans = no. This method is for MES (ShopFloor) use only. - the given LaborType is not "S" or "P" Parameters Name
Type
ds
1254
Description Labor Entry Data set
pcResourceGrpId
String
The Resource Group id for this work.
pcResourceId
String
The Resource id for this work.
pcLaborType
String
Labor Type: S=Setup, P=Production
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
SelectForWorkCheckWarnings This method runs the shop warning routine and returns any warnings the user needs to be aware of. This needs to be run right before the SelectForWork method. If the user answers okay to all of the questions, then the SelectForWork method can be run. Otherwise the labor record needs to be corrected Parameters Name
Type
ds vMessage
Description Labor Entry Data set
String@
List of error warnings for user
SetClockInAndDisplayTimeMES Sets the Time Stamp in which the Employee Starts his/her activity and also populates the field that displays the time correctly. Parameters Name
Type
ds
Description The Labor data set
SetTERetrieveApproved Method to set the value UserFile.TERetrieveApproved Parameters Name
Type
Description
ipTERetrieveApproved
Boolean
Value to set UserFile.TERetrieveApproved Yes/No
SetTERetrieveByDay Method to set the value for retrieve by day Parameters Name
Type
Description
ipTERetrieveByDay
Boolean
Value to set the by day option Yes/No
SetTERetrieveByMonth Method to set the value for retrieve by month
Epicor 9.05 | 9.05.605
1255
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipTERetrieveByMonth
Boolean
Value to set the by month option Yes/No
SetTERetrieveByWeek Method to set the value for retrieve by week Parameters Name
Type
Description
ipTERetrieveByWeek
Boolean
Value to set the by week option Yes/No
SetTERetrieveEntered Method to set the value UserFile.TERetrieveEntered Parameters Name
Type
Description
ipTERetrieveEntered
Boolean
Value to set UserFile.TERetrieveEntered Yes/No
SetTERetrievePartiallyApproved Method to set the value UserFile.TERetrievePartiallyApproved Parameters Name
Type
Description
ipTERetrievePartiallyApproved
Boolean
Value to set UserFile.TERetrievePartiallyApproved Yes/No
SetTERetrieveRejected Method to set the value UserFile.TERetrieveRejected Parameters Name
Type
Description
ipTERetrieveRejected
Boolean
Value to set UserFile.TERetrieveRejected Yes/No
SetTERetrieveSubmitted Method to set the value UserFile.TERetrieveSubmitted
1256
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ipTERetrieveSubmitted
Boolean
Value to set UserFile.TERetrieveSubmitted Yes/No
StartActivity Method to call to start an activity in Shop Floor. Parameters Name
Type
Description
laborHedSeq
Int32
The labor header sequence
startType
String
The type of activity being started. Values are: P - Production I - Indirect S - Setup R - Rewwork
ds
The Labor data set
SubmitForApproval Method to submit Labor for Approval. Parameters Name
Type
ds
Description The Labor data set
lWeeklyView
Boolean
Is this method being called with WeeklyView records?
cMessageText
String@
Message text to present to the user after the process is finished
ValidateSerialAfterSelect Validates after calling SN selection screen Parameters Name
Type
ds
Description Labor data set
ValidateSerialBeforeSelect Call before allowing the select of serial numbers Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description Labor data set
1257
F-L
Business Object Reference Guide
Name
Type
Description
notEnoughSerials
String@
Not enough serials for labor entry
totSNReq
Decimal@
Total number of serials required for labor entry
ReportPartQtyAllowed Returns TRUE if Part Quantity Reporting is allowed for a given operation. Notes: In order to be allowed the following conditions must be meet. 1. Must be final assembly (AssemblySeq = 0) 2. Must be the final operation. 3. Job must have more that one end part defined or has one or more Parts with PartPerOp > 1 Parameters Name
Type
Description
ipJobNum
String
Job number
ipAssemblySeq
Int32
Assembly Sequence number
ipOprSeq
Int32
Operation Sequence number
LaborApproval Epicor.Mfg.BO.LaborApproval: This business object contains 13 methods.
GetNewLaborDtl Inserts a new row in the DataSet with defaults populated.
GetNewLaborDtlComment Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1258
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ApproveReject The procedure is called when the user selects LaborDtl records for reject or approve Parameters Name
Type
Description
ipSalesRepCode
String
The sales Rep Code of the approver.
ipAction
String
Action to take A = approver, R = reject.
ipComment
String
Comment text if comments are to be created.
ds outMessage
Epicor 9.05 | 9.05.605
Labor Approval Entry Data set String@
Informational message returned to display to the user after the process has run
1259
F-L
Business Object Reference Guide
CheckRecall The procedure is called prior to performing a recall. It will check if subsequent approvals have occurred. If they have the user will have the opportunity to cancel the recall. Parameters Name
Type
Description
ipSalesRepCode
String
The sales Rep Code of the approver.
ds
Labor Approval Entry Data set
outRecallMsg
String@
Recall message
GetRowsTran Called from Aprrovals screen to get related task transactions Parameters Name
Type
Description
calcLbrChrg
Boolean
To inlcude charge rate
ds
LaborApprovalDataSet
RecallTrans The procedure is called when the user selects LaborDtl records to recall Parameters Name
Type
Description
ipSalesRepCode
String
The sales Rep Code of the approver.
ds outMessage
Labor Approval Entry Data set String@
Informational message returned to display to the user after the process has run
SetChargeRate This method should call when EquipID is changed Parameters Name ds
1260
Type
Description Labor Approval Entry Data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
LaborDtl Epicor.Mfg.BO.LaborDtl: This business object contains 7 methods.
GetNewLaborDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1261
F-L
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
LaborDtlGroup Epicor.Mfg.BO.LaborDtlGroup: This business object contains 8 methods.
GetNewLaborDtlGroupAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1262
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
EmployeeExists A public method to test if a given Employee ID already exists in the EmpBasic table. Return True if it exists else returns False. Parameters Name
Type
empID
String
Description
Returns
LaborDtlSearch Epicor.Mfg.BO.LaborDtlSearch: This business object contains 7 methods.
GetNewLaborDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
1263
F-L
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
LangName Epicor.Mfg.BO.LangName: This business object contains 9 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1264
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListCustom This overload of GetList shows all or only the languages with translations. Parameters Name
Type
Description
whereClause
String
The criteria
installed
Boolean
Show only Installed Languages
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Epicor 9.05 | 9.05.605
1265
F-L
Business Object Reference Guide
Returns Returns the list of Languages
GetListWithTranslations This overload of GetList filters out languages with no translations. Parameters Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of Securities
GetNextLanguage Returns next language. Parameters Name
Type
Description
languageID
String
Language ID
nextLanguage
String@
Next language
LangOrg Epicor.Mfg.BO.LangOrg: This business object contains 8 methods.
GetNewLangOrg Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1266
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetOriginalTextID Returns Original Text ID. Parameters Name
Type
Description
pcText
String
Text ID
piTextID
Int32@
Original Text ID
Epicor 9.05 | 9.05.605
1267
F-L
Business Object Reference Guide
LangProg Epicor.Mfg.BO.LangProg: This business object contains 7 methods.
GetNewLangProg Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
1268
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
LangTran Epicor.Mfg.BO.LangTran: This business object contains 19 methods.
GetNewLangTran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1269
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DeleteTranslation Deletes Translation Parameters Name
Type
Description
pcLanguageID
String
The language ID
pcProgramID
String
The program ID
pcText
String
Text
bSucceed
Boolean@
Deleted YES/NO
Name
Type
Description
pcLanguageID
String
The language ID
pcProgramID
String
The program ID
pcOrgTextID
Int32
ID
bSucceed
Boolean@
Deleted YES/NO
DeleteTranRecords Deletes Translation Parameters
GetProgTrans This method returns a list of program specific translations for a original text and language Parameters
1270
Name
Type
Description
pcLangID
String
The language ID
piOrigTextID
Int32
The original text ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns Translation Text data set
GetTransByProgramID This method returns a list of translations from a start at program id Parameters Name
Type
Description
pcLangID
String
The language ID
pcProgID
String
The start at program ID
Returns Translation Text data set
GetTransByText This method returns a list of translations from a start at text Parameters Name
Type
Description
pcLangID
String
The language ID
pcText
String
The start at text
Returns Translation Text data set
GetTransByTextID This method returns a list of translations from a start at text id Parameters Name
Type
Description
pcLangID
String
The language ID
piTextID
Int32
The start at text ID
Returns Translation Text data set
GetTransByTranslation This method returns a list of translations from a start at translated text Parameters Name
Type
Description
pcLangID
String
The language ID
Epicor 9.05 | 9.05.605
1271
F-L
Business Object Reference Guide
Name
Type
Description
pcTranslation
String
The start at translated text
Returns Translation Text data set
ImportXml Translate procedure Parameters Name
Type
ds
Description Translation Text data set
bCustomization
Boolean
If True and record is missing in LangOrg, it will be added
Returns Translation Text data set
Translate Translate procedure Parameters Name
Type
ds
Description Translation Text data set
bAddIfMissing
Boolean
If True and record is missing in LangOrg, it will be added
bFindSimilar
Boolean
If True search for similar record when exact unmatched
Returns Translation Text data set
UpdateAll This method update LangTran table Parameters Name
Type
ds
Description Language Translation data set
UpdateSingleTranslation Updates single translation.
1272
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
pcLanguage
String
Language
pcProgram
String
Program
pcText
String
Text
pcTranslation
String
Translation
pcProgTranslation
String
ProgTranslation
bSeccess
Boolean@
Updated YES/NO
UpdateTranslations This method update translations and also LangOrg, LangXref if necessary Parameters Name
Type
ds
Description Translation Text data set
pbUpdateLangOrg
Boolean
Flag indicating if a LangOrg should be created if not exists
bReturn
Boolean@
Not used
Returns Translation Text data set
LangXref Epicor.Mfg.BO.LangXref: This business object contains 7 methods.
GetNewLangXref Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1273
F-L
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
LbrPrjRole Epicor.Mfg.BO.LbrPrjRole: This business object contains 9 methods.
GetNewLaborDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1274
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeNewPrjRoleCd This method validates the NewPrjRoleCd. Parameters Name
Type
Description
ipNewPrjRoleCd
String
The NewPrjRoleCd value.
Epicor 9.05 | 9.05.605
1275
F-L
Business Object Reference Guide
Name
Type
Description
ds
ProjectDataSet
UpdatePrjRoleCd . Parameters Name
Type
ds
Description Inventory qty adj data set
LegalNumCnfg Epicor.Mfg.BO.LegalNumCnfg: This business object contains 24 methods.
GetNewLegalNumCnfg Inserts a new row in the DataSet with defaults populated.
GetNewLegalNumDocType Inserts a new row in the DataSet with defaults populated.
GetNewLegalNumPrefix Inserts a new row in the DataSet with defaults populated.
GetNewLegalNumSeqPrefix Inserts a new row in the DataSet with defaults populated.
GetNewLegalNumSeq Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1276
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
1277
F-L
Business Object Reference Guide
Returns
GenerationTypeOverrideablePrefix This method should be called after the Generation Type changes. The OnChangeOfGenerationType method is going to set the the PrefixIsOverrideable field to false if the generation type = 'system'. If the new value is 'system' then it will check to see if any LegalNumPrefix records exist. If they do then it will return a message in opMsgText. If OpMsgText is not returned as null, it should be displayed to the user as a Yes/No question. If the user answers "Yes" then the method RemoveAltPrefix should be called. Parameters Name
Type
Description
ipLegalNumberID
String
The current legalNumCnfg Number
proposedGenerationType
String
The proposed value of the new generation type
opMsgText
String@
Message to be displayed to the user
ds
legalNumCnfg is to used to set up the parameters used to generate legal numbers.
GetTranDocType This method return the TranDoctType that has not already assinged to legalNumber Parameters Name
Type
Description
ipLegalNumberType
String
The current legalNumberType Number
ipLegalNumberID
String
The current legalNumberID Number
Returns Available DocType
OnChangeGenSSCC This method should be called if the Generate SSCC changes. Parameters Name
Type
Description
ipGenSSCC
Boolean
The current Generate SSCC value
ds
LegalNumCnfg dataset
OnChangeOfGenerationType This method should be called if the Generation Type changes.
1278
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ds
legalNumCnfg is to used to set up the parameters used to generate legal numbers.
OnChangeOfLegalNumberType This method should be called after the LegalNumberType comboBox changes. Parameters Name
Type
Description
ipLegalNumberType
String
The current legalNumCnfg Number
ds
LegalNumCnfg is to used to set up the parameters used to generate legal numbers.
OnChangeOfNumberOption This method should be called after the NumberOption comboBox changes. Parameters Name
Type
Description
ipNumberOption
String
The Number Option
ds
LegalNumCnfg is to used to set up the parameters used to generate legal numbers.
OnChangeOfPrefixType This method should be called if the Prefix Type changes. Parameters Name
Type
ds
Description legalNumCnfg is to used to set up the parameters used to generate legal numbers.
OverrideablePrefixChanged This method should be called after the Overridable Prefix checkbox changes. If the new value is false then it will check to see if any LegalNumPrefix records exist. If they do then it will return a message in opMsgText. If OpMsgText is not returned as null, it should be displayed to the user as a Yes/No question. If the user answers "Yes" then the method RemoveAltPrefix should be called.
Epicor 9.05 | 9.05.605
1279
F-L
Business Object Reference Guide
Parameters Name
Type
Description
ipLegalNumberID
String
The current legalNumCnfg Number
proposedPrefixIsOverrideable
Boolean
The proposed value of PrefixIsOverrideable
opMsgText
String@
Message to be displayed to the user
ProcessPrefix This method should be called after changing the default prefix. This method checks for a modified ttLegalNumCnfg record so an update shouldn't be done before calling this method (it needs the modified record to see what the old default prefix was). It will check to see if sequences have been created using the old default sequence. If opMsgText is not returned as null, it should be displayed to the user as a Yes/No question. If the user answers "Yes" then the method RemoveSequences should be called. Parameters Name
Type
Description
ipLegalNumberID
String
The current legalNumCnfg Number
proposedDefaultPrefix
String
Proposed default prefix
opMsgText
String@
Message to be displayed to the user
ds
legalNumCnfg is to used to set up the parameters used to generate legal numbers.
RemoveAltPrefix This method should be called after calling the OverrideablePrefixChanged method and the user answers "Yes" to the message returned from OverrideablePrefixChanged. This method will delete all Alternate Prefix record for the current Legal Number. Parameters Name
Type
Description
ipLegalNumberID
String
Current LegalNumCnfg Number
ds
LegalNumCnfg is to used to set up the parameters used to generate legal numbers.
RemoveSequences This method should be called after calling the ProcessPrefix method and the user answer "Yes" to the message returned from ProcessPrefix. This method will remove sequences that are using the old Default Prefix. Parameters
1280
Name
Type
Description
ipLegalNumberID
String
Current legalNumCnfg Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Name
Type
Description
ds
legalNumCnfg is to used to set up the parameters used to generate legal numbers.
VoidLegalNumCnfg Parameters Name
Type
Description
ds
legalNumCnfg is to used to set up the parameters used to generate legal numbers.
LegalNumGenOpts Epicor.Mfg.BO.LegalNumGenOpts: This business object contains 2 methods.
ChangeNumberPrefix This method will update values in the LegalNumGenOpts datatable based on the number prefix. This method should be called when the prefix is changing. Parameters Name
Type
Description
proposedNumberPrefix
String
The proposed prefix value
ds
Object for legal number prompts
ValidatePrompts This method performs validation on the legal number prompt data that was entered. This method will also verify the legal number entered is not already being used. If it is, the user has the option of continuing with this number. If the answer to the question is no, the user will be required to enter different data. If the answer is yes, the user can continue with the number. This method should be called when the user attempts to save the data. Parameters Name
Type
ds questionText
Epicor 9.05 | 9.05.605
Description Object for legal number prompts
String@
Text of the question to ask the user if the number is already in use
1281
F-L
Business Object Reference Guide
LegalNumHistory Epicor.Mfg.BO.LegalNumHistory: This business object contains 7 methods.
GetNewLegalNumHistory Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
1282
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
LegalNumPrefix Epicor.Mfg.BO.LegalNumPrefix: This business object contains 7 methods.
GetNewLegalNumPrefix Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1283
F-L
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Lifecycle Epicor.Mfg.BO.Lifecycle: This business object contains 7 methods.
GetNewLifecycle Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1284
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
LinkQuoteSearch Epicor.Mfg.BO.LinkQuoteSearch: This business object contains 1 methods.
GetRows This methods will return all of the LinkQuoteSearch records which will be a subset of the 'for each jobprod, each orderdtl of jobprod, each quotedtl of orderdtl' records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table (LinkQuoteSearch) we need our own public method. Parameters Name
Type
Description
whereClauseJobProd
String
The where clause to restrict data for
whereClauseOrderDtl
String
The where clause to restrict data for
whereClauseQuoteDtl
String
The where clause to restrict data for
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Returns The dataset for the linkquotesearch temp table.
LogAPInv Epicor.Mfg.BO.LogAPInv: This business object contains 48 methods.
GetNewLogAPInv Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1285
F-L
Business Object Reference Guide
GetNewLogAPInvAttch Inserts a new row in the DataSet with defaults populated.
GetNewLogAPInvTax Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1286
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
ChangeCurrency Method to call when changing the currency on the invoice. Validates the currency code and updates APInvHed with default values based on the currency. Parameters Name
Type
Description
proposedCurrencyCode
String
The proposed currency code
ds
The APInvoice data set
ChangeFixedAmount Method to call when changing the fixed amount on a tax record. Updates LogAPInvTax tax amounts based on the new fixed amount. Epicor 9.05 | 9.05.605
1287
F-L
Business Object Reference Guide
Parameters Name
Type
Description
proposedFixedAmt
Decimal
The proposed fixed amount
ds
The Logged AP Invoice data set
ChangeGLCntrlType Return if GL Control Type have GL Control Code Parameters Name
Type
Description
vGLControlType
String
GL Control Type selected for the Invoice
opGLControlCode
String@
Return GLControlCode.
opDescription
String@
Return description of GLControlCode.
ChangeInvoiceDate Method to call when changing the invoice date on the invoice. Updates APInvHed with default values based on the new date. Parameters Name
Type
Description
proposedInvoiceDate
Nullable{System.DateTime}
The proposed invoice date
ds
The Log AP Invoice data set
ChangeInvoiceNum Method to call when changing the invoice num. Parameters Name
Type
Description
ipInvoiceNum
String
The proposed invoice Number
ipVendorNum
Int32
The vendor Num (ID)
ChangeInvoiceRef Method to call when changing the invoice reference on the debit memo. Validates the invoice reference number id and updates APInvHed with values from the new invoice reference.
1288
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
proposedInvoiceRef
String
The proposed invoice reference number
ds
The APInvoice data set
ChangeInvoiceVendorAmt Method to call when changing the invoice vendor amount on an invoice record. Updates APInvHed amounts based on the new invoice vendor amount. Parameters Name
Type
Description
proposedInvoiceVendorAmt
Decimal
The proposed tax amount
ds
The Logged AP Invoice data set
ChangeLockRate Method to call when changing the lock rate flag on the invoice. Updates APInvHed.EnableExchangeRate field. Parameters Name
Type
ds
Description The Logged AP Invoice data set
ChangeManualTaxCalculation Method to call when changing the manual tax calculation value on a tax record. Updates APInvTax tax amounts based on the new value of the flag. Parameters Name
Type
ds
Description The Logged AP Invoice data set
ChangeRateCode Method to call when changing the tax percent on a tax record. Updates LogAPInvTax tax amounts based on the new tax percent. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The Logged AP Invoice data set
1289
F-L
Business Object Reference Guide
ChangeRefPONum Method to call when changing the po number reference on the invoice. Validates the po number reference and updates APInvHed with default values based on the po number. Parameters Name
Type
Description
proposedRefPONum
Int32
The proposed po number reference
ds
The Logged AP Invoice data set
ChangeReportableAmt Method to call when changing the taxable amount on a tax record. Updates APInvTax tax amounts based on the new taxable amount. Parameters Name
Type
Description
proposedReportableAmt
Decimal
The proposed reportable amount
ds
The Logged AP Invoice data set
ChangeSEPMUID Method to call when changing the Payment Method. Parameters Name
Type
Description
ds
The APInvoice data set
ChangeTaxableAmt Method to call when changing the taxable amount on a tax record. Updates APInvTax tax amounts based on the new taxable amount. Parameters Name
Type
Description
proposedTaxableAmt
Decimal
The proposed taxable amount
ds
The Log AP Invoice data set
ChangeTaxAmt Method to call when changing the tax amount on a tax record. Updates APInvTax tax amounts based on the new tax amount.
1290
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
proposedTaxAmt
Decimal
The proposed tax amount
ds
The Logged AP Invoice data set
ChangeTaxCode Method to call when changing the tax code on a tax record. Validates the tax code and updates APInvTax tax amounts based on the new tax code. Parameters Name
Type
Description
proposedTaxCode
String
The proposed tax code
ds
The Logged AP Invoice data set
ChangeTaxDeductable Method to call when changing the tax deductable on a tax record. Updates APInvTax tax amounts based on the new tax percent. Parameters Name
Type
Description
proposedTaxDeductable
Decimal
The proposed tax deductable
ds
The APInvoice data set
ChangeTaxLock Method to call when changing the tax lock rate flag on the invoice. Updates LogAPInv.EnableTaxExRate field. Parameters Name
Type
Description
ds
The Logged AP Invoice data set
ChangeTaxPercent Method to call when changing the tax percent on a tax record. Updates LogAPInvTax tax amounts based on the new tax percent. Parameters Name
Type
Description
proposedTaxPercent
Decimal
The proposed tax percent
ds
Epicor 9.05 | 9.05.605
The Log AP Invoice data set
1291
F-L
Business Object Reference Guide
ChangeTermsCode Method to call when changing the terms code on the invoice. Validates the terms code and updates LogAPInv with default values based on the new code. Parameters Name
Type
Description
proposedTermsCode
String
The proposed terms code
ds
The Logged AP Invoice data set
ChangeVendorID Method to call when changing the vendor id on the invoice. Validates the vendor id and updates LogAPInv with values from the new vendor. updates LogAPInv with values from the new vendor. Parameters Name
Type
Description
proposedVendorID
String
The proposed vendor id
ds
The Log AP Invoice data set
CheckBankRef Before updating the LogAPInv record, CheckBankRef will be called to check if the bank reference conforms to format standards. If not, the user will be presented with a warning message and allowed to continue with the save. At this time this method is specific to Finland/Sweden localization Parameters Name
Type
Description
ds opMessage
The APInvoice data set String@
The Message to ask the user if the changes for the linked AP Invoice are okay.
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters
1292
Name
Type
Description
keyValue
String
VendorNum
keyValue2
String
InvoiceNum
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
CheckRateGrpCode Update APInvoice Detail information when the RateGrp is changed. Parameters Name
Type
Description
ipRateGrpCode
String
Currency Rate Group Code
ds
The Log AP Invoice data set
CheckTaxRateGrpCode Update APInvoice Detail information when the TaxRateGrp is changed. Parameters Name
Type
Description
ipRateGrpCode
String
Currency Rate Group Code
ds
The Log AP Invoice data set
GetNewLogAPInvDebitMemo Method to call when adding a new Logged Debit Memo AP Invoice record Parameters Name
Type
ds cGroupID
Description The Logged Invoice data set
String
The group id to add the invoice to
GetNewLogAPInvInvoice Method to call when adding a new logged AP Invoice record Parameters Name
Type
ds cGroupID
Epicor 9.05 | 9.05.605
Description The Logged AP Invoice data set
String
The group id to add the invoice to
1293
F-L
Business Object Reference Guide
GetPercentFixedAmt Parameters Name
Type
Description
ipInvDate
Nullable{System.DateTime}
Invoice date to use
GetValueExchageRate This method returns the Exchange Rate information for the selected Currency. The system may not have an exchange rate between the APInvoice and Base so it may use an middle Currency so that it will go APInvoice Currency -> Ref Currency -> Base Currency Parameters Name
Type
Description
vCurrencyCode
String
Currency selected for the Logged APInvoice
vRateGrpCode
String
Currency Rate Group selected for the Logged APInvoice
vExchangeRate
Decimal@
Current exchange rate between the Logged APInvoice currency and the Ref Currency
vXRateLabel
String@
Label for the Exchange Rate field
OnChangeofApplyDate This method should be called to validate the new apply date entered by the user. Parameters Name
Type
Description
vendorNum
Int32
Vendor Number.
invoiceNum
String
Invoice Number.
newApplyDate
Nullable{System.DateTime}
New Apply Date.
ds
Logged AP Invoice Entry data set.
OnChangeofTaxRateDate This method should be called to validate the new apply date entered by the user. Parameters
1294
Name
Type
Description
vendorNum
Int32
Vendor Number.
invoiceNum
String
Invoice Number.
newTaxDate
Nullable{System.DateTime}
New Tax Date.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
F-L
Type
Description
ds
Logged AP Invoice Entry data set.
OnChangeOfTransApplyDate This method should be called to validate the new apply date entered for the transferred invoice. Parameters Name
Type
Description
vendorNum
Int32
Vendor Number.
invoiceNum
String
Invoice Number.
newTransApplyDate
Nullable{System.DateTime}
New Apply Date.
ds
Logged AP Invoice Entry data set.
OnChangeVendBankID Call this method when the user enters the ttLogApInv.BankID Parameters Name
Type
Description
pcVendBankID
String
Vendor Bank ID
ds
The Logged AP Invoice data set
PreUpdate This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
Boolean@
Indicates if the legal number requires user input
ds requiresUserInput
SetReadyToCalc Parameters Name
Type
Description
ipGroupID
String
ipGroupID
ipInvoiceNum
String
ipInvoiceNum
Epicor 9.05 | 9.05.605
1295
F-L
Business Object Reference Guide
Name
Type
Description
ipVendorNum
Int32
ipVendorNum
ipCalcAll
Boolean
ipCalcAll
ds
The Log AP Invoice data set
TransferInvoiceToGroup Method to call when transfering an invoice to a different group. Parameters Name
Type
Description
transferToGroupID
String
The group id to transfer the invoice to
xferInvVendorNum
Int32
The vendor number on the invoice to transfer
xferInvInvoiceNum
String
The invoice number of the invoice to transfer
ValidateRateCode Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
LogInvAprvVoid Epicor.Mfg.BO.LogInvAprvVoid: This business object contains 15 methods.
GetNewLogAPInv Inserts a new row in the DataSet with defaults populated.
GetNewLogAPInvTax Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewLegalNumberGenerate Inserts a new row in the DataSet with defaults populated.
1296
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1297
F-L
Business Object Reference Guide
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
CanUserVoid Parameters Name
Type
Description
ipInvoiceNum
String
Invoice Number user wants to void
ipVendorNum
Int32
Vendor assigned to ipInvoiceNum
opCanVoid
Boolean@
indicates if the user can void the logged invoice
opMessage
String@
text indicating why a user cannot void
ChangeApproved Method to call when changing the approved flag on the invoice. Parameters Name
Type
Description
proposedApproved
Boolean
The proposed approval flag value
ds
The Logged APInvoice approval void data set
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth.
1298
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
keyValue
String
VendorNum
keyValue2
String
InvoiceNum
VoidLoggedInvoice Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
LogInvGrp Epicor.Mfg.BO.LogInvGrp: This business object contains 11 methods.
GetNewLogInvGrp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
1299
F-L
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DeleteZeroAmtTaxRec This method deletes LogAPInvTax records which have zero amounts Since Logged Invoices TAx logic calculates tax conditionally only for the first tax line the invoice could have multiple zero tax records. Parameters Name
Type
Description
postGroupID
String
The Group ID of the Group to post
OnChangeofApplyDate This method should be called to validate the new apply date entered by the user. Parameters Name
Type
Description
groupID
String
Group ID.
newApplyDate
Nullable{System.DateTime}
New Apply Date.
ds
Log Invoice Entry data set.
PrePostGroupInvoices Method to call before posting invoices for a specific group. If the G/L module is installed, this method will determine if A/P is interfaced with G/L. If it is not, text of a question is returned indicating this and asking if it is ok to
1300
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
continue. This question should be presented to the user in yes/no format. If the user replies no, the PostGroupInvoices method should not be called. This method can also throw exceptions if certain configuration records do not exist. This method will also check if variances exist on the header or lines and return message text asking the user if they would like to continue nor not with posting. Parameters Name
Type
Description
postGroupID
String
The Group ID of the Group to post
returnMessage
String@
Contains text of the message to present to the user.
varianceMessage
String@
Contains text of the message to present to the user if variances exist.
taxRecMessage
String@
Contains text of the message to present to the user if zero amount tax line exist.
UnlockGroup Method to call to unlock a group record. This method should be called whenever the group no longer needs to be locked. The group no longer needs to be locked when the invoice object is closed, or when a different group is selected. Parameters Name
Type
Description
inGroupID
String
The group id of the group record to unlock
LotSelectUpdate Epicor.Mfg.BO.LotSelectUpdate: This business object contains 12 methods.
GetNewPartLot Inserts a new row in the DataSet with defaults populated.
GetNewPartLotAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
1301
F-L
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckDupLotNum This method checks the Lot Number to see if there is any duplicate lot number used by another part number. A warning message will be returned to the user asking if the user wants to continue creating a duplicate lot number. This needs to be run before Update method. If the user answers yes to the question then the update method can be run.
1302
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Parameters Name
Type
Description
vLotNum
String
The Lot Number to be checked for duplicate
vPartNum
String
Part Number associated with the current Lot Number
vRowid
String
RowIdent field of the PartLot
vMessage
String@
Returns a warning message for duplicate lot number
ChkForNeedsLotAttrs Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GenerateNewLotNum This method Parameters Name
Type
Description
vPartNum
String
Part Number associated with the current Lot Number
vNewLotNum
String@
Returns the next valid lot number
ValidateLotAttributes Validate the attributes information introduced by the user. Parameters Name ds
Type
Description The LotSelectUpdate DataSet
LotSeq Epicor.Mfg.BO.LotSeq: This business object contains 9 methods.
GetNewLotSeq Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1303
F-L
Business Object Reference Guide
GetNewLotSeqAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
1304
Epicor 9.05 | 9.05.605
Business Object Reference Guide
F-L
Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
Epicor 9.05 | 9.05.605
1305
M-R
Business Object Reference Guide
Part III: M-R Chapter 13: M MaintReq Epicor.Mfg.BO.MaintReq: This business object contains 14 methods.
GetNewMaintReq Inserts a new row in the DataSet with defaults populated.
GetNewMaintReqAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
1306
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnApproveJob This method should be called when request is approved. Parameters Name
Type
Description
plant
String
plant
reqID
String
reqID
onHold
Boolean
onHold
ds
MaintReq data set
OnChangeEquipID This method should be called when EquipID change. Parameters Name
Type
Description
equipID
String
equipID
ds
Epicor 9.05 | 9.05.605
MaintReq data set
1307
M-R
Business Object Reference Guide
OnChangeIssueTopics This method should be invoked when the IssueTopics changes. Validates and sets the individual IssueTopic fields. Parameters Name
Type
Description
topics
String
Proposed topics string id
ds
MaintReq data set
OnChangeResTopics This method should be invoked when the ResTopics changes. Validates and sets the individual ResTopic fields. Parameters Name
Type
Description
topics
String
Proposed topics string id
ds
MaintReq data set
StatusRequest This method should be called when Status Request is changed. Parameters Name
Type
Description
ipReqID
String
RequestID
ipPlant
String
Plant
ipStatus
String
StatusRequest
ds
MaintReq data set
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
1308
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
MaintResource Epicor.Mfg.BO.MaintResource: This business object contains 7 methods.
GetNewResource Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1309
M-R
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MangCustSearch Epicor.Mfg.BO.MangCustSearch: This business object contains 8 methods.
GetNewMangCust Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1310
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsCustom Search Managed Customers by Customer ID. Call normal GetList method. Parameters Name
Type
Description
whereClauseMangCust
String
Where Clause for MangCust.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The MangCust data set
Manufacturer Epicor.Mfg.BO.Manufacturer: This business object contains 9 methods.
GetNewManufacturer Inserts a new row in the DataSet with defaults populated.
GetNewManufacturerAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
1311
M-R
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetByManufacturerId This method finds the manufacturer record by MfgId instead of MfgNum
1312
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
mfgID
String
The manufacturer character ID
MassIssueToMfg Epicor.Mfg.BO.MassIssueToMfg: This business object contains 21 methods.
BuildMassIssueBrowse This method is called when the user presses Issue button after entering the Job#. This method builds and returns the Epicor.Mfg.BO.MassIssueToMfgDataSet dataset. Parameters Name
Type
Description
ds pcMessage
Input dataset - Epicor.Mfg.BO.MassIssueInputDataSet with the Job# to which the Mass issue is to be done. String@
If the job has any serialized parts, those are listed in this variable.
Returns The MassIssueToMfg Data Set
ClearAll Clear All - Clear all issued quantities Parameters Name
Type
Description
pcView
String
Input the filter shown in the browse. Valid values are Open, Completed or All.
ds
The MassIssueToMfg Data Set
GetList List of jobs that can be selected for Mass Issue. Parameters Name
Type
Description
whereClauseSetupGrp
String
Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Epicor 9.05 | 9.05.605
Are there more pages ? Yes/No
1313
M-R
Business Object Reference Guide
Returns The MassIssueJobList Data Set
GetNewMassIssueInput Create a new Epicor.Mfg.BO.MassIssueInputDataSet. Only few fields like Company and TranDate are populated. All other fields are dependent on the user selecting a job#. After the user enters a Job# call OnChangeJobNum to populate other fields in MassIssueInputDataSet . Parameters Name
Type
Description
ds
The MassIssueInput Data Set
GetNewMassIssueInputJobNum Create a new Epicor.Mfg.BO.MassIssueInputDataSet based on the Job# input. Parameters Name
Type
Description
pcJobNum
String
Job number.
ds
The MassIssueInput Data Set
GetNewMassIssueInputList This method creates a new ttMassIssueInputList row entry. Parameters Name
Type
Description
ds
The MassIssueInputList Data Set
GetNewMassIssueInputMultiple Call this method when the user selects multiple jobs. This method populates the Epicor.Mfg.BO.JobClosingDataSet dataset with Job , JobOper and JobMtl information. Parameters Name ds
Type
Description Input dataset contains the jobs selected by the user.
Returns The JobClosing Data Set
GetRows List of jobs that can be selected for Mass Issue.
1314
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClauseSetupGrp
String
Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The MassIssueJobList Data Set
IssueAll Issue All - Default Issue All Parameters Name
Type
Description
pcView
String
Input the filter shown in the browse. Valid values are Open, Completed or All.
ds
The MassIssueToMfg Data Set
NegativeStockCheck This method performs the Negative Stock check. This procedure should be run before calling PerformMassIssue method. Parameters Name
Type
Description
pcJobNum
String
Job# to which the Mass issue is to be done.
ds
The MassIssueToMfg Data Set, contains information to PerformMassIssue
pcQuestion
String@
If non-blank, display the question to the user. The response should be passed as parameter to PerformMassIssue method.
pcError
String@
If non-blank, stop error has occured. Display message to the user. The response should be passed as parameter to PerformMassIssue method.
OnChangeAssemblySeq To populate the MassIssueInputDataSet dataset with the fields when JobNum changes This method populates and returns the Epicor.Mfg.BO.MassIssueInputDataSet dataset.
Epicor 9.05 | 9.05.605
1315
M-R
Business Object Reference Guide
Parameters Name
Type
ds
Description Call this method when JobNum to which the Mass issue is to be done changes in the MassIssueInput Data Set
OnChangeBinNum Call this method when binnum changes in Epicor.Mfg.BO.MassIssueToMfgDataSet dataset It returns a new Bin number and onhandqty. Parameters Name
Type
Description
pcWarehouse
String
Warehouse
pcPartNum
String
Part number
pcBinNum
String
New Bin number which should be checked
ds
The MassIssueToMfg Data Set
OnChangeJobNum Call this method when the Job# changes in ttMassIssueInputJob. Parameters Name
Type
Description
pcJobNum
String
Job Number.
ds
The MassIssueInput Data Set
OnChangeLotNum Call this method when Lot number changes in Epicor.Mfg.BO.MassIssueToMfgDataSet dataset. This method checks wheter the user has security permissions to create lot. Parameters Name
Type
Description
plLotTrack
Boolean
Is the part lot tracked ?
pcLotNum
String
Lot number
plCreatePartLot
Boolean
User's answer to the question - Do you want to create a lot number
ds
1316
The MassIssueToMfg Data Set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangePartNum To populate the Epicor.Mfg.BO.MassIssueToMfgDataSet dataset with the fields when PartNum changes Call this method when PartNum changes. Parameters Name
Type
Description
pcJobNum
String
Job # to which the Mass Issue is done
piAssemblySeq
Int32
Assembly#
piSeqNum
Int32
Seq Number
ds
The MassIssueToMfg Data Set
OnChangeQtyIssued Call this method when Qty Issued changes in Epicor.Mfg.BO.MassIssueToMfgDataSet dataset It returns a yes or no value for IssuedComplete. Parameters Name
Type
Description
piAssemblySeq
Int32
Assembly#
piSeqNum
Int32
Seq Number
pdQtyIssued
Decimal
Proposed Quantity Issued
pdAssemblyQty
Decimal
Current Assembly Quantity
ds pcWarning
The MassIssueToMfg Data Set, contains information to PerformMassIssue String@
If non-blank, display the warning to the the user.
OnChangeUOMCode Recalculates stockqty when the UOM changes. Parameters Name
Type
Description
pcRowIdent
String
RowIdent of the current record
pcUOM
String
Proposed UOM
pdAssemblyQty
Decimal
Current Assembly Quantity
ds
Epicor 9.05 | 9.05.605
The MassIssueToMfg Data Set
1317
M-R
Business Object Reference Guide
OnChangeWareHouse Call this method when Ware house changes in Epicor.Mfg.BO.MassIssueToMfgDataSet dataset It returns a new Bin number Parameters Name
Type
Description
pcWarehouse
String
Ware house
pcPartNum
String
Part number
pcWarning
String@
If non-blank, display the warning to the user.
ds
The MassIssueToMfg Data Set, contains information to PerformMassIssue
OnPartNumChanging Call this method when the value of Part is changing for validation. Parameters Name
Type
Description
pcPartNum
String
PartNum
PerformMassIssue This function performs the processing required to do the Mass Issue to manufacturing. No transactions are committed to the database unless this function is invoked. Please call NegativeStockCheck method before calling PerformMassIssue. Parameters Name
Type
Description
pcJobNum
String
Job# to which the Mass issue is to be done.
pdtTranDate
Nullable{System.DateTime} Transaction Date
piCallNum
Int32
Identifies the Service Call.
plMaterialComplete
Boolean
Material complete? - Answer to the user question - Have all materials been issued for this Service Call?
plNegStockCheckContinue Boolean
The response to the question generated from NegativeStockCheck method.
ds
The MassIssueToMfg Data Set, contains information to PerformMassIssue
pcMessage
1318
String@
Non-error, informational message
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PrePerformMassIssue This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
pdtTranDate
Nullable{System.DateTime}
Transaction Date
ds requiresUserInput
The MassIssue data set Boolean@
Indicates if the legal number requires user input
MassOperationReplace Epicor.Mfg.BO.MassOperationReplace: This business object contains 4 methods.
ChangeFromOpCode Validates the FromOpCode field and poplutes the From OpCode description. Is called when the From Op Code changes. If the code is not valid, an exception will be thrown. Parameters Name
Type
Description
cFromOpCode
String
The proposed from operation code
ds
The MassOperationReplace data set
ChangeToOpCode Validates the ToOpCode field and poplutes the To OpCode description. Is called when the To Op Code changes. If the code is not valid, an exception will be thrown. Parameters Name
Type
Description
cToOpCode
String
The proposed To operation code
ds
The MassOperationReplace data set
MassOperationReplace Peforms the Mass Operation Replace.
Epicor 9.05 | 9.05.605
1319
M-R
Business Object Reference Guide
Parameters Name
Type
ds
Description The MassOperationReplace data set
Creates a temporary record to store information needed for the mass operation replace process. Returns The MassOperationReplace data set
MassPartReplaceDelete Epicor.Mfg.BO.MassPartReplaceDelete: This business object contains 4 methods.
ChangeFromPartNum Validates the FromPartNum field and poplutes the From Part description. Is called when the From Part Number changes. If the part is not valid, an exception will be thrown. Parameters Name
Type
Description
cFromPartNum
String
The proposed from part number
ds
The MassPartReplaceDelete data set
ChangeToPartNum Validates the ToPartNum field and poplutes the To Part description. Is called when the To Part Number changes. If the part is not valid, an exception will be thrown. Parameters Name
Type
Description
cToPartNum
String
The proposed to part number
ds
The MassPartReplaceDelete data set
MassPartReplaceDeleteGetNew Creates a temporary record to store information needed for the mass part replace/delete process. Parameters Name
Type
Description
cAction
String
The action to take: Options are Replace or Delete
Returns The MassPartReplaceDelete data set
1320
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
MassReplaceDelete Peforms the Mass Replace/Mass Delete of the Part. The field ActionRequest determines which action to perform. Parameters Name
Type
Description
ds
The MassPartReplaceDelete data set
MassRscGrpReplace Epicor.Mfg.BO.MassRscGrpReplace: This business object contains 4 methods.
ChangeFromResourceGrpID Validates the FromResourceGrpID field and poplutes the From ResourceGrpID description. Is called when the From ResourceGrpID changes. If the code is not valid, an exception will be thrown. Parameters Name
Type
Description
ipFromResourceGrpID
String
The proposed from op code
ds
The MassOperationReplace data set
ChangeToResourceGrpID Validates the ToResourceGrpID field and poplutes the To ResourceGrpID description. Is called when the To ResourceGrpID changes. If the code is not valid, an exception will be thrown. Parameters Name
Type
Description
ipToResourceGrpID
String
The proposed from op code
ds
The MassOperationReplace data set
Creates a temporary record to store information needed for the mass work center replace process. Returns The MassRscGrpReplace data set
MassRscGrpReplace Peforms the Mass Work Center Replace.
Epicor 9.05 | 9.05.605
1321
M-R
Business Object Reference Guide
Parameters Name
Type
ds
Description The MassRscGrpReplace data set
Masterpack Epicor.Mfg.BO.Masterpack: This business object contains 38 methods.
GetNewMasterpack Inserts a new row in the DataSet with defaults populated.
GetNewMasterpackDtl Inserts a new row in the DataSet with defaults populated.
GetNewMasterpackUPS Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
1322
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AssignLegalNumber Assigns a legal number to the miscellaneous shipment.
Epicor 9.05 | 9.05.605
1323
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
String@
Legal number message
ds opLegalNumMsg Returns The Master Pack data set
CalculateWeight Parameters Name
Type
ds weight
Description MasterpackDataSet
Decimal@
Pack Weight
CancelVoidCarton Checks to see if the carton void can be cancelled and re-opens it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to open
Returns The SalesOrder data set
ClearConvertedManifest Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to clear Manifest fields
CloseCarton Checks to see if the carton can be closed and closes it if it is allowed. Parameters
1324
Name
Type
Description
iPackNum
Int32
The carton number of the carton to close
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The SalesOrder data set
ConvertToManifestUOM Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to populate Manifest fields
GetCustPayBTFlagDefaults Parameters Name
Type
Description
ipPayFlag
String
Pay Flag to retrieve defaults
GetLegalNumGenOpts Returns the legal number generation options. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
GetMiscPayBTFlagDefaults Parameters Name
Type
Description
ipPayFlag
String
Pay Flag to retrieve defaults
GetPackaging Parameters Name
Type
Description
ipPkgCode
String
package code
ds
Epicor 9.05 | 9.05.605
Masterpack Shipment data set
1325
M-R
Business Object Reference Guide
GetPackClass Parameters Name
Type
Description
ipPkgClass
String
package class
ds
Masterpack Shipment data set
GetPayBTFlagDefaults Parameters Name
Type
Description
ipPayFlag
String
Pay Flag to retrieve defaults
ds
The Masterpack shipment data set
GetScale Parameters Name
Type
Description
workstationID
String
Workstation ID to retrieve scale settings
scaleID
String@
Workstation default scale
GetShipDetails This method displays the shipto address information when the ShipToNum field changes Should only be called on new Shipments or if the Shipment has no lines and if the MultipleShippers flag is yes Parameters Name
Type
ds
1326
Description Master Pack Shipment data set
packNum
Int32
Master Pack ID
dtlPackNum
Int32
Detail Pack ID
shipmentType
String
Shipment type:Sales,Misc,Sub or Transfer
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetSubPayBTFlagDefaults Parameters Name
Type
Description
ipPayFlag
String
Pay Flag to retrieve defaults
GetTranDocTypeID Sets default values when the TranDocTypeID changes Parameters Name
Type
Description
ipTranDocTypeID
String
TranDocTypeID supplied
ds
Masterpack Shipment data set
GetTransferPayBTFlagDefaults Parameters Name
Type
Description
ipPayFlag
String
Pay Flag to retrieve defaults
OpenCarton Checks to see if the carton can be opened and opens it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to open
ipResetCODCharges
Boolean
Indicates if the CODAmount is to be reset to zero
ipResetInsCharges
Boolean
Indicates if the DeclaredAmt is to be reset to zero
opWarnMsg
String@
Warning message the UI is to display to the user
Returns The SalesOrder data set
Epicor 9.05 | 9.05.605
1327
M-R
Business Object Reference Guide
ProcessFreightInfo Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to open
ds
Freight Response data set
Returns The Masterpack data set
ProcessUnFreightInfo Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to open
opWarnMsg
String@
Warning message the UI is to present to the user
Returns The Masterpack data set
SetUPSQVEnable Parameters Name
Type
Description
ipQVEnable
Boolean
logical indicating if the quantum view is to enabled/disabled
ds
The Masterpack data set
SetUPSQVShipStatus Parameters Name
Type
Description
ipShipStatus
String
Shipment status
ds
The Masterpack shipment data set
StageCarton Checks to see if the carton can be voided and voids it if it is allowed.
1328
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to Stage
Returns The Masterpack data set
UpdateManifestChargeAmts Parameters Name
Type
Description
ipAmountType
String
COD or DeclaredAmt
ipAction
Boolean
Yes = recalculate No = reset to zero
ds
Masterpack Shipment data set
VoidCarton Checks to see if the carton can be voided and voids it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to void
Returns The SalesOrder data set
VoidLegalNumber Voids the legal number. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
ipVoidedReason
String
Reason for the void
Returns The Master Pack data set
Epicor 9.05 | 9.05.605
1329
M-R
Business Object Reference Guide
CheckShipStatus Parameters Name
Type
Description
packNum
Int32
PackID
shipmentType
String
Sales,Sub,Transfer or Misc
MaterialQueue Epicor.Mfg.BO.MaterialQueue: This business object contains 10 methods.
GetNewMtlQueue Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1330
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process. Retrieve material queue entry by company and by employee. Returns The MaterialQueue Data Set
GetMtlQueueByTranID Retrieve material queue entry by company and by mtlQueueSeq. Parameters Name
Type
Description
ipMtlQueueSeq
String
Material Queue Sequence
Returns The MaterialQueue Data Set
anyWhseGroupWhseAssigned Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
1331
M-R
Business Object Reference Guide
Memo Epicor.Mfg.BO.Memo: This business object contains 7 methods.
GetNewMemo Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1332
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MemoCat Epicor.Mfg.BO.MemoCat: This business object contains 8 methods.
GetNewMemoCat Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1333
M-R
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process. This returns a list of RelatedToFileList records. The reason getcodedesclist could not be used is because the list changes based on Vista or Vantage system. Returns The RelatedToFileList Data Set
Menu Epicor.Mfg.BO.Menu: This business object contains 15 methods.
GetNewMenu Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1334
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
1335
M-R
Business Object Reference Guide
Returns
CopyBeforeMenuItem Move or Copy one menu item (source) before another (Target) Parameters Name
Type
Description
sourceMenuId
String
Menu ID of the sourcerp
targetMenuId
String
Menu ID of the Target
newMenuID
String@
new menu ID if source is copied
bSuccess
Boolean@
true = successful
CopyToParentMenu Move or Copy one menu item to the last menu item of the parent Parameters Name
Type
Description
sourceMenuId
String
Menu ID of the sourcerp
parentMenuID
String
Menu ID of the parent
newMenuID
String@
new menu ID if source is copied
bSuccess
Boolean@
true = successful
GetRowsTranslated Gets translation for each existing Row Parameters Name
Type
Description
whereClauseMenu
String
whereClauseSetupGrp">Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The Menu data set
GetRowsWebAccess Gets Rows that that are accessible from the WEB
1336
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClauseMenu
String
whereClauseSetupGrp">Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The Menu data set
GetRowsWebAccessTranslated Gets Rows that that are accessable from the WEB Parameters Name
Type
Description
whereClauseMenu
String
whereClauseSetupGrp">Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The Menu data set
GetRowsCRM Gets Rows that that are accessible from the WEB Parameters Name
Type
Description
whereClauseMenu
String
whereClauseSetupGrp">Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The Menu data set
GetRowsCRMTranslated Gets Rows that that are accessable from the WEB
Epicor 9.05 | 9.05.605
1337
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClauseMenu
String
whereClauseSetupGrp">Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The Menu data set
MenuTab Epicor.Mfg.BO.MenuTab: This business object contains 7 methods.
GetNewMenuTab Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
1338
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MeterRead Epicor.Mfg.BO.MeterRead: This business object contains 7 methods.
GetNewMeterRead Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
1339
M-R
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MfgCubeDefSearch Epicor.Mfg.BO.MfgCubeDefSearch: This business object contains 7 methods.
GetNewMfgCubeDef Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
1340
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MfgCubeDimSearch Epicor.Mfg.BO.MfgCubeDimSearch: This business object contains 7 methods.
GetNewMfgCubeDim Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1341
M-R
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
1342
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
MfgPart Epicor.Mfg.BO.MfgPart: This business object contains 7 methods.
GetNewMfgPart Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1343
M-R
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MiscChrg Epicor.Mfg.BO.MiscChrg: This business object contains 12 methods.
GetNewMiscChrg Inserts a new row in the DataSet with defaults populated.
GetNewLangDesc Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1344
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeIncomeTaxCode Performs required logic when MiscChrg.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
Epicor 9.05 | 9.05.605
1345
M-R
Business Object Reference Guide
Name
Type
ds
Description MiscChrg data set
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
MiscShip Epicor.Mfg.BO.MiscShip: This business object contains 39 methods.
GetNewMscShpHd Inserts a new row in the DataSet with defaults populated.
GetNewMscShpDt Inserts a new row in the DataSet with defaults populated.
GetNewShipCOO Inserts a new row in the DataSet with defaults populated.
GetNewMscShpUPS Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1346
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
1347
M-R
Business Object Reference Guide
Returns
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AssignLegalNumber Assigns a legal number to the miscellaneous shipment. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
String@
Legal number message
ds opLegalNumMsg Returns The Miscellaneous Shipment data set
CalculateWeight Parameters Name
Type
Description
cartonNumber
Int32
Carton Number
calculatedWeight
Decimal@
Shipment weight based upon part values
CancelVoidCarton Checks to see if the carton void can be cancelled and re-opens it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to open
Returns The SalesOrder data set
1348
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
CheckCOOPercents Checks to see if the Qty percent and value percent fields total 100 percent. Parameters Name
Type
Description
iPackNum
Int32
The current PackNum
iPackLine
Int32
The current PackLine
ClearConvertedManifest Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to clear Manifest fields
CloseCarton Checks to see if the carton can be closed and closes it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to close
Returns The SalesOrder data set
ConvertToManifestUOM Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to populate Manifest fields
CreateMiscShipRecsFromDMR Creates Miscellaneous Shipment Records from DRM Entries. Header and details. Parameters Name
Type
Description
ipDMRNum
Int32
DMR number supplied
Epicor 9.05 | 9.05.605
1349
M-R
Business Object Reference Guide
GetAddrInfo This method updates the address information from either the Vendor or Customer table when the Shipto or PurPoint field has been changed. If custID and VendorID fields are both blank this procedure assumes that the user is entering the information in free form and there is nothing to default (or no need to call this method). Parameters Name
Type
Description
ds
The MiscShip data set
GetCallInfo This method defaults the Call Number and shipto fields when the Job, PO or Order number fields change Parameters Name
Type
Description
updatedField
String
Name of the field that changed, Order, Job, or PO
ds
The MiscShip data set
GetDefaultUOM Gets the default UOM from Part or XaSyst Parameters Name
Type
Description
ds
GetDMRSupplierInfo Gets DRM Supplier's info Parameters Name
Type
Description
ipDMRNum
Int32
IPDMRNum DMR number supplied
ds
FAssetImportExportDataSet Dataset of candidates for import.
GetLegalNumGenOpts Returns the legal number generation options.
1350
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
GetMtlInfo This method defaults the Quantity, Part and Line description fields when the MtlSeq field has been updated Parameters Name
Type
ds
Description The MiscShip data set
GetPackageClass Parameters Name
Type
Description
ipPkgClass
String
package class to validate
ds
Miscellaneaous shipment dataset
GetPackaging Parameters Name
Type
Description
ipPkgCode
String
package code
ds
Miscellaneaous shipment dataset
GetPOSupplierInfo Gets PO Supplier's info Parameters Name
Type
Description
ipPONum
Int32
IPPONum PO number supplied
ds
Epicor 9.05 | 9.05.605
1351
M-R
Business Object Reference Guide
GetScale Parameters Name
Type
Description
workstationID
String
Proposed change to OrderNum
scaleID
String@
If customer is on credit hold an error message will be returned.
GetTranDocTypeID Sets default values when the TranDocTypeID changes Parameters Name
Type
Description
ipTranDocTypeID
String
TranDocTypeID supplied
ds
OpenCarton Checks to see if the carton can be opened and opens it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to open
ipResetCODCharges
Boolean
Indicates if the CODAmount is to be reset to zero
ipResetInsCharges
Boolean
Indicates if the DeclaredAmt is to be reset to zero
Returns The Miscellaneous shipment data set
PrintSlip This method prints the Miscellaneous Packing Slip Parameters
1352
Name
Type
Description
packNum
Int32
Packing Slip number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
SetUPSQVEnable Parameters Name
Type
Description
ipQVEnable
Boolean
logical indicating if the quantum view is to enabled/disabled
ds
The miscellaneous data set
SetUPSQVShipStatus Parameters Name
Type
Description
ipShipStatus
String
Shipment status
ds
The Miscellaneous shipment data set
StageCarton Checks to see if the carton can be voided and voids it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to Stage
Returns The MscShpHd data set
UpdateManifestChargeAmts Parameters Name
Type
Description
ipAmountType
String
COD or DeclaredAmt
ipAction
Boolean
Yes = recalculate No = reset to zero
ds
Miscellaneous Shipment data set
VoidCarton Checks to see if the carton can be voided and voids it if it is allowed.
Epicor 9.05 | 9.05.605
1353
M-R
Business Object Reference Guide
Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to void
Returns The SalesOrder data set
VoidLegalNumber Voids the legal number. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
ipVoidedReason
String
Reason for the void
Returns The Miscellaneous Shipment data set
MiscShipToSearch Epicor.Mfg.BO.MiscShipToSearch: This business object contains 8 methods.
GetNewMiscShipTo Inserts a new row in the DataSet with defaults populated. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1354
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MiscShipToList MiscShipTo is not a real database table. It stores results from ShipTo and VendorPP tables. The UI needs the standard methods (GetByID, GetRows, GetList etc..) for the Search model to work. So we have to use core/BOBase.i . When we do that we get compilation error. To overcome that we have defined PHYSICAL_TABLE_01 ShipTo. This solves most of the problems i.e. we can compile the code and generate a dll. The GetList also works, except it displays invalid query when we try to use a where clause on non ShipTo fields. To overcome that problem. This method is developed. It is a copy of GetList. Except it fills the data from both the tables and then applies the where condition. Parameters Name
Type
Description
whereClause
String
Where clause to filter the query results.
pageSize
Int32
page size.
absolutePage
Int32
absolute page
morePages
Boolean@
more pages.
Returns The MiscShipToList data set.
Epicor 9.05 | 9.05.605
1355
M-R
Business Object Reference Guide
MktgAct Epicor.Mfg.BO.MktgAct: This business object contains 7 methods.
GetNewMktgAct Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1356
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MktgAdv Epicor.Mfg.BO.MktgAdv: This business object contains 8 methods.
GetNewMktgAdv Inserts a new row in the DataSet with defaults populated.
GetNewMktgAdvAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
1357
M-R
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MktgCamp Epicor.Mfg.BO.MktgCamp: This business object contains 10 methods.
GetNewMktgCamp Inserts a new row in the DataSet with defaults populated.
GetNewMktgCampAttch Inserts a new row in the DataSet with defaults populated.
GetNewMktgEvnt Inserts a new row in the DataSet with defaults populated.
GetNewMktgEvntAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1358
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MktgEvnt Epicor.Mfg.BO.MktgEvnt: This business object contains 8 methods.
GetNewMktgEvnt Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1359
M-R
Business Object Reference Guide
GetNewMktgEvntAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
1360
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MktgLst Epicor.Mfg.BO.MktgLst: This business object contains 26 methods.
GetNewMktgList Inserts a new row in the DataSet with defaults populated.
GetNewMktgListAttch Inserts a new row in the DataSet with defaults populated.
GetNewMktgLstDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
1361
M-R
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangedCreateCall This method refreshes the dataset when the CreateTask flage is turned off Parameters Name ds
Type
Description Marketing List Export DataSet
ChangedCreateTask This method refreshes the dataset when the CreateTask flage is turned off
1362
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description Marketing List Export DataSet
CopyDtlFrom This method copies detail records from another MktgList to the current MktgList Parameters Name
Type
Description
fromListID
String
Marketing List ID to copy FROM
toListID
String
Marketing List ID to copy TO
Returns Marketing List Dataset
GenerateMktgLstDtl This method creates detail records from MktgListGenerate dataset Parameters Name
Type
ds statusMsg
Description Marketing List Detail Generate Dataset
String@
A message that indicates how many records were added
GetExportList This method creates the MktgLstExp table using the values in the MktgLstExpParam table Parameters Name
Type
Description
listID
String
Marketing List to export
ds
Marketing List Export DataSet
This method creates the MktgLstParam table for use in the export process Returns Marketing List Export DataSet
OnChangeCallType This method validates and defaults Call Type information when CallType is changed
Epicor 9.05 | 9.05.605
1363
M-R
Business Object Reference Guide
Parameters Name
Type
Description
callType
String
Proposed Call Type
ds
Marketing List Export DataSet
OnChangeCampaignID This method validates the Campaign ID when the user changes the value Parameters Name
Type
Description
campaignID
String
Proposed Marketing Campaign ID
ds
Marketing List Dataset
OnChangeConNum This method validates the Contact when the user changes the value Parameters Name
Type
Description
conNum
Int32
Proposed Contact Number
ds
Marketing List Dataset
OnChangeCustID This method validates the Customer ID when the user changes the value Parameters Name
Type
Description
custID
String
Proposed Customer ID
ds
Marketing List Dataset
OnChangeEvntSeq This method validates the Event Sequence when the user changes the value Parameters Name
Type
Description
evntSeq
Int32
Proposed Marketing Event Sequence
ds
1364
Marketing List Dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangeShipTo This method validates the Ship To Number when the user changes the value Parameters Name
Type
Description
shipTo
String
Proposed ShipTo Number
ds
Marketing List Dataset
OnChangeTaskID This method validates and defaults Task information when TaskID is changed Parameters Name
Type
Description
listID
String
Marketing List to export
taskID
String
Proposed Task ID
ds
Marketing List Export DataSet
OnChangeTaskType This method validates and defaults Task Type information when TaskType is changed Parameters Name
Type
Description
taskType
String
Proposed TaskType value
ds
Marketing List Export DataSet
PrePullList This method is to be run before the PullList method to validate the BatchID if the batch Id already exists for the target Marketing List a question will be returned to the user asking them if they'd like to reuse the batch ID. If the user answers yes they can continue on to the PullList method. Parameters Name
Type
Description
listID
String
Marketing List ID to add the data to
batchID
String
Batch id associated with the execution of the query
vQuestion
String@
Question asking if the user wants to reuse the batch id (yes/no)
Epicor 9.05 | 9.05.605
1365
M-R
Business Object Reference Guide
PullList This method takes the Busines Activity Query ID and runs the query internally. It will create MktLstDtl record for every Customer/Contact that is returned by the B.A. Query and will return the updated dataset to the UI Parameters Name
Type
Description
queryID
String
Business Activity ID to run
listID
String
Marketing List ID to add the data to
batchID
String
Batch id associated with the execution of the query
noCustomer
Boolean
If true, then only contacts will be created, otherwise a Customer record for every contact will be created
Returns Marketing List Dataset
MktgPub Epicor.Mfg.BO.MktgPub: This business object contains 8 methods.
GetNewMktgPub Inserts a new row in the DataSet with defaults populated.
GetNewMktgPubAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1366
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MLSupplyDemand Epicor.Mfg.BO.MLSupplyDemand: This business object contains 1 methods.
GetSupplyDemand This method returns the pegging information for the selected supply/demand/part. No maintenance is allowed in this object so there is only this one method. Parameters Name
Type
Description
key1
String
First unique key
key2
String
Second optional key
key3
String
Third optional key
Epicor 9.05 | 9.05.605
1367
M-R
Business Object Reference Guide
Name
Type
Description
mlType
String
S = Sales Order, P = PO, J = Job, T = Transfer Order, R = Part
Returns SupplyDemand Dataset
MobileConnectConflict Epicor.Mfg.BO.MobileConnectConflict: This business object contains 12 methods.
GetNewIntQueOut Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1368
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
KeyReassignment This method is the final step in the KeyReassignment stage. If this has been run then row has passed all the error checking and UI updates required. because of the potential cascading changes to other IntQueOut record, it would be best to refetch the dataset after running this method Parameters Name
Type
Description
vMessage
String@
Message to display to user when method is done
ds
PreDeleteQueue This method is to be run before the actual delete method. This method may return a question to ask the user. If the user answers yes to this question (or there was no question to ask) then the UI may run the DeleteQueue method. Otherwise the delete process should be cancelled. Parameters Name
Type
Description
vIntQueID
Decimal
Unique ID for IntQueOut
vQuestion
String@
Question to ask the user (yes/no)
ds
PreKeyReassignmentChk This method is to be run before the KeyReassignment method. This method will return the field(s) the User is allowed to update. Once the user has updated the fields, you need to call PreKeyReassignmentVal method which validates the newly changed keys.
Epicor 9.05 | 9.05.605
1369
M-R
Business Object Reference Guide
Parameters Name
Type
Description
vIntQueID
Decimal
Unique identifier of IntQueOut
vIntQueFieldList
String@
List of fields the user needs to update for key reassignment
vActualFieldList
String@
List of the actual database labels that correspond to the IntQue fields
ds
PreKeyReassignmentVal This method is to be run before the update method and after the PreKeyReassignmentChk method. This method will validate the new keys the user entered. It may return a question. If the user answers yes to the question (or no question was returned an no errors) the user can continue on to the KeyReassignment method. Parameters Name
Type
Description
vIntQueID
Decimal
The unique identifier of IntQueOut
vQuestion
String@
A possible question to ask the user (yes/no)
ds
The MobileConnectConflict Data Set
ResendQueue This method allows the user to resend the Mobile Connect syncronization record to the main database Parameters Name
Type
Description
vIntQueID
Decimal
Unique identifier of IntQueOut
vMessage
String@
Message to display to the user when the method is done
ds
The MobileConnectConflict Data Set
MobileConnectSetup Epicor.Mfg.BO.MobileConnectSetup: This business object contains 11 methods.
GetNewDCRMDev Inserts a new row in the DataSet with defaults populated.
GetNewDCRMComp Inserts a new row in the DataSet with defaults populated.
1370
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetNewDCRMTerr Inserts a new row in the DataSet with defaults populated.
GetNewDCRMUser Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1371
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TestConnection Test Connction method. Creates initial connection setups. Parameters Name
Type
Description
dCRMDevRowid
String
rowid of DCRMDev
MoveRequest Epicor.Mfg.BO.MoveRequest: This business object contains 13 methods.
CheckEmployee This method needs to be called from the main menu only. if the object is being called from the shop floor menu then the employee id has already been determined and validated and is passed in Parameters Name
Type
Description
empID
String
Employee ID
empName
String@
Employee Name
GetNewMoveRequest Call this method to create a new Epicor.Mfg.BO.MoveRequestDataSet with the RequestType Parameters Name
Type
Description
requestType
String
Request Type
ds
MoveRequestDataSet
OnChangeAssembly Call this method when the AssemblySeq field changes RowMod must be "A" or "U" for this method to work
1372
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
asmSeq
Int32
Assembly Sequence
ds
The MoveRequest data set
OnChangeFromBin Call this method when the FromBin field changes RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
fromBin
String
From Bin Number
ds
The MoveRequest data set
OnChangeFromWhse Call this method when the FromWhse field changes RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
fromWhse
String
From Warehouse
ds
The MoveRequest data set
OnChangeJobNum Call this method when the JobNum field changes RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
jobNum
String
Job Number
ds
The MoveRequest data set
OnChangeLot Call this method when the lotNum field changes RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
lotNum
String
Lot Number
ds
Epicor 9.05 | 9.05.605
The MoveRequest data set
1373
M-R
Business Object Reference Guide
OnChangeMtlSeq Call this method when the MtlSeq field changes if RequestType = "MW":U then MtlSeq is actually the JobOper.OprSeq RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
mtlSeq
Int32
Material Sequence
ds
The MoveRequest data set
OnChangePartNum Call this method when the PartNum field changes RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
partNum
String
Part Number
ds
The MoveRequest data set
OnChangeReqDirection Call this method when the ReqDirection field changes RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
reqDirection
String
Request Direction
ds
The MoveRequest data set
OnChangeToBin Call this method when the ToBin field changes RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
toBin
String
To Bin Number
ds
The MoveRequest data set
OnChangeToWhse Call this method when the ToWhse field changes RowMod must be "A" or "U" for this method to work
1374
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
toWhse
String
To Warehouse
ds
The MoveRequest data set
ProcessRequest Must set the MoveRequest RowMod to "U" or "A" for this method to work The method updates the Mtl Queue record when the user is done inputing data Parameters Name
Type
ds
Description The MoveRequest data set
MPS Epicor.Mfg.BO.MPS: This business object contains 9 methods.
GetNewMasProd Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
1375
M-R
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CopyFromForecast Copy the master production schedule from the forecast for the given Part/Plant and the forecast horizon of the given date. The forecast horizon is determined from the company MRP configuration settings to determine a starting date. All forcast entries after that date will be copied to the Master Production Schedule. Parameters Name
Type
Description
ipPartNum
String
The Part number of the forecast/schedule
ipPlant
String
The Plant of the forecast/schedule
ipDate
Nullable{System.DateTime}
The starting date of the schedule. This is typically TODAY.
ForecastInHorizon This will determine if a forecast entry exists for a part/plant within the forecast horizon of a given date. The forecast horizon starts at the given dates and looks backward the number of days as defined in the MRP configuration. Parameters
1376
Name
Type
Description
ipPartNum
String
The Part number of the forecast
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
ipPlant
String
The Plant of the forecast
ipDate
Nullable{System.DateTime}
The starting date of the forecast. This is typically TODAY.
opForecastExists
Boolean@
Returns TRUE if a forecast entry exists within the horizon.
MRPProc Epicor.Mfg.BO.MRPProc: This business object contains 7 methods.
GetNewMrpProc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1377
M-R
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MRPProcQueue Epicor.Mfg.BO.MRPProcQueue: This business object contains 8 methods.
GetNewMrpProcQueue Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1378
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeGroupID UPdate MRPPRocQueue when a different GroupID is selected. Parameters Name
Type
Description
ipGroupID
String
The MRPProcQueue data set
ds
The MRPProcQueue data set
MRPQueue Epicor.Mfg.BO.MRPQueue: This business object contains 7 methods.
GetNewMrpQueue Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
1379
M-R
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
1380
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Chapter 14: N NamedSearch Epicor.Mfg.BO.NamedSearch: This business object contains 10 methods.
GetNewNamedSearch Inserts a new row in the DataSet with defaults populated.
GetNewControlSetting Inserts a new row in the DataSet with defaults populated.
GetNewWhereClause Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1381
M-R
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
NARelationship Epicor.Mfg.BO.NARelationship: This business object contains 18 methods.
GetNewRlsHead Inserts a new row in the DataSet with defaults populated.
GetNewRlsParent Inserts a new row in the DataSet with defaults populated.
GetNewCreditPoolHead Inserts a new row in the DataSet with defaults populated.
GetNewCreditPoolDtl Inserts a new row in the DataSet with defaults populated.
1382
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1383
M-R
Business Object Reference Guide
AddChildCustomer Add Child to the Customer for both tiered and non tiered classes Parameters Name
Type
ds
Description The Relationship data set
ipRlsClassCode
String
RlsClass.RlsClassCode
ipTopCustNum
Int32
Top Cust Num
ipCustNum
Int32
Parent Cust Num
ipChildCustID
String
Child CustID
errorMsg
String@
associated error message
CustListPayFor Gets list CustNum of customers which can be payed by Customer ipPayerCustNum Parameters Name
Type
Description
ipPayerCustNum
Int32
Payer Cust Num
listPayFor
String@
list Pay For
GetNAData Get National Accout dataset by RlsClass and any Customer from Relationship (TODO-rename parameters TopCust with Cust) Parameters Name
Type
Description
ipRlsClassCode
String
RlsClass.RlsClassCode
ipTopCustID
String
Customer CustID
ipNewNA
Boolean
Is it a new record
pTopCustNum
Int32@
Customer Num
errorMsg
String@
associated error message
Returns The Relationship data set
1384
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
MoveChildCustomer Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeCustID Check Cust Id, get Name, Num Parameters Name
Type
Description
ipCustID
String
Customer ID
pCustName
String@
Cust Name
OnChangeGlobalNAGroup Check all customers if they are Global if the flag was set Parameters Name
Type
ds
Description The Relationship data set
ipRlsGlobal
Boolean
Global flag
isSetGlobal
Boolean@
Confirm Global settings
OnChangeParentCustID Check Parent Cust Id for non tiered Relationship Parameters Name
Type
ds ipParentCustID
Description The Relationship data set
String
Parent CustID
OnChangeRlsClassCode Check Rls Class Code
Epicor 9.05 | 9.05.605
1385
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipRlsClassCode
String
Relationship Class Code
errorMsg
String@
associated error message
NaturalAcctCurrSearch Epicor.Mfg.BO.NaturalAcctCurrSearch: This business object contains 1 methods.
GetList Get Rows Parameters Name
Type
Description
whereClause
String
Where Clause ExpressShip
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages?
Returns ExpressShip dataset
NCChgLog Epicor.Mfg.BO.NCChgLog: This business object contains 8 methods.
GetNewNCChgLog Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1386
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetTableList This method gets Table list Parameters Name
Type
Description
outTables
String@
List of tables' names
Epicor 9.05 | 9.05.605
1387
M-R
Business Object Reference Guide
NonConf Epicor.Mfg.BO.NonConf: This business object contains 28 methods.
GetNewNonConf Inserts a new row in the DataSet with defaults populated.
GetNewNonConfAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1388
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage
Epicor 9.05 | 9.05.605
1389
M-R
Business Object Reference Guide
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AddNonConf Add NonConf of a certain type. Valid types are Operation, Inventory, JobMaterial, SubContract, and Other. Since Update() disallows changes to the TrnTyp field, you MUST use this instead of GetNewNonConf(). Parameters Name
Type
Description
pcNonConfType
String
Type/origin of NonConformance.
Returns Inspection Processing dataset.
GetPartRev Get the latest Revision (as of TODAY) for the given Part. Parameters Name
Type
Description
pcPartNum
String
Part Number.
pcRevisionNum
String@
Revision Number.
GetAvailableQty Get the available quantity for the part/warehouse/bin/dim code/lot. Parameters Name ds
Type
Description The NonConf data set
GetMtlSources To retrieve the list of possible Material Sources for the given Job Material, as a dataset, to facilitate presenting them to the user to pick one. See the Pick Material Source dialog in v6.10 (qae10-ml.w). The purpose of determining the material source is to set NonConf.VendorNum and NonConf.PurPoint in the case where the tranType = "PUR-MTL". The user's selection of one of these should be stored in the NonConf.MtlSourceTrnType field (i.e. NonConf.MtlSourceTrnType = NonConfSource.TrnType). Note that in v6.10, the user is only presented
1390
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
with the dialog if the Job Material has more than one possible source. To support that behavior, this routine sets the output parameter pcMtlSourceTrnType to the PartTran.TranType when it is unambiguous. Parameters Name
Type
Description
pcJobNum
String
Job number of the Job Material.
piAssemblySeq
Int32
Job Assembly Sequence of the Job Material.
piMtlSeq
Int32
Material Sequence of the Job Material.
pcMtlSourceTrnType
String@
Material Source Transaction Type.
Returns Material Sources data set.
GetPartInfo For a given Part Number, retrieve the current Revision, Unit of Measure, Default Warehouse, and whether it is tracked by Lot, and/or Dimension. Any time the Part has changed, the Lot-, Dimension-, and SerialNumber-tracking attributes need to be checked, and corresponding fields enabled/disabled as appropriate. Also, the SelectedSerialNumbers dataset needs to be cleared out. Parameters Name
Type
Description
pcPartNum
String
Part Number.
pcRevisionNum
String@
Part Revision Number.
pcUM
String@
Unit of Mesaure.
pcWarehouseCode
String@
Warehouse Code.
plLotTracked
Boolean@
Item is tracked by Lot Number.
plDimTracked
Boolean@
Item is tracked by Dimension.
pcWareHseCodeDesc
String@
Warehouse description.
pcBinNum
String@
Bin Number.
GetPartTranPKs Returns primary keys of the part transaction related to the particular non conformance. Parameters Name
Type
Description
tranID
Int32
NonConf.TranID.
partTranPKs
String@
Part transaction primary keys
GetSelectedSerialNumbers This method will populate the SelectedSerialNumber datatable for the Non Conf RowIdent.
Epicor 9.05 | 9.05.605
1391
M-R
Business Object Reference Guide
Parameters Name
Type
Description
pcNonConfRowIdent
String
Input RowIdent field of NonConf datatable
snIsEnabled
Boolean
Indicates if serial numbers are requied for the NonConf line
serialControlPlant
String
The plant that is controlling the serial behavior for the NonConf line
ds
The NonConf data set
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
Description
serialControlPlantIsFromPlt Boolean
Indicates if the from plant is controlling the serial processing (UI Application).
serialControlPlant
String
The plant that is controlling serial behavior for the transaction(UI Application).
serialControlPlant2
String
The to plant for the transaction if from plant is controlling (UI Application).
snIsEnabled
Boolean
Indicates if the transaction requires serial number selection (UI Application).
partNum
String
The part number for the transaction(UI Application).
binNum
String
The bin for the transaction(UI Application).
warehouseCode
String
The warehouse for the transaction(UI Application).
jobNum
String
The job for the transaction(UI Application).
assemblySeq
String
The assembly for the transaction(UI Application).
quantity
Decimal
The quantity for the transaction(UI Application).
scrapUM
String
The unit of measure for the transaction(UI Application).
tranUOM
String
The the converted UOM for the transaction(UI Application).
sourceRowID
String
The RowIdent of the NonConf line for the transaction(UI Application).
pcProcessID
String
The name of the calling process (UI Application).
trnTyp
String
The name of the calling process (UI Application).
materialSeq
Int32
The Material Sequence for the transaction.
Returns The SelectSerialNumbersParams dataset
1392
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangeJobAsm This method validates the ProposedAssemblySeq, then updates the following assembly-related fields: NonConf.PartNum NonConf.PartNumPartDescription NonConf.RevisionNum NonConf.ScrapUM NonConf.WarehouseCode NonConf.BinNum NonConf.PartNumTrackSerialNum NonConf.PartNumTrackLots NonConf.PartNumTrackDimension NonConf.OprSeq NonConf.MtlSeq NonConf.ResourceID NonConf.ResourceIDDescription This method should be run when the NonConf.AssemblySeq field changes. Any time the Part has changed, the Lot-, Dimension-, and SerialNumber-tracking attributes need to be checked, and corresponding fields enabled/disabled as appropriate. Also, the SelectedSerialNumbers dataset needs to be cleared out. An exception is thrown if: - No Job Assembly exists with the given Assembly Sequence Number Parameters Name
Type
Description
piProposedAssemblySeq
Int32
The new proposed Job Assembly value
ds
The NonConf data set
OnChangeJobMtl This method validates the piProposedMtlSeq, then updates the following material-related fields: NonConf.PartNum NonConf.PartNumPartDescription NonConf.RevisionNum NonConf.ScrapUM This method should be run when the NonConf.MtlSeq field changes. Any time the Part has changed, the Lot-, Dimension-, and SerialNumber-tracking attributes need to be checked, and corresponding fields enabled/disabled as appropriate. Also, the SelectedSerialNumbers dataset needs to be cleared out. An exception is thrown if: - No Job Material exists with the given MtlSeq Number Parameters Name
Type
Description
piProposedMtlSeq
Int32
The new proposed Job Material value
ds
The NonConf data set
OnChangeJobNum This method validates the JobNum, then updates the following Job-related fields: PartNum, AssemblySeq, MtlSeq, OprSeq, ResourceID, ResourceIDDescription, JobNumPartDescription, Plant This method should be run when the NonConf.JobNum field changes. If the Part related to the job has only one possible Assembly, the appropriate assembly information is returned, and the plAsmReturned flag is returned as TRUE. This should be used to disable the Assembly Number field and lookup, if appropriate. Any time the Part has changed, the Lot-, Dimension-, and SerialNumber-tracking attributes need to be checked, and corresponding fields enabled/disabled as appropriate. Also, the SelectedSerialNumbers dataset needs to be cleared out. An exception is thrown if: - No Job exists with the given JobNum - Job is not for current plant - Job has been closed - Job has not been released - Job is for a service call that has been invoiced Parameters Name
Type
Description
pcProposedJobNum
String
The new proposed JobNum value
plAsmReturned
Boolean@
TRUE if the indicated Part only has one assembly.
Epicor 9.05 | 9.05.605
1393
M-R
Business Object Reference Guide
Name
Type
Description
snWarning
String@
Message returned if there are currently selecte serial numbers.
ds
The NonConf data set
OnChangeJobOpr This method validates the piProposedOprSeq, then updates the following operation-related fields: NonConf.OprSeq NonConf.WCCode NonConf.WrkCntrDesc NonConf.WarehouseCode NonConf.WarehouseCodeDescription NonConf.BinNum This method should be run when the NonConf.OprSeq field changes. Any time the Part has changed, the Lot-, Dimension-, and SerialNumber-tracking attributes need to be checked, and corresponding fields enabled/disabled as appropriate. Also, the SelectedSerialNumbers dataset needs to be cleared out. An exception is thrown if: - No Job Operation exists with the given OprSeq Number Parameters Name
Type
Description
piProposedOprSeq
Int32
The new proposed Job Operation Sequence value
ds
The NonConf data set
OnChangeTranQty Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.TranQty changes. This method performs validation on TranQty and sets the Issued Complete flag. Parameters Name
Type
Description
pdTranQty
Decimal
Transaction Qty
ds
IssueReturnDataSet
OnChangeUM Call this method when the value of Epicor.Mfg.BO.IssueReturnDataSet.UM changes. Parameters Name
Type
Description
pUM
String
Transaction UOM
ds
IssueReturnDataSet
PreUpdate This method does: 1 - Returns a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called.
1394
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
Boolean@
Indicates if the legal number requires user input
ds requiresUserInput
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
ds
Description NonConf data set
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
GetReasonWhereClause Provides a WHERE clause for obtaining a list of Reason codes suitable for the given type of NonConformance. Valid types are Operation, Inventory, JobMaterial, SubContract, and Other. Parameters Name
Type
Description
pcNonConfType
String
Type/origin of NonConformance.
Returns WHERE clause suitable for use with Reason.GetList()
Epicor 9.05 | 9.05.605
1395
M-R
Business Object Reference Guide
Chapter 15: O ObjectSecurity Epicor.Mfg.BO.ObjectSecurity: This business object contains 20 methods.
GetNewSecurity Inserts a new row in the DataSet with defaults populated.
GetNewObjectSecurityMethod Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1396
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
buildAccessList Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckCompanyInfo This method is run before Update procedure to warn the user if the same record exists, the old record will be deleted during saving. Parameters Name
Type
Description
pcSecCode
String
The current security code
pcCurCompOnly
Boolean
The flag CurrentCompanyOnly
rowExists
Boolean@
It returns true if the record already exists
DenyAccess This method deny token access to a particular user or group Parameters Name
Type
Description
pcSecCode
String
The security token
pcUser
String
The user id or a group code
Epicor 9.05 | 9.05.605
1397
M-R
Business Object Reference Guide
Name
Type
Description
pbCurrentCompanyOnly
Boolean
yes = no particular company
ds
The dataset representing Security object
DenyMethodAccess This method deny token access to a particular user or group Parameters Name
Type
Description
pcSecCode
String
The security token
pcUser
String
The user id or a group code
pbCurrentCompanyOnly
Boolean
yes = no particular company
ds
The dataset representing Security object
GetByIDEx This method returns a dataset representing a Security with CompanyID, which is allowable for the current company. Parameters Name
Type
Description
pcSecCode
String
The security code
pcComp
String
The company
strictPrimKey
Boolean
If it is false, look for all recordes allowed for the current company
Returns The dataset representing the Security row
GetGroupUserList This method returns a double-delimited list of value-name pairs of all Users and Groups. This could be used to provide a "picker list" as a starting point when adding a new Security record related to a method. These would look the same as a Security record for an object, but with a SecCode field that has been appended with "." + MethodName. For example, a security record for the Parameters
1398
Name
Type
Description
pcGroupUserList
String@
The double-delimited list of Group and User codes and names.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetListEx This method returns a list of Security, including those with blank Company ID Parameters Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of Securities
GetMethodList This method returns a delimited list of the public methods for the given object. This could be used to provide a "picker list" as a starting point when adding a new Security record related to a method. These would look the same as a Security record for an object, but with a SecCode field that has been appended with "." + MethodName. For example, a security record for the Parameters Name
Type
Description
pcSecCode
String
The security code for which you want the list of methods.
pcMethodList
String@
The delimited list of method names.
GetNewSubSecurity This method creates a new sub security row Parameters Name
Type
ds
Description Returns the created subsecurity row
pcParentSecCode
String
The parent security code
pcSecCode
String
The security code
GrantAccess This method Grant security token access to a particular user or group Parameters Name
Type
Description
pcSecCode
String
The Security token
Epicor 9.05 | 9.05.605
1399
M-R
Business Object Reference Guide
Name
Type
Description
pcColumn
String
The column
pcUser
String
The user id or a group code
pbCurrentCompanyOnly
Boolean
yes = only for current company
ds
The dataset representing Security object
GrantMethodAccess This method Grant security token access to a particular user or group Parameters Name
Type
Description
pcSecCode
String
The Security token
pcColumn
String
The Column
pcUser
String
The user id or a group code
pbCurrentCompanyOnly
Boolean
yes = only for current company
ds
Returns the dataset representing Security object
ValidateNewSecCode This method don't allow create new record, if there are records with the same code for all companies and for the current company. If there is only record for all companies, this method retuns the current company ID to allow create new record only for the current company. Parameters Name
Type
Description
newSecCode
String
The new security code
curComp
String@
The current company
ObjectSecuritySearch Epicor.Mfg.BO.ObjectSecuritySearch: This business object contains 6 methods. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1400
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OpMaster Epicor.Mfg.BO.OpMaster: This business object contains 27 methods.
GetNewOpMaster Inserts a new row in the DataSet with defaults populated.
GetNewOpMasterAttch Inserts a new row in the DataSet with defaults populated.
GetNewOpMasRestriction Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1401
M-R
Business Object Reference Guide
GetNewOpMasRestrictSubst Inserts a new row in the DataSet with defaults populated.
GetNewOpMasterInsp Inserts a new row in the DataSet with defaults populated.
GetNewOpMasDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1402
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeCapabilityID Method to call when changing the Capability ID. Blank is a valid entry for Capability ID. Parameters Name
Type
Description
proposedCapID
String
The proposed Capability ID
ds
The OpMaster data set
ChangeOpMasRestrictionType This methods assigns associated fields when OpMasRestriction.RestrictionTypeID changes. Parameters Name
Type
ds
Description OpMaster dataset
ChangeOpMasRestrictSubstance This methods assigns associated fields when OpMasRestrictSubst.SubstanceID changes.
Epicor 9.05 | 9.05.605
1403
M-R
Business Object Reference Guide
Parameters Name
Type
ds
Description OpMaster dataset
ChangeOpMasterPrimaryProdOpDtl This method checks if the entered primary production operation detail is valid. This method should run when the OpMaster.ScrPrimaryProdOpDtl field changes. Parameters Name
Type
Description
proposedProdOpDtl
Int32
The proposed primary production operation detail sequence
ds
The Operation Master data set
ChangeOpMasterPrimarySetupOpDtl This method checks if the entered primary setup operation detail is valid. This method should run when the OpMaster.ScrPrimarySetupOpDtl field changes. Parameters Name
Type
Description
proposedSetupOpDtl
Int32
The proposed primary setup operation detail sequence
ds
The Operation Master data set
ChangeResourceGrpID Method to call when changing the Resource Group ID. This method will update OpMasDtl with the default labor and burden rates from the new resource group. Blank is a valid entry for Resource Group ID. Parameters Name
Type
Description
proposedResGrpID
String
The proposed Resource Group ID
ds
The Operation Master data set
ChangeResourceID Method to call when changing the Resource ID. Blank is a valid entry for Resource ID. Parameters Name
Type
Description
proposedResourceID
String
The proposed Resource ID
ds
1404
The Operation Master data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangeVendorNumVendorID Method to call when changing the Vendor Num. Blank is a valid entry for Vendor Num. Parameters Name
Type
Description
proposedVendorNumVendorID
String
The proposed Vendor ID
ds
The OpMaster data set
CheckInactiveSchedRequirement Method to call check the capability, resource group, or resource is active. This method should be called prior to calling the Update method on an OpMasDtl record. Will return message text to present to the user if the code is inactive. The message is asking the user if it is ok to save the record with an inactive code. If the user answers yes, the record can be saved. If a blank value is returned for InactiveMessage, continue as normal - no special processing needs to occur. Parameters Name
Type
ds inactiveMessage
Description The OpMaster data set
String@
The text of the message
GetByIDandOpType A variation of the standard GetByID. Gets a OpMaster for a specific OpCode with consideration of OpType(s). Note OpType is a comma separated list of Operation types to be considered valid for this Get. Used as a predecessor to calling GetByID. Parameters Name
Type
Description
opCode
String
Opmaster.OpCode
opType
String
Opmaster.OpType
InsertCapability This methods allows for the insertion of Capability on an operation to create operation detail for drag/drop functionality. Parameters Name
Type
Description
ipOpMasterRowID
String
The rowid of the OpMaster record to add the operation detail to
ipCapabilityID
String
The Capability ID being added
Epicor 9.05 | 9.05.605
1405
M-R
Business Object Reference Guide
Name
Type
Description
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
Returns The OpMaster data set
InsertResource This methods allows for the insertion of Resource on an operation to create operation detail for drag/drop functionality. Parameters Name
Type
Description
ipOpMasterRowID
String
The rowid of the OpMaster record to add the operation detail to
ipResourceID
String
The Resource ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
Returns The OpMaster data set
InsertResourceGroup This methods allows for the insertion of Resource Group on an operation to create operation detail for drag/drop functionality. Parameters Name
Type
Description
ipOpMasterRowID
String
The rowid of the OpMaster record to add the operation detail to
ipResourceGrpID
String
The Resource Group ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
Returns The OpMaster data set
ValidateInspection Method to validate the Inspection control fields. (EQM)
1406
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipProposedInspPlan
String
The new proposed InspPlanPartNum value
ipProposedSpecId
String
The new proposed SpecID value
ds
The OpMaster entry Dataset.
OpStd Epicor.Mfg.BO.OpStd: This business object contains 8 methods.
GetNewOpStd Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1407
M-R
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
OpText Epicor.Mfg.BO.OpText: This business object contains 7 methods.
GetNewOpText Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1408
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OrderAlloc Epicor.Mfg.BO.OrderAlloc: This business object contains 45 methods.
AllocateByLotBin Allocate sales demand records by choosing specific Lots and/or Bins Parameters Name
Type
ds
Description The OrderAlloc data set
cIPWhseList
String
The list of warehouses
cWhseType
String
All or primary warehouse only
Epicor 9.05 | 9.05.605
1409
M-R
Business Object Reference Guide
Name
Type
Description
cMessageText
String@
Message text to present to the user after the process is finished
AllocateBySerialNum Allocate demand by choosing specific Serial Numbers Parameters Name
Type
ds
Description The OrderAlloc data set
cIPWhseList
String
The list of warehouses
cWhseType
String
All or primary warehouse only
cMessageText
String@
Message text to present to the user after the process is finished
Type
Description
AutoAllocation Auto allocate demand Parameters Name ds
The OrderAlloc data set
cIPWhseList
String
The list of warehouses
cWhseType
String
All or primary warehouse only
cMessageText
String@
Message text to present to the user after the process is finished
AutoPick Auto Pick demand Parameters Name
Type
ds
1410
Description The OrderAlloc data set
cIPWhseList
String
The list of warehouses
o_Success
Boolean@
Sends a flag if there are records to process
cMessageText
String@
Message text to present to the user after the process is finished
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
AutoReserve Auto reserve demand Parameters Name
Type
ds
Description The OrderAlloc data set
cIPWhseList
String
The list of warehouses
cWhseType
String
All or primary warehouse only
cMessageText
String@
Message text to present to the user after the process is finished
AutoReserveJob Parameters Name
Type
Description
ipJobNum
String
Job Number
ipAssemblySeq
Int32
AssemblySeq - can be zero
ipCutoffDate
Nullable{System.DateTime}
Cutoff Date - can be blank
Name
Type
Description
ipJobNum
String
Job Number
ipAssemblySeq
Int32
AssemblySeq - can be zero
ipCutoffDate
Nullable{System.DateTime}
Cutoff Date - can be blank
Returns The AutoReserveJob data set
AutoUnreserveJob Parameters
ChangePartNum Rebuild the AllocSupply list when the part number changes. Prior to calling this procedure, the RowMod field in all OrderAllocSupply records must be set to "U":U because these records need to be cleared from the table before rebuilding the list. Parameters Name
Type
ds cPartNum
Epicor 9.05 | 9.05.605
Description The OrderAlloc data set
String
The part number
1411
M-R
Business Object Reference Guide
Name
Type
Description
iOrderNum
Int32
The order number
iOrderLine
Int32
The order line
iOrderRelNum
Int32
The order release number
ChangeStagingWarehouse Default the staging bin based on the staging warehouse code passed in. Parameters Name
Type
ds
Description The OrderAlloc data set
cProposedStageWhseCode
String
The proposed warehouse code
CheckDates Check Dates, return any warnings Parameters Name
Type
ds cMessageText
Description The OrderAlloc data set
String@
Warning Message Text
CreateWave Parameters Name
Type
Description
ipWaveDesc
String
Wave Description
ipDemandType
String
Demand Type - valid values are Order/Job/Transfer
opWaveNum
Int32@
New Wave Number
GetCalcPref Parameters
1412
Name
Type
Description
opCalcFulfillOnSearch
Boolean@
Should calculations be executed after search? Yes/No
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetList Gets List of order records that can be selected for Order Allocation. Parameters Name
Type
Description
whereClause
String
where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The OrderAllocList Data Set
GetListAdvanced Gets List of order records that can be selected for fulfillment. Parameters Name
Type
Description
i_CustId
String
Customer ID associated with the release
i_GroupCode
String
Customer Group Code associated with the release
i_ReservePri
String
Reservation Priority Code associated with the release
i_FromDate
String
Earliest Ship Date
i_ToDate
String
Latest Ship Date
i_StartOrder
Int32
Lowest Order Number
i_EndOrder
Int32
Highest Order Number
i_PONum
String
Customer PO Number associated with the release
i_PartNum
String
Part Number
i_DoNotShipBefore
String
Do Not Ship before date associated with the release
i_ShipVia
String
Ship Via Code
i_SortBy
String
Sort By field
i_StartingAt
String
Starting At field
i_Order
Boolean
Order filter
i_Job
Boolean
Job filter
i_Transfer
Boolean
Transfer filter
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Epicor 9.05 | 9.05.605
Are there more pages ? Yes/No
1413
M-R
Business Object Reference Guide
Returns The OrderAllocList Data Set
GetListBasicSearch Called from "Basic" search screen Parameters Name
Type
Description
ipPartFrom
String
From Part
ipPartTo
String
To Part
ipWaveFrom
String
From Wave
ipWaveTo
String
To Wave
ipPlantFrom
String
From Plant
ipPlantTo
String
To Plant
ipWhseFrom
String
From Whse
ipWhseTo
String
To Whse
ipNeedByFrom
Nullable{System.DateTime}
From Need By Date
ipNeedByTo
Nullable{System.DateTime}
To Need By Date
ipOrderFrom
Nullable{System.DateTime}
From Order Date
ipOrderTo
Nullable{System.DateTime}
To Order Date
ipShipByFrom
Nullable{System.DateTime}
To Ship By Date
ipShipByTo
Nullable{System.DateTime}
From Ship By Date
ipDemandType
String
Demand Type
ipSortBy
String
Sort By
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The OrderAllocList Data Set
GetListFromSelectedKeys This methods will return all of the OrderAlloc records which will be a subset of the PartDtl records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method. Parameters Name
Type
ds pageSize
1414
Description The dataset with populated key values
Int32
The page size, used only for UI adaptor
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
GetListJob Gets List of Job records that can be selected for fulfillment. Parameters Name
Type
Description
whereClausePartDtl
String
PartDtl where condition without the where word
whereClauseJobMtl
String
JobMtl where condition without the where word
whereClauseJobHead
String
JobHead where condition without the where word
whereClausePartAlloc
String
PartAlloc where condition without the where word
whereClauseWaveOrder
String
WaveOrder where condition without the where word
sortBy
String
Sort condition WITH the by word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The OrderAllocList Data Set
GetListOrders Gets List of order records that can be selected for Order Allocation. Parameters Name
Type
Description
waveWhereClause
String
Order Head where clause
orderHedWhereClause
String
Order Head where clause
orderDtlWhereClause
String
Order Dtl where clause
orderRelWhereClause
String
Order Release where clause
customerWhereClause
String
Customer where clause
partAllocWhereClause
String
PartAlloc where clause
countryWhereClause
String
Country where clause
shipToWhereClause
String
ShipTo where clause
creditHoldClause
String
Credit Hold filter clause
i_SortByOrder
String
Sort By Order field
i_SortByWarehouse
String
Sort By WarehouseCode
Epicor 9.05 | 9.05.605
1415
M-R
Business Object Reference Guide
Name
Type
Description
i_SortByAllocation
String
Sort By Allocated
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The OrderAllocList Data Set
GetListTFO Gets List of Transfer Order records that can be selected for fulfillment. Parameters Name
Type
Description
whereClausePartDtl
String
PartDtl where Clause
whereClauseTFOrdDtl
String
TFOrdDtl where Clause
whereClauseTFOrdHed
String
TFOrdHed where Clause
whereClausePartAlloc
String
PartAlloc where Clause
whereClauseWaveOrder
String
WaveOrder where Clause
sortBy
String
Sort By
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The OrderAllocList Data Set
GetLotBinOnHand Select OrderAlloc rows based on criteria. Parameters Name
Type
ds
Description The OrderAlloc data set
GetLotBinOnHandByWhseCode Select OrderAlloc rows based on criteria for warehouse, pass a blank warehouse to include all warehouses.
1416
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ds
The OrderAlloc data set
ipWarehouseCode
String
Warehouse Code
GetLotBinOnHandByWhseCodeZoneBinType Select OrderAlloc rows based on criteria for warehouse, pass a blank warehouse to include all warehouses. Parameters Name
Type
ds
Description The OrderAlloc data set
ipWarehouseCode
String
Warehouse Code
ipWarehouseZone
String
Warehouse Zone
ipBinType
String
Bin Type
GetRowsFromSelectedKeys This methods will return all of the OrderAlloc records which will be a subset of the PartDtl records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method. Parameters Name
Type
ds
Description The dataset with populated key values
ipLastDisplaySeq
Int32
Last DisplaySeq value currently in the grid
pageSize
Int32
The page size, used only for UI adapter
absolutePage
Int32
The absolute page, used only for the UI adapter
morePages
Boolean@
More pages?, used only for the UI adapter
GetSerialNumOnHand Select OrderAlloc rows based on criteria. Parameters Name
Type
ds
Description The OrderAlloc data set
GetSerialNumOnHandByWhseCode Select OrderAlloc rows based on criteria for warehouse, pass a blank warehouse to include all warehouses.
Epicor 9.05 | 9.05.605
1417
M-R
Business Object Reference Guide
Parameters Name
Type
ds ipWarehouseCode
Description The OrderAlloc data set
String
Warehouse Code
GetSerialNumOnHandByWhseCodeZoneBinType Select OrderAlloc rows based on criteria for warehouse, pass a blank warehouse to include all warehouses. Parameters Name
Type
ds
Description The OrderAlloc data set
ipWarehouseCode
String
Warehouse Code
ipWarehouseZone
String
Warehouse Zone
ipBinType
String
Bin Type
GetSubmitOptionsList Returns a delimited list of the pick options in code`description format. Each code-description entry is separated with character ~. Parameters Name
Type
Description
cSubmitOptionsList
String@
The submit options list
GetWhseTeamUserList Returns the list of all employees from Database Table WhseGroupEmp Parameters Name
Type
Description
groupCode
String
Warehouse Group Code.
Returns The WhseTeamEmpList Data Set
JobMtlUpdate Update the JobMtl database table with changes saved to the OrderAlloc datatable.
1418
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ds
The OrderAlloc data set
MassAssign Mass assign data in various columns as defined by user Parameters Name
Type
Description
cStageWhseCode
String
Proposed staging warehouse code
cStageBinNum
String
Proposed staging bin number
cMessageText
String@
Message text to present to the user after the process is finished
ds
MtlQueueUpdate Material Queue Update Parameters Name
Type
Description
iReleaseForPickingSeq
Int32
This Release for Pickings Seq
OnChangeWaveNum OnChangeWaveNum Parameters Name
Type
Description
newWaveNum
Int32
Wave.WaveNum
ds
The OrderAllocList Data Set
OneDemandType Only one Demand Type can be selected Parameters Name
Type
ds o_ErrorText
Epicor 9.05 | 9.05.605
Description The OrderAlloc data set
String@
Error Text if more than one Demand Type is selected
1419
M-R
Business Object Reference Guide
Name
Type
Description
o_DemandType
String@
If only one Demand Type is selected, return the value
OrderAllocationGetRows Returns the full dataset. Parameters Name
Type
ds ipLastDisplaySeq
Description The OrderAllocList data set
Int32
Last DisplaySeq value currently in the grid
Returns The OrderAlloc data set
OrderAllocSupplyUpdate Update the PartAlloc database table with changes saved to the OrderAllocSupply datatable. Parameters Name
Type
ds
Description The OrderAlloc data set
OrderRelUpdate Update the OrderRel database table with changes saved to the OrderAlloc datatable. Parameters Name
Type
ds
Description The OrderAlloc data set
Recalculate Recalculate public method - called from Refresh Fulfillment button in Fulfillment Workbench Parameters Name
Type
ds
Description The OrderAlloc data set
SelectForProcessing Select OrderAlloc rows based on criteria.
1420
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The OrderAlloc data set
cCountry
String
Country code
cShipVia
String
Ship Via code
dEndDate
Nullable{System.DateTime}
The end date
cCustID
String
The customer id
cPartNum
String
The part number
lAllDates
Boolean
Indicates if all dates should considered for the allocate process
dPctFillable
Decimal
Percent Fillable
cMessageText
String@
Message text to present to the user after the process is finished
SetCalcPref Parameters Name
Type
Description
ipCalcFulfillOnSearch
Boolean
Value to set UserComp.CalcFulfillOnSearch Yes/No
SubmitForPicking Submit order releases for picking Parameters Name
Type
ds
Description The OrderAlloc data set
iNumDays
Int32
Number of days prior to ship by date
dNeedByDate
Nullable{System.DateTime} Specific need by date
lUseSpecifiedDate
Boolean
Use the specific date passed in
cMessageText
String@
Message text to present to the user after the process is finished
iReleaseForPickingSeq
Int32@
iReleaseForPickingSeq
TFOrdDtlUpdate Update the TFOrdDtl database table with changes saved to the OrderAlloc datatable.
Epicor 9.05 | 9.05.605
1421
M-R
Business Object Reference Guide
Parameters Name
Type
ds
Description The OrderAlloc data set
UnallocateAndReserve Unallocate and Unreserve demand records Parameters Name
Type
Description
String@
Message text to present to the user after the process is finished
ds cMessageText
UnallocateAndUnreserve Unallocate and Unreserve sales demand records Parameters Name
Type
Description
String@
Message text to present to the user after the process is finished
Type
Description
String@
Message text to present to the user after the process is finished
ds cMessageText
Unreserve Unreserve demand Parameters Name ds cMessageText
GetSearchSortDefault This methods will return all the Search Sort Defaults defined in the Plant Configuration Parameters
1422
Name
Type
Description
ipDemandType
String
Demand Type - valid values are Order/Job/Transfer
opSearchSort
String@
Search Sort Default
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OrderDtlSearch Epicor.Mfg.BO.OrderDtlSearch: This business object contains 9 methods.
GetNewOrderDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1423
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsContactTracker Calls the normal GetRows method and then constructs a custom data set combining Job and Order fields for the customer tracker. Parameters Name
Type
Description
whereClauseOrderDtl
String
Whereclause for OrderDtl table.
whereClauseOrderRel
String
Whereclause for OrderRel table.
jobWhereClause
String
Whereclause for Job table.
contactName
String
Contact name to return records for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The JobCustTrk data set
GetRowsCustomerTracker Calls the normal GetRows method and then constructs a custom data set combining Job and Order fields for the customer tracker. Parameters Name
Type
Description
whereClauseOrderDtl
String
Whereclause for OrderDtl table.
whereClauseOrderRel
String
Whereclause for OrderRel table.
jobWhereClause
String
Whereclause for Job table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The JobCustTrk data set
1424
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OrderHist Epicor.Mfg.BO.OrderHist: This business object contains 1 methods.
GetListOrderHistory This method returns latest Parts sold by a given Customer. Parameters Name
Type
Description
custNum
Int32
CustNum
orderNum
Int32
OrderNum
Returns OrderHist dataset
OrderJobWiz Epicor.Mfg.BO.OrderJobWiz: This business object contains 6 methods.
CreateJobs This method creates job for selected orderdtls and/or orderrels. This method will process any and all records where the ttJWJobOrderDtl.JobChkBox or ttJWOrderRel.RelJobChkBox is set to true. This method will also process the getDetails, Schedule and Release booleans. Parameters Name
Type
ds pErrorMessages
Description The OrderJobWiz Data Set
String@
If non-blank, display the message to the user.
GetMatrix To retrieve the OrdJobWiz dataset for a given part number. This dataset consists of the Order Detail lines that are of type 'make' and thier related releases. The dataset also includes open jobs for any part in the detail, The client my need to filter the job dataset to represent only the jobs relevant to the part on the detail. Index constraints on the xsd, did not allow me to do that in the BL. Parameters Name
Type
Description
curOrderNum
Int32
OrderNum to be processed
curOrderLine
Int32
Optional, Passing in when comming from Job Planner to valid Suggestion
curOrderRelNum
Int32
Optional, Passing in when comming from Job Planner to valid Suggestion
Epicor 9.05 | 9.05.605
1425
M-R
Business Object Reference Guide
Returns The OrderJobWiz data set
Link Creates link between selected release and selected job . Parameters Name
Type
Description
ds
The OrderJobWiz data set
SelectAll This method processes the select all, getallmethod, sheduleall and releaseall fields in the ttJWJobOrderDtl record. If any of the values in these fields change, this method must be invoked in order for that change to be refelcted to the database. Notes: ttJWJobOrderDtl.Selectall = Set all values of Job checkbox to true for all lines in the Order Lines Grid EXCEPT whre partID is an MRP part OR any release line for the detail line linked to a job. ttJWJobOrderDtl.DetailChkBox = Get All methods for all dtl lines, Selectall must be checked ttJWJobOrderDtl.ScheduleAll = Schedule all jobs, DetailChkBox must be checked ttJWJobOrderDtl.ReleaseAll = Release all jobs, ScheduleAll must be checked Parameters Name
Type
Description
curOrderNum
Int32
Order Number
insavedSelectAll
Boolean
insavedgetallmethods
Boolean
Get All Methods
insavedScheduleAll
Boolean
Schedule All
insavedReleaseAll
Boolean
Release All
Returns OrderJobWiz data set
UnLink Unlink releases to Jobs . Parameters Name ds
Type
Description The OrderJobWiz data set
ValidateJobs Gather all of the parts that are flagged to create jobs, and display the ones in a message that won't be getting details.
1426
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds warnMsg
Description The OrderJobWiz data set
String@
The Warning message
OrderRelPlantSearch Epicor.Mfg.BO.OrderRelPlantSearch: This business object contains 7 methods.
GetNewOrderRelPlantSearch Inserts a new row in the DataSet with defaults populated. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1427
M-R
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OrderRelSearch Epicor.Mfg.BO.OrderRelSearch: This business object contains 9 methods.
GetNewOrderRel Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1428
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListByCustNum This method returns a list of OrderRel filtered by CustNum. Parameters Name
Type
Description
whereClause
String
The criteria
custNum
Int32
Filter by this CustNum
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns The list of OrderRel
GetListFilterShipped This method returns a list of OrderRel that have not been shipped Parameters Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns The list of Securities
Epicor 9.05 | 9.05.605
1429
M-R
Business Object Reference Guide
OverrideSchedOrders Epicor.Mfg.BO.OverrideSchedOrders: This business object contains 3 methods.
DeleteRec Delete current record and reset values (Job Number - number or list Parameters Name
Type
Description
ipJobNum
String
Job Number
LoadOverrideSched Populates ttOverrideSchedOrders table from JobHead, PatchFld Parameters Name
Type
Description
WasChanged
Boolean@
DataSet has been Changed
ds
The OverrideSchedOrders data set
UpdateSchedPri Update default information based on the warehouse changing Parameters Name ds
1430
Type
Description The OverrideSchedOrders data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Chapter 16: P PackagingUnit Epicor.Mfg.BO.PackagingUnit: This business object contains 25 methods.
GetNewPkgUnit Inserts a new row in the DataSet with defaults populated.
GetNewPkgDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1431
M-R
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AddSelectedSubPkg Link the selected Packaging Units to the current Packaging Unit. Parameters Name
Type
Description
ipPkgNum
Int32
The Parent Packaging Unit
ds
The SelectSubPkgID dataset
Returns Packaging Unit DataSet
AssignLegalNumber Assigns a legal number to the Packaging Unit. Parameters Name
Type
Description
ipPkgNum
Int32
Invoice number
String@
Legal number message
ds opLegalNumMsg Returns The Packaging Unit data set
ChangePkgDtlOrderNum Update information when Sales Order is changed.
1432
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
pOrderNum
Int32
Sales Order Number
ds
Packaging Unit DataSet
ChangePkgDtlOrderRelNum Update information when Sales Order Release is changed. Parameters Name
Type
Description
pOrderRelNum
Int32
Order Release
ds
Packaging Unit DataSet
ChangePkgDtlPartNum Validate Part Number when it is changed. Parameters Name
Type
Description
pPartNum
String
Part Number Num
ds
Packaging Unit DataSet
ChangePkgUnitOrderNum Update information when Sales Order is changed. Parameters Name
Type
Description
pOrderNum
Int32
Sales Order Number
ds
Packaging Unit DataSet
ChangePkgUnitOrderRelNum Update information when Sales Order Release is changed. Parameters Name
Type
Description
pOrderRelNum
Int32
Order Release
ds
Epicor 9.05 | 9.05.605
Packaging Unit DataSet
1433
M-R
Business Object Reference Guide
ChangePkgUnitParentPkgNum Validate Parent Packaging ID when it is changed. Parameters Name
Type
Description
pParentPkgNum
Int32
Parent Packaging ID
ds
Packaging Unit DataSet
ChangePkgUnitPkgCode Sets default values when the PkgCode changes Parameters Name
Type
Description
ipPkgCode
String
PkgCode supplied
ds
Packaging Unit DataSet
ChangePkgUnitTranDocTypeID Sets default values when the TranDocTypeID changes Parameters Name
Type
Description
ipTranDocTypeID
String
TranDocTypeID supplied
ds
Packaging Unit DataSet
ClosePackage Set the status of the current Packaging Unit to Close. This is only available if the current status is Open. Parameters Name
Type
Description
iPkgNum
Int32
The Pre-Pack ID
Returns The Packaging Unit DataSet
GetDatasetForTree This methods will return the dataset for Packaging Unit Entry. The method will return the records related to the Packaging Unit provided and the first child level related to the input inputted Packaging.
1434
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipPkgNum
Int32
The Top Packaging Unit to return data for.
ipSubPkgNum
Int32
The current sub Packaging Unit to return data for.
Returns Packaging Unit DataSet
GetLegalNumGenOpts Returns the legal number generation options. Parameters Name
Type
Description
ipPkgNum
Int32
Packaging Unit Number
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
Description
ds
Packaging Unit DataSet
Returns The SelectSerialNumbersParams dataset
OpenPackage Reset the status of the current Packaging Unit to Open. This is only available if the current status is Closed. If the Pre-Pack is detail of another Pre-Pack then the Unit status cannot be changed to Open. Parameters Name
Type
Description
iPkgNum
Int32
The Pre-Pack ID
Returns The Packaging Unit DataSet
ValidateSN Validates that a single serial number is valid for this transaction
Epicor 9.05 | 9.05.605
1435
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
Packaging Unit DataSet
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
VoidLegalNumber Voids the legal number. Parameters Name
Type
Description
ipPkgNum
Int32
Packaging Unit Number
ipVoidedReason
String
Reason for the void
Returns The Packaging Unit data set
PackClss Epicor.Mfg.BO.PackClss: This business object contains 7 methods.
GetNewPackClss Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1436
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Packing Epicor.Mfg.BO.Packing: This business object contains 7 methods.
GetNewPacking Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1437
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PackOutSearch Epicor.Mfg.BO.PackOutSearch: This business object contains 1 methods.
POGetRows This methods will return all of the ttPackOut search records. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table we need our own public method. Parameters
1438
Name
Type
Description
whereClausettPackOutSearch
String
The where clause to restrict data for
matchfield
String
comma delimited list of field to find unique hits
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
ds
Description The PoDetailSearch data set
Returns The PoDetailSearch data set
PAPlan Epicor.Mfg.BO.PAPlan: This business object contains 9 methods.
GetNewPAPlan Inserts a new row in the DataSet with defaults populated.
GetNewPAPlanDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1439
M-R
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeWeekID Call when PAPlan.PAWeekID is changing to validate the ID and populate the description. Parameters Name
Type
Description
pWeekID
String
The new week ID.
ds
The PAPlanDataSet. If valid, the week description will be returned in the dataset.
Part Epicor.Mfg.BO.Part: This business object contains 102 methods.
GetNewPart Inserts a new row in the DataSet with defaults populated.
GetNewPartAttch Inserts a new row in the DataSet with defaults populated.
GetNewPartCOO Inserts a new row in the DataSet with defaults populated.
GetNewPartDim Inserts a new row in the DataSet with defaults populated.
GetNewPartLangDesc Inserts a new row in the DataSet with defaults populated.
1440
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetNewPartPlant Inserts a new row in the DataSet with defaults populated.
GetNewPartWhse Inserts a new row in the DataSet with defaults populated.
GetNewPartBinInfo Inserts a new row in the DataSet with defaults populated.
GetNewPartRestriction Inserts a new row in the DataSet with defaults populated.
GetNewPartRestrictSubst Inserts a new row in the DataSet with defaults populated.
GetNewPartRev Inserts a new row in the DataSet with defaults populated.
GetNewPartRevAttch Inserts a new row in the DataSet with defaults populated.
GetNewPartAudit Inserts a new row in the DataSet with defaults populated.
GetNewPartRevInspPlan Inserts a new row in the DataSet with defaults populated.
GetNewPartRevInspPlanAttch Inserts a new row in the DataSet with defaults populated.
GetNewPartRevInspVend Inserts a new row in the DataSet with defaults populated.
GetNewPartSubs Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewTaxExempt Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1441
M-R
Business Object Reference Guide
GetNewPartPC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
1442
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The dataset with list of errors occured during update process.
GetPartGlobalFields To return the list of fields that are maintained by the "Master/Owner" of global record. The client can use this list to disable these fields on the UI.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ConstructExampleString TO BE CALLED ON CHANGE OF ttSerialMask.Mask Parameters Name
Type
Description
ipMask
String
SerialMask.Mask
ipPart
String
Part.PartNum
opExampleStr
String@
SerialMask.Example
OnChangeSNLastUsedSeq Parameters Name
Type
Description
ipGenSeqStr
String
SerialMask.GenerateSeqString
ipLastUsedSeq
String
SerialMask.SNLastUsedSeq
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
1443
M-R
Business Object Reference Guide
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
This method exists soley for the purpose of allowing security for dimension maintenance to be defined This method exists soley for the purpose of allowing security for inventory information to be defined This method exists soley for the purpose of allowing security for lot maintenance to be defined
1444
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
This method exists soley for the purpose of allowing security for purchasing information to be defined This method exists soley for the purpose of allowing security for viewing part lot costs to be defined
ChangeMRPWarning When the ProcessMRP flag for a Part/Plant is changed from Yes to No all related unfirm jobs will be deleted when the record is committed to the database. You can use this method to provide a warning to the user of this fact and provide a confirmation dialog. This is intended to be called upon value change of the ProcessMRP field. If there are existing unfirm Jobs for the given Part/PlantThis warningMsg will contain a translated text message which can be used to display in your message dialog. Otherwise it returns blanks and there is no need to provide a dialog. Parameters Name
Type
Description
partNum
String
Part number of the PartPlant record that is being updated.
plant
String
Plant ID of the PartPlant record that is being updated .
processMRP
Boolean
New value of the PartPlant.ProcessMRP field.
warningMsg
String@
Contains warning message text if jobs will be deleted by changing the ProcessMRP value.
ChangePartBinInfoKBCode Used when the KBCode field of PartBinInfo is being changed to a new value. It will validate the new KBCode field. If it is valid the dataset will be updated with the new KBCode and related KBActionCode. Parameters Name
Type
Description
newKBCode
String
The new Kan Ban Type code field value.
ds
The PartDataset. If valid, the NewKBCode will be returned in the dataset, along with a refreshed KBActionCode field. IMPORTANT, the PartWhse record must be sent as modified otherwise you will received error that record cannot be found.
ChangePartBuyToOrder Used when the Buy To Order field of Part is being changed to a new value. Parameters Name
Type
Description
ipBuyToOrder
Boolean
The new part Buy To Order value.
ds
Epicor 9.05 | 9.05.605
The PartDataset.
1445
M-R
Business Object Reference Guide
ChangePartCommodityCode Used when the Part.CommodityCode field is being changed to a new value. It will validate the new value, passed in with newCommodityCode If it is valid the dataset will be updated with the new value and related values will be refreshed. Parameters Name
Type
Description
newCommodityCode
String
The new commodity code.
ds
The PartDataset. IMPORTANT, the Part record must be sent as modified otherwise you will received error that record cannot be found.
ChangePartGlobalPart Method to call when changing the global part flag on a part. Assigns the GlbFlag base on the new value. Parameters Name
Type
Description
proposedGlobalPart
Boolean
The proposed global part value
ds
The Part data set
ChangePartNum Method to call when changing the Part Number. Validates this is a "Add", PartNumber does not already exist, sets defaults for UOMClass, UOM Parameters Name
Type
Description
proposedPartNum
String
The proposed product code value
ds
The Part data set
ChangePartPlantBuyToOrder Used when the Buy To Order field of PartPlant is being changed to a new value. Parameters Name
Type
Description
ipBuyToOrder
Boolean
The new part Buy To Order value.
ds
1446
The PartDataset.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangePartPlantSourceType Used when the SourceType field of PartPlant or the TypeCode of Part is being changed to a new value and the user selected to update the PartPlant records with the change. It will check to see if a configuration exists for the part. If a configuration exists it will return a warning message in ruleMessage that should be displayed to the user as a warning. If the configuration is not marked as single-level configuration then a message will be returned in singleLevelConfMsg which should be displayed to the user asking if they want to continue. If they answer Yes to continue then the method DeleteMultiLevelRules should be called. Parameters Name
Type
Description
newSourceType
String
The new SourceType value.
ruleMessage
String@
If this message isn't returned as null then it should be displayed to the user.
singleLevelConfMsg
String@
If this message isn't returned as null then it should be displayed to the user.
ds
The PartDataset. IMPORTANT, the PartPlant record must be sent as modified otherwise you will received error that record cannot be found.
ChangePartPlantVendorID Used when the VendorID field of PartPlant is being changed to a new value. It will validate the new VendorID field. If it is valid the dataset will be updated with the new value and related values will be refreshed. Parameters Name
Type
Description
newVendorId
String
The new Vendor ID value.
ds
The PartDataset. IMPORTANT, the PartPlant record must be sent as modified otherwise you will received error that record cannot be found.
ChangePartProdCode Method to call when changing the product group code on a part. Validates the code and defaults the part tax category code based on the product group. Parameters Name
Type
Description
proposedProdCode
String
The proposed product code value
ds
The Part data set
ChangePartRestrictionManual Used when Manual field of PartRestriction is being changed to a new value.
Epicor 9.05 | 9.05.605
1447
M-R
Business Object Reference Guide
Parameters Name
Type
Description
checkManual
Boolean
Manual value
ds
The PartDataset.
ChangePartRestrictionType This methods assigns associated fields when PartRestriction.RestrictionTypeID changes. Parameters Name
Type
ds
Description Part dataset
ChangePartRestrictSubstance This methods assigns associated fields when PartRestrictSubst.SubstanceID changes. Parameters Name
Type
ds
Description Part dataset
ChangePartRevApproved This method checks that a valid password was provided when required before changing the PartRev.Approved flag Parameters Name
Type
Description
ipApproved
Boolean
The proposed PartRev.Approved value
ipValidPassword
Boolean
Did the user supply a valid password to run this functionality? The value for this parameter should come from running the ValidatePassword method in the UserFile BO.
ds
The Part data set
ChangePartSNBaseDataType Parameters Name
Type
Description
ipSNBaseDataType
String
Part.SNBaseDataType
ds
1448
The PartDataset.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangePartSNMaskPrefixSuffix Parameters Name
Type
Description
ipSNMaskPrefix
String
Part.SNMaskPrefix
ipSNMaskSuffix
String
Part.SNMaskSuffix
ds
The PartDataset.
ChangePartSubsPartNum Method to call when changing the Part Number for an Alternate Part Parameters Name
Type
Description
proposedPartNum
String
The proposed PartNum
ds
The Part data set
ChangePartTrackDimension Used when the Track Dimension field of Part is being changed to a new value. It cannot be turned On if Part.TypeCode is Sales Kit (K). Parameters Name
Type
Description
trackDimension
Boolean
The new part Track Dimension value.
ds
The PartDataset. If valid, the TypeCode will be returned in the dataset.
ChangePartTrackLots Used when the Track Lots field of Part is being changed to a new value. It cannot be turned On if Part.TypeCode is Sales Kit (K). Parameters Name
Type
Description
trackLots
Boolean
The new part Track Lots value.
ds
Epicor 9.05 | 9.05.605
The PartDataset. If valid, the TypeCode will be returned in the dataset.
1449
M-R
Business Object Reference Guide
ChangePartTrackSerialNum Used when the Track Serial Numbers field of Part is being changed to a new value. It cannot be turned On if Part.TypeCode is Sales Kit (K). Parameters Name
Type
Description
trackSerialNum
Boolean
The new part Track Serial Numbers value.
ds
The PartDataset. If valid, the TypeCode will be returned in the dataset.
ChangePartTypeCode Used when the Type field of Part is being changed to a new value. It can be turned to Sales Kit if any of Track Lots, Dimension or Serial Numbers are ON. Parameters Name
Type
Description
typeCode
String
The new part Type Code field value.
ds
The PartDataset. If valid, the TypeCode will be returned in the dataset.
ChangePartUOMConvOverride Parameters Name
Type
Description
ipConvOverrride
Boolean
The new ConvOverrride field value.
ds
The Part Dataset.
ChangePartWhseKBCode Used when the KBCode field of PartWhse is being changed to a new value. It will validate the new KBCode field. If it is valid the dataset will be updated with the new KBCode and related KBActionCode. Parameters Name
Type
Description
newKBCode
String
The new Kan Ban Type code field value.
ds
1450
The PartDataset. If valid, the NewKBCode will be returned in the dataset, along with a refreshed KBActionCode field. IMPORTANT, the PartWhse record must be sent as modified otherwise you will received error that record cannot be found.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangePlantSNBaseDataType Parameters Name
Type
Description
ipSNBaseDataType
String
Part.SNBaseDataType
ds
The PartDataset.
ChangePlantSNMaskPrefixSuffix Parameters Name
Type
Description
ipSNMaskPrefix
String
Part.SNMaskPrefix
ipSNMaskSuffix
String
Part.SNMaskSuffix
ds
The PartDataset.
ChangeQtyBearing Parameters Name
Type
Description
newQtyBearing
Boolean
The new QtyBearing value.
ds
The PartDataset.
ChangeSNMask Parameters Name
Type
Description
ipSNMask
String
Part.SNMask
ds
The PartDataset.
ChangeUOMClassID Used when the UOM Class ID is modified Parameters Name
Type
Description
uomClassID
String
proposed UOMClassId.
ds
Epicor 9.05 | 9.05.605
The PartDataset.
1451
M-R
Business Object Reference Guide
ChangeUOMCode Used when the UOM code is modified Parameters Name
Type
Description
uomCode
String
proposed uomCode.
ds
The PartDataset.
ChanginPartRestrictSubs This methods to validate duplicated substances on the part. Parameters Name
Type
Description
pSubstanceID
String
Substance ID
ds
Part dataset
CheckAltMethodForDelete This method should be called before allowing delete a revision. This method will determine if the revision being deleted has alternate methods. If it does, the user will be prompted with a message indicating this revision has alternate methods and if they want to delete those records as well. If the user answers yes, the delete can procede. If they answer no, the delete should be canceled. This method will return a string that contains the text of the message to ask the user. Parameters Name
Type
Description
ipPartNum
String
The current Part Number
ipRevisionNum
String
The current Revision Number
ipAltMethod
String
The current Alt Method
opMessage
String@
The message to be displayed to the user if alt methods exist.
CheckConfigForDelete This method should be called before allowing delete a part or revision. This method will determine if the part/revision being deleted has an existing configuration. If it does, the user will be prompted with a message indicating this part/revision has an existing configuration and if they want to delete those records as well. If the user answers yes, the delete can procede. If they answer no, the delete should be canceled. This method will return a string that contains the text of the message to ask the user.
1452
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipPartNum
String
The current Part Number
ipRevisionNum
String
The current Revision Number
ipForRevision
Boolean
True if deleting revision record
opMessage
String@
The message to be displayed to the user if configuration exist.
CheckCOOPercents CheckCOOPercents Parameters Name
Type
Description
cPartNum
String
The Part Number
CheckDuplicateCOO Check Duplicate COO - called only when the coo is changed or a partcoo is being added Parameters Name
Type
Description
ipPart
String
The Part Number
ipOrigCountry
Int32
proposed origin country
CheckPartChanges Checks to see if certain fields changed on the part record. If they did, a question is presented to the user asking if these changes should carry over to the PartPlant records. Changes to Part serial format fields builds a separate message. This method returns the text of the message to ask. When adding a part it is not necessary to call this method because the default (current) PartPlant record already uses the Part fields to default from. The user can answer yes or no, but processing doesn't stop based on the answer. The answers should be stored in the dataset in field Part.UpdatePartPlant and Part.UpdateSNPartPlant. Parameters Name
Type
ds
Description The Part data set
cPartChangedMsgText
String@
The message text
cPartSNChangedMsgText
String@
The message for change of part serial format changes text
Epicor 9.05 | 9.05.605
1453
M-R
Business Object Reference Guide
DeleteMRPJobs Deletes MRP Jobs. Parameters Name
Type
Description
ds
The Part data set
DeleteMultiLevelRules Used when the SourceType field of PartPlant is being changed to SalesKit and a multi-level configuration exists for the part. This method is called after displaying the message returned from ChangePartPlantSourceType. This method will unapprove the revision and configuration, set the single-level configuration flag to true on the configuration, and then delete any existing lower level rules that may have been created for the configuration. Parameters Name
Type
Description
newSourceType
String
The new SourceType value.
ds
The PartDataset. IMPORTANT, the PartPlant record must be sent as modified otherwise you will received error that record cannot be found.
DuplicatePart To create a new part by duplicating from another. Parameters Name
Type
Description
sourcePartNum
String
Existing part number that will be duplicated.
targetPartNum
String
New part number that will be created.
targetPartDescription
String
Description that will be used for the new part.
Returns The Part Data Set
GetGlbPartList This method returns the GlbPart dataset based on a delimited list of GlbPartNum values passed in. If GlbPart.PartNum = chr(9) that means the record has been skipped and should be shown at the bottom of the browser. (GlbPart only) Parameters
1454
Name
Type
Description
glbPartNumList
String
Delimited list of GlbPartNum values
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The GlbPart data set
GetListFilterPlants Filter parts by plant. Call normal GetList method. Parameters Name
Type
Description
whereClause
String
Whereclause.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The PartList data set
GetListFromSelectedKeys This methods will return all of the Part recordsthat meet the selection criteria. This method will try to mirror the functionality of the base GetList method but since we are populating a temp table we need our own public method. Parameters Name
Type
ds
Description The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
GetPartForLink This returns the Part dataset for linking. Parameters Name
Type
Description
partNum
String
Global PartNum field on the GlbPart record to link
Returns The Part data set
GetPartWhereUsed To return a PartWhereUsed dataset for a given part number
Epicor 9.05 | 9.05.605
1455
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereUsedPartNum
String
Part number which you want the where used dataset for.
pageSize
Int32
pageSize
absolutePage
Int32
absolutePage
morePages
Boolean@
morePages
Returns The PartWhereUsed data set
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GlbPartsExist This method checks if GlbPart records exist or not. Can be used to determine if the option to link/unlink parts is available. Parameters Name
Type
Description
glbPartsExist
Boolean@
Yes - they do exist; No - they do not exist
HasIntrastat To determine if the Current company is using Intrastat The following fields on the part table are controlled by this method part.CommodityCode part.ISOrigCountry part.ISSuppUnitsFactor
1456
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
hasIntrastat
Boolean@
The current company has intrastat
IsRunOutOnHand This method receives a part and returns a flag if the part is a run out part with on hand quantity. Parameters Name
Type
Description
partNum
String
The PartNum
isRunOutOnHand
Boolean@
The flag indicating if it is a run out part with on hand qty
LinkGlbPart This method performs the actual logic behind linking a Part. It is run after the PreLinkGlbPart method which determines the Part Number to link to. If the Part Number is for a Part that already exists, the GlbPart information is translated and then copied to the PartDataSet as an update. If the Part Number is for a new Part, the GlbPart information is translated and then copied to the PartDataSet as an Add. Until the update method is run on Part record the Link process is not completed. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbPart record to link
glbPartNum
String
Global PartNum field on the GlbPart record to link
ds
The GlbPart data set
ds1
The Part data set
OnChangePlant Run after Plant changing. Parameters Name
Type
Description
plantCode
String
Code of Plant which is changed to
ds
The Part data set
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK
Epicor 9.05 | 9.05.605
1457
M-R
Business Object Reference Guide
• QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
PreLinkGlbPart Linking a GlbPart record ties a global record to a new or existing Vendor record so that any changes made to the GlbPart record in another company are automatically copied to any linked Parts. This method performs the pre link logic to check of okay to link or get the new partnum to create/link to. Will be run before LinkGlbPart which actually creates/updates a Part record and will send the modified record back for update. When the Link "button" is originally selected, the LinkPartNum will be defaulted to the GlbPartNum field. It will then check to see if this part number is available for Use. If available for use the system will return a question asking the user if they want to use this number. If the answer is no, then the user either needs to select an existing Part Number to link to or enter a brand new number. You will run this method until the user answer is yes. Then the LinkGlbPart method is called. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbPart record to link
glbPartNum
String
Global VendorNum field on the GlbPart record to link
ds vMessage
The GlbPart data set String@
Returns a message the user needs to respond yes or no to. If the user answers no, then they need to update the LinkPartNum field and then run this method again to test the new PartNum they want to link to
PromptForPassword This method checks the BMSyst record to see if a password should prompted for and then validated by the ValidatePassword method in UserFile BO. Run this before ApproveAll, CheckECORevApproved, CheckIn, CheckInAll, and CheckOut. Parameters Name
Type
Description
opPromptForPassword
Boolean@
Logical value stating whether the UI should prompt to validate for a password.
RenamePartRev To rename a part revision for Vista Non BOM customers. Parameters
1458
Name
Type
Description
sourcePartNum
String
Existing part number.
sourcePartRevNum
String
Existing part revision number that will be renamed.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
targetPartRevNum
String
New part revision number for the existing part revision.
targetPartRevDescription
String
New description for the existing part revision.
SetMRPRecalcFlag This method is used to enable the MRPRecalcFlag on PartPlant. This field determines whether the part is picked up in MRP Net Change mode or not. Parameters Name
Type
Description
partNum
String
Part to update MRP flag for
plant
String
Plant to update MRP flag for, blank for all plants of part
Returns Part Dataset
SetNextGeneratedLotNum Set the Next Generated Lot Number. Parameters Name
Type
ds
Description The Part Dataset
SkipGlbPart This method performs the logic behind the skip option for GlbPart Skip sets the Skipped flag to true. If the PartNum field is not blank will error out Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbPart record to skip
glbPartNum
String
Global PartNum field on the GlbPart record to skip
ds
The GlbPart data set
UnlinkGlbPart This method performs the logic behind the unlink option for GlbPart Unlink - clears the PartNum field in GlbPart. Returns the Part DataSet
Epicor 9.05 | 9.05.605
1459
M-R
Business Object Reference Guide
Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbPart record to unlink
glbPartNum
String
Global CustNum field on the GlbPart record to unlink
ds
The GlbPart data set
Returns The Part data set
ValidateInspection Method to validate the Inspection control fields. (EQM) Parameters Name
Type
Description
ipProposedInspPlan
String
The new proposed InspPlanPartNum value
ipProposedSpecId
String
The new proposed SpecID value
iptable
String
table name
ds
The PartDataset.
ValidateInspVendor Method to validate the Inspection control fields. (EQM) Parameters Name
Type
Description
ipProposedVendor
String
The new proposed Vendor value
ds
The PartDataset.
PartExists A public method to test if a given part number already exists in the part table. Return True if it exists else returns False. Parameters Name
Type
partNumber
String
Description
Returns
PartIsActive A public method to test if a given part number already is active in the part table. Return True if it exists else returns False.
1460
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
partNumber
String
Description
Returns
PartIsSalesKit Returns true if the given PartNumber is defined as a Sales Kit on the current plant (PartPlant.SourceType = "K") Parameters Name
Type
partNumber
String
isSalesKit
Boolean@
isPhantom
Boolean@
Description
Returns
PartAdvisor Epicor.Mfg.BO.PartAdvisor: This business object contains 16 methods.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find
Epicor 9.05 | 9.05.605
1461
M-R
Business Object Reference Guide
• QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Allows profitability
GetByID This method returns a dataset for Part Advisor Parameters Name
Type
Description
ipPartNum
String
Part Number
Returns The dataset representing the Security row
GetInvcDtlPARows Searches and fills the InvcDtlPA table with the InvcDtl records that match the given part and the InvoiceType = SHP Parameters
1462
Name
Type
Description
iPartNum
String
Part Number for which you want details
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns PartAdvisor data set
GetJobHeadPARows Searches and fills the JobHeadPA table with the JobHead records that match the given part Parameters Name
Type
Description
iPartNum
String
Part Number for which you want details
Returns PartAdvisor data set
GetList This method returns a list of Part, including those with blank Company ID Parameters Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns The list of Parts
GetOrderDtlPARows Searches and fills the OrderDtlPA table with the OrderDtl records that match the given part Parameters Name
Type
Description
iPartNum
String
Part Number for which you want details
Returns PartAdvisor data set
GetPartBinRows Searches and fills the PartBin table with the PartBin records that match the given part Parameters Name
Type
Description
iPartNum
String
Part Number for which you want details
Epicor 9.05 | 9.05.605
1463
M-R
Business Object Reference Guide
Returns PartAdvisor data set
GetPartDetails This method returns a list of Parts, including those with blank Company ID Parameters Name
Type
Description
iPartNum
String
Part Number for which you want details
Returns PartAdvisor data set
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetQuoteDtlPARows Searches and fills the QuoteDtlPA table with the QuoteDtl records that match the given part Parameters Name
Type
Description
iPartNum
String
Part Number for which you want details
Returns PartAdvisor data set
GetRows This method returns a list of Parts
1464
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClausePart
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns The list of Parts
PartAllocTemplate Epicor.Mfg.BO.PartAllocTemplate: This business object contains 12 methods.
GetNewPartAllocTemplate Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1465
M-R
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetWhseTeamUserList Returns the list of all employees from Database Table WhseGroupEmp Parameters Name
Type
Description
groupCode
String
Warehouse Group Code.
Returns The WhseTeamEmpList Data Set
OnChangeEmpID Call this method when User Assignment is changed. Parameters Name
Type
Description
empID
String
Proposed value for User Assignment.
ds
Returns Epicor.Mfg.BO.PartAllocTemplateDataSet
OnChangeWhseTeam Call this method when the user changes team whse group. Parameters Name
Type
Description
teamWhse
String
Proposed value for team whse.
ds
1466
Returns Epicor.Mfg.BO.PartAllocTemplateDataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
partalloctemplateCheckAllocType Checks PartAllocType code entered Parameters Name
Type
Description
newPartAllocType
String
PartAllocType code entered
ds
The Part Allocation Template Entry data set
partAllocTemplateCheckDemandType Checks Part Alloc Demand Type code entered Parameters Name
Type
Description
newPartAllocDemandType
String
PartAllocDemandType code entered
ds
The Part Allocation Template Entry data set
PartBinSearch Epicor.Mfg.BO.PartBinSearch: This business object contains 12 methods.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
1467
M-R
Business Object Reference Guide
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CheckBin Validate the bin and warehouse for the current plant.. Parameters Name
Type
Description
whseCode
String
The Warehouse.
binNum
String
The Bin.
errMsg
String@
Blank if no error. Otherwise error message.
GetBinContents Gets a listing of parts in a particular whse/bin.
1468
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whseCode
String
The Warehouse is required.
binNum
String
A specific Bin. Required.
Returns The PartBinSearch data set
GetFullBinSearch Gets the dataset of bins, in difference with GetPartBinSearch, this one includes All bins whether they have a dimension or lot number or neither of both. Parameters Name
Type
Description
partNum
String
Part number.
whseCode
String
The Warehouse can be for a specific warehouse or null for all warehouses.
Returns The PartBinSearch data set
GetPartBinByLot Gets the warehouse/bin information for a specific lot. Parameters Name
Type
Description
partNum
String
Part number. Required.
lotNum
String
The Lot number. Required.
Returns The PartBinSearch data set
GetPartBinSearch Gets the dataset of warehouses and bins for a Part. If a change is made to this method the same change should be applied to the GetSpecificBinSearch method. Parameters Name
Type
Description
partNum
String
Part number.
whseCode
String
The Warehouse can be for a specific warehouse or null for all warehouses.
Epicor 9.05 | 9.05.605
1469
M-R
Business Object Reference Guide
Name
Type
Description
lotNum
String
The Lot number can be for a specific lot if null is passed, only bins with no lot number will be returned .
uomCode
String
The UOM Code can be for a specific Unite of Measure code if null is passed, only bins with no UOM codes will be returned.
displayAllBins
Boolean
True or False. False will search for bins with a qty ne 0. True will return all bins for a warehouse.
startAtBinNum
String
If a starting bin is to be used.
binType
String
If a specific type of bin is to be used.
vendorNum
Int32
If a specific vendorNum for a managed bin is to be used.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The PartBinSearch data set
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetSpecificBinSearch Gets the dataset of warehouses and bins for a Part. If a change is made to this method the same change should be applied to the GetPartBinSearch method. Parameters
1470
Name
Type
Description
partNum
String
Part number. Required
whseCode
String
The Warehouse can be for a specific warehouse or null for all.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
lotNum
String
The Lot number can be for a specific lot if null is passed, only bins with no lot number will be returned.
uomCode
String
The UOM Code can be for a specific Unit of Measure code if null is passed, only bins with no UOM codes will be returned.
displayAllBins
Boolean
True or False. False will search for bins with a qty ne 0. True will return all bins for a warehouse.
binNum
String
A specific Bin. Required.
Returns The PartBinSearch data set
PartClass Epicor.Mfg.BO.PartClass: This business object contains 12 methods.
GetNewPartClass Inserts a new row in the DataSet with defaults populated.
GetNewPartClassPlt Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
1471
M-R
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetUsePurchCode Gets value if Purchase Code is used Parameters
1472
Name
Type
Description
plUsePurchCode
Boolean@
is there are anypurchase codes?
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangeCommodityCode Validates if changes in Commodity codes are correct. Parameters Name
Type
ds
Description The PartClass data set
PartCostSearch Epicor.Mfg.BO.PartCostSearch: This business object contains 7 methods.
GetNewPartCost Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1473
M-R
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PartDim Epicor.Mfg.BO.PartDim: This business object contains 7 methods.
GetNewPartDim Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
1474
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PartFIFOCost Epicor.Mfg.BO.PartFIFOCost: This business object contains 7 methods.
GetNewPartFIFOCost Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
1475
M-R
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PartLangDesc Epicor.Mfg.BO.PartLangDesc: This business object contains 7 methods.
GetNewPartLangDesc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
1476
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PartOnHandWhse Epicor.Mfg.BO.PartOnHandWhse: This business object contains 1 methods.
GetPartOnHandWhse Get the Part quantity on hand records from the parameters.
Epicor 9.05 | 9.05.605
1477
M-R
Business Object Reference Guide
Parameters Name
Type
Description
cPartNum
String
The Part Number
cPlant
String
The plant
Returns The PartOnHandWhse data set
PartPlantSearch Epicor.Mfg.BO.PartPlantSearch: This business object contains 8 methods.
GetNewPartPlant Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1478
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetActiveParts Calls the standard GetRows and filters the Inactive parts Parameters Name
Type
Description
whereClause
String
Whereclause.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.PartPlantSearchDataSet
PartPlantWhseSearch Epicor.Mfg.BO.PartPlantWhseSearch: This business object contains 1 methods.
GetRows This method returns a list of warehouses (including shared warehouses) available for a plant. The Plant parameter allows the user to search on just one plant or leave blank to search on all plants. Parameters Name
Type
Description
vPart
String
Part
pageSize
Int32
pageSize
absolutePage
Int32
absolutePage
morePages
Boolean@
morePages
Epicor 9.05 | 9.05.605
1479
M-R
Business Object Reference Guide
Returns Returns the dataset representing Part Plant Warehouse
PartRevSearch Epicor.Mfg.BO.PartRevSearch: This business object contains 7 methods.
GetNewPartRev Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1480
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PartSched Epicor.Mfg.BO.PartSched: This business object contains 32 methods.
GetNewPartSched Inserts a new row in the DataSet with defaults populated.
GetNewPartSchedVend Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
1481
M-R
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find
1482
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
• QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
Epicor 9.05 | 9.05.605
1483
M-R
Business Object Reference Guide
Name
Type
Description
uomCode
String@
UOM Code (only used for Product Codes)
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
OnChangeCalendarID Validate CalendarId value Parameters Name
Type
Description
proposedCalendarId
String
The proposed CalendarId value
ds
The PartSched data set
OnChangeInspNextDelivery Validate InspNextDelivery value Parameters Name
Type
Description
proposedInspNextDelivery
Int32
The proposed InspNextDelivery value
ds
The PartSched data set
OnChangeMinDeliveryQty1 Validate MinDeliveryQty1 value Parameters Name
Type
Description
ipMinDeliveryQty1
Int32
The proposed MinDeliveryQty1 value
ds
The PartSched data set
OnChangeMinDeliveryQty2 Validate MinDeliveryQty2 value
1484
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipMinDeliveryQty2
Int32
The proposed MinDeliveryQty2 value
ds
The PartSched data set
OnChangeMinForwardSpan Validate MinForwardSpan value Parameters Name
Type
Description
proposedMinForwardSpan
Int32
The proposed MinForwardSpan value
ds
The PartSched data set
OnChangeOrderCover Validate OrderCover value Parameters Name
Type
Description
proposedOrderCover
Int32
The proposed OrderCover value
ds
The PartSched data set
OnChangePartNum Validate PartNum value Parameters Name
Type
Description
proposedPartNum
String
The proposed PartNum value
uomCode
String
UOM Code (only used for Product Codes)
ds
The PartSched data set
OnChangePercentShare Validate PercentShare value Parameters Name
Type
Description
proposedPercentShare
Int32
The proposed PercentShare value
ds
Epicor 9.05 | 9.05.605
The PartSched data set
1485
M-R
Business Object Reference Guide
OnChangePeriodicityCode1 Validate PeriodicityCode1 value Parameters Name
Type
Description
proposedPeriodicityCode1
Int32
The proposed PeriodicityCode1 value
ds
The PartSched data set
OnChangePeriodicityCode2 Validate PeriodicityCode2 value Parameters Name
Type
Description
proposedPeriodicityCode2
Int32
The proposed PeriodicityCode2 value
ds
The PartSched data set
OnChangePeriodShift Validate PeriodShift value Parameters Name
Type
Description
proposedPeriodShift
Int32
The proposed PeriodShift value
ds
The PartSched data set
OnChangePrintLength Validate PrintLength value Parameters Name
Type
Description
proposedPrintLength
Int32
The proposed PrintLength value
ds
The PartSched data set
OnChangePurPoint Validate PurPoint value
1486
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
proposedPurPoint
String
The proposed Purchase Point value
ds
The PartSched data set
OnChangeScheduleFirm Validate ScheduleFirm value Parameters Name
Type
Description
proposedScheduleFirm
Int32
The proposed ScheduleFirm value
ds
The PartSched data set
OnChangeScheduleLength Validate ScheduleLength value Parameters Name
Type
Description
proposedScheduleLength
Int32
The proposed ScheduleLength value
ds
The PartSched data set
OnChangeVendorID Validate VendorId value Parameters Name
Type
Description
proposedVendorID
String
The proposed VendorId value
ds
The PartSched data set
OnChangeVendorNum Validate VendorNum value Parameters Name
Type
Description
proposedVendorNum
Int32
The proposed VendorNum value
ds
Epicor 9.05 | 9.05.605
The PartSched data set
1487
M-R
Business Object Reference Guide
PartSchedSearch Epicor.Mfg.BO.PartSchedSearch: This business object contains 1 methods.
GetRows This method returns a list of parts. The Table parameter allows the user to search in the PartSched or the Part table. Parameters Name
Type
Description
whereClause
String
Whereclause
vTable
String
Table to search in
pageSize
Int32
page Size
absolutePage
Int32
absolute Page
morePages
Boolean@
more Pages: true/false
Returns PartSchedSearch DataSet
PartSchedVendSearch Epicor.Mfg.BO.PartSchedVendSearch: This business object contains 1 methods.
GetRows This methods will return all of the PartSchedVend records which will be a subset of the PartSched records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table (PartSchedVendSearch) we need our own public method. Parameters Name
Type
Description
whereClausePartSchedSearch
String
The where clause to restrict data for
whereClausePartSchedVendSearch String
The where clause to restrict data for
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Returns The PartSchedVendSearch data set
1488
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PartTran Epicor.Mfg.BO.PartTran: This business object contains 7 methods.
GetNewPartTran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1489
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PartTranHist Epicor.Mfg.BO.PartTranHist: This business object contains 9 methods.
GetNewPartTranHist Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1490
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetSortByList This method returns the Sort By selection list. Parameters Name
Type
Description
ipPartNum
String
The Part Number to be processed
sortByList
String@
The list of available Sort By options
RunPartTranHistory This method returns the transaction history of a given part. Parameters Name
Type
Description
ipPartNum
String
The Part Number to process
ipPlant
String
The valid Plant ID to process.
ipTranDate
Nullable{System.DateTime} The starting Transaction Date to process. If not supplied then the default is today.
ipLotNum
String
The starting Lot Number to process
ipDimCode
String
The starting Dimension Code to process
ipSortBy
String
The sort by selected by the user. Valid options are: THIST-BRW (Tran Date Browse); THISTLOT-BRW (Lot Number/Tran Date browse) and THISTDIM-BRW (Dim Code/Tran Date browse)
Returns The Part Transaction History data set
Epicor 9.05 | 9.05.605
1491
M-R
Business Object Reference Guide
PartWhseFullSearch Epicor.Mfg.BO.PartWhseFullSearch: This business object contains 6 methods.
GetNewPartWhseSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
1492
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PartWhseSearch Epicor.Mfg.BO.PartWhseSearch: This business object contains 8 methods.
GetNewPartWhseSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1493
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListbyKBPlant Filter warehouses by current KB Plant. Call normal GetList method. Parameters Name
Type
Description
whereClause
String
Whereclause.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
curKBPlant
String
Current KB Plant.
morePages
Boolean@
More pages.
Returns The PartWhseSearchList data set
PartWipSearch Epicor.Mfg.BO.PartWipSearch: This business object contains 8 methods.
GetNewPartWip Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1494
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetPartWipOprList The same as GetList but deletes the records with IsDistinct = false Parameters Name
Type
Description
whereClause
String
The Where Clause
pageSize
Int32
The Page Size
absolutePage
Int32
The Absolute Page
morePages
Boolean@
The More Pages
Returns The PartWipListDataSet data set
Epicor 9.05 | 9.05.605
1495
M-R
Business Object Reference Guide
PartXRefMfg Epicor.Mfg.BO.PartXRefMfg: This business object contains 11 methods.
GetNewAprvMfg Inserts a new row in the DataSet with defaults populated.
GetNewPartXRefMfg Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1496
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetPartDesc This method finds the part Description Parameters Name
Type
Description
pNum
String
The Part Num
pDesc
String@
The Part Description
GetPartInfo This method retrieves the Part Info (qualified Manufacturers) Parameters Name
Type
Description
partNum
String
Part Number
OnChangeManufacturerID Verifies if the Manufacturer is valid. Parameters Name
Type
Description
ipPartNum
String
The PartNum
ipMfgID
String
The Manufacturer ID
ds
Epicor 9.05 | 9.05.605
The Qualified Manufacturer DataSet
1497
M-R
Business Object Reference Guide
PartXRefSelect Epicor.Mfg.BO.PartXRefSelect: This business object contains 1 methods.
GetXRefParts Parameters Name
Type
Description
ipPartNum
String
Part Number
PASchedule Epicor.Mfg.BO.PASchedule: This business object contains 8 methods.
GetNewPASchedule Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1498
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangePlanID Used when the PlanID is being changed to a new value Parameters Name
Type
Description
ipNewPlanID
String
The new Plan ID code field value.
ds
The PAScheduleDataset.
PatchFld Epicor.Mfg.BO.PatchFld: This business object contains 7 methods.
GetNewPatchFld Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1499
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PAWeek Epicor.Mfg.BO.PAWeek: This business object contains 8 methods.
GetNewPAWeek Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1500
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
1501
M-R
Business Object Reference Guide
PaymentEntry Epicor.Mfg.BO.PaymentEntry: This business object contains 59 methods.
GetNewCheckHed Inserts a new row in the DataSet with defaults populated.
GetNewCheckHedAttch Inserts a new row in the DataSet with defaults populated.
GetNewAPTran Inserts a new row in the DataSet with defaults populated.
GetNewAPTTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewAPTranTGLC Inserts a new row in the DataSet with defaults populated.
GetNewBankTran Inserts a new row in the DataSet with defaults populated.
GetNewBankTranTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewBankTranTGLC Inserts a new row in the DataSet with defaults populated.
GetNewTaxDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1502
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
1503
M-R
Business Object Reference Guide
Returns
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
CalcThaiWHTCertNo Assigns a legal number to the paid invoice when apply With Holding Tax. Parameters Name
Type
Description
ipGroupID
String
Group ID
opLegalNumMsg
String@
Legal number message
ds
The Payment Entry data set
ChangeIncomeTaxCode Performs required logic when APTran.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
1504
PaymentEntry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangeTranAmt This method updates the BankTran amounts when the adjustment amount changes or the currency switch toggles. Parameters Name
Type
Description
ipTranAmtType
String
Indicate which of the transaction amount is changed. Valid values are: 'B' for Base Tran Amount and 'D' for Doc Tran Amount
proposedTranAmt
Decimal
The proposed Transaction Amount
ds
The Payment Entry data set
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
HeadNum
CreateChecks Create Vendor Checks for selected invoices. Parameters Name
Type
Description
pcGroupID
String
AP Check Group ID
ds
The APInvSel data set
CreateNewCheckHed Create New CheckHed record. To be used instead of GetNewCheckHed record. Parameters Name
Type
Description
pcGroupID
String
AP Check Group ID
ds
The PaymentEntry data set
DeleteNegPayments DeleteNegPayments. Deletes all checks in the group that have negative check. amounts. Works the same as MassDelete but only deletes negative balance checks.
Epicor 9.05 | 9.05.605
1505
M-R
Business Object Reference Guide
Parameters Name
Type
Description
pcGroupID
String
AP Check Group ID
GetElecInterface Check if Payment Method is marked as Electronic Interface. Parameters Name
Type
Description
pcGroupID
String
AP Check Group ID
opElecInt
Boolean@
If Payment Method is electronic interface then Yes
GetNewBankTranByHeadNum Alternate routine to load the Bank Fee Parameters Name
Type
Description
lvHeadNum
Int32
Bank Fee Code
lvBankAcctID
String
Bank Account ID
ds
The AP Payment Entry data set
GetNewMiscPayment Create New Miscellaneous APTran record. Parameters Name
Type
Description
piHeadNum
Int32
value of CheckHed.HeadNum
ds
The PaymentEntry data set
GetRestartProcessPayment Gets restart Process Payment Parameters
1506
Name
Type
Description
groupID
String
GroupID
restartProcessPayment
Boolean@
should the process payment be restarted: Yes/No
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
MassDelete Mass Delete. Delete all checks in the Group. Parameters Name
Type
Description
pcGroupID
String
AP Check Group ID
OnChangeBankFeeID Validate for a Correct Bank Fee Code Parameters Name
Type
Description
pcBankFeeID
String
Bank Fee Code
ds
The Payment Entry data set
OnChangeBankTotalAmt Call method when the user changes Bank Total Amount Parameters Name
Type
Description
pBankTotalAmt
Decimal
Propopsed Bank Total Amount
ds
The PaymentEntry data set
OnChangeCheckDate Call method when the user changes CheckHed.CheckDate. Parameters Name
Type
Description
pdtCheckDate
Nullable{System.DateTime}
Propopsed CheckDate
ds
The PaymentEntry data set
OnChangeCheckNum Call method when the user changes CheckHed.CheckNum.
Epicor 9.05 | 9.05.605
1507
M-R
Business Object Reference Guide
Parameters Name
Type
Description
piCheckNum
Int32
Propopsed check num
ds
The PaymentEntry data set
OnChangeCurrency Call method when the user changes flag CheckHed.IsEnterTotal Parameters Name
Type
Description
pCurrencyCode
String
Propopsed Currency
ds
The PaymentEntry data set
OnChangeDocDiscAmt Call method when the user changes the Doc Discount Amount changes in Pay Invoice. Use this method with Payment Invoice screen for PaymentEntryDataSet. Parameters Name
Type
Description
pdDocDiscAmt
Decimal
Proposed Document Amount value
ds
The PaymentEntry data set
OnChangeDocPaymentTotal Call method when the user changes Payment Total Parameters Name
Type
Description
pDocPaymentTotal
Decimal
Propopsed DocPaymentTotal
ds
The PaymentEntry data set
OnChangeDocTranAmt Call method when the user changes the Doc Tran Amount changes in Pay Misc and Invoice. Parameters Name
Type
Description
pdDocTranAmt
Decimal
Proposed Document Amount value
ds
1508
The PaymentEntry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangeExchangeRate Call method when the user changes Rate from Payment Currency to Bank Currency Parameters Name
Type
Description
pExchangeRate
Decimal
Propopsed ExchangeRate - Check Document currency - Base Currency
ds
The PaymentEntry data set
OnChangeFixedAmount Call method when the user changes the FixedAmount in Tax screen. Use this method with Misc. Payment screen for PaymentEntryDataSet. Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch
pdFixed
Decimal
Proposed taxable amount value
taxtbl
String
Tax temp-table name
ds
The PaymentEntry data set
OnChangeInvoiceNum Call this method when the user enters the Invoice Number in Pay Invoice screen. Parameters Name
Type
Description
pcInvoiceNum
String
Invoice Num
pcChangeExchangeRateResponse String
Response to the question pcChangeExchangeRateResponse. ? means question has not been asked. Yes/No is considered a response.
ds
The PaymentEntry data set
pcQuestion
String@
Question to be answered by the user in pcChangeExchangeRateResponse.
OnChangeInvSelPayment Call this method when the user changes either Gross Payment or Disc. Taken field. Use this method with Payment maintenance screen for ApInvSelDataSet.
Epicor 9.05 | 9.05.605
1509
M-R
Business Object Reference Guide
Parameters Name
Type
Description
pdDocGrossPay
Decimal
Proposeed Document Gross Payment value
pdDocDiscAmt
Decimal
Proposeed Disc. Taken value. Not applicable in Debit Memos
pcRowIdent
String
Pass ttAPInvSel.RowIdent value here to uniquely identify the record to change.
ds
The APInvSel data set
OnChangeIsEnterTotal Call method when the user changes flag CheckHed.IsEnterTotal Parameters Name
Type
Description
pIsEnterTotal
Boolean
Propopsed IsEnterTotal
ds
The PaymentEntry data set
OnChangeManualPrint Call method when the user checks / unChecks the Manual Print flag. Parameters Name
Type
Description
plManualPrint
Boolean
Manual Print
ds
The PaymentEntry data set
OnChangePaymentBankRate Call method when the user changes Rate from Payment Currency to Bank Currency Parameters Name
Type
Description
pPaymentBankRate
Decimal
Propopsed Rate
ds
The PaymentEntry data set
OnChangePrePayment Call this method when the user change flag PrePayment in Misc Payment screen.
1510
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The PaymentEntry data set
OnChangeRateCode This method updates the dataset when the RateCode field changes Parameters Name
Type
Description
rateCode
String
Proposed RateCode value
taxtbl
String
Tax temp-table name
ds
The PaymentEntry data set
OnChangeRefPONum Call this method when the user enters the RefPONum for PrePayment Parameters Name
Type
Description
piRefPONum
Int32
Reference Purchase Order Number
ds
The PaymentEntry data set
OnChangeTaxableAmt Call method when the user changes the Taxable Amt in Tax screen. Use this method with Misc. Payment screen for PaymentEntryDataSet. Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch
pdTaxableAmt
Decimal
Proposed taxable amount value
taxtbl
String
Tax temp-table name
ds
The PaymentEntry data set
OnChangeTaxAmt Call method when the user changes the Tax Amt in Tax screen. Use this method with Misc. Payment screen for PaymentEntryDataSet.
Epicor 9.05 | 9.05.605
1511
M-R
Business Object Reference Guide
Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch
pdTaxAmt
Decimal
Proposed taxable amount value
taxtbl
String
Tax temp-table name
ds
The PaymentEntry data set
OnChangeTaxCode Call method when the user changes the Tax ID in Tax maintainence. Use this method with Misc. Payment screen for PaymentEntryDataSet. Parameters Name
Type
Description
pcTaxCode
String
Proposed Tax ID
taxtbl
String
Tax temp-table name
ds
The PaymentEntry data set
OnChangeTaxPercent Call method when the user changes the Tax Percent in Tax screen. Use this method with Misc. Payment screen for PaymentEntryDataSet. Parameters Name
Type
Description
plCurrencySwitch
Boolean
Currency switch
pdPercent
Decimal
Proposed taxable amount value
taxtbl
String
Tax temp-table name
ds
The PaymentEntry data set
OnChangeVendor Call this method when the user enters the ttCheckHed.VendorNum Parameters Name
Type
Description
pcVendorID
String
Vendor ID - character code for Vendor
ds
1512
The PaymentEntry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PostAllowed Check if Post operation is available. Parameters Name
Type
Description
pcGroupID
String
AP Check Group ID
allowed
Boolean@
If Post operation is allowed then Yes
PreUpdate This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
Boolean@
Indicates if the legal number requires user input
ds requiresUserInput
processInvTaxes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ResetProcessPayment Clears out the check numbers from all checks in the CheckHed table and refreshes the checks data (i.e. the Supplier information, etc.). Parameters Name
Type
Description
pcGroupID
String
AP Check Group ID
Returns The Payment Entry data set
Epicor 9.05 | 9.05.605
1513
M-R
Business Object Reference Guide
SelectInvoices Read ApInvHed records and create ApinvSel records if they meet the selection criteria. Parameters Name
Type
Description
pcGroupID
String
AP Check Group ID
pcPayableAccountsList
String
Delimited list of Payable Accounts
pdtDueDate
Nullable{System.DateTime} Select invoices due by this date.
pdtInvoicePM
Boolean
Select invoices wihtout Payment Method.
pdtInvoiceLC
Boolean
Select invoices wiht Letter of Credit.
pcSupplierList
Boolean
Select invoices for the supplier list.
pcPaymentMethod
String
Select payment methods for the specific.
plConsiderDiscountDate
String
Consider discount date for invoice selection
pcCurrencyList
String
Select invoices for the currency list.
Returns The APInvSel data set
setPCashDocUnprinted Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
SetReadyToCalc Parameters Name
Type
Description
ipGroupID
String
ipGroupID
ipHeadNum
Int32
ipHeadNum
ipAPTranNo
Int32
ipAPTranNo
ipBankAcctID
String
ipBankAcctID
ipTranNum
Int32
ipTranNum
ipVoided
Boolean
ipVoided
ipCalcAll
Boolean
ipCalcAll
ds
1514
Payment dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PayMethod Epicor.Mfg.BO.PayMethod: This business object contains 15 methods.
GetNewPayMethod Inserts a new row in the DataSet with defaults populated.
GetNewPayMethodProp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1515
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangePayMethodEFTHeadUID Method to call when changing the paymethod electronic interface. Parameters Name
Type
Description
proposedEFTHeadUID
Int32
The proposed paymethod electronic interface
ds
The pay method data set
ChangePayMethodPMSource Method to call when changing the paymethod source. Parameters Name
Type
Description
proposedPMSource
Int32
The proposed paymethod source
ds
The pay method data set
ChangePayMethodType Method to call when changing the paymethod source.
1516
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
proposedType
Int32
The proposed paymethod type
ds
The pay method data set
DeleteOldPayMethodProps This method should be called when the invoice lock rate has been changed. Parameters Name
Type
Description
returnMsg
String@
Text of a message to inform the user if PayMethod Properties are in use.
ds
Pay Method Entry data set.
GetIdByName Method for retrieving ID, PMUID using Payment Method Name. Parameters Name
Type
Description
cName
String
Name
iPMUID
Int32@
The logical variable which shows is it neccessary to generate legal numbers
SetAPInfo Enable APInfo Tab. Parameters Name ds
Type
Description PayMethodDataSet
PayMethodSearch Epicor.Mfg.BO.PayMethodSearch: This business object contains 7 methods.
GetNewPayMethod Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
1517
M-R
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
1518
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PayrollCheckEntry Epicor.Mfg.BO.PayrollCheckEntry: This business object contains 31 methods.
GetNewPRCheck Inserts a new row in the DataSet with defaults populated.
GetNewPRChkDtl Inserts a new row in the DataSet with defaults populated.
GetNewPRCheckTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1519
M-R
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CalculateDeductsAndTaxes Method to call to calculate deductions and taxes. Parameters Name
Type
Description
groupID
String
The group id to calculate deductions and taxes for
headNum
Int32
The current PRCheck.HeadNum record. Is used to rebuild the dataset so the data is current
ds
The PayrollCheckEntry data set
CalculateOvertime Method to call to calculate overtime. Parameters
1520
Name
Type
Description
groupID
String
The group id to calculate overtime for
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
headNum
Int32
The current PRCheck.HeadNum record. Is used to rebuild the dataset so the data is current
ds
The PayrollCheckEntry data set
CalculateOvertimeVerification Method to call prior to calling CalculateOvertime. This method will return text of a verification message to ask the user to verify the process should run. The question is yes-no. If the answer is yes, proceed with the calculation of overtime. If the answer is no, cancel the calculation of overtime. Parameters Name
Type
Description
verificationMsg
String@
The text of the verification message
ChangePRCheckEmpID Method to call to when the Employee ID changes. This method will set employee fields in PRCheck based on the new employee id. Parameters Name
Type
Description
proposedEmpID
String
The proposed employee id
ds
The PayrollCheckEntry data set
ChangePRChkDtlAmountType Method to call to when the Check Detail Amount Type changes. This method will reset values for the new amount type. Parameters Name
Type
Description
proposedAmountType
String
The proposed amount type
ds
The PayrollCheckEntry data set
ChangePRChkDtlBaseHours Method to call to when the Check Detail Base Hours changes. This method will recalculate detail values based on the new hours. Parameters Name
Type
Description
proposedBaseHours
Decimal
The proposed base hours
Epicor 9.05 | 9.05.605
1521
M-R
Business Object Reference Guide
Name
Type
Description
ds
The PayrollCheckEntry data set
ChangePRChkDtlBasePay Method to call to when the Check Detail Base Pay changes. This method will recalculate detail values based on the new base pay amount. Parameters Name
Type
Description
proposedBasePay
Decimal
The proposed base pay amount
ds
The PayrollCheckEntry data set
ChangePRChkDtlPayRate Method to call to when the Check Detail Pay Rate changes. This method will recalculate detail values based on the new pay rate. Parameters Name
Type
Description
proposedPayRate
Decimal
The proposed pay rate
ds
The PayrollCheckEntry data set
ChangePRChkDtlPayrollDate Method to call to when the Check Detail Payroll Date changes. This method will recalculate detail values if the amount type is calculated. Parameters Name
Type
Description
proposedPayrollDate
Nullable{System.DateTime}
The proposed payroll date
ds
The PayrollCheckEntry data set
ChangePRChkDtlPayTypeID Method to call to when the Check Detail Pay Type changes. This method will recalculate detail values based on the new pay type. Parameters Name
Type
Description
proposedPayTypeID
String
The proposed pay type id
ds
1522
The PayrollCheckEntry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangePRChkDtlPremiumHours Method to call to when the Check Detail Premium Hours changes. This method will recalculate detail values based on the new hours. Parameters Name
Type
Description
proposedPremiumHours
Decimal
The proposed premium hours
ds
The PayrollCheckEntry data set
ChangePRChkDtlPremiumPayType Method to call to when the Check Detail Premium Pay Type changes. This method will recalculate detail values based on the new pay type. Parameters Name
Type
Description
proposedPremiumPayType
String
The proposed premium pay type id
ds
The PayrollCheckEntry data set
ChangePRChkDtlShift Method to call to when the Check Detail Shift changes. This method will reassign values based on the new shift. Parameters Name
Type
Description
proposedShift
Int32
The proposed shift
ds
The PayrollCheckEntry data set
CheckPrinted Method to call to retrieve the text of the question to ask the user when checks have been printed. This question is asked when the user attempts to add hours, update hours, delete hours, update deductions, or update taxes to a check. Parameters Name
Type
Description
groupID
String
The group id the check is assigned to
questionText
String@
The text of the question to ask the user. If blank, a question does not need to be asked.
Epicor 9.05 | 9.05.605
1523
M-R
Business Object Reference Guide
GeneratePayChecks Method to call to generate paychecks. Parameters Name
Type
Description
groupID
String
The group id to generate paychecks for
headNum
Int32
The current PRCheck.HeadNum record. Is used to rebuild the dataset so the data is current. Not required. If the value is 0, a refreshed dataset won't be passed back.
ds
The PayrollCheckEntry data set
GeneratePayChecksVerification Method to call prior to calling GeneratePaychecks. This method will return text of a verification message to ask the user to verify the process should run. The question is yes-no. If the answer is yes, proceed with the check generation. If the answer is no, cancel the check generation. Parameters Name
Type
Description
verificationMsg
String@
The text of the verification message
GetNewPRCheckForGroup Method to call to get a new PRCheck record.. Parameters Name
Type
Description
groupID
String
The group id to add the payroll check to
ds
The PayrollCheckEntry data set
GetRowsByEmpID Validates the FromOpCode field and poplutes the From OpCode description. Is called when the From Op Code changes. If the code is not valid, an exception will be thrown. Parameters
1524
Name
Type
Description
empID
String
Employee ID
whereClausePRCheck
String
WhereClause Payroll Check
whereClausePRChkDtl
String
WhereClause Payroll Check Details
whereClausePRChkDed
String
WhereClause Payroll Check Deductions
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
whereClausePRChkTax
String
WhereClause Payroll Check Tax
whereClausePRCheckTGLC
String
WhereClause Payroll Check TranGLC
pageSize
Int32
PageSize
absolutePage
Int32
Absolute Page
morePages
Boolean@
MorePages?
Returns The PayrollCheckEntry data set
UpdatePRChkDed Method to call to update a PRChkDed record. This method should be called in place of the standard Update method when updating a PRChkDed record. Parameters Name
Type
Description
ds
The PayrollCheckEntry data set
UpdatePRChkTax Method to call to update a PRChkTax record. This method should be called in place of the standard Update method when updating a PRChkTax record. Parameters Name
Type
Description
ds
The PayrollCheckEntry data set
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
HeadNum
PayrollTax Epicor.Mfg.BO.PayrollTax: This business object contains 18 methods.
GetNewPRTaxMas Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1525
M-R
Business Object Reference Guide
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewPRTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewPRTaxCrd Inserts a new row in the DataSet with defaults populated.
GetNewPRTaxExp Inserts a new row in the DataSet with defaults populated.
GetNewPRTaxTbl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1526
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CheckForDetails This method is to be called when leaving the PRTaxMas record by any means (changing rows, new search, leaving the screen, etc.). A PRTaxMas record must have at least one PRTaxDtl record to be considered a valid PRTaxMas record. If no details exist for the PRTaxDtl, the user must either delete the PRTaxMas record or add a detail record before being allowed to leave. Parameters Name
Type
Description
taxTblID
String
Tax Table ID of the Tax Table record to validate
errorMsg
String@
String containing the error message. If blank it is okay to leave the PRTaxMas record
CopyDetails This method copies a detail record for a specific TaxTblID, FileStatus and Year to the specified new Year
Epicor 9.05 | 9.05.605
1527
M-R
Business Object Reference Guide
Parameters Name
Type
Description
taxTblID
String
TaxTblID to copy from
fileStat
String
Filing Status to copy from
fromYear
Int32
Tax year to copy from
toYear
Int32
Tax year to copy to
ds
The PayrollTax data set
GetNewTaxMaster This method creates a new PRTaxMas record after prompting for the TaxType. Certain fields are initialized on create depending on which TaxType is being created. This method replaces the standard GetNewPRTaxMas() method Parameters Name
Type
ds taxType
Description The PayrollTax data set
String
Payroll Tax Master's Tax Type for new record
SetFilingDescription This method uses the PRTaxDtl.FileStatus field to determine the PRTaxDtl.FileStatusDesc if there exists another PRTaxDtl with the same FileStatus for the same TaxTblID Parameters Name
Type
ds
Description The PayrollTax data set
SetW2State This method sets the W2State to the first 2 digits of the TaxTblId when the taxType = "SIT" if the W2State is blank Parameters Name ds
1528
Type
Description The PayrollTax data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PayType Epicor.Mfg.BO.PayType: This business object contains 12 methods.
GetNewPayType Inserts a new row in the DataSet with defaults populated.
GetNewPayTLbr Inserts a new row in the DataSet with defaults populated.
GetNewPayTLbrEGLC Inserts a new row in the DataSet with defaults populated.
GetNewPayTypeEGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1529
M-R
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeIncomeTax Performs required logic when PayType.IncomeTaxCode is modified. Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
PayType data set
DeletePayTLbr Deletes records with appropriate Type Id and Expence Code Parameters Name
Type
Description
cPayTypeID
String
The PayType IDproposed from operation code
cExpenseCode
String
The Expence Code
PBGInvoice Epicor.Mfg.BO.PBGInvoice: This business object contains 14 methods.
GetNewPBGInvcHead Inserts a new row in the DataSet with defaults populated.
GetNewPBGInvcBdn Inserts a new row in the DataSet with defaults populated.
1530
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetNewPBGInvcDtlFF Inserts a new row in the DataSet with defaults populated.
GetNewPBGInvcDtlTC Inserts a new row in the DataSet with defaults populated.
GetNewPBInvoicedAmt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1531
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ApproveInvoice ApproveInvoice. Parameters Name
Type
Description
ipProjectID
String
The ProjectID.
askWarning
Boolean
warnMessage
String@
ds
Invoice DataSet
GetDataByProjectID Custom GetRows method to retrieve data by ProjectID and ConInvMeth. Parameters Name
Type
Description
ipProjectID
String
The ProjectID.
ipConInvMeth
String
The ConInvMeth.
Returns The PBGInvoice DataSet
1532
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PBillSchSearch Epicor.Mfg.BO.PBillSchSearch: This business object contains 7 methods.
GetNewPBillSch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1533
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PBSchWrkSearch Epicor.Mfg.BO.PBSchWrkSearch: This business object contains 7 methods.
GetNewPBSchWrk Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1534
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PCashCloseDay Epicor.Mfg.BO.PCashCloseDay: This business object contains 8 methods.
GetNewPCashBal Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1535
M-R
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ClosePettyCashDay Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
PCashDesk Epicor.Mfg.BO.PCashDesk: This business object contains 25 methods.
GetNewPCashDesk Inserts a new row in the DataSet with defaults populated.
GetNewPCashDeskAttch Inserts a new row in the DataSet with defaults populated.
GetNewPCashDeskAuth Inserts a new row in the DataSet with defaults populated.
GetNewPCashDeskOpr Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
1536
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1537
M-R
Business Object Reference Guide
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangePCashDeskCurrencyCode Method to call when changing the currency code. Parameters Name
Type
Description
proposedCurrencyCode
String
The proposed currency code
ds
The PCashDesk data set
ChangePCashDeskEntrustedCashier Method to call when changing the entrusted cashier. Parameters Name
Type
Description
proposedEntrustedCashier
String
The proposed entrusted cashier
ds
The PCashDesk data set
ChangePCashDeskInitPayrollBal Method to call when changing the initial payroll balance. Parameters Name
Type
Description
proposedInitPayrollBal
Decimal
The proposed initial payroll balance
docOrBase
String
Was the base amount (Base) or doc amount (Doc) changed
ds
The PCashDesk data set
ChangePCashDeskInitTotalBal Method to call when changing the initial balance.
1538
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
proposedInitTotalBal
Decimal
The proposed initial balance
docOrBase
String
Was the base amount (Base) or doc amount (Doc) changed
ds
The PCashDesk data set
ChangePCashDeskOpenedFrom Method to call when changing the initial balances date. Parameters Name
Type
Description
proposedOpenedFrom
Nullable{System.DateTime}
The proposed opened from date
ds
The PCashDesk data set
ChangePCashDeskOprOprTypeCode Method to call when changing the operation type code. Parameters Name
Type
Description
proposedOprTypeCode
String
The proposed operation type code
ds
The PCashDesk data set
ChangePCashDeskOprTranDocTypeID Method to call when changing the tran doc type id. Parameters Name
Type
Description
proposedTranDocTypeID
String
The proposed tran doc type id
ds
The PCashDesk data set
ChangePCashDeskRateGrpCode Method to call when changing the rate group code. Parameters Name
Type
Description
proposedRateGrpCode
String
The proposed rate group code
Epicor 9.05 | 9.05.605
1539
M-R
Business Object Reference Guide
Name
Type
ds
Description The PCashDesk data set
ChangePCashDeskReportTranDocType Method to call when changing the report tran document type. Parameters Name
Type
Description
proposedReportTranDocType
String
The proposed report tran document type
ds
The PCashDesk data set
GetCashDeskBalance Get overall balance for defined Cash Desk Parameters Name
Type
Description
ipCashDeskID
String
Cash Desk ID
ds
The PCashDeskTracker data set
GetCashDeskBalHist Get day balances for defined Cash Desk Parameters Name
Type
Description
ipCashDeskID
String
Cash Desk ID
ipFromDate
Nullable{System.DateTime}
From Date
ipToDate
Nullable{System.DateTime}
To Date
ipIncludeDrafts
Boolean
Include Drafts
ipPayrollOnly
Boolean
Payroll Only
ds
The PCashDeskTracker data set
GetCashDeskDocsHist Get documents for defined Cash Desk and Date Parameters
1540
Name
Type
Description
ipCashDeskID
String
Cash Desk ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
ipDate
Nullable{System.DateTime}
To Date
ipDirection
String
To Date
ds
The PCashDeskTracker data set
checkSecurity Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
PCashEntry Epicor.Mfg.BO.PCashEntry: This business object contains 35 methods.
GetNewPCashDoc Inserts a new row in the DataSet with defaults populated.
GetNewPCashDocAttch Inserts a new row in the DataSet with defaults populated.
GetNewBankTran Inserts a new row in the DataSet with defaults populated.
GetNewBankTranTaxDtl Inserts a new row in the DataSet with defaults populated.
GetNewBankTranTGLC Inserts a new row in the DataSet with defaults populated.
GetNewPCashDocTGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
1541
M-R
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
1542
Name
Type
tableName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
fieldName
String
Description
Returns
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
AssignLegalNumber Assigns a legal number to the customer shipment. Parameters Name
Type
Description
ipCashDeskID
String
Cash Desk ID
ipReferenceNum
Int32
Cash Doc Reference Num
String@
Legal number message
ds opLegalNumMsg Returns The Customer Shipment data set
CreateLine Call this method before calling other business objects like Cash Receipts, PaymentEntry, Bank Adjustment etc. This method creates the CashBDtl record and any other records required to call the business object.
Epicor 9.05 | 9.05.605
1543
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipCashDeskID
String
Identifier of Cash Desk
ipReferenceNum
Int32
Petty Cash document number
ipLineType
String
Line type
opGroupID
String@
Line type
opLineNum
Int32@
Line type
GetLegalNumGenOpts Returns the legal number generation options. Parameters Name
Type
Description
ipCashDeskID
String
Cash Desk ID
ipReferenceNum
Int32
Cash Doc Reference Num
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
GetNewBankTranForPCashDoc Alternate routine to load the Bank Fee Parameters Name
Type
Description
inCashDeskID
String
Cash Desk ID
inReferenceNum
Int32
Cash Desk Reference Number
ds
The Petty Cash Entry data set
GetNewPCashDocByType Creates a new PCashDoc record based on the add new option selected. Parameters
1544
Name
Type
Description
inCashDeskID
String
The cash desk id selected
inNewType
String
The type of new option selected. Valid types are CR-DOC Cash Receipt Document. CI-DOC - Cash Issue Document. CR-DRAFT - Cash Receipt Draft. CI-DRAFT - Cash Issue Draft
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
inDocDate
Nullable{System.DateTime} Document Date. If null the default of today is use.
ds
PCashEntry data set.
OnChangeBankTranBankFeeID Validate for a Correct Bank Fee Code Parameters Name
Type
Description
inBankFeeID
String
Bank Fee Code
ds
The Petty Cash Entry data set
OnChangeBankTranTaxAmt Call method when the user changes the Tax Amt in Tax screen. Parameters Name
Type
Description
inAmtType
String
Indicate which of the amount is changed. Valid values are: 'B' for Base Amount and 'D' for Doc Amount
inTaxAmt
Decimal
Proposed taxable amount value
ds
The Petty Cash Entry data set
OnChangeBankTranTaxCode Call method when the user changes the Tax ID in Tax maintainence. Parameters Name
Type
Description
inTaxCode
String
Proposed Tax ID
ds
The PCashEntry data set
OnChangeBankTranTaxPercent Call method when the user changes the Tax Percent. Parameters Name
Type
Description
inPercent
Decimal
Proposed taxable amount value
ds
Epicor 9.05 | 9.05.605
The Petty Cash Entry data set
1545
M-R
Business Object Reference Guide
OnChangeBankTranTaxRateCode This method updates the dataset when the RateCode field changes Parameters Name
Type
Description
inRateCode
String
Proposed RateCode value
ds
The PaymentEntry data set
OnChangeBankTranTaxTaxableAmt Call method when the user changes the Taxable Amt in Tax screen. Parameters Name
Type
Description
inAmtType
String
Indicate which of the amount is changed. Valid values are: 'B' for Base Amount and 'D' for Doc Amount
inTaxableAmt
Decimal
Proposed taxable amount value
ds
The PCashEntry data set
OnChangeBankTranTranAmt This method updates the BankTran amounts when the adjustment amount changes or the currency switch toggles. Parameters Name
Type
Description
ipTranAmtType
String
Indicate which of the transaction amount is changed. Valid values are: 'B' for Base Tran Amount and 'D' for Doc Tran Amount
proposedTranAmt
Decimal
The proposed Transaction Amount
ds
The Petty Cash Entry data set
OnChangePCashDocApplyDate Occurs when Apply Date is changed Parameters Name
Type
Description
ipApplyDate
Nullable{System.DateTime}
New Apply Date
ds
1546
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangePCashDocBankAcctID Occurs when Bank Account ischanged Parameters Name
Type
Description
ipBankAcctID
String
New Bank Acct ID
ds
OnChangePCashDocCashAmt This method updates the bank amounts when the cash amount changes Parameters Name
Type
Description
inAmtType
String
Indicate which of the cash amount is changed. Valid values are: 'B' for Base Cash Amount and 'D' for Doc Cash Amount
proposedCashAmt
Decimal
The proposed Transaction Amount
ds
The Petty Cash Entry data set
OnChangePCashDocCashDeskIDTransfer Occurs when Cash Desk ID Transfer is changed Parameters Name
Type
Description
ipCashDeskIDTransfer
String
New Cash Desk ID Num
ds
OnChangePCashDocCustID Occurs when Customer is changed Parameters Name
Type
Description
ipCustomerID
String
New Customer ID
ds
OnChangePCashDocEmployeeNum Occurs when Employee is changed
Epicor 9.05 | 9.05.605
1547
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipEmployeeNum
String
New Employee Num
ds
OnChangePCashDocOprType Occurs when Operation type was changed Parameters Name
Type
Description
ipOprTypeCode
String
New Operation type code
ds
OnChangePCashDocVendorID Occurs when Vendor is changed Parameters Name
Type
Description
ipVendorID
String
New Vendor ID
ds
UpdatePCashDoc Call this method after calling other business objects like Cash Receipts, PaymentEntry, Bank Adjustment etc. This method updates the PCashDoc record with the data from other business objects. Parameters Name
Type
Description
pCashDeskID
String
Cash Desk ID
pReferenceNum
Int32
Cash Desk reference number
Returns Epicor.Mfg.BO.PCashEntryDataSet
PCashOprType Epicor.Mfg.BO.PCashOprType: This business object contains 12 methods.
GetNewPCashOprType Inserts a new row in the DataSet with defaults populated.
1548
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
1549
M-R
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeDirection Method to call when changing the operation type direction. Parameters Name
Type
Description
proposedDirection
String
The proposed direction
ds
The PCashOprType data set
ChangeOprClass Method to call when changing the operation class. Parameters Name
Type
Description
proposedOprClass
String
The proposed operation class
ds
The PCashOprType data set
ChangeRecPayerType Method to call when changing the payer type. Parameters Name
Type
Description
proposedRecPayerType
String
The proposed payer type
ds
1550
The PCashOprType data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PcConData Epicor.Mfg.BO.PcConData: This business object contains 9 methods.
GetNewPcConData Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1551
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeTypeCode This method validates and populates the TypeCode Parameters Name
Type
Description
iProposedTypeCode
String
Proposed Type Code
ds
The PcConData data set
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
PcConType Epicor.Mfg.BO.PcConType: This business object contains 7 methods.
GetNewPcConType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1552
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PeLogViewer Epicor.Mfg.BO.PeLogViewer: This business object contains 9 methods. This procedure supposed to delete old logging file. (pelog.txt)
GetPostModeList Returns list of posting modes
Epicor 9.05 | 9.05.605
1553
M-R
Business Object Reference Guide
GetLoggingList Returns list of posting modes
GetValidList Returns RJ
CheckLogging Turn On/Off PE logging Returns LogMessage
SetLogging Turn On/Off PE logging Parameters Name
Type
Description
turnOn
Int32
valid review journal
IsLogging Return True if Logging is Turn On Returns Is Logging
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
ds
1554
The PeLogDataSet. This procedure should populate this dataset with the info.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetPELogInfo This function should return dataset containing logging infromation about requested posting process Parameters Name
Type
Description
inActType
String
Act type name
inPostDate
Nullable{System.DateTime}
Posting Date
inGroupID
String
posting group id
inRJ
Int32
review journal number
inValid
String
valid review journal
inPostMode
String
posting process mode
ds
The PeLogDataSet. This procedure should populate this dataset with the info.
PerCon Epicor.Mfg.BO.PerCon: This business object contains 20 methods.
GetNewPerCon Inserts a new row in the DataSet with defaults populated.
GetNewPerConAttch Inserts a new row in the DataSet with defaults populated.
GetNewPerConLnk Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1555
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetPerConGlobalFields To return the list of fields that are maintained by the "Master/Owner" of global record. The client can use this list to disable these fields on the UI.
ChangeGlobalPerCon Method to call when changing the GlobalPerCon on a PerCon. Parameters Name
Type
Description
ipGlobalPerCon
Boolean
The proposed GlobalPerCon value.
ds
1556
The PerCon data set.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangePerConLnk . Parameters Name
Type
Description
ipNewPerConID
Int32
New PerConID.
ipPerConID
Int32
Current PerConID.
ipContextLink
String
ContextLink.
ipLinkSysRowID
String
LinkSysRowID.
ds
The PerCon data set.
CheckDupPerCon This method checks the Name, FirstName and LastName fields to see if there are any duplicate contacts. A ListDataSet will be returned to the user of any duplicates asking if the user wants to continue. Needs to be run before Update on a NEW record only. Parameters Name
Type
Description
vName
String
The name of the contact.
vSysRowID
String
SysRowID field of the PerCon record.
Returns Epicor.Mfg.BO.PerConListDataSet
DefaultName This method populates the detail fields from PerCon.Name when targetName = "Detail". When targetField = "Name", then the PerCon.Name is built from the detail fields. Parameters Name
Type
Description
targetField
String
Indicates which fields to populate either "Detail" or "Name"
perConID
Int32
PerCon.PerConID
ds
The PerCon data set
GetGlbPerConList This method returns the GlbPerCon dataset based on a delimited list of GlbPerConID values passed in.
Epicor 9.05 | 9.05.605
1557
M-R
Business Object Reference Guide
Parameters Name
Type
Description
glbPerConIDList
String
Delimited list of GlbPerConID values
Returns The GlbPerCon data set
GetPerConForLink This returns the PerCon dataset for linking. Parameters Name
Type
Description
ipPerConID
Int32
Global PerConID field on the GlbPerCon record to link
Returns The PerCon data set
LinkGlbPerCon This method performs the actual logic behind linking a PerCon. It is run after the PreLinkGlbPerCon method which determines the PerConID to link to. If the PerConID is for a PerCon that already exists, the GlbPerCon information is translated and then copied to the PerConDataSet as an update. If the PerConID is for a new PerCon, the GlbPerCon information is translated and then copied to the PerConDataSet as an Add. Until the update method is run on PerCon record the Link process is not completed. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbPerCon record to link
glbPerConID
Int32
Global PerConID field on the GlbPerCon record to link
ds
The GlbPerCon data set
ds1
The PerCon data set
PreLinkGlbPerCon Linking a GlbPerCon record ties a global record to a new or existing PerCon record so that any changes made to the GlbPerCon record in another company are automatically copied to any linked PerCon's. This method performs the pre link logic to check of okay to link or get the new PerConID to create/link to. Will be run before LinkGlbPerCon which actually creates/updates a PerCon record and will send the modified record back for update. When the Link "button" is originally selected, the LinkPerConID will be defaulted to the GlbPerConID field. It will then check to see if this PerConID is available for use. If available for use the system will return a question asking the user if they want to use this number. If the answer is no, then the user either needs to select an existing PerConID to link to or enter a brand new number. You will run this method until the user answer is yes. Then the LinkGlbPerCon method is called.
1558
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbPerCon record to link
glbPerConID
Int32
Global PerConID field on the GlbPerCon record to link
checkDuplicate
Boolean
checkDuplicate
ds vMessage
The GlbPerCon data set String@
Returns a message the user needs to respond yes or no to. If the user answers no, then they need to update the LinkPerConID field and then run this method again to test the new PerConID they want to link to
Returns Epicor.Mfg.BO.PerConListDataSet
SkipGlbPerCon This method performs the logic behind the skip option for GlbPerCon Skip - sets the Skipped flag to true. If the PerConID field is not 0 will error out Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbPerCon record to skip
glbPerConID
Int32
Global PerConID field on the GlbPerCon record to skip
ds
The Global PerCon data set
UnlinkGlbPerCon This method performs the logic behind the unlink option for GlbPerCon Unlink - clears the PerConID field in GlbPerCon. Returns the PerCon DataSet Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbPerCon record to unlink
glbPerConID
Int32
Global PerConID field on the GlbPerCon record to unlink
ds
The Global PerCon data set
Returns The PerCon data set
Epicor 9.05 | 9.05.605
1559
M-R
Business Object Reference Guide
PerConLnkSearch Epicor.Mfg.BO.PerConLnkSearch: This business object contains 2 methods.
GetList This methods will return all of the PerConLnkSearch records which will be a subset of the PerCon records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table (PerConLnkSearch) we need our own public method. Parameters Name
Type
Description
whereClause
String
The where clause to restrict data for.
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Returns The PerConLnkSearch list data set
GetRows This methods will return all of the PerConLnkSearch records which will be a subset of the PerCon records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table (PerConLnkSearch) we need our own public method. Parameters Name
Type
Description
whereClausePerConSearch
String
The where clause to restrict data for
whereClausePerConLnkSearch
String
The where clause to restrict data for
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Returns The PerConLnkSearch data set
Periodicity Epicor.Mfg.BO.Periodicity: This business object contains 11 methods.
GetNewPeriodicity Inserts a new row in the DataSet with defaults populated.
1560
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1561
M-R
Business Object Reference Guide
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
existplant Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindCustNum Returns the CustNum and Customer Name. Parameters Name
Type
Description
inCustID
String
The CustID to get the CustNum for
outCustNum
Int32@
The CustNum for
outCustName
String@
The Customer Name for
findVendorNum Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
1562
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Person Epicor.Mfg.BO.Person: This business object contains 7 methods.
GetNewPerson Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1563
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PickedOrders Epicor.Mfg.BO.PickedOrders: This business object contains 9 methods.
GetNewPickedOrders Inserts a new row in the DataSet with defaults populated.
GetNewMtlQueue Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1564
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetOrdersWithNoPickingLines This method creates the packing slip for the selected picked order Parameters Name
Type
Description
plant
String
Picked Order Plant
whseCode
String
Picked Order Warehouse (optional)
Returns The PickedOrders data set
PipeLine Epicor.Mfg.BO.PipeLine: This business object contains 10 methods.
BuildPipeLine Call this method to build the Pipeline grid for a Salesperson. Parameters Name
Type
Description
pdtFromFilterDate
Nullable{System.DateTime}
From Filter Date
pdtToFilterDate
Nullable{System.DateTime}
To Filter Date
piFiscalYear
Int32
Fiscal Year
piFiscalPeriod
Int32
Fiscal Period
Returns The PipeLine data set
Epicor 9.05 | 9.05.605
1565
M-R
Business Object Reference Guide
CompanyActualQuota Company Actual Quota. Parameters Name
Type
Description
piFiscalYear
Int32
Fiscal Year
pcFiscalYearSuffix
String
Fiscal Year Suffix
piFiscalPeriod
Int32
Fiscal Period
pdtFromFilterDate
Nullable{System.DateTime}
From Filter Date
pdtToFilterDate
Nullable{System.DateTime}
To Filter Date
ds
The PipeLineTotals data set
GetComboValues Call this method to get list of Region, Territory and Sales Rep There are three levels of access: View All: This is enabled when the user's SalesRepID has 'View Company Pipeline' turned on in Workforce Maintenance. Can view aggregate totals of Actuals by Company, Region, Territory or SalesRep for ALL regions, territories, salesreps in the company Sales Manager: This is enabled when the user's SalesRepID is entered as the Sales Manager for one or more Regions in Sales Region Maintenance. Can view aggregate totals of Actuals by Region, Territory or SalesRep for the regions for which they are Sales Manager In this situation: pcTypeList contains Region, Territory, SalesManager and SalesRep pcRegionList contains the Regions for which the current user is Sales Manager pcTerritoryList contains the territories for their Regions pcSalesRepList contains only the SalesReps that "Report To" the current user Sales Rep: This is the level of access granted when neither of the other two levels apply. Can view only their own totals, and NOT aggregated by Region, or Territory In this situation: pcTypeList contains only the "SalesRep" choice pcRegionList and pcTerritoryList are empty pcSalesRepList contains only the SalesRep associated with the current user Parameters Name
Type
Description
pcActualsType
String
Type (aggregation-level). One of: Company, Region, Territory, SalesManager, SalesRep
pcRegionList
String@
Delimited list of regions
pcTerritoryList
String@
Delimited list of territory
pcSalesRepList
String@
Delimited list of sales rep
GetDates This method returns the initial default values for FiscalYear and FiscalPeriod and From and To FilterDate. Parameters
1566
Name
Type
Description
piFiscalYear
Int32@
Fiscal Year
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
pcFiscalYearSuffix
String@
Fiscal Year Suffix
piFiscalPeriod
Int32@
piFiscal Period
pdtFromFilterDate
Nullable{System.DateTime}@
From Filter Date
pdtToFilterDate
Nullable{System.DateTime}@
To Filter Date
GetQuarter This method returns the Fiscal Quarter for given Company and FiscalPeriod. Parameters Name
Type
Description
piFiscalYear
Int32
Fiscal Year
pcFiscalYearSuffix
String
Fiscal Year Suffix
piFiscalPeriod
Int32
Fiscal Period
piFiscalQtr
Int32@
Fiscal Quarter
GetTypeList Call this method to get list of Region, Territory and Sales Rep There are three levels of access: View All: This is enabled when the user's SalesRepID has 'View Company Pipeline' turned on in Workforce Maintenance. Can view aggregate totals of Actuals by Company, Region, Territory or SalesRep for ALL regions, territories, salesreps in the company Sales Manager: This is enabled when the user's SalesRepID is entered as the Sales Manager for one or more Regions in Sales Region Maintenance. Can view aggregate totals of Actuals by Region, Territory or SalesRep for the regions for which they are Sales Manager In this situation: pcTypeList contains Region, Territory, SalesManager and SalesRep pcRegionList contains the Regions for which the current user is Sales Manager pcTerritoryList contains the territories for their Regions pcSalesRepList contains only the SalesReps that "Report To" the current user Sales Rep: This is the level of access granted when neither of the other two levels apply. Can view only their own totals, and NOT aggregated by Region, or Territory In this situation: pcTypeList contains only the "SalesRep" choice pcRegionList and pcTerritoryList are empty pcSalesRepList contains only the SalesRep associated with the current user Parameters Name
Type
Description
pcTypeList
String@
Delimited list of aggregation-levels (Actuals Types)
RegionActualQuota This method displays the Regional Actual Quota Parameters Name
Type
Description
pcSalesRepCode
String
SalesRep Code
Epicor 9.05 | 9.05.605
1567
M-R
Business Object Reference Guide
Name
Type
Description
pcRegionCode
String
Region Code
piFiscalYear
Int32
Fiscal Year
pcFiscalYearSuffix
String
Fiscal Year Suffix
piFiscalPeriod
Int32
Fiscal Period
pdtFromFilterDate
Nullable{System.DateTime}
From Filter Date
pdtToFilterDate
Nullable{System.DateTime}
To Filter Date
ds
The PipeLineTotals data set
SalesManagerActualQuota This method displays Sales Manager Actual Quota. Parameters Name
Type
Description
pcSalesRepCode
String
SalesRep Code
piFiscalYear
Int32
Fiscal Year
pcFiscalYearSuffix
String
Fiscal Year Suffix
piFiscalPeriod
Int32
Fiscal Period
pdtFromFilterDate
Nullable{System.DateTime}
From Filter Date
pdtToFilterDate
Nullable{System.DateTime}
To Filter Date
ds
The PipeLineTotals data set
SalesRepActualQuota This method displays Sales Rep's Actual Quota. Parameters Name
Type
Description
pcSalesRepCode
String
SalesRep Code
pcTerritoryID
String
Territory ID
piFiscalYear
Int32
Fiscal Year
pcFiscalYearSuffix
String
Fiscal Year Suffix
piFiscalPeriod
Int32
Fiscal Period
pdtFromFilterDate
Nullable{System.DateTime}
From Filter Date
pdtToFilterDate
Nullable{System.DateTime}
To Filter Date
ds
1568
The PipeLineTotals data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
TerritoryActualQuota This method displays Territory Actual Quota Parameters Name
Type
Description
pcSalesRepCode
String
SalesRep Code
pcTerritoryID
String
Territory ID
piFiscalYear
Int32
Fiscal Year
pcFiscalYearSuffix
String
Fiscal Year Suffix
piFiscalPeriod
Int32
Fiscal Period
pdtFromFilterDate
Nullable{System.DateTime}
From Filter Date
pdtToFilterDate
Nullable{System.DateTime}
To Filter Date
ds
The PipeLineTotals data set
PIStatus Epicor.Mfg.BO.PIStatus: This business object contains 8 methods.
GetNewPIStatus Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
1569
M-R
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PIType Epicor.Mfg.BO.PIType: This business object contains 9 methods.
GetNewPIType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
1570
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeDefault Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
1571
M-R
Business Object Reference Guide
OnChangePIScope This method should be called to set GLStage for PIScope. Parameters Name
Type
Description
ipPIType
String
PI Type.
ipPIScopeNew
Int32
New PI Type Scope.
ds
PI Type data set.
PlanningWB Epicor.Mfg.BO.PlanningWB: This business object contains 7 methods.
GetNewPartSug Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1572
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Plant Epicor.Mfg.BO.Plant: This business object contains 17 methods.
GetNewPlant Inserts a new row in the DataSet with defaults populated.
GetNewPlantAttch Inserts a new row in the DataSet with defaults populated.
GetNewPlantEGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1573
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ETCAfterAddrVal After the tax integration has been called, update the Plant address if it was changed. Parameters Name
Description
ds
The Plant data set
ds1
The ETCAddrValidation data set
plantID
1574
Type
String
Plant.Plant
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ETCValidateAddress Call tax integration and loads temp tables from the results. Parameters Name
Type
Description
plantID
String
Plant.Plant
statusFlag
Boolean@
Set to true if the integration is up, false if down.
errorFlag
Boolean@
If true, an error occured.
errorMsg
String@
If Error Flag is true, this is the associated message.
Returns The ETCAddrValidation data set This Method Get all Companies Plants Returns Plant List dataset.
GetCompleteList This method is the same as GetList(), except that it causes a bypass of the call to removeUnauthorizedRows. It is to be used only in the situations where the user is allowed to see Plants for which they are not authorized, such as in this example from Vantage Help for Multi-Plant Management: The selection list for Plants will include all Plants for the To option when creating Plant to Plant transfers. However, when receiving a Plant to Plant transfer the user must be authorized to the receiving Plant. Parameters Name
Type
Description
whereClause
String
(optional)Additional Where conditions.
pageSize
Int32
absolutePage
Int32
morePages
Boolean@
Returns TRUE if there are more pages.
Returns Plant List dataset.
GetDisabledFields This method will send a list of fields to be disabled on the UI side if either the Multi-Plant or Advanced Planning and Scheduling license is not available or MRP, data collection and field service. Parameters Name
Type
Description
disabledList
String@
Returns the list of fields to be disabled
Epicor 9.05 | 9.05.605
1575
M-R
Business Object Reference Guide
IsAuthorizedForPlant IsAuthorizedForPlant determines whether the logged user is allowed to access a specific plant Parameters Name
Type
Description
plantID
String
The plant ID parameter.
isValid
Boolean@
True if authorized for that plant, false if plant does not exist, and throws an exception if not authorized
OnChangeOfCalendarID This method validates the CalendarID Parameters Name
Type
Description
calendarID
String
Proposed Calendar ID field
ds
The Plant data set
PlantCostIDChanged This method should be called anytime the PlantCostID is changed when updating a plant record (this method does not need to be called when adding a record). This method returns message text to present to the user in question form. The question informs the user Plant General Ledger Cost values will need to be updated, do they wish to continue with this change. Parameters Name
Type
Description
pcQuestion
String@
Question message passed back from the business logic.
PlantConfCtrl Epicor.Mfg.BO.PlantConfCtrl: This business object contains 38 methods.
GetNewPlantConfCtrl Inserts a new row in the DataSet with defaults populated.
GetNewPlantConfCtrlAttch Inserts a new row in the DataSet with defaults populated.
GetNewPlantConfABC Inserts a new row in the DataSet with defaults populated.
1576
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetNewPlantMFBill Inserts a new row in the DataSet with defaults populated.
GetNewPlantShared Inserts a new row in the DataSet with defaults populated.
GetNewPlntTranDef Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewPltUPSEmail Inserts a new row in the DataSet with defaults populated.
GetNewPlantConfCtrlEGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
1577
M-R
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CheckApprovalDefaults Checks if a workflow group already exists for any of the selected options. If yes, returns a message asking if the defaults should be rebuilt Parameters Name
Type
Description
String@
Question to display to the user
ds cQuestionText
CreateApprovalDefaults Creates default records needed for time and expense approvals.
1578
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
String@
Text to display to the user
ds cReturnText
GetCompleteList This method is the same as GetList(), except that it causes a bypass of the call to removeUnauthorizedRows. It is to be used only in the situations where the user is allowed to see Plants for which they are not authorized, such as in this example from Vantage Help for Multi-Plant Management: The selection list for Plants will include all Plants for the To option when creating Plant to Plant transfers. However, when receiving a Plant to Plant transfer the user must be authorized to the receiving Plant. Parameters Name
Type
Description
whereClause
String
(optional)Additional Where conditions.
pageSize
Int32
absolutePage
Int32
morePages
Boolean@
Returns TRUE if there are more pages.
Returns Plant List dataset. Creates a record in the DfltApprTasksParams DataSet so the user can choose what default tasks are created Returns
GetDisabledFields This method will send a list of fields to be disabled on the UI side if either the Multi-Plant or Advanced Planning and Scheduling license is not available or MRP, data collection and field service. Parameters Name
Type
Description
disabledList
String@
Returns the list of fields to be disabled
IsAuthorizedForPlant IsAuthorizedForPlant Parameters Name
Type
Description
plantID
String
Plant ID
Epicor 9.05 | 9.05.605
1579
M-R
Business Object Reference Guide
Name
Type
Description
isValid
Boolean@
Flag that indicates if the Plant is authorized
OnChangeOfAbcCode Parameters Name
Type
ds
Description PlantConf data set
ipABCCode
String
Plant ABC code
OnChangeOfCCProdCal This method validates CCProdCal Parameters Name
Type
Description
calendarID
String
Proposed Cycle Count Calendar ID field
ds
The Plant Confif Control data set
OnChangeOfExpenseApprovalReqd This method resets default values when ExpenseApprovalReqd changes Parameters Name
Type
Description
ipApprovalRequired
Boolean
Proposed ExpenseApprovalReqd field
ds
The Plant Confif Control data set
OnChangeOfExpenseRestrictEntry This method resets default values when ExpenseRestrictEntry changes Parameters Name
Type
Description
ipRestrictEntry
Boolean
Proposed ExpenseRestrictEntry field
ds
1580
The Plant Confif Control data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangeOfLowLvlSerialTrk Parameters Name
Type
Description
ipLLSerTrk
Int32
PlantConfCtrl.LowLvlSerialTrk
ds
The Plant data set
OnChangeOfMaintTmpJobNum This method should be called when Equip.TemplateJobNum changes. Parameters Name
Type
Description
ipJobNum
String
Job Num
ds
PlantConf data set
OnChangeOfPcntTolerance Parameters Name
Type
Description
ipPcntTolerance
Decimal
Percentage Tolerance
OnChangeOfQtyTolerance Parameters Name
Type
Description
ipQtyTolerance
Decimal
Quantity Tolerance Value
OnChangeOfSerialTracking This method validates SerialTracking Parameters Name
Type
Description
ipSerialTracking
Int32
Proposed Serial Tracking field
ds
Epicor 9.05 | 9.05.605
The Plant Confif Control data set
1581
M-R
Business Object Reference Guide
OnChangeOfStockValPcnt Parameters Name
Type
Description
ipStockValPcnt
Decimal
Stock Value Percent
OnChangeOfTimeApprovalReqd This method resets default values when TimeApprovalReqd changes Parameters Name
Type
Description
ipApprovalRequired
Boolean
Proposed TimeApprovalReqd field
ds
The Plant Confif Control data set
OnChangeOfTimeRestrictEntry This method resets default values when TimeRestrictEntry changes Parameters Name
Type
Description
ipRestrictEntry
Boolean
Proposed TimeRestrictEntry field
ds
The Plant Confif Control data set
OnChangeOfValueTolerance Parameters Name
Type
Description
ipValTolerance
Decimal
Value of tolerance
ResourceTransfer Plant Resource Transfers allow you to create new plants from the resources available in current plants. Once resources are moved to a new plant, they are no longer available in their previous plant. Parameters
1582
Name
Type
Description
pcPlant
String
The plant from where you want to move the resources
pcRemotePlant
String
The plant where you want to move the resources
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
pcWrkCenterList
String
The delimited list of Work centers that you want to transfer to the remote plant
pcWareHseList
String
The delimited list of warehouses that you want to transfer to the remote plant
plExecuteTransfer
Boolean
Yes will update the records. No will run a simulation
pcMessage
String@
Non error, informational message passed back from the business logic.
cTransferLog
String@
The parameter that is sent to PlantTranferRsrcTestReport
SetUPSQVEnable SetUPSQVEnable Parameters Name
Type
Description
ipQVEnable
Boolean
logical indicating if the quantum view is to enabled/disabled
ds
The Plant data set
ValidatePayBTFlag ValidatePayBTFlag Parameters Name
Type
Description
ipPayBTFlag
String
requested pay bt flag to edit
PlantCost Epicor.Mfg.BO.PlantCost: This business object contains 8 methods.
GetNewPlantCost Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
1583
M-R
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PreUpdatePlantCost This method will return a message/question for the user to answer before continuing with the update. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
String@
Question for the user to confirm FIFO Layer status
ds opMessage
1584
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PlantTranSearch Epicor.Mfg.BO.PlantTranSearch: This business object contains 7 methods.
GetNewPlantTran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1585
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PlantWhseSearch Epicor.Mfg.BO.PlantWhseSearch: This business object contains 8 methods.
GetNewPlantWhseSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1586
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListAAM This procedure should return the same list of warehouses as the buildWhseList procedure in CustShip.p does. Parameters Name
Type
Description
i_PartNum
String
Part number that we're building the warehouse list for
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.PlantWhseSearchListDataSet
PO Epicor.Mfg.BO.PO: This business object contains 90 methods.
GetNewPOHeader Inserts a new row in the DataSet with defaults populated.
GetNewPOHeaderAttch Inserts a new row in the DataSet with defaults populated.
GetNewPODetail Inserts a new row in the DataSet with defaults populated.
GetNewPODetailAttch Inserts a new row in the DataSet with defaults populated.
GetNewPORel Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1587
M-R
Business Object Reference Guide
GetNewPORelTGLC Inserts a new row in the DataSet with defaults populated.
GetNewPODetailInsp Inserts a new row in the DataSet with defaults populated.
GetNewPOMisc Inserts a new row in the DataSet with defaults populated.
GetNewPOHeadMisc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1588
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
1589
M-R
Business Object Reference Guide
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeApproveSwitch Invoke this method when the Approve switch on the summary screen changes. Parameters Name
Type
Description
approveValue
Boolean
Was PO approved? Yes/No
violationMsg
String@
The message contains error text
ds
The Purchase Order data set
ChangeContractUOM Call this method when the PODetail.ContractQtyUOM changes.
1590
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
newUOM
String
New UOM
ds
The Purchase Order data set
ChangeCountry Changes country Parameters Name
Type
Description
ds
The Purchase Order data set
ChangeCurrencyCode Run this method when the currency code changes on the poheader. This method will pull in the exchange rate. Parameters Name
Type
Description
iCurrencyCode
String
Currency Code
ds
The Purchase Order data set
ChangeCurrencySwitch Run this method when the currency toggle changes on the POHeadeMisc. It will update the currency symbol. Parameters Name
Type
ds
Description The Purchase Order data set
ChangeDetailAssemblySeq Invoke when assembly on the detail sheet changes. It will validate the release and zero out the JobSeq. Parameters Name
Type
Description
newAsmSeq
Int32
New Assembly to be tested
ds
The Purchase Order data set
ChangeDetailCalcOurQty Run this method when our quantity on the detail changes.
Epicor 9.05 | 9.05.605
1591
M-R
Business Object Reference Guide
Parameters Name
Type
Description
newCalcOurQty
Decimal
New Quantity
ds
The Purchase Order data set
ChangeDetailCalcVendQty Run this method when supplier quantity on the detail changes. Parameters Name
Type
Description
newCalcVendQty
Decimal
New Quantity
ds
The Purchase Order data set
ChangeDetailIUM Call this method when the IUM changes on the PODetail. Parameters Name
Type
Description
newIUM
String
New IUM
ds
The Purchase Order data set
ChangeDetailJobNum This method is used when the jobnumber on the detail screen changes . Parameters Name
Type
Description
newJobNum
String
New Job Number
ds
The Purchase Order data set
ChangeDetailJobSeq Invoke when Job/mtl sequence on the Detail sheet changes. I Parameters Name
Type
Description
newJobSeqNum
Int32
New job/mtl seq to be tested
ds
1592
The Purchase Order data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangeDetailMangCust Run this method when MangCustID on the detail changes. Parameters Name
Type
Description
newMangCust
String
New MangCustID
ds
The Purchase Order data set
ChangeDetailMfgNum Call this method when the MfgNum changes on the PODetail. Parameters Name
Type
Description
newMfgNum
Int32
New MfgNum
ds
The Purchase Order data set
ChangeDetailMfgPartNum Call this method when the MfgPartNum changes on the PODetail. Parameters Name
Type
Description
newMfgPartNum
String
New MfgPartNum
ds
The Purchase Order data set
ChangeDetailOrderLine Call this method when the OrderLine changes on the PODetail. Parameters Name
Type
Description
ipOrderLine
Int32
New OrderLine
ds
The Purchase Order data set
ChangeDetailOrderNum Call this method when the OrderNum changes on the PODetail.
Epicor 9.05 | 9.05.605
1593
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipOrderNum
Int32
New OrderNum
ds
The Purchase Order data set
ChangeDetailPartClass Run this method when the partnumber on the detail screen changes . Parameters Name
Type
Description
newClassID
String
New Class ID
ds
The Purchase Order data set
ChangeDetailPartNum Run this method when the partnumber on the detail screen changes . Parameters Name
Type
Description
newPartNum
String@
New Part Number
sysRowID
String
Sys Row ID for match (conflict resolution only)
rowType
String
Row Type for match (conflict resolution only)
isSubstitute
Boolean
True whether it is a Substitute Part
multipleMatch
Boolean@
Returns whether multiple matches were found.
ds
The Purchase Order data set
ChangeDetailPUM Call this method when the PUM changes on the PODetail. Parameters Name
Type
Description
newPUM
String
New PUM
ds
The Purchase Order data set
ChangeDetailTranType Call this method when the TranType (LineType) changes on the PODetail. It will update the price on the release
1594
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
newTranType
String
New Transaction Type
ds
The Purchase Order data set
ChangeExpAcct This method sets the flag in PORelTGLC that indicates if the account has been overridden from the default. Parameters Name
Type
Description
proposedAccountNum
String
The proposed account number
inTGLCTranNum
Int32
The TGLCTranNum of the PORelTGLC record to be checked
ds
The Purchase Order data set
ChangePOHeadMiscCode Run this method when the misc code is changed on the POHeadMisc. It will recalaculate amounts. Parameters Name
Type
Description
newMiscCode
String
The code of misc charge
ds
The Purchase Order data set
ChangePOHeadMiscPrcnt Run this method when the percentage changes on the POHeadMisc. It will recalaculate doc and base amounts. Parameters Name
Type
ds
Description The Purchase Order data set
ChangePOMiscCode Run this method when the misc code is changed on the POMisc. It will recalaculate amounts. Parameters Name
Type
Description
newMiscCode
String
The code of misc charge
ds
Epicor 9.05 | 9.05.605
The Purchase Order data set
1595
M-R
Business Object Reference Guide
ChangePoMiscCurrSwitch Run this method when the currency toggle changes on the POMisc. It will update the currency symbol and recalaculate doc and base amounts. Parameters Name
Type
ds
Description The Purchase Order data set
ChangePOMiscPrcnt Run this method when the percentage changes on the POMisc. It will recalaculate doc and base amounts. Parameters Name
Type
ds
Description The Purchase Order data set
ChangePOType This method should be invoked when the newPOType changes. Parameters Name
Type
Description
newPOType
String
Proposed newPOType to be validated
ds
The Purchase Order data set
ChangePrcConNum This method should be invoked when the PrcConNum changes. This method will validate the vendorCnt and pull in the new default information. Parameters Name
Type
Description
prcConNum
Int32
Proposed PrcConNum to be validated
ds
The Purchase Order data set
ChangePurPoint Invoke this method to change the purchase point on the POHeader. This method will validate the PP and pull in default information.
1596
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
purPoint
String
New Purchase Point
ds
The Purchase Order data set
ChangeRelAssemblySeq Invoke when assembly on the release sheet changes. It will validate the release and zero out the JobSeq. Parameters Name
Type
Description
newAsmSeq
Int32
New Assembly to be tested
ds
The Purchase Order data set
ChangeRelGlbCompany This method should be called when the GlbCompany field on a po release changes. It will populate default values in PORel based on the new GlbCompany value. Parameters Name
Type
Description
proposedGlbCompany
String
Proposed GlbCompany value
ds
The Purchase Order data set
ChangeRelGlbPlant This method should be called when the GlbPlant field on a po release changes. It will populate default values in PORel based on the new GlbPlant value. Parameters Name
Type
Description
proposedGlbPlant
String
Proposed GlbPlant value
ds
The Purchase Order data set
ChangeRelGlbWarehouse This method should be called when the GlbWarehouse field on a po release changes. It will populate default values in PORel based on the new GlbWarehouse value. Parameters Name
Type
Description
proposedGlbWarehouse
String
Proposed GlbCompany value
Epicor 9.05 | 9.05.605
1597
M-R
Business Object Reference Guide
Name
Type
ds
Description The Purchase Order data set
ChangeRelIUM Call this method when the IUM changes on the PORel. Parameters Name
Type
Description
newIUM
String
New IUM
ds
The Purchase Order data set
ChangeRelJobNum Purpose: Invoke after the jobnumber has changed either on the release sheet . Parameters Name
Type
Description
newJobNum
String
New Job Number
ds
The Purchase Order data set
ChangeRelJobSeq Invoke when Job/mtl sequence on the release sheet changes. It will validate the release and zero out the JobSeq. Parameters Name
Type
Description
newJobSeqNum
Int32
New job/mtl seq to be tested
ds
The Purchase Order data set
ChangeRelJobSeqWarning Gets specified material or operation record and changes the warning message. Parameters
1598
Name
Type
Description
ipTranType
String
Transaction Type
ipJobNum
String
Job Number
ipAssemblySeq
Int32
Assembly Sequence
ipNewJobSeq
Int32
Job Sequence
ipPODtlPartNum
String
Part Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
opWrnMsg
String@
Warning Message to be displayed to the user
ChangeRelMangCust Run this method when MangCustID on the release changes. Parameters Name
Type
Description
newMangCust
String
New MangCustID
ds
The Purchase Order data set
ChangeRelOrderLine Call this method when the OrderLine changes on the PORel. Parameters Name
Type
Description
ipOrderLine
Int32
New OrderLine
ds
The Purchase Order data set
ChangeRelOrderNum Call this method when the OrderNum changes on the PORel. Parameters Name
Type
Description
ipOrderNum
Int32
New OrderNum
ds
The Purchase Order data set
ChangeRelOrderRelNum Call this method when the OrderRelNum changes on the PORel. Parameters Name
Type
Description
ipOrderRelNum
Int32
New OrderRelNum
ds opWrnMsg
Epicor 9.05 | 9.05.605
The Purchase Order data set String@
Warning Message to be displayed to the user
1599
M-R
Business Object Reference Guide
ChangeRelOurQty This should be run after OurQty (PORel.XRelQty) changed on the PO release. Parameters Name
Type
Description
newOurQty
Decimal
New quantity to be tested
ds opWarningMsg
The Purchase Order data set String@
BTO Warning message.
ChangeRelPUM Call this method when the PUM changes on the PORel. Parameters Name
Type
Description
newPUM
String
New PUM
ds
The Purchase Order data set
ChangeRelVendQty This should be run after VendorQty (PORel.RelQty) changed on the PO release. Parameters Name
Type
Description
newVendQty
Decimal
New quantity to be tested
ds opWarningMsg
The Purchase Order data set String@
BTO Warning message.
ChangeTranType Call this method when the TranType (LineType) changes on the POREL. ExpAccount will change Parameters Name
Type
Description
newTranType
String
New transaction type
ds
The Purchase Order data set
ChangeUnitPrice Calculates the UnitPrice or DocUnitPrice depending of the Currency Switch.
1600
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The Purchase Order data set
ChangeVendor This method should be invoked when the vendor ID changes. This method will validate the vendor and pull in the new default vendor information. 1. Validate Vendor ID / Vendor Num 2. check for inactive vendor 3. check Vendor for Approved flag 4. check item(s) for conficts with AprvVend Parameters Name
Type
Description
vendID
String
Proposed vendor ID to be validated
ds
The Purchase Order data set
CheckComplianceFail Check for every release of the PO if it is compliant. Parameters Name
Type
Description
poNum
Int32
Current PO Number.
compliant
Boolean@
Indicates if the current PO is compliant.
CheckLOC Checks outstanding amounts to limit on APLOC (if applicable) This should be called before updating POHeader, PODetail, POMisc, or POHeadMisc If limit is exceeded a string is returned asking the user if they want to override. Parameters Name
Type
Description
opMsg
String@
Any returned error message.
ds
The Purchase Order data set
CheckPONum Method to call when entering proposed PO Number. This method will return two output variables. One is a logical field to indicate if the PO number entered is existing or not. The other variable is for the error message in case the proposed PO number is invalid.
Epicor 9.05 | 9.05.605
1601
M-R
Business Object Reference Guide
Parameters Name
Type
Description
proposedPONum
Int32
The proposed PO Number
opFoundPO
Boolean@
Indicates if the proposed PO number is already existing.
opMessage
String@
Error message for the user to see.
CheckProjectID Validate Projec ID value Parameters Name
Type
Description
ipProjectID
String
The Project ID value
ds
The Purchase Order data set
CheckRateGrpCode Update Quote Detail information when the Part Number is changed. Parameters Name
Type
Description
ipRateGrpCode
String
Currency Rate Group Code
ds
Quote dataset
CloseOrder Filters up available open orders/lines Parameters Name
Type
Description
poNum
Int32
The purchase order number
Returns The Purchase order data set
CloseOrderLine Filters up available open lines
1602
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
poNum
Int32
The purchase order number
poLine
Int32
The purchase order line
Returns The Purchase order data set
CloseRelease Run this method to close a release . Parameters Name
Type
Description
poNum
Int32
The purchase order number
poLine
Int32
The purchase order line
poRelease
Int32
The purchase order release number
Returns The Purchase order data set
DuplicatePO Duplicates PO Parameters Name
Type
Description
poNum
Int32
The purchase order number
copyUnitCosts
Boolean
Unit Costs
copyJobInfo
Boolean
Job Info
newDueDate
Nullable{System.DateTime}
new Due Date
Returns The Purchase order data set
GetAPLOCDescription This method should be invoked when it is required to set the APLOC Description changes. Parameters Name
Type
Description
poAPLOCID
String
Proposed newPOType to be validated
ds
Epicor 9.05 | 9.05.605
The Purchase Order data set
1603
M-R
Business Object Reference Guide
GetCurrencyBase This method returns the Base CurrencyCode Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
GetGlbCompanyList Returns a list of available companies to choose from for the Global Company field. Returns the list in code1`desc1~code2`desc2 format. Parameters Name
Type
Description
glbCompanyList
String@
The global company list
GetNewConsolidatedPO Method to call when adding a Consolidated PO Parameters Name
Type
ds
Description The PO data set
GetNewContractPO Method to call when adding a Consolidated PO Parameters Name
Type
ds
Description The PO data set
GetPartSubList Public method to get the poapvmsg dataset. Parameters
1604
Name
Type
Description
partNum
String
The part number
pageSize
Int32
pageSize
absolutePage
Int32
absolutePage
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
morePages
Boolean@
is there more Pages? Yes/No
Returns The PartSubs data set
GetPlantsForPart Gets Plant for appropriate Part Parameters Name
Type
Description
ipPartNum
String
Part Number
opPlantList
String@
Delimited list of plants for part
GetPOReceipts Gets RcvDtl's and DropShipDtl's for a given PONum. Parameters Name
Type
Description
ipPONum
Int32
PONum.
Returns Epicor.Mfg.BO.POReceiptsDataSet.
PartStatusValidationMessages The method is to be run on leave of the PartNum, Revision fields before the GetPartInfo or Update methods are run. This returns all the questions that need to be asked before a part can be changed. Parameters Name
Type
Description
valpartnum
String@
The new PartNum if a substitute part is found, partNum will be the substitute part
questionString
String@
Asks if the user wants to use a substitute part
substitutePartAvail
Boolean@
Indicates other substitute parts besides the default exist
msgType
String@
Type of message returned. if avail porel then message porel.poline porel.trantype. Values can be; "Question" (asking if they want to use the substitute part) "Warning" (Warns them that a part is onhold or runout). "Error" (Part in Inactive, or Onhold/Runout parts are not accepted in this case) . "Question" is asking if they want to use the substitute part.
Epicor 9.05 | 9.05.605
1605
M-R
Business Object Reference Guide
ReopenOrder Reopens order Parameters Name
Type
Description
poNum
Int32
The Purchase ordre number
Returns The Purchase Order data set
ReopenOrderLine Reopens order line Parameters Name
Type
Description
poNum
Int32
The Purchase ordre number
poLine
Int32
The Purchase ordre line
Returns The Purchase Order data set
ReOpenRelease Run this method to reopen a release. Parameters Name
Type
Description
poNum
Int32
The Purchase ordre number
poLine
Int32
The Purchase order line
poRelease
Int32
The Purchase ordre release
Returns The Purchase Order data set
ValidateInspection Method to validate the Inspection control fields. (EQM) Parameters
1606
Name
Type
Description
ipProposedInspPlan
String
The new proposed InspPlanPartNum value
ipProposedSpecId
String
The new proposed SpecID value
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
ds
Description The PO entry Dataset.
POApvMsg Epicor.Mfg.BO.POApvMsg: This business object contains 12 methods.
GetNewPOApvMsg Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1607
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CheckApprovalLimit This method determines whether the Approval needs to be passed on to a manager To be run before the update method Parameters Name
Type
Description
vPONum
Int32
PO Number
vAprvAmt
Decimal
Amount being Approved
vApproved
String
Approver Response
vMessage
String@
If approval is needed, this message will ask the user if they want to continue
GetAllRows GetAllRows displays all the rows from POApvMsg table just like GetRows. Except - no filtering of POApvMsg records based on PurAuth will be performed in afterGetRows. Parameters
1608
Name
Type
Description
whereClausePOApvMsg
String
Where Clause for POApvMsg table.
pageSize
Int32
Page Size
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
absolutePage
Int32
absolutePage
morePages
Boolean@
morePages
Returns Returns the new POApvMsg DataSet
GetApprovalActivity GetApprovalActivity displays all the rows from POApvMsg table just like GetRows. Except - no filtering of POApvMsg records based on PurAuth will be performed in afterGetRows. Parameters Name
Type
Description
whereClausePOApvMsg
String
Where Clause for POApvMsg table.
pageSize
Int32
Page Size
absolutePage
Int32
absolutePage
morePages
Boolean@
morePages
Returns Returns the new POApvMsg DataSet
GetDateUser This method puts a date/time/user stamp in the MsgText box for the user Parameters Name
Type
Description
ds
Returns the new POApvMsg DataSet
PODetailSearch Epicor.Mfg.BO.PODetailSearch: This business object contains 4 methods.
GetList This methods will return all of the PoDetailSearch records which will be a subset of the PoHeader records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table (PoDetailSearch) we need our own public method. Parameters Name
Type
Description
whereClausePoHeaderSearch
String
The where clause to restrict data for
whereClausePoDetailSearch
String
The where clause to restrict data for
pageSize
Int32
The page size, used only for UI adaptor
Epicor 9.05 | 9.05.605
1609
M-R
Business Object Reference Guide
Name
Type
Description
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Returns The PoDetailSearch data set
GetListsFromSelectedKeys This methods will return all of the PoDetailSearch records which will be a subset of the PoHeader records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table (PoDetailSearch) we need our own public method. Parameters Name
Type
Description
ds
The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
GetRows This methods will return all of the PoDetailSearch records which will be a subset of the PoHeader records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table (PoDetailSearch) we need our own public method. Parameters Name
Type
Description
whereClausePoHeaderSearch
String
The where clause to restrict data for
whereClausePoDetailSearch
String
The where clause to restrict data for
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Returns The PoDetailSearch data set
GetRowsFromSelectedKeys This methods will return all of the PoDetailSearch records which will be a subset of the PoHeader records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table (PoDetailSearch) we need our own public method.
1610
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
PODetailTrackerSearch Epicor.Mfg.BO.PODetailTrackerSearch: This business object contains 8 methods.
GetNewPODetail Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1611
M-R
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsByVendorNum Calls the normal GetRows method and then constructs a custom data set combining Job and Order fields for the customer tracker. Parameters Name
Type
Description
whereClausePODetail
String
Whereclause for PODetail table.
poHeaderVendorNum
Int32
POHeder Vendor Number
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The PODetailTrackerSearch data set
PORelSearch Epicor.Mfg.BO.PORelSearch: This business object contains 9 methods.
GetNewPORel Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1612
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ContainerPORelSearch Parameters Name
Type
Description
whereClausePoRel
String
PO Release search clause
pageSize
Int32
Page size
Epicor 9.05 | 9.05.605
1613
M-R
Business Object Reference Guide
Name
Type
Description
absolutePage
Int32
Absolute page
morePages
Boolean@
More Pages
Returns PO Rel List Data Set
GetRowsExcludeGlobal Filter Releases from other Companies. Call normal GetRows method. Parameters Name
Type
Description
whereClausePoRel
String
PO Release search clause
excludeGlobal
Boolean
excludeGlobal
pageSize
Int32
Page size
absolutePage
Int32
Absolute page
morePages
Boolean@
More Pages
Returns PO Rel List Data Set
POSchedule Epicor.Mfg.BO.POSchedule: This business object contains 12 methods.
GetNewPOSchedule Inserts a new row in the DataSet with defaults populated.
GetNewPOScheduleDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1614
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ApproveAllSchedules Approved all schedules Parameters Name ds
Type
Description The POSchedule data set
ApproveSchedule Approved one schedule
Epicor 9.05 | 9.05.605
1615
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
The POSchedule data set
CopyQuantities Provides a simply way of being able to copy the quantities from either the Current, Suggestion or Adjusted fields to the Proposed field for the whole schedule Parameters Name
Type
Description
ipFromField
String
The From field value
ipContractPONum
Int32
The current ContractPONum value
ipContractPOLine
Int32
The current ContractPOLine value
ipContractRev
Int32
The current ContractRev value
ds
The POSchedule data set
lastPackSlip Add your summary for this object here Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
POSugg Epicor.Mfg.BO.POSugg: This business object contains 28 methods.
GetNewSugPoDtl Inserts a new row in the DataSet with defaults populated.
GetNewSugPoMsc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
1616
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field.
Epicor 9.05 | 9.05.605
1617
M-R
Business Object Reference Guide
Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
Autoselect This method will automatically change the Buy specification to Yes for any suggestion for the currently selected buyer that spicifies a vendor, a unit price a quantity , a purchasing factor and a unit of measure . The UI must mark the selected ttSugPODtl records are "dirty" before calling this method. This is to allow auto select to only run on the records selected This is a danger that there will be some records selected that will not show up in this dataset. These records may have been updated using a previous filter ( or lack of filter ) or by another user. This is consistant with Vantage 6.1. The result is more records may be marked as buy then expected.... Parameters Name
Type
ds
Description The POSugg data set
ipPlantKey
String
Plant or blank for all
ipCurBuyer
String
BuyerId or blank for all buyers
ipCutOffDate
Nullable{System.DateTime}
Cut off date for suggestions
CalcQtys This method recalculates RelQty, XRelQty Parameters Name
Type
Description
calcField
String
calcField
ds
The POSugg data set
CapableToPromiseGenerate Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
1618
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangeCurrencySwitch Returns the currency display symbol base on currencyswitch. Parameters Name
Type
Description
currencySwitch
Boolean
Logical indicating if the currency toggle is checked
vendorNum
Int32
SugPODtl.VendorNum
displaySymbol
String@
DisplaySymbol for currency
ChangeMfgNum Called when MfgNum is changed. Updates MfgNumName. Parameters Name
Type
Description
ipMfgNum
Int32
Manufacturer Number
ds
PO Suggestion data set
ChangePoLine This method should be invoked when the poLine changes. It validates the poline and sets the Taxable field. Parameters Name
Type
Description
newPoLine
Int32
New Po Line
ds
The POSugg data set
ChangePoNum This method will change the PoNum and pull in the defaults associated with the PO. The default fields are; PONum,VendorNum,BuyerID,CommentText,ShipVia,FOB,TermsCode and Taxable Parameters Name
Type
Description
newPoNum
Int32
Indicates the Po to retrieve
ds
The POSugg data set
ChangeSugPoMscAmt Run this method when the amount changes on the ttSugPoMsc .
Epicor 9.05 | 9.05.605
1619
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
The POSugg data set
ChangeSugPoMscCharge Run this method when the poMsc charge changes to default in a description. Parameters Name
Type
Description
newMiscCode
String
New Misc Code
ds
The POSugg data set
ChangeSugPoMscPercent Run this method when the percentage changes on the ttSugPoMsc . Parameters Name
Type
ds
Description The POSugg data set
ChangeVendor This method returns the default information for a vendor. Such as FOB,Terms, purchase point and currency . This method must be run after changing the VendorID and before invoking the update method, otherwise all related vendor information on the screen will not be updated. Parameters Name
Type
Description
newVendID
String
New Vendor ID
ds
The POSugg data set
CheckBuyers Need to be run before generating po's, the Generate() method. This method will check to see if generating PO from the currently tagged suggestions will generate po's for other buyers. Running the Generate method will assume that all tagged suggestion records will generate PO's, regardless of the buyer. Parameters
1620
Name
Type
Description
poForOtherBuyer
Boolean@
Logical of whether or not Generate() will generate PO's for other buyers
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
suggList
String@
List of Suggestions that will generate PO's for other buyers
opCurBuyer
String@
Current BuyerID
opBuyerName
String@
Current Buyer Name
Generate This method processes all suggestion records where buy has been set to true within the passed parameters. Note: This is doing a getrows and passing back a new dataset minus the records that were processed. The dataset at the client will still have the processed records, in order to removed these records we may have to somehow tag the processed records with a "D":U or, have the UI replace their dataset with this new one. Parameters Name
Type
Description
ds
The POSugg data set
ipPlantKey
String
Plant or blank for all
ipCurBuyer
String
BuyerId or blank for all buyers
ipCutOffDate
Nullable{System.DateTime}
Cut off date for suggestions
GetAuthorizedAgentList Returns a list of Buyers, authorized for the Current User. Parameters Name
Type
Description
opBuyerName
String@
List of buyers.
This method returns a list of inter-company trading partners. Use to populate the grid to select inter-company partners. Returns The ForecastVendors data set
GetListPlant Returns a list of rows that satisfy the where clause. Use in place of GetList Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
1621
M-R
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The POSugg List data set
GetRowsPlant Returns a dataset containing all rows that satisfy the where clauses. use in place of GetRows Parameters Name
Type
Description
whereClauseSugPODtl
String
whereClause for SugPODtl table
whereClauseSugPOMsc
String
whereClause for SugPOMsc table
pageSize
Int32
pageSize
absolutePage
Int32
absolutePage
morePages
Boolean@
morePages
Returns The POSugg data set
PartIsRunOut The method chekcs status of the current Part and if this Part is Active and not onHold or it`s HoldDay later then today, but it is flagged as Run Out then it sets value of isRunOut parament in true.. Parameters Name
Type
Description
valpartnum
String
The PartNum, whose status need to check
msg
String@
return not empty value if this part is Active and not onHold or it`s HoldDay later then today, but it is flagged as Run Out
SendForecast This method will process the selected forcast vendor records and send a forcast. Parameters Name ds
1622
Type
Description The ForecastVendors data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
POSuggChg Epicor.Mfg.BO.POSuggChg: This business object contains 11 methods.
GetNewSugPOChg Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1623
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AcceptSuggestionChange This methods will accept the PO Suggestion change. Parameters Name
Type
Description
ipPONum
Int32
The po number.
ipPOLine
Int32
The po line number.
ipPORelNum
Int32
The po release number.
ipVendorChange
Boolean
The Vendir Change.
ds
The POSuggChg data set
CheckTracker This method does stuff . Parameters Name
Type
Description
partTrackerOK
Boolean@
Indicates whether or not this user has securty rights to part tracker
GetListPlant Returns a list of rows that satisfy the where clause. Use in place of GetList Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The POSugg List data set
1624
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetRowsPlant Returns a dataset containing all rows that satisfy the where clauses. use in place of GetRows Parameters Name
Type
Description
whereClauseSugPOChg
String
whereClause for SugPOChg table
pageSize
Int32
pageSize
absolutePage
Int32
absolutePage
morePages
Boolean@
morePages
Returns The POSuggChg data set
POWorkbench Epicor.Mfg.BO.POWorkbench: This business object contains 2 methods.
GetOnHandQty Get the total quantity we have in stock of this part converted to the parts primary inventory UOM. Parameters Name
Type
Description
ipPartNum
String
Part Number
opOnHandQty
Decimal@
Primary UOM On Hand Quantity
GetPOWorkbench Retrieves data for UOM codes per part that are defined to be tracked for it (PartUOM.TrackOnHand = true). Part: Only Parts where Part.TrackDimension is true should be used. Horizon Date: Default to today. Parameters Name
Type
Description
ipPartNum
String
Part Number
ipHorizonDate
Nullable{System.DateTime}
Horizon Date
Returns POWorkbench Dataset
Epicor 9.05 | 9.05.605
1625
M-R
Business Object Reference Guide
PRChkGrp Epicor.Mfg.BO.PRChkGrp: This business object contains 13 methods.
GetNewPRChkGrp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
1626
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeBankAcctID Method to call when changing the bank account. Parameters Name
Type
Description
proposedBankAcctID
String
The proposed bank account id
ds
The PRChkGrp data set
ChangeCheckDate Method to call to update the fiscal period fields for the new check date. Parameters Name
Type
Description
proposedCheckDate
Nullable{System.DateTime}
The proposed check date
ds
The PRChkGrp data set
PostGroup Method to call when posting checks for a specific group. Posting of a group causes the PRChkGrp record to be deleted from the database if all checks in the group posted correctly. Parameters Name
Type
Description
postGroupID
String
The group id of the group of checks to be posted
postErrors
String@
Contains information regarding why a check may not have been posted. This field should be presented to the user to inform them of what the posting issues are.
PrePostGroup Method to call before posting checks for a specific group. It will check to see if the register has printed or not. The text for this question is returned in RegisterText. It will also check to see if payroll is interfaced with G/L. The text for this question is returned in InterfacedText. For both questions, if the answer is yes, posting can continue, otherwise posting is canceled.
Epicor 9.05 | 9.05.605
1627
M-R
Business Object Reference Guide
Parameters Name
Type
Description
postGroupID
String
The Group ID of the Group to post
registerText
String@
Contains text of the register message to present to the user.
interfacedText
String@
Contains text of the interface message to present to the user.
PreUpdateCheck Method to call to perform pre-validations on the update of a check group record. The pre-validations involve asking the user various questions about the changes being made and if the changes will be ok. The validations are: 1) The check date is less than today or more than 14 days out 2) The check date changed, which will require taxes and deductions to be recalculated. 3) The Deduction period value is zero. If the user answers yes to all questions, the save can continue. If the user answers no to any question, the update is canceled. This method should be called prior to the Update method. Parameters Name
Type
Description
groupID
String
The group id
checkDate
Nullable{System.DateTime} The check date
deductionPeriod
Int32
The deduction period to validate
dateRangeText
String@
The text of the question to ask the user if the check date range is not between today's date and 14 days out. If blank, a question does not need to be asked.
recalcTaxAndDedText
String@
The text of the question to ask the user when the check date changes, which requires taxes and deductions to be recalculated. If blank, a question does not need to be asked.
deductionPeriodText
String@
The text of the question to ask the user if the deduction period is zero. If blank, a question does not need to be asked.
ds
The PRChkGrp data set
UnlockGroup Method to call to unlock a group record. This method should be called whenever the group no longer needs to be locked. The group no longer needs to be locked when the payroll entry object is closed, or when a different group is selected. Parameters
1628
Name
Type
Description
inGroupID
String
The group id of the group record to unlock
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PRClass Epicor.Mfg.BO.PRClass: This business object contains 11 methods.
GetNewPRClass Inserts a new row in the DataSet with defaults populated.
GetNewPRClsDed Inserts a new row in the DataSet with defaults populated.
GetNewPRClsDedEGLC Inserts a new row in the DataSet with defaults populated.
GetNewPRClsTax Inserts a new row in the DataSet with defaults populated.
GetNewPRClsTaxEGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
1629
M-R
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PRDeduct Epicor.Mfg.BO.PRDeduct: This business object contains 9 methods.
GetNewPRDeduct Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1630
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
1631
M-R
Business Object Reference Guide
Returns
PrefScheme Epicor.Mfg.BO.PrefScheme: This business object contains 8 methods.
GetNewPrefScheme Inserts a new row in the DataSet with defaults populated.
GetNewPrefSchemeCtry Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1632
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PREmployee Epicor.Mfg.BO.PREmployee: This business object contains 28 methods.
GetNewPREmpMas Inserts a new row in the DataSet with defaults populated.
GetNewPREmpMasAttch Inserts a new row in the DataSet with defaults populated.
GetNewPREmpDed Inserts a new row in the DataSet with defaults populated.
GetNewPREmpRt Inserts a new row in the DataSet with defaults populated.
GetNewPREmpTax Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1633
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
AddEmployeeResultsLinkCompany This method will add employee results link to all employees in the company
1634
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds opMessage
Description The PREmployee data set
String@
Message to be displayed to the user
BuildClassList This method returns a list of valid Classes to select from for the user's security Parameters Name
Type
Description
classList
String@
Limited list of ClassIDs and Description
BuildFilingList This method returns a list of filing status' based on the TaxTable ID selected Parameters Name
Type
Description
taxTblID
String
Tax Table ID code
filingList
String@
Filing Status List
BuildTaxTblList This method generates a list of TaxTbls available to choose from when Adding/Updating a PREmpTax record Parameters Name
Type
Description
taxTblID
String
Current Tax Table ID, blank if new
empID
String
Curreny Employee ID
taxList
String@
Delimited List of available TaxTblID including the current one
CalcSalaryRate This method updates the salary or rate field on PREmpRt when the other field is updated It is to be run after either Salary or PayRate is updated. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The PREmployee data set
1635
M-R
Business Object Reference Guide
ChangeFileStatus This method should run when the JobMtl.Plant field changes. This method determines the default JobMtl.WarehouseCode associated with the new JobMtl.Plant. Parameters Name
Type
Description
proposedFileStatus
String
propsed value
ds
PREmploye Entry data set
CheckLeavePREmpMas This method checks if a PREmpRt record exists for the current employee record if no record exists then the user cannot leave the record until they create a rate record or delete the employee record. Parameters Name
Type
Description
empId
String
The current employee's ID
vMessage
String@
Error string if no rate record exists (otherwise blank)
GetDeductDefaults This method sets the deduction defaults once the DeductionID is selected Parameters Name
Type
ds
Description The PREmployee data set
GetEmpIDInfo This method will default the name and address information from EmpBasic if the EmpId entered exists in EmpBasic Parameters Name ds
Type
Description The PREmployee data set
GetEmpLinkValue Gets Employee Link
1636
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
inEmpID
String
in Employee Link
outEmpLink
String@
out Employee Link
GetNewShopEmployee This method creates a new PREmpMas record based on information from the EmpBasic record. It takes EmpID as a parameter. The standard GetNewPREmpMas method will be used when adding a new Payroll Employee from scratch. Parameters Name
Type
ds empID
Description The PREmployee data set
String
Shop Employee's ID
GetOverrideList This method is identical to the GetList method except that it overrides the PREmpMas find trigger and will return all Employees, not just the ones the user has clearance for. This is mainly for the SupervisorID lookups for Shop and Payroll employee maintenance Parameters Name
Type
Description
whereClause
String
The search statement to filter the PREmpMas table on
pageSize
Int32
The page size (required)
absolutePage
Int32
Absolte Page size (required)
morePages
Boolean@
More Pages? Yes/No
Returns List dataset
GetPerConData Used to validate and Get the PerCon info. Parameters Name
Type
Description
perConID
Int32
Proposed PerConID.
ds
Epicor 9.05 | 9.05.605
PREmployee data set.
1637
M-R
Business Object Reference Guide
GetShopEmployeeInfo This method is called for a new employee. If the employee exists in the Parameters Name
Type
ds
Description The PREmployee dataset
RemoveEmployeeResultsLinkCompany This method will add employee results link to all employees in the company Parameters Name
Type
ds opMessage
Description The PREmployee data set
String@
Message to be displayed to the user
PRHoldy Epicor.Mfg.BO.PRHoldy: This business object contains 7 methods.
GetNewPRHoldy Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1638
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PriceGroup Epicor.Mfg.BO.PriceGroup: This business object contains 15 methods.
GetNewPriceGroup Inserts a new row in the DataSet with defaults populated.
GetNewPriceGrpValBrk Inserts a new row in the DataSet with defaults populated.
GetNewProdGrup Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
1639
M-R
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AddAllProdGroups Add all available Product Groups to current Price Group Parameters
1640
Name
Type
Description
prPriceGroupCode
String
Price Group Code
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
M-R
Type
Description
ds
Price Group data set
AddNewProdToPrice Add new Product Group to Price Group or replace old Product Group Parameters Name
Type
prPriceGroupCode
String
prProdCodeOld
String
prProdCodeNew
String
Description
ds
data set
CheckNewProdCode Validation of new Product group before it'll be added to Price Group Parameters Name
Type
Description
prPriceGroupCode
String
Price Group Code
prProdCodeNew
String
Product Group Code
CreateNewProd Add new Product Group as child record to Price Group with empty Prod Code Parameters Name
Type
prPriceGroupCode
String
Description
ds
Price Group data set
DeleteProdGroupFromPrice Delete link between Price and Product Group (delete child record) Parameters Name
Type
prProdCode
String
ds
Epicor 9.05 | 9.05.605
Description
Price Group data set
1641
M-R
Business Object Reference Guide
RemoveAllProdGroups Delete all links between Product Groups and current Price Group Parameters Name
Type
Description
prPriceGroupCode
String
Price Group Code
ds
Price Group data set
PriceListInquiry Epicor.Mfg.BO.PriceListInquiry: This business object contains 13 methods.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
1642
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeCustID Get filter values from the Customer. Parameters Name
Type
Description
cCustID
String
The Customer ID
cCustName
String@
The Customer name
cShipToNum
String@
The Ship To Number
cCustGroupCode
String@
The Customer Group Code
dDiscountPercent
Decimal@
The Customer discount percent
ChangeDiscountPercent Update NetPrice when the discount percent changes. Parameters Name
Type
ds
Description The Price List Inquiry data set
ChangePartNum Get filter values from the Part.
Epicor 9.05 | 9.05.605
1643
M-R
Business Object Reference Guide
Parameters Name
Type
Description
cPartNum
String
The part number
cProdCode
String@
The part product code
cPartDesc
String@
The part description
ChangeShipToNum Get filter values from the ShipTo. Parameters Name
Type
Description
cCustID
String
The Customer ID
cShipToNum
String
The Ship To Number
cCustName
String@
The Customer name
GetCurrencyByCustID Get currency values from the Customer. Parameters Name
Type
Description
cCustID
String
The Customer ID
cCurrencyCode
String@
The Currency Value
cCurrencyCurrDesc
String@
The currency Description
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters
1644
Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
uomCode
String@
UOM Code (only used for Product Codes)
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetPriceListInquiry Get the PriceListInquiry records for the inquiry parameters. Parameters Name
Type
Description
icCustID
String
The Customer ID
icShipToNum
String
The Part Number
icPartNum
String
The Ship To Number
icCustGroupCode
String
The Customer Group Code
icProductCode
String
The Product Code
idQuantity
Decimal
The Quantity
icUOMCode
String
The UOM Code
icWarehouseCode
String
The Warehouse Code
icCurrencyCode
String
The Currency Code
pageSize
Int32
The pageSize parameter
absolutePage
Int32
The absolutePages parameter
morePages
Boolean@
The morePages parameter
Returns The PriceListInquiry data set
validUOM Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
PriceLst Epicor.Mfg.BO.PriceLst: This business object contains 20 methods.
GetNewPriceLst Inserts a new row in the DataSet with defaults populated. Epicor 9.05 | 9.05.605
1645
M-R
Business Object Reference Guide
GetNewPriceLstAttch Inserts a new row in the DataSet with defaults populated.
GetNewPriceLstGroups Inserts a new row in the DataSet with defaults populated.
GetNewPLGrupBrk Inserts a new row in the DataSet with defaults populated.
GetNewPriceLstParts Inserts a new row in the DataSet with defaults populated.
GetNewPLPartBrk Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1646
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
BuildUOMList Build a list of all the valid UOM's defined for all the parts within the product group. Parameters Name
Type
Description
prodCode
String
Order Number
uomList
String@
delimited list of available ShipTo's
ChangePartNum Get the track multiple UOM setting when the part number changes. Parameters Name
Type
Description
proposedPartNum
String
Proposed Part Number
Epicor 9.05 | 9.05.605
1647
M-R
Business Object Reference Guide
Name
Type
Description
trackMulti
String
Track Multiple UOM setting.
opUOM
Boolean@
UOM
pListCode
String@
ListCode
ChangingKeyParts Validate the entered part an UOM doesn't exist in the price list. Parameters Name
Type
Description
pPartNum
String
Part Number
pListCode
String
List Code
pUOMcode
String
UOM Code
GetListFilterPriceList Filter parts by plant. Call normal GetList method. Parameters Name
Type
Description
orderNum
Int32
Order Number.
orderLine
Int32
Order Line.
partNum
String
Part Number.
prodCode
String
Product Code.
whereClause
String
Whereclause.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The PriceList data set
GetPriceLstGroupDefaults Gets the following fields for the product group: Description. Parameters
1648
Name
Type
Description
prodCode
String
Product group code to retrieve details for.
prodGrpDescription
String@
Product group description.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetPriceLstPartsDefaults Gets the following fields for the Part: Sales unit of measure, selling factor, price per code, part description and selling factor direction. Parameters Name
Type
Description
partNum
String@
Part number to retrieve details for.
salesUM
String@
Part unit of measure.
sellingFactor
Decimal@
Part selling factor.
pricePerCode
String@
Part price per code.
partDescription
String@
Part description.
sellingFactorDirection
String@
Part selling factor direction.
validUOM Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
PriceLstGroups Epicor.Mfg.BO.PriceLstGroups: This business object contains 11 methods.
GetNewPriceLstGroups Inserts a new row in the DataSet with defaults populated.
GetNewPLGrupBrk Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
1649
M-R
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListFromSelectedKeys This methods will return all of the PriceLstGroups records which will be a subset of the PriceLstGroups records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method. Parameters Name
Type
ds pageSize
1650
Description The dataset with pupolated key values
Int32
The page size, used only for UI adaptor
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
GetRowsFromSelectedKeys This methods will return all of the PriceLstGroups records which will be a subset of the PriceLstGroups records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method. Parameters Name
Type
ds
Description The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
getCurrencyCode Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
PriceLstHed Epicor.Mfg.BO.PriceLstHed: This business object contains 7 methods.
GetNewPriceLst Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
1651
M-R
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PriceLstParts Epicor.Mfg.BO.PriceLstParts: This business object contains 11 methods.
GetNewPriceLstParts Inserts a new row in the DataSet with defaults populated.
GetNewPLPartBrk Inserts a new row in the DataSet with defaults populated.
1652
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1653
M-R
Business Object Reference Guide
GetListFromSelectedKeys This methods will return all of the PriceLstParts records which will be a subset of the PriceLstParts records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method. Parameters Name
Type
ds
Description The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
GetRowsFromSelectedKeys This methods will return all of the PriceLstParts records which will be a subset of the PriceLstParts records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method. Parameters Name
Type
ds
Description The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
getCurrencyCode Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ProcessSet Epicor.Mfg.BO.ProcessSet: This business object contains 11 methods.
GetNewProcessSet Inserts a new row in the DataSet with defaults populated.
GetNewProcessTask Inserts a new row in the DataSet with defaults populated.
1654
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1655
M-R
Business Object Reference Guide
DuplicateProcessSet This method copies an existing process set to a new process set specified by the user. Parameters Name
Type
Description
targetProcessID
String
New Process Set ID
sourceProcessID
String
Process Set ID to copy from
Returns ProcessSet Dataset
MoveOnePosition This method moves the Task Up/Down one position in the ProcessSet and returns the whole updated dataset. Parameters Name
Type
Description
processID
String
Process Set ID
taskNum
Int32
Task Number to move up one position
moveDir
String
Direction to move task, "Up" or "Down"
Returns ProcessSet Dataset
MoveTaskToSet This method moves a process task from a source process set to the target process set. The source process set cannot be a system process set. Parameters Name
Type
Description
targetProcessID
String
Process Set ID to move task into
sourceProcessID
String
Process Set ID to move task from
sourceTaskNum
Int32
Process Task Num to move
ds
ProcessSet Dataset
ProdActDay Epicor.Mfg.BO.ProdActDay: This business object contains 11 methods.
GetNewPADay Inserts a new row in the DataSet with defaults populated.
1656
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetNewPADayDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
1657
M-R
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeShift Parameters Name
Type
Description
ipShiftValue
Int32
ipShiftValue.
ds
Production Activity Day Data Set
ChangeTime Parameters Name
Type
Description
ipTimeValue
Int32
Time to convert.
ipStartEnd
String
Whether this is start time or end time.
ds
Production Activity Day Data Set
ProdActivity Epicor.Mfg.BO.ProdActivity: This business object contains 12 methods.
GetNewPActivity Inserts a new row in the DataSet with defaults populated.
GetNewPActDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
1658
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1659
M-R
Business Object Reference Guide
ChangePlanID Parameters Name
Type
Description
ipPlanID
String
plan ID
ds
dataset parameter
Clear Parameters Name
Type
ds
Description dataset parameter
Refresh Parameters Name
Type
ds
Description dataset parameter
RefreshPActDtlFormattedTimes Parameters Name ds
Type
Description dataset parameter
ProdCal Epicor.Mfg.BO.ProdCal: This business object contains 12 methods.
GetNewProdCal Inserts a new row in the DataSet with defaults populated.
GetNewProdCalDay Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
1660
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CustomizeDay Call this method to specify a special working day or non working day. When this method is called, if a ProdCalDay record exists it will be deleted (undo the special working or non working day). If a ProdCalDay record doesn't
Epicor 9.05 | 9.05.605
1661
M-R
Business Object Reference Guide
exist, it will create a ProdCalDay record. If the date specified is a normal working day, then the WorkingDay field will be set to false and the capacity is set to 0. If the date specified is not a normal working day, then the WorkingDay field will be set to true and the ProdHour fields will be set to true depending on the number of ProdCal.HoursPerDay (example: If the ProdCal.HoursPerDay is 8 then ProdHour 1 through 8 would be set to true) and the capacity for the working day is set equal to the ProdCal.HoursPerDay. Parameters Name
Type
Description
cCalendarID
String
cCalendar Descriptive Code
daDate
Nullable{System.DateTime}
Modified date
ds
The ProdCal data set
DecideReadOnlyFields Decides if start processReadOnlyFieldsor not Parameters Name
Type
Description
ds
The ProdCal data set
DuplicateCalendar This duplicates the production calendar for calendar ID. Parameters Name
Type
Description
cOldCalendarID
String
The Current Calendar ID.
cNewCalendarID
String
Calendar ID of the new Calendar
ds
The ProdCal data set
GetPlantCalendar This method gets the plant calendar. Parameters Name ds
1662
Type
Description The ProdCal data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ProdCalWk Epicor.Mfg.BO.ProdCalWk: This business object contains 8 methods.
GetNewProdCalWeek Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1663
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AddWeekRange Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ProdGrup Epicor.Mfg.BO.ProdGrup: This business object contains 11 methods.
GetNewProdGrup Inserts a new row in the DataSet with defaults populated.
GetNewProdGrupPlt Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1664
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeDeferredRev Performs required logic when ProdGrup.DeferredRev is modified. Parameters Name
Type
Description
ipDeferredRev
Boolean
Proposed input value of Deferred Rev
ds
ProdGrup data set
ChangeRACode Performs required logic when ProdGrup.RACode is modified.
Epicor 9.05 | 9.05.605
1665
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipRACode
String
Proposed input value of RA Code
ds
ProdGrup data set
ProdTeam Epicor.Mfg.BO.ProdTeam: This business object contains 7 methods.
GetNewProdTeam Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1666
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ProjAnalysis Epicor.Mfg.BO.ProjAnalysis: This business object contains 7 methods.
BuildAnalysis Call this method when the user already selected project(s) to process. This method expects a LIST-DELIM delimited string of RowIds of all selected Project records. Parameters Name
Type
Description
ipRowList
String
A RowId list of selected Project records.
opMessage
String@
Returns message indicating number of records processed.
ClearAnalysis Call this method to delete or clear all ProjectAnalysis records. This method expects that the user already confirmed that records will be deleted. Parameters Name
Type
Description
ipProjectID
String
ProjectID
opMessage
String@
Returns message indicating process completion.
DefaultPctComplete Get the default Download % Complete code before passing the input parameters for the Project Download to MS Project. Call this method before the user manipulate the MSP Download input parameters. This method will return the default value for PctComplete variable.
Epicor 9.05 | 9.05.605
1667
M-R
Business Object Reference Guide
Parameters Name
Type
Description
vPctComplete
String@
The default value for Percent Complete code.
GetByProjectID This method finds the Project record by ProjectId. Parameters Name
Type
Description
ipProjectID
String
The Project ID
Returns The ProjAnalysis data set
GetProjectBrw This method assembles the Project browse for the main data set. Parameters Name
Type
Description
whereClauseProject
String
Where clause to specify set of ProjectBrw records to return
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages
Returns Returns Epicor.Mfg.BO.ProjAnalysisDataSet
ProcessMSPDownload This method performs the actual Project Download to MS Project. Call this method after the user selected the Project and entered the necessary input parameters. This method returns the data table ttMSPDownload containing all appropriate project information. The resulting records from the ttMSPDownload will then need to be outputted as a CSV file (comma delimited). Parameters
1668
Name
Type
Description
ipProjectID
String
The project ID of the selected Project.
ipPctComplete
String
The Download Percent Complete code.
ipPredecessors
Boolean
Include Predecessors in the download.
ipTasks
Boolean
Include Tasks in the download.
ipPhases
Boolean
Include Phases in the download.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
ipJobs
Boolean
Include Jobs in the download.
ipJobAsm
Boolean
Include Job Assemblies in the download.
ipJobOper
Boolean
Include Job Operations in the download.
ipDuration
String
The operation duration unit (Days or Hours).
opMessage
String@
Returns message about the status of the process.
Returns The MSPDownload data set
ProcessMSPUpload This method performs the actual Project Upload from MS Project. Call this method after the user selected the Project and entered the necessary input parameters. This method expects an input data table ttMSPUpload with data coming from an external comma delimited file. The ttMSPUpload table should only contain data (i.e. if the first line of the external file is just the field descriptions then this record should not be included in ttMSPUpload.) Parameters Name
Type
Description
ipProjectID
String
The project ID of the selected Project.
ipPhases
Boolean
Indicates if Phases should be created.
ipTasks
Boolean
Indicates if Tasks should be created.
ipProjJobs
Boolean
Indicates if Project and Job links should be updated.
ipPhaseTasks
Boolean
Indicates if Phase and Task links should be updated.
ipPhaseJobs
Boolean
Indicates if Phase and Job links should be updated.
ipPhaseStart
Boolean
Indicates if Phase Start Date should be updated.
ipPhaseEnd
Boolean
Indicates if Phase End Date should be updated.
ipTaskStart
Boolean
Indicates if Task Start Date should be updated.
ipTaskEnd
Boolean
Indicates if Task End Date should be updated.
ipJobStart
Boolean
Indicates if Job Start Date should be updated.
ipJobEnd
Boolean
Indicates if Job End Date should be updated.
ds opMessage
The MSPUpload data set String@
Returns message about the status of the process.
ProjChkLstType Epicor.Mfg.BO.ProjChkLstType: This business object contains 7 methods.
GetNewProjChkLstType Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1669
M-R
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
1670
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Project Epicor.Mfg.BO.Project: This business object contains 109 methods.
GetNewProject Inserts a new row in the DataSet with defaults populated.
GetNewProjectAttch Inserts a new row in the DataSet with defaults populated.
GetNewFieldServiceCalls Inserts a new row in the DataSet with defaults populated.
GetNewFieldServiceContracts Inserts a new row in the DataSet with defaults populated.
GetNewPBWrkMeasuredHead Inserts a new row in the DataSet with defaults populated.
GetNewPBWrkMeasuredDtl Inserts a new row in the DataSet with defaults populated.
GetNewProjectCst Inserts a new row in the DataSet with defaults populated.
GetNewProjectMilestone Inserts a new row in the DataSet with defaults populated.
GetNewProjectCriteria Inserts a new row in the DataSet with defaults populated.
GetNewPBdnSets Inserts a new row in the DataSet with defaults populated.
GetNewPBEmpCeiling Inserts a new row in the DataSet with defaults populated.
GetNewPBillSch Inserts a new row in the DataSet with defaults populated.
GetNewPBRoleRt Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1671
M-R
Business Object Reference Guide
GetNewPBSchWrk Inserts a new row in the DataSet with defaults populated.
GetNewPBSupCeiling Inserts a new row in the DataSet with defaults populated.
GetNewPConVar Inserts a new row in the DataSet with defaults populated.
GetNewProjectTask Inserts a new row in the DataSet with defaults populated.
GetNewProjPhase Inserts a new row in the DataSet with defaults populated.
GetNewPPhaseOper Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1672
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
AddPhaseQuote This method validates the given PONum, POLine and PORelease, then if valid, adds a ttProjectPO record. An exception is thrown if: - The given PO/Line/Rel does not exist - The given PO/Line/Rel... Parameters Name
Type
Description
piQuoteNum
Int32
The PO number of the candidate release to Add to the Project.
piQuoteLine
Int32
The PO Line number of the candidate release to Add to the Project.
pcWarningMsg
String@
A warning message appears here if the given release is associated with another Project.
Epicor 9.05 | 9.05.605
1673
M-R
Business Object Reference Guide
Name
Type
ds
Description ProjectDataSet
AddProjectJob This method validates the given JobNum, then if valid, adds a ttProjectJob record. An exception is thrown if: The given Job does not exist - The given Job... Parameters Name
Type
Description
pcJobNum
String
The Job number of the candidate Job to Add to the Project.
pcWarningMsg
String@
A warning message appears here if the given Job is associated with another Project.
ds
The Project data set
AddProjectOrderLine This method validates the given OrderNum and OrderLine, then if valid, adds a ttProjectOrderLine record. An exception is thrown if: - The given Order/Line does not exist - The given Order/Line... Parameters Name
Type
Description
piOrderNum
Int32
The Order number of the candidate OrderLine to Add to the Project.
piOrderLine
Int32
The Line number of the candidate OrderLine to Add to the Project.
pcWarningMsg
String@
A warning message appears here if the given OrderLine is associated with another Project.
ds
ProjectDataSet
AddProjectPO This method validates the given PONum, POLine and PORelease, then if valid, adds a ttProjectPO record. An exception is thrown if: - The given PO/Line/Rel does not exist - The given PO/Line/Rel... Parameters
1674
Name
Type
Description
piPONum
Int32
The PO number of the candidate release to Add to the Project.
piPOLine
Int32
The PO Line number of the candidate release to Add to the Project.
piPORelNum
Int32
The Release number of the candidate release to Add to the Project.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
pcWarningMsg
String@
A warning message appears here if the given release is associated with another Project.
ds
ProjectDataSet
AddProjectQuote This method validates the given PONum, POLine and PORelease, then if valid, adds a ttProjectPO record. An exception is thrown if: - The given PO/Line/Rel does not exist - The given PO/Line/Rel... Parameters Name
Type
Description
piQuoteNum
Int32
The PO number of the candidate release to Add to the Project.
piQuoteLine
Int32
The PO Line number of the candidate release to Add to the Project.
pcWarningMsg
String@
A warning message appears here if the given release is associated with another Project.
ds
ProjectDataSet
AddUpNumbers Parameters Name
Type
Description
ds
ProjectDataSet
BuildInvoicingMethodList This procedure returns the available Invoicing Methods depending if the Progress Billing license is installed or not. Parameters Name
Type
Description
opInvMethList
String@
Delimited list of available Invoicing Methods
BuildPBCloseBS Parameters Name
Type
Description
ipProjectID
String
project id
Epicor 9.05 | 9.05.605
1675
M-R
Business Object Reference Guide
Returns PBCloseBSDataSet
BuildPhaseLevels Parameters Name
Type
Description
ipProjectID
String
ipProjectID
ipPhaseID
String
ipPhaseID
BuildRetentionProcList This procedure returns the available Retention Proc Parameters Name
Type
Description
opRetentionProcList
String@
Delimited list of available Retention Proc
BuildRevenRecogDS Parameters Name
Type
Description
ipProjectID
String
ipProjectID
CalculateButton Parameters Name
Type
Description
ds
RevenRecogDataSet
CheckChangedConInvMeth Parameters Name
Type
Description
ipConInvMeth
String
ipConInvMeth
outMessage
String@
outMessage
ds
1676
Project DataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ClearAnalysis Call this method to delete or clear all ProjectAnalysis records. This method expects that the user already confirmed that records will be deleted. Parameters Name
Type
Description
ipProjectID
String
ipProjectID.
opMessage
String@
Returns message indicating process completion.
ds
ProjectDataSet
ClearApprovals Call this method to clear the Approvals Methods of children of the Phase given. Parameters Name
Type
Description
ipProjID
String
Project ID
ipPhaseID
String
Phase ID
ds
ProjectDataSet
ClearTaskSet Call this method to clear the Task Sets of children of the Phase given. Parameters Name
Type
Description
ipProjID
String
Project ID
ipPhaseID
String
Phase ID
ds
ProjectDataSet
CloseBillSched Parameters Name
Type
Description
ds
ProjectDataSet
ds1
PBCloseBSDataSet
Epicor 9.05 | 9.05.605
1677
M-R
Business Object Reference Guide
CloseProjAccruals Parameters Name
Type
ds
Description RevenRecogDataSet
CloseProject Parameters Name
Type
ds
Description ProjectDataSet
DuplicateProject To create a new Project by duplicating from another. All project Dates are amended according to the new Start Date. Parameters Name
Type
Description
sourceProjectID
String
Existing Project that will be duplicated.
targetProjectID
String
New Project ID that will be created.
targetDescription
String
Description that will be used for the new Project.
ipCreateWBSJobs
Boolean
Create WBS Phase Jobs.
targetStartDate
Nullable{System.DateTime} New Project Start Date.
outMessage
String@
Warning message.
Returns The Project DataSet
ExportToMSProject This method performs the actual Project Download to MS Project. Call this method after the user selected the Project and entered the necessary input parameters. This method returns the data table ttMSPDownload containing all appropriate project information. The resulting records from the ttMSPDownload will then need to be outputted as a CSV file (comma delimited). Parameters
1678
Name
Type
Description
ipProjectID
String
The project ID of the selected Project.
ipPctComplete
String
The Download Percent Complete code.
ipPredecessors
Boolean
Include Predecessors in the download.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
ipTasks
Boolean
Include Tasks in the download.
ipPhases
Boolean
Include Phases in the download.
ipPhaseAsTask
Boolean
Send phase as task.
ipJobs
Boolean
Include Jobs in the download.
ipJobAsm
Boolean
Include Job Assemblies in the download.
ipJobOper
Boolean
Include Job Operations in the download.
ipDuration
String
The operation duration unit (Days or Hours).
opMessage
String@
Returns message about the status of the process.
Returns
GetAvailablePersonList This method returns a double-delimited list of value-name pairs of all active Persons for the Person table. This could be used to provide a starting point for a "picker list" to maintain the Project.PersonList. Parameters Name
Type
Description
pcAvailablePersonList
String@
The double-delimited list of PersonIDs and names.
GetCurrencyBase This method returns the Base CurrencyCode Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
GetNewPhaseQuot This method adds a ProjectQuot row to the dataset. Parameters Name
Type
ds
Description ProjectDataSet
projectID
String
ProjectID.
phaseID
String
PhaseID.
GetNewProjectJob This method adds a ProjectJob row to the dataset.
Epicor 9.05 | 9.05.605
1679
M-R
Business Object Reference Guide
Parameters Name
Type
ds projectID
Description ProjectDataSet
String
ProjectID.
GetNewProjectOrderLine This method adds a ProjectOrderLine row to the dataset. Parameters Name
Type
ds projectID
Description ProjectDataSet
String
ProjectID.
GetNewProjectPO This method adds a ProjectPO row to the dataset. Parameters Name
Type
ds projectID
Description ProjectDataSet
String
ProjectID.
GetNewProjectQuot This method adds a ProjectQuot row to the dataset. Parameters Name
Type
ds projectID
Description ProjectDataSet
String
ProjectID.
GetNewWBSProjPhase This method adds a ttWBSProjPhase row to the dataset. Parameters Name
Type
ds
1680
Description ProjectDataSet
projectID
String
ProjectID.
measuredWorkID
String
MeasuredWorkID.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetPBillHistory This method gets the related PBillHistory for a ProjectID,BillSchedID. Parameters Name
Type
Description
ipProjectID
String
The ProjectID
ipBillSchedID
String
The BillSchedID.
GetPBWrkDtlHistory Gets the related Progress Billing History for a ProjectID. Parameters Name
Type
Description
ipProjectID
String
ProjectID
GetValidPhases Parameters Name
Type
Description
ipProjectID
String
ProjectID.
ipPhaseID
String
PhaseID.
opPhaseList
String@
Returns Valid Parent Phases.
ImportFromMSProject This method performs the actual Project Upload from MS Project. Call this method after the user selected the Project and entered the necessary input parameters. This method expects an input data table ttImportFromMSP with data coming from an external comma delimited file. The ttImportFromMSP table should only contain data (i.e. if the first line of the external file is just the field descriptions then this record should not be included in ttImportFromMSP.) Parameters Name
Type
Description
ipProjectID
String
The project ID of the selected Project.
ipPhases
Boolean
Indicates if Phases should be created.
ipTasks
Boolean
Indicates if Tasks should be created.
ipProjJobs
Boolean
Indicates if Project and Job links should be updated.
ipPhaseTasks
Boolean
Indicates if Phase and Task links should be updated.
ipPhaseJobs
Boolean
Indicates if Phase and Job links should be updated.
Epicor 9.05 | 9.05.605
1681
M-R
Business Object Reference Guide
Name
Type
Description
ipCrtePhsJobs
Boolean
Indicates if Jobs should be created.
ipPhaseStart
Boolean
Indicates if Phase Start Date should be updated.
ipPhaseEnd
Boolean
Indicates if Phase End Date should be updated.
ipTaskStart
Boolean
Indicates if Task Start Date should be updated.
ipTaskEnd
Boolean
Indicates if Task End Date should be updated.
ipJobStart
Boolean
Indicates if Job Start Date should be updated.
ipJobEnd
Boolean
Indicates if Job End Date should be updated.
String@
Returns message about the status of the process.
ds opMessage
OnChangeActivityStatus Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeActivityUnit This method validates the ActivityUnit. Parameters Name
Type
Description
ipActivityUnit
String
The ActivityUnit value.
ds
ProjectDataSet
OnChangeBdnSetCode Validates the given Burden Set Code. Parameters Name
Type
Description
ipBdnSetID
String
Burden Set Code.
ipProjectID
String
Project ID Code.
ds
1682
ProjectDataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangeBillSchOrderLine This method validates the given OrderNum and OrderLine, then if valid, updates the ttPBillSch dataset row. Parameters Name
Type
Description
piOrderNum
Int32
The Order number of the candidate OrderLine to Add to the Project.
piOrderLine
Int32
The Line number of the candidate OrderLine to Add to the Project.
ds
ProjectDataSet
OnChangeBillSchOrderNum This method validates the given OrderNum, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
piOrderNum
Int32
The Order number of the candidate OrderLine to Add to the Project.
ds
ProjectDataSet
OnChangeConBTCustNumCustID This method validates the given Project.ConBTCustNumCustID, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
ipConBTCustNumCustID
String
The ConBTCustNumCustID.
ds
ProjectDataSet
OnChangeConCustNumCustID This method validates the given Project.ConCustNumCustID, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
ipConCustNumCustID
String
The ConCustNumCustID.
ds
Epicor 9.05 | 9.05.605
ProjectDataSet
1683
M-R
Business Object Reference Guide
OnChangeConEndDate This method validates the given Project.ConEndDate, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
ipConEndDate
Nullable{System.DateTime}
The ConEndDate.
ds
ProjectDataSet
OnChangeConInvMeth This method validates the ConInvMeth. Parameters Name
Type
Description
ipConInvMeth
String
The ConInvMeth value.
ds
ProjectDataSet
OnChangeConListCode This method validates the ConListCode. Parameters Name
Type
Description
ipConListCode
String
The ConListCode value.
ds
ProjectDataSet
OnChangeConProjMgr This method validates the ConProjMgr. Parameters Name
Type
Description
ipConProjMgr
String
The ConProjMgr value.
ds
ProjectDataSet
OnChangeConTotValue This method validates the given Project.ConTotValue, then if valid, updates the related fields in the dataset row.
1684
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipConTotValue
Decimal
The ConProjMgr value.
ds
ProjectDataSet
OnChangeCriteriaJobAsm This method validates the ProjectCriteria fields JobNum/AsmSeq. Parameters Name
Type
Description
pcJobNum
String
The Job number of the candidate Job to Add to the Project.
piAssemblySeq
Int32
The Assembly Sequence number of the candidate Job to Add to the Project.
ds
ProjectDataSet
OnChangeCriteriaJobNum This method validates the ProjectCriteria fields JobNum. Parameters Name
Type
Description
pcJobNum
String
The Job number of the candidate Job to Add to the Project.
ds
ProjectDataSet
OnChangeCriteriaJobOpr This method validates the ProjectCriteria fields JobNum/AsmSeq/OprSeq. Parameters Name
Type
Description
pcJobNum
String
The Job number of the candidate Job to Add to the Project.
piAssemblySeq
Int32
The Assembly Sequence number of the candidate Job to Add to the Project.
piOprSeq
Int32
The Operation Sequence number of the candidate Job to Add to the Project.
ds
ProjectDataSet
OnChangeCurrencyCode This method validates the given Project.CurrencyCode, then if valid, updates the related fields in the dataset row.
Epicor 9.05 | 9.05.605
1685
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipCurrencyCode
String
The ConProjMgr value.
ds
ProjectDataSet
OnChangeDecimalValue This method validates the OnChangeDecimalValue. Parameters Name
Type
Description
ipColumnName
String
The column name value.
ipDecimal
Decimal
The decimal value.
ds
ProjectDataSet
OnChangeDtlCustQtySurveyor Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeDtlQtySurveyor Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeEstHours This method validates the given PPhaseOper.EstHours, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
ipEstHours
Decimal
The EstHours.
ds
1686
ProjectDataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangeJobNum This method validates the given JobNum, then if valid, updates the ttProjectJob dataset row. Parameters Name
Type
Description
pcJobNum
String
The Job number of the candidate Job to Add to the Project.
pcWarningMsg
String@
A warning message appears here if the given Job is associated with another Project.
ds
ProjectDataSet
OnChangeMarkupID This method validates the MarkupID field. Parameters Name
Type
Description
ipMarkupID
String
The MarkupID value.
ds
ProjectDataSet
OnChangeMilestoneComplete This method validates the complete value Parameters Name
Type
Description
pcMessage
String@
The warning message.
ds
ProjectDataSet
OnChangeMilestoneOrderLine This method validates the given OrderNum and OrderLine, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
piOrderNum
Int32
The Order number of the candidate OrderLine to Add to the Project.
piOrderLine
Int32
The Line number of the candidate OrderLine to Add to the Project.
ds
Epicor 9.05 | 9.05.605
ProjectDataSet
1687
M-R
Business Object Reference Guide
OnChangeMilestoneOrderNum This method validates the given OrderNum, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
piOrderNum
Int32
The Order number of the candidate OrderLine to Add to the Project.
ds
ProjectDataSet
OnChangeOpCode This method validates the given PPhaseOper.OpCode, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
ipOpCode
String
The OpCode.
ds
ProjectDataSet
OnChangeOrderLine This method validates the given OrderNum and OrderLine, then if valid, updates the ttProjectOrderLine dataset row. Parameters Name
Type
Description
piOrderNum
Int32
The Order number of the candidate OrderLine to Add to the Project.
piOrderLine
Int32
The Line number of the candidate OrderLine to Add to the Project.
pcWarningMsg
String@
A warning message appears here if the given OrderLine is associated with another Project.
ds
ProjectDataSet
OnChangePBillSchMgr This method validates the Mgr. Parameters Name
Type
Description
ipMgr
String
The Mgr value.
ds
1688
ProjectDataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangePBOrder Validates the given OrderNum and OrderLine Parameters Name
Type
Description
ipProjectID
String
The Project ID.
ipOrderNum
Int32
Order Number.
ipOrderLine
Int32
The Project ID.
ipValidate
Boolean
if true, validate order detail.
opAskMessage
String@
Question generated to the user.
opErrMessage
String@
A string message that indicates if there were errors.
ds
ProjectDataSet
OnChangePORelNum This method validates the given PONum, POLine and PORelease, then if valid, updates the ttProjectPO dataset row. Parameters Name
Type
Description
piPONum
Int32
The PO number of the candidate release to Add to the Project.
piPOLine
Int32
The PO Line number of the candidate release to Add to the Project.
piPORelNum
Int32
The Release number of the candidate release to Add to the Project.
pcWarningMsg
String@
A warning message appears here if the given release is associated with another Project.
ds
ProjectDataSet
OnChangePPhaseRoleCd This method validates the given PPhaseOper.RoleCd, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
ipRoleCd
String
The RoleCd.
ds
ProjectDataSet
OnChangePricePerUnit This method validates the PricePerUnit.
Epicor 9.05 | 9.05.605
1689
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipPricePerUnit
Decimal
The PricePerUnit value.
ds
ProjectDataSet
OnChangeProjectID Method to call when changing the ProjectID. Validates this is a "Add", ProjectID does not already exist Parameters Name
Type
Description
proposedProjectID
String
The proposed ProjectID value
ds
The Project data set
OnChangeProjectWFGroup Update the Project TaskSet fields according to the WF Group. Parameters Name
Type
Description
ipColChanging
String
The column name changing
ipWFGrpID
String
The value changing
ds
ProjectDataSet
OnChangeProjPhaseWFGroup Update the Project Phase TaskSet fields according to the WF Group. Parameters Name
Type
Description
ipColChanging
String
The column name changing
ipWFGrpID
String
The value changing
ds
ProjectDataSet
OnChangeQtySurveyor This method validates the QtySurveyor.
1690
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipQtySurveyor
String
The QtySurveyor value.
ds
ProjectDataSet
OnChangeQuoteLine This method validates the given QuotNum, QuotLine then if valid, updates the ttProjectQuot dataset row. Parameters Name
Type
Description
piQuoteNum
Int32
The Quote number of the candidate release to Add to the Project.
piQuoteLine
Int32
The Quote Line number of the candidate release to Add to the Project.
pcWarningMsg
String@
A warning message appears here if the given release is associated with another Project.
ds
ProjectDataSet
OnChangeRateGrpCode This method validates the given Project.RateGrpCode, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
ipRateGrpCode
String
The ConProjMgr value.
ds
ProjectDataSet
OnChangeStartDate This method validates the given Project.StartDate, then if valid, updates the related fields in the dataset row. Parameters Name
Type
Description
ipStartDate
Nullable{System.DateTime}
The StartDate.
ds
ProjectDataSet
OnChangeTotalQty This method validates the TotalQty.
Epicor 9.05 | 9.05.605
1691
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipTotalQty
Decimal
The TotalQty value.
ds
ProjectDataSet
OnSupCeilingSupplierIDChanged Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ProcessMilestones This method evaluates the ProjectCriteria for all active Projects in the current company, and sets the "complete" flag for milestones that have been met. Parameters Name
Type
Description
projectID
String
Project ID.
pcCompletedMessage
String@
Message showing a count of how many milestones were completed.
RecalcRevenRecogFieldData Parameters Name
Type
Description
ipFieldName
String
field name
ds
RevenRecogDataSet
RecognizedSave Save Recognition data before posting (in ProjCstHistory table) Parameters Name ds
1692
Type
Description RevenRecogDataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
TrackerGetByID Custom GetByID method to retrive historical data if necessary. Parameters Name
Type
Description
projectID
String
The ProjectID.
revision
Int32
The Revision.
Returns The Project DataSet
TrueUpCalcActual Hold percentages, recalculate Actual burden amounts Parameters Name
Type
Description
ipYear
Int32
Fiscal Year
ds
Project True up DataSet
TrueUpCreateInvoice Create True Up invoice according to true up amounts for each line Parameters Name
Type
Description
ouMessage
String@
Messages
ds
Project True up DataSet
TrueUpGetBdn Get dataset of Burden codes and actual amounts Parameters Name
Type
Description
ipProjectID
String
The Project ID
ouYearsList
String@
List of the years when Invoices have been generated
ValidateProjectData Validates data has been entered for Project.
Epicor 9.05 | 9.05.605
1693
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipProjectID
String
ProjectID
outShowMsg
Boolean@
Show the message to the user
outMessage
String@
Message text
ProjPhaseSearch Epicor.Mfg.BO.ProjPhaseSearch: This business object contains 7 methods.
GetNewProjPhase Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1694
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ProjSummary Epicor.Mfg.BO.ProjSummary: This business object contains 2 methods.
CalcSummaryOrdered Culculates summary orders. Parameters Name
Type
Description
curProjectID
String
Project ID
totord
Decimal@
Total Order amount
totinv
Decimal@
Total Invoice amount
totdep
Decimal@
Total Deposit amount
totstkmtl
Decimal@
Total stock material amount
totstklbr
Decimal@
Total stock labor amount
totstkbur
Decimal@
Total stock burden amount
totstksub
Decimal@
Total stock sub amount
totstkmbur
Decimal@
Total stock material burden amount
totactstk
Decimal@
Total Order active stock amount
ProjectCostsHours Calculates Project cost hours Parameters Name
Type
Description
curProjectID
String
Project ID
Epicor 9.05 | 9.05.605
1695
M-R
Business Object Reference Guide
Returns The ProjSummary data set
PropertyValueSearch Epicor.Mfg.BO.PropertyValueSearch: This business object contains 7 methods.
GetNewEFTPropVal Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1696
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PRTaxDtlSearch Epicor.Mfg.BO.PRTaxDtlSearch: This business object contains 7 methods.
GetNewPRTaxDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1697
M-R
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PRW2Dtl Epicor.Mfg.BO.PRW2Dtl: This business object contains 14 methods.
GetNewPRW2Dtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1698
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckPRW2DtlExists Checks if PRW2Dtl exists Parameters Name
Type
Description
inTaxYear
Int32
Tax Year
dataExists
Boolean@
Data Exists logical value
DeletePRW2Dtls This procedure deletes the PRW2Dtl records from the database. Parameters Name
Type
Description
taxYrFill
Int32
Tax Year
ds
The PRW2Dtl data set
ExportPRW2Dtls This procedure takes the pin code number and tax year as input parameters and returns the PRW2DtlExportDataSet. The UI person has to read the records in the data set and export it in the LineNum order. It is very important that the export order be in the line number ascending order.
Epicor 9.05 | 9.05.605
1699
M-R
Business Object Reference Guide
Parameters Name
Type
Description
pinNum
String
Pin code Number
taxYrFill
Int32
Tax Year
Returns PRW2DtlExport Dataset of candidates for export.
GetEmployeeAddress Gets Employee Adress Parameters Name
Type
Description
empID
String
Employee ID
employeeAddress
String@
Employee Address
GetEmployerAddress Gets Employer Adress Parameters Name
Type
Description
employerAddress
String@
Employer Address
GetEmployerEIN Gets Employer FIN Parameters Name
Type
Description
oEIN
String@
Employer EIN
LeaveTaxYear This procedrue must be called on leave of TaxYear field. Parameters
1700
Name
Type
Description
taxYrFill
Int32
Tax Year
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PRWrkCmp Epicor.Mfg.BO.PRWrkCmp: This business object contains 8 methods.
GetNewPRWrkCmp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1701
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
PublishedView Epicor.Mfg.BO.PublishedView: This business object contains 7 methods.
GetNewPublishedView Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1702
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
PurAgent Epicor.Mfg.BO.PurAgent: This business object contains 12 methods.
GetNewPurAgent Inserts a new row in the DataSet with defaults populated.
GetNewPurAgentAttch Inserts a new row in the DataSet with defaults populated.
GetNewPurAuth Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
1703
M-R
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetPerConData Gets the person contact information. Parameters Name
Type
Description
perConID
Int32
Person Contact ID
ds
1704
Buyer DataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangedofAuthUser Set the EnableDefaultBuyer flag Parameters Name
Type
Description
buyerID
String
Buyer for this user.
dcDUserID
String
Authorized user ID.
ds
The PurAgent data set
OnChangeIsPrimaryUser Set the EnableDefaultBuyer flag to no on all PurAuth records except for the one that meets the parameters passed in as it is the primary user. Parameters Name
Type
Description
buyerID
String
Buyer for this user.
dcDUserID
String
Authorized user ID.
ds
The PurAgent data set
PurAuthSearch Epicor.Mfg.BO.PurAuthSearch: This business object contains 8 methods.
GetNewPurAuthSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1705
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
BuyerListAuth Gets list of BuyerID according to PurAgen available for the curren User Parameters
1706
Name
Type
Description
listBuyer
String@
list Pay For
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
PurchaseAdvisor Epicor.Mfg.BO.PurchaseAdvisor: This business object contains 4 methods.
ChangePlantOnOrder Rebuild the On Order list when the plant changes. Prior to calling this procedure, the RowMod field in all ttPAOnOrder records must be set to "U" because these records need to be cleared from the table before rebuilding the list. Parameters Name
Type
ds
Description The PurchaseAdvisor data set
cPartNum
String
The part number
iPONum
Int32
The PO number
cPlant
String
The plant
ChangePlantPurchasedBefore Rebuild the Purchased Before list when the plant changes. Prior to calling this procedure, the RowMod field in all ttPAPurchasedBefore records must be set to "U" because these records need to be cleared from the table before rebuilding the list. Parameters Name
Type
ds
Description The PurchaseAdvisor data set
cPartNum
String
The part number
cPlant
String
The plant
GetPurchaseAdvisor Get the PurchaseAdvisor records from the parameters. Parameters Name
Type
Description
cPartNum
String
The Part Number
iPONum
Int32
The Purchase Order Number
cAPVType
String
The APVType for Approved Vendors
cClassID
String
The Class ID
cOpCode
String
The Op Code
iCustNum
Int32
The customer number
Epicor 9.05 | 9.05.605
1707
M-R
Business Object Reference Guide
Returns The PurchaseAdvisor data set
GetSupplierPriceList Method to call to get the dataset based on a specific part. Parameters Name
Type
Description
cPartNum
String
The Part Number to retrieve the dataset for
Returns The SupplierPriceList data set
PurMisc Epicor.Mfg.BO.PurMisc: This business object contains 14 methods.
GetNewPurMisc Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewPurMiscExpUB Inserts a new row in the DataSet with defaults populated.
GetNewPurMiscVend Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1708
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeIncomeTaxCode Performs required logic when PurMisc.IncomeTaxCode is modified.
Epicor 9.05 | 9.05.605
1709
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipIncomeTaxCode
String
Proposed input value of Income Tax Code
ds
PurMisc data set
OnEmpExpenseFlagChange Sets or clears the fields related to the EmpExpanseFlag Parameters Name
Type
Description
ipEmpExpenseFlag
Boolean
The proposed value for EmpExpenseFlag
ds
The Purchase Miscellaneous charge/credit master Data Set.
OnSupplierChange Verifies if is valid supplier. Parameters Name
Type
Description
ipSupplierID
String
The Supplier ID
ds
The Purchase Miscellaneous charge/credit master Data Set.
PurTerms Epicor.Mfg.BO.PurTerms: This business object contains 14 methods.
GetNewPurTerms Inserts a new row in the DataSet with defaults populated.
GetNewPurTermsAttch Inserts a new row in the DataSet with defaults populated.
GetNewPurTermsDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1710
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangingDisDays Parameters Name
Type
Description
vDueOnDay
Int32
Propose Discount Days
ds
Epicor 9.05 | 9.05.605
Temporary tables for PurTerms details
1711
M-R
Business Object Reference Guide
OnChangingDisPercent Parameters Name
Type
Description
vDiscountPercent
Decimal
Propose Discount Days
ds
Temporary tables for PurTerms details
OnChangingNumOfDays Parameters Name
Type
Description
vNumOfDay
Int32
Propose Discount Days
ds
Temporary tables for PurTerms details
OnChangingNumOfMonths Parameters Name
Type
Description
vNumOfMonths
Int32
Propose Discount Days
ds
Temporary tables for PurTerms details
OnChangingTermDueOnDay Parameters Name
Type
Description
pDueOnDay
Int32
Propose Discount Days
PWLocHisSearch Epicor.Mfg.BO.PWLocHisSearch: This business object contains 9 methods.
GetNewPWLocHis Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
1712
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetJobInspectionsData Retrieves Part Locations Inspections related to a Job
Epicor 9.05 | 9.05.605
1713
M-R
Business Object Reference Guide
Parameters Name
Type
Description
jobNum
String
Job Number
Returns The PWInspect data set.
GetPartInspectionsData Retrieves Part Locations Inspections related to a Part Parameters Name
Type
Description
partNum
String
Job Number
Returns The PWInspect data set.
1714
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Chapter 17: Q QMarkUp Epicor.Mfg.BO.QMarkUp: This business object contains 17 methods.
GetNewQMarkUp Inserts a new row in the DataSet with defaults populated.
GetNewQmmkup Inserts a new row in the DataSet with defaults populated.
GetNewPrjMkUp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1715
M-R
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeQMarkUpBurdenMarkUp Validate BurdenMarkUp when it is changing. Parameters Name
Type
Description
ipBurdenMarkUp
Decimal
The proposed BurdenMarkUp value
ds
The QMarkUp data set
OnChangeQMarkUpCommissionPct Validate CommissionPct when it is changing. Parameters Name
Type
Description
ipCommissionPct
Decimal
The proposed CommissionPct value
ds
The QMarkUp data set
OnChangeQMarkUpLaborMarkUp Validate LaborMarkUp when it is changing. Parameters Name
Type
Description
ipLaborMarkUp
Decimal
The proposed LaborMarkUp value
ds
1716
The QMarkUp data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangeQMarkUpMaterialMarkUp Validate MaterialMarkUp when it is changing. Parameters Name
Type
Description
ipMaterialMarkUp
Decimal
The proposed MaterialMarkUp value
ds
The QMarkUp data set
OnChangeQMarkUpMiscCostMarkUp Validate MiscCostMarkUp when it is changing. Parameters Name
Type
Description
ipMiscCostMarkUp
Decimal
The proposed MiscCostMarkUp value
ds
The QMarkUp data set
OnChangeQMarkUpMtlBurMarkUp Validate MtlBurMarkUp when it is changing. Parameters Name
Type
Description
ipMtlBurMarkUp
Decimal
The proposed MtlBurMarkUp value
ds
The QMarkUp data set
OnChangeQMarkUpSubcontractMarkUp Validate SubcontractMarkUp when it is changing. Parameters Name
Type
Description
ipSubcontractMarkUp
Decimal
The proposed SubcontractMarkUp value
ds
The QMarkUp data set
OnChangeQmmkupMaterialMarkUp Validate MaterialMarkUp when it is changing.
Epicor 9.05 | 9.05.605
1717
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipMaterialMarkUp
Decimal
The proposed MaterialMarkUp value
ds
The QMarkUp data set
QuickEntry Epicor.Mfg.BO.QuickEntry: This business object contains 21 methods.
GetNewEmpBasic Inserts a new row in the DataSet with defaults populated.
GetNewQuickEntryExpense Inserts a new row in the DataSet with defaults populated.
GetNewQuickEntryTime Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
1718
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
OnChangeIndirectCode Method to call when changing the Indirect Code Parameters Name
Type
Description
proposedIndirectCode
String
The proposed Indirect Code
ds
The QuickEntry data set
OnChangeLaborType Method to call when changing the Labor Type
Epicor 9.05 | 9.05.605
1719
M-R
Business Object Reference Guide
Parameters Name
Type
Description
proposedLaborType
String
The proposed Labor Type
ds
The QuickEntry data set
OnChangeMiscCode Method to call when changing the Miscellaneous Code. Parameters Name
Type
Description
proposedMiscCode
String
The proposed miscellaneous code
ds
The QuickEntry data set
OnChangeOprSeq Method to call when changing the Operation Sequence Parameters Name
Type
Description
proposedOprSeq
Int32
The proposed Operation Sequence
ds
The QuickEntry data set
OnChangePaymentMethod Method to call when changing the Payment Method. Parameters Name
Type
Description
proposedPMUID
Int32
The proposed pay method id
ds
The QuickEntry data set
OnChangePhaseID Method to call when changing the Phase ID. Parameters Name
Type
Description
proposedPhaseID
String
The proposed phase ID
ds
1720
The QuickEntry data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangeProjectID Method to call when changing the Project ID. Parameters Name
Type
Description
proposedProjectID
String
The proposed project ID
ds
The QuickEntry data set
OnChangeRoleCd This method defaults dataset fields when the RoleCd field changes. Parameters Name
Type
Description
ds ipRoleCd
The QuickEntry data set String
Proposed RoleCd change
BuildRoleCodeWhereClause Returns a where clause to filter the Role Codes. Parameters Name
Type
iEmpID
String
iProjID
String
iJobNum
String
iAssSeq
Int32
iOprSeq
Int32
Description
Returns
EmployeeExists A public method to test if a given Employee ID already exists in the EmpBasic table. Return True if it exists else returns False. Parameters Name
Type
empID
String
Epicor 9.05 | 9.05.605
Description
1721
M-R
Business Object Reference Guide
Returns
IsEmpAuthToBookTime Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
QuickEntrySearch Epicor.Mfg.BO.QuickEntrySearch: This business object contains 7 methods.
GetNewQuickEntry Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1722
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
QuickJobEntry Epicor.Mfg.BO.QuickJobEntry: This business object contains 14 methods.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
Epicor 9.05 | 9.05.605
1723
M-R
Business Object Reference Guide
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeQuickJobEngineered This method validates the QuickJob.Engineered and potentially changes the Released field. This method should run when the QuickJob.Engineered field changes. Parameters Name
Type
ds
Description The QuickJobEntry data set
ChangeQuickJobFirm This method validates the QuickJob.Firm and potentially changes the Released and Engineered fields. This method should run when the QuickJob.Firm field changes. Parameters Name
Type
ds
Description The QuickJobEntry data set
ChangeQuickJobPartNum This method validates the QuickJob.PartNum and defaults fields associated with the partnum. This method should run when the QuickJob.PartNum field changes.
1724
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds uomCode
Description The QuickJobEntry data set
String
UOM Code (only used for Product Codes)
ChangeQuickJobReleased This method validates the QuickJob.Released and potentially changes the firm and engineered fields. This method should run when the QuickJob.Released field changes. Parameters Name
Type
ds
Description The QuickJobEntry data set
ChangeQuickJobWarehouseCode This method validates the QuickJob.WarehouseCode and defaults warehousedesc field associated with the warehousecode. This method should run when the QuickJob.WarehouseCode field changes. Parameters Name
Type
ds
Description The QuickJobEntry data set
GenerateJob Generate the job. Parameters Name
Type
ds cMessageText
Description The QuickJobEntry data set
String@
Contains non-error processing information the user may need to see
This method is the first thing that should be ran. It creates a ttQuickJob record in the dataset that we will use to collect user inputs for this Quick Job Entry process. This method creates the record and assigns the next job number, date, firm, released,engineered,and legal number fields and returns the dataset with the one record. This dataset is not a database dataset, it is a temporary dataset with the only record ever in the dataset is the one that you create here. Returns The QuickJobEntry data set
Epicor 9.05 | 9.05.605
1725
M-R
Business Object Reference Guide
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
uomCode
String@
UOM Code (only used for Product Codes)
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
PreGenerateJob This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds requiresUserInput
Description The QuickJobEntry data set
Boolean@
Indicates if the legal number requires user input
QuickSearch Epicor.Mfg.BO.QuickSearch: This business object contains 20 methods.
GetNewQuickSearch Inserts a new row in the DataSet with defaults populated.
GetNewQuickSearchCriteria Inserts a new row in the DataSet with defaults populated.
GetNewQuickSearchValueList Inserts a new row in the DataSet with defaults populated.
1726
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1727
M-R
Business Object Reference Guide
BAQExists This method returns a list of quick searches for this user Parameters Name
Type
Description
pcGlbComp
String
The ID of the global company
pcQuickSearchID
String
The ID of the quick search
pbExists
Boolean@
Returns true if the BAQ in this quick search exists
BAQsExist This method returns a dataset of quick searches indicating if a BAQ exists for each Quick Search Parameters Name
Type
Description
pcGlbComp
String
The ID of the global company
ds
Returns the list of Quick Searches
CopyQuickSearch This method copies a quick search Parameters Name
Type
Description
pcSourceQuickSearchID
String
The ID of source quick search
pcTargetQuickSearchID
String
The ID of target quick search
pbSucceeded
Boolean@
Returns true if copy operation is successful
GetBaseDefault This method returns a quick search dataset with the given like field and call from name. Parameters
1728
Name
Type
Description
pcLikeField
String
The Like Field
pcCallFrom
String
The name of the call from
pcBaseSearchID
String@
Returns the quick search ID which is the BaseDefault
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetContextDefault This method returns a quick search dataset with the given like field and call from name. Parameters Name
Type
Description
pcLikeField
String
The Like Field
pcCallFrom
String
The name of the call from
pcContextSearchID
String@
Returns the quick search ID which is the ContextDefault
GetLikeFieldSearches This method returns a list of quick searches for a like field A like field has a format of table.field Parameters Name
Type
Description
pcLikeField
String
The name of the like field
Returns Returns the list of Quick Searches
GetListForBAQ This method returns a list of quick searches that use a given BAQ Parameters Name
Type
Description
pcBAQID
String
The BAQ ID
Returns The returned list This method returns a list of quick searches for this user Returns Returns the list of Quick Searches
GetVersion This method returns the version code of a quick searches Parameters Name
Type
Description
pcGlbComp
String
The ID of the global company
Epicor 9.05 | 9.05.605
1729
M-R
Business Object Reference Guide
Name
Type
Description
pcQuickSearchID
String
The ID of the quick search
pcVersion
String@
Returns the version code
RunQuickSearch This method runs a quick search based on a QuickSearchDataSet. Parameters Name
Type
ds
Description The dataset represents a QuickSearch
Returns Returns the result dataset
RunQuickSearchPaged This method runs a quick search based on a QuickSearchDataSet. Parameters Name
Type
ds
Description The dataset represents a QuickSearch
piPageSize
Int32
The size of page
pbMorePage
Boolean@
Flag indicating if there are more pages
Returns Returns the result dataset
Quote Epicor.Mfg.BO.Quote: This business object contains 109 methods.
GetNewQuoteHed Inserts a new row in the DataSet with defaults populated.
GetNewQuoteHedAttch Inserts a new row in the DataSet with defaults populated.
GetNewQSalesRP Inserts a new row in the DataSet with defaults populated.
GetNewQuoteCnt Inserts a new row in the DataSet with defaults populated.
1730
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetNewQuoteCom Inserts a new row in the DataSet with defaults populated.
GetNewQuoteDtl Inserts a new row in the DataSet with defaults populated.
GetNewQuoteDtlAttch Inserts a new row in the DataSet with defaults populated.
GetNewQuoteMsc Inserts a new row in the DataSet with defaults populated.
GetNewQuoteQty Inserts a new row in the DataSet with defaults populated.
GetNewQtmmkup Inserts a new row in the DataSet with defaults populated.
GetNewQtQtyMsc Inserts a new row in the DataSet with defaults populated.
GetNewPartSubs Inserts a new row in the DataSet with defaults populated.
GetNewQuoteHedMsc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1731
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
1732
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK
Epicor 9.05 | 9.05.605
1733
M-R
Business Object Reference Guide
• QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
This method exists soley for the purpose of allowing security for unchecking the Ready To Quote flag to be defined
ApplyOrderBasedDiscount This method applys the OrderBased Discount logic Parameters Name
Type
Description
quoteNum
Int32
The current QuoteHed.QuoteNum field
Returns Returns the updated dataset
CalcMaterialMarkup Each part class can have its own material markup percentage This method calculates the Material Markup from the Qtmmkup table Parameters Name
Type
Description
quoteNum
Int32
Quote Num
quoteLine
Int32
Quote Line
qtyNum
Int32
Quote Qty Number
ds
Returns the updated dataset
ChangeDiscBreakListCode Change the DiscBreakListCode Parameters Name ds
Type
Description The Quote data set
ChangeDtlContractNum Method to call when changing the ContractNum field in the Quote Line record. Updates the QuoteDtl with values based on the new ContractNum.
1734
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipContractNum
Int32
Proposed Contract Number
ds
The Quote data set
ChangeDtlRenewalNbr Method to call when changing the RenewalNbr field in the Quote Line record. Updates the QuoteDtl with values based on the new RenewalNbr. Parameters Name
Type
Description
ipRenewalNbr
Int32
Proposed Renewal Number
ds
The Quote data set
ChangeKitPricing Recalculates the parent line's unit price when the kit pricing is set to "P", if the kit pricing is set to "C" the price will be calculated on the AfterUpdate procedure. Parameters Name
Type
ds
Description Quote DataSet
ChangeKitQtyPer Used to recalculate the OrderQty of the component kit line using the parent's OrderQuantity Parameters Name
Type
ds
Description Quote DataSet
ChangeMiscPercent This method recalculates Misc Charges Amounts when Percentage was changed. Parameters Name
Type
ds tableName
Epicor 9.05 | 9.05.605
Description Returns the updated dataset
String
name of table being passed in
1735
M-R
Business Object Reference Guide
ChangeOrderQty Gets the proposed OrderQty and if the current OrderDtl record is a sales kit then it recalculates the order qty of each component based on the proposed OrderQty amount Parameters Name
Type
Description
ds
Quote dataset to get the dirty OrderDtl and update its components
ChangeOverrideDiscPriceList Rerun the price break calculation if the override price list flag is changed from true to false. Parameters Name
Type
ds
Description The Quote data set
ChangePartNum Update Quote Detail information when the Part Number is changed. Parameters Name
Type
ds
Description Quote dataset
uomCode
String
UOM Code (only used for Product Codes)
ChangeQuoteCntCustID This method takes in a proposed CustID, and if valid, updates the customer- related fields on the QuoteCnt. Parameters Name
Type
Description
pcCustID
String
Proposed Customer ID
ds
Quote DataSet
ChangeQuoteHedUseOTS Method to call when changing the UseOTS field. Refreshes the address list Parameters Name ds
1736
Type
Description The Service Contract data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangeRevisionNum Get the defaults from the RevisionNum field on the QuoteDtl record. Parameters Name
Type
ds
Description Quote data set
proposedRevisionNum
String
The proposed RevisionNum
ChangeSellingExpQty Parameters Name
Type
ds
Description Quote DataSet
ChangeShipToCustID Update Ship To Information when Ship To is changed Parameters Name
Type
Description
iShipToCustID
String
Ship To Customer ID
ds
Quote dataset
ChangeStandardPct This method updates the QuoteQty markup percents and the Qtmmkup table using the specified markup record Parameters Name
Type
Description
markupId
String
Standard Percent Markup Id
quoteNum
Int32
Quote Number
quoteLine
Int32
Quote Line
qtyNum
Int32
Quote Quantity Number
ds
Returns the updated dataset
CheckBOMErrors This method runs through a quote's BOM and returns a list of assembly and/or materials that are on hold or inactive. Quote Line cannot be engineered or QuoteHed cannot be Quoted until these errors are taken care of
Epicor 9.05 | 9.05.605
1737
M-R
Business Object Reference Guide
Parameters Name
Type
Description
quoteNum
Int32
Quote Number
quoteLine
Int32
QuoteLine, 0 for all lines, otherwise only looks a specific line
errorList
String@
contains the Run Out warning messages
CheckCustomerCreditLimit The method returns a character string if the customer will go over their credit limit and the user is given the choice of continuing or not. Parameters Name
Type
Description
ds
QuoteDataSet
cCreditLimitMessage
String@
The over credit limit message text
CheckPhaseID The method review if phaseid is availble in ProjPhase Table Parameters Name
Type
Description
ipProjectID
String
Project ID
ipPhaseID
String
Phase ID
CheckPreCustPartInfo The method is to be run on leave of the CustPartNum field before the GetCustPartInfo or Update methods are run. In case existance of CustomerPart it returns Part Number which belongs this CustomerPart. Parameters Name
Type
Description
xPartNum
String
The new Customenr Part Number
custNum
Int32
The current QuoteHed.CustNum
partNum
String@
The new Part Num for this Customer Part
CheckPrePartInfo The method is to be run on leave of the PartNum, Revision and CustPartNum fields before the GetCustPartInfo or Update methods are run. This returns all the questions that need to be asked before a part can be changed.
1738
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
quoteNum
Int32
The current QuoteHed.QuoteNum field
quoteLine
Int32
The current QuoteDtl.QuoteLine field
fieldName
String
The name of the field you are leaving
partNum
String@
The new PartNum if a substitute part is found, partNum will be the substitute part
vMessage
String@
If the part is configured, asks if it's okay to delete the configuration inputs No means the part cannot be changed
vBMessage
String@
Asks if you want to refresh the QuoteQty records. The answer will be stored in QuoteDtl.RefreshQty
vPMessage
String@
Asks if the user wants to use a substitute part
vSubAvail
Boolean@
Indicates other substitute parts besides the default exist
vMsgType
String@
Indicates what type of message vPMessage is
CheckProjectID The method review if projectid is availble in Project Table Parameters Name
Type
Description
ipProjectID
String
Project ID
CheckQuoteNum This method will check if the quote number entered is valid. If the quote number that's entered doesn't already exist and the number entered is greater than the number defined as the starting quote number in company maintenance, then the quote number is invalid. Parameters Name
Type
Description
quoteNum
Int32
Quote Number
CheckQuoteSecurity Parameters Name
Type
Description
ipquoteNum
Int32
The current QuoteHed.QuoteNum field
Epicor 9.05 | 9.05.605
1739
M-R
Business Object Reference Guide
CheckRateGrpCode Update Quote Detail information when the Part Number is changed. Parameters Name
Type
Description
ipRateGrpCode
String
Currency Rate Group Code
ds
Quote dataset
CopyLines This method copies lines from other Quotes to the current Quote Parameters Name
Type
Description
targetQuoteNum
Int32
The Quote to write the lines to
sourceQuoteLines
String
A delimited list of quote lines to be copied. Format QuoteNum tick QuoteLine tilde QuoteNum tick QuoteLine
mtlCosts
Boolean
Indicates if Material/Operation Costs should be refreshed
opStds
Boolean
Indicates if Operation Standards should be refreshed
vMessage
String@
Output list of lines that could not be copied
Returns returns the new lines
CreateOrder This method takes the specified QuoteDtl lines and creates a Sales Order Parameters Name
Type
ds orderNum
Description QuoteDataSet
Int32@
New Order Number
CreateOrderSaveOTS This method takes the specified QuoteDtl lines and creates a Sales Order after saving the One Time Ship To as Customer. Parameters Name ds
1740
Type
Description SaveQuoteOTSParamsDataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
M-R
Type
ds1 orderNum
Description QuoteDataSet
Int32@
New Order Number
CreateQuoteDtlComplements Create new lines for every complement selected for a given Line, Parameters Name
Type
Description
iQuoteNum
Int32
The Quote Number
ds
The Quote data set
DefaultOrderFields This method takes the Quote and initializes the fields used during CreateOrder. The user will then update the Quote dataset and then call the CreateOrder method to actually create the order. Parameters Name
Type
Description
quoteNum
Int32
Quote Number
creditMessage
String@
If the Customer is on credit hold, this will warn the user before the order can be created
Returns
DuplicateQuote This method creates a new Quote from an existing quote Parameters Name
Type
Description
sourceQuote
Int32
The Quote to duplicate
sourceLines
String
List of lines from the source Quote to be copied. If blank all lines will be copied Format:QuoteLine~QuoteLine
mtlCosts
Boolean
Indicates if Material/Operation Costs should be refreshed
opStds
Boolean
Indicates if Operation Standards should be refreshed
Returns Returns the new Quote
ETCValidateAddress Call tax integration and loads temp tables from the results.
Epicor 9.05 | 9.05.605
1741
M-R
Business Object Reference Guide
Parameters Name
Type
Description
quoteNum
Int32
QuoteHed.QuoteNum
quoteLine
Int32
QuoteDtl.QuoteLine
statusFlag
Boolean@
Set to true if the integration is up, false if down.
errorFlag
Boolean@
If true, an error occured.
errorMsg
String@
If Error Flag is true, this is the associated message.
Returns The ETCAddrValidation data set
exportQuoteToEST Exports quotation for the Estimating System. Parameters Name
Type
Description
quoteNum
Int32
Quote Number
GetCompetitorInfo This method returns default information for the competitor. Method must use parameters instead of the dataset due to the problem with changing the primary key field Parameters Name
Type
Description
quoteNum
Int32
QuoteNum of the QuoteCom record
compNum
Int32
Competitor Number of the QuoteCom record
name
String@
Returns the Competitor Name
faxNum
String@
Returns the Competitor Fax#
phoneNum
String@
Returns the Competitor Phone#
emailAddress
String@
Returns the Competitor Email Address
compURL
String@
Returns the Competitor Web Site Address
GetContactInfo This method returns default information for the Contact. Method must use parameters instead of the dataset due to the problem with changing the primary key field
1742
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
quoteNum
Int32
QuoteNum of the QuoteCom record
custNum
Int32
Customr Number of the QuoteCom record
shipToNum
String
ShipTo Number of the QuoteCom record
conNum
Int32
Contact Number of the QuoteCom record
name
String@
Returns the Contact Name
func
String@
Returns the Contact fucntion
phoneNum
String@
Returns the Contact Phone#
fax
String@
Returns the Contact Fax#
emailAddress
String@
Returns the Contact Email Address
GetCurrencyBase This method returns the Base CurrencyCode Parameters Name
Type
Description
opCurrencyBase
String@
Base Currency
GetCustomerInfo This method returns default information for the Customer. Parameters Name
Type
ds
Description The Quote data set
GetCustPartInfo Defaults Part Information when the Customer Part Number changes MUST RUN UPDATE AFTER THIS METHOD Parameters Name ds
Type
Description The Quote data set
GetDtlUnitPriceInfo This method updates the QuoteDtl unit price and revenue fields when the SellingExpextedQty changes
Epicor 9.05 | 9.05.605
1743
M-R
Business Object Reference Guide
Parameters Name
Type
Description
skipDiscLookup
Boolean
Skip lookup of DiscPercent
preserveAmt
Boolean
Preserve the DiscountAmt
ds
The Quote data set
GetExchangeRate This method returns the Exchange Rate information for the selected Currency. The system may not have an exchange rate between the Quote and Base so it may use an middle Currency so that it will go Quote Currency -> Ref Currency -> Base Currency Parameters Name
Type
Description
vCurrencyCode
String
Currency selected for the Quote
vRateGrpCode
String
Currency Rate Group selected for the quote
vExchangeRate
Decimal@
Current exchange rate between the Quote currency and the Ref Currency
vXRateLabel
String@
Label for the Exchange Rate field
GetKitComponents Calls GetKitComponents from SalesKitting.p, which creates a list of OrderDtl records that will be treated as kit components of the given OrderLine. Parameters Name
Type
Description
iPartNum
String
Part Number of the given QuoteLine
iRevisionNum
String
Revision Number selected for the given PartNum
iAltMethod
String
Aletrnate Method of the given Part number
iTargetAsm
Int32
Target assembly to be exploded (usually asm 0)
quoteNum
Int32
Quote number to be exploded
quoteLine
Int32
Quote line which will be the Kit Parent
iUseMethodForParts
Boolean
-
regenerateKit
Boolean
If TRUE then it will delete all components before getting them again
errorMsg
String@
Input-Output parameter that will hold the error messages in case something went wrong
ds
1744
Quote DataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetListCustom This overload of GetList adds Quotes which ShipTo's fall within authorized territories. Parameters Name
Type
Description
whereClause
String
The search criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
customClause
String
Custom WhereClause
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of Quotes
GetListFromSelectedKeys This methods will return all of the Quote records which will be a subset of the QuoteHEd records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method. Parameters Name
Type
Description
ds
The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
GetMaterialMarkup This procedure is used to be called from EQR10.p to get the MaterialMarkupP and MaterialMarkupM fields since these two fields are external and they're needed to be displayed on the report. Parameters Name
Type
Description
quoteNum
Int32
Quote Num
quoteLine
Int32
Quote Line
qtyNum
Int32
Quote Qty Number
mtlMarkupP
Decimal@
The MarkupP
mtlMarkupM
Decimal@
The MarkupM
Epicor 9.05 | 9.05.605
1745
M-R
Business Object Reference Guide
GetMiscChrgDefaults This method returns default information for the MiscChrg. Method must use parameters instead of the dataset due to the problem with changing the primary key field as well as QuoteMsc and QtQtyMsc can the same code Parameters Name
Type
ds tableName
Description Returns the updated dataset
String
name of table being passed in
GetMktgInfo This method updates the description fields for the Marketing Campaign and Event fields Parameters Name
Type
ds
Description Returns the updated dataset
GetNewContractQuoteDtl Method to call when adding a new QuoteDtl record for a Service Contract or a Renewal Parameters Name
Type
ds
Description The Quote data set
ipQuoteNum
Int32
The quote number to add the line to
GetNewSalesKit Created a new QuoteDtl and sets it as a kit component for the given QuoteLine Parameters Name
Type
Description
quoteNum
Int32
Quote number where the Kit Parent resides
quoteLine
Int32
Quote line that has the SalesKit and to which the kit component will be added
ds
Quote Dataset with the new QuoteDtl record as a Sales Kit
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes
1746
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
uomCode
String@
UOM Code (only used for Product Codes)
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetPhantomComponents This procedure will explode the BOM of a part set as Phantom Parameters Name
Type
Description
phPartNum
String
The phantom part number
quoteNum
Int32
Quote number where the lines will be saved
quoteLine
Int32
Quote line of the parent line
errMessage
String@
Returns any error messages found during the process
ds
Quote DataSet
GetPriceListInfo Finds the default pricelist if override field is blank updates the QuoteDtl record with the new pricebreak information called when OverridePriceList, BreakListCode or ProdCode fields change Parameters Name
Type
refreshQty ds
Description Indicate if the app needs to refresh the Quantity Breaks
Boolean
Returns the updated dataset
Returns list of Project Roles
GetQtyPriceInfo This method updates the unitprice information when the QuoteQty SellingQty has changed
Epicor 9.05 | 9.05.605
1747
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds hasPriceBreak
Returns the updated dataset Boolean@
Indicates if there is a price break
GetQtyPriceInfoCfgPart This method updates the unitprice information when the QuoteQty SellingQty has changed Parameters Name
Type
Description
ds hasPriceBreak
Returns the updated dataset Boolean@
Indicates if there is a price break
GetQtyToOrdPrice This method takes the QuantityToOrder field and returns the base and doc unit price Parameters Name
Type
Description
quoteNum
Int32
Quote Number
quoteLine
Int32
Quote Line
quantityToOrder
Decimal
Quantity used to create order
sellingUM
String
Selling UM
orderUnitPrice
Decimal@
Base Expected Unit Price
docOrderUnitPrice
Decimal@
Document Expected Unit Price
GetQuotedInfo Updates the DateQuoted,ExpirationDate and FollowUpDate fields based on the Quoted field Parameters Name ds
Type
Description Returns the updated dataset
GetReasonInfo This method returns default reason code for the specified ReasonType. Run when the reasonType field has changed.
1748
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
vReasonType
String
ReasonType of the Quote (Win, Task)
vQuoteNum
Int32
Unique key of the Quote
vOrdered
Boolean
Flag indicating if an order has been created from the quote
vReasonCode
String@
Default ReasonCode for the Quote Task/ReasonType
GetRowsCustomerTracker Calls the normal GetRows method and then constructs a custom data set combining Hed/Dtl fields for the customer tracker. Parameters Name
Type
Description
whereClauseQuoteHed
String
Whereclause for QuoteHed table.
whereClauseQuoteHedAttch
String
Whereclause for QuoteHedAttch table.
whereClauseQSalesRP
String
Whereclause for QSalesRP table.
whereClauseQuoteCnt
String
Whereclause for QuoteCnt table.
whereClauseQuoteCom
String
Whereclause for QuoteCom table.
whereClauseQuoteDtl
String
Whereclause for QuoteDtl table.
whereClauseQuoteDtlAttch
String
Whereclause for QuoteDtlAt table.
whereClauseQuoteMsc
String
Whereclause for QuoteMsc table.
whereClauseQuoteHedMsc
String
Whereclause for QuoteHedMsc table.
whereClauseQuoteQty
String
Whereclause for QuoteQty table.
whereClauseQtmmkup
String
Whereclause for Qtmmkup table.
whereClauseQtQtyMsc
String
Whereclause for QtQtyMsc table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.QuoteCustTrkDataSet
GetRowsFromSelectedKeys This methods will return all of the Quote records which will be a subset of the QuoteHEd records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method.
Epicor 9.05 | 9.05.605
1749
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
GetSalesRepInfo This method returns default commision information when the SalesRepCode or RoleCode field(s) change. Method must use parameters instead of the dataset due to the problem changing the primary key field Parameters Name
Type
Description
defaultRoleCode
Boolean
Indicates whether to default the RoleCode from the SalesRep
quoteNum
Int32
QuoteNum of the QSalesRP record
salesRepCode
String
Salesperson of the QSalesRP record
roleCode
String@
RoleCode of the QSalesRP record, if defaultRoleCode is checked, then a different value may be returned
name
String@
Returns the SalesRep Name
repRate
Decimal@
Returns the Commission Rate
repSplit
Int32@
Returns the Commission Split flag
officePhone
String@
Returns the SalesRep Office#
homePhone
String@
Returns the SalesRep Home#
reportsTo
String@
Returns the SalesRep Manager
emailAddress
String@
Returns the SalesREp Email Address
fax
String@
Returns the SalesRep Fax#
mobilePhone
String@
Returns the SalesRep Cell#
salesRepTitle
String@
Returns the SalesRep Title
roleCodeRoleDescription
String@
Returns the Role Code Description
GetSearchRows This method is to be used in searches only. It returns only partial information on the QuoteHed, QuoteDtl, and QSalesRP tables. Parameters
1750
Name
Type
Description
whereClauseQuoteHed
String
Whereclause for QuoteHed table.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
whereClauseQSalesRP
String
Whereclause for QSalesRP table.
whereClauseQuoteDtl
String
Whereclause for QuoteDtl table.
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Returns The dataset with pupolated key values
GetShipToInfo This method updates the ShipTo information when the ShipToNum field changes Parameters Name
Type
ds
Description Quote DataSet
GetSmartString Parameters Name
Type
Description
quoteNum
Int32
Kit component quote number
quoteLine
Int32
Kit component quote line
partNum
String
The part being configured
revisionNum
String
The revision being configured
smartString
String@
The generated smartstring of the configuration
createPart
Boolean@
True if a new part should be created
promptForPartNum
Boolean@
True if the user should be prompted for the part number
notifyOfExistingPart
Boolean@
If true the user should be warned if the new part number already exists
newPartNum
String@
The generated portion of the new part number
createCustPart
Boolean@
If true the user should be asked if they want the Customer Part Number assigned
promptForCustPartNum
Boolean@
If true the user should be prompted to update the new Customer Part Number
newCustPartNum
String@
The generated customer part number
promptForAutoCreatePart
Boolean@
True if the user should be prompted to create part
Epicor 9.05 | 9.05.605
1751
M-R
Business Object Reference Guide
GetTaskSetInfo This method updates the QuoteHed.Stage field when the TaskSetId is changed Parameters Name
Type
ds
Description The updated dataset
GetTerrInfo This method returns the TaskSetId when the territory ID changes Parameters Name
Type
Description
vQuoteNum
Int32
The current QuoteHed.QuoteNum field
vTerritoryID
String
The QuoteHed.TerritoryID
vActiveTaskID
String
The QuoteHed.ActiveTaskID
vTaskSetId
String@
Returns the correct TaskSet for the Territory
GetWSUnitPrice This method updates the Base and Doc Unit Prices when the Quoted Unit Price or Price Per Code changes on the Quote Worksheet form Parameters Name
Type
ds
Description The updated dataset
KitCompPartCreate Parameters
1752
Name
Type
Description
quoteNum
Int32
Kit component quote number
quoteLine
Int32
Kit component quote line
partNum
String
The part being configured
revisionNum
String
The revision being configured
smartString
String
The generated smartstring of the configuration
newPartNum
String
The Part Number to be used for a new part creation. If blank, a part will not be created.
newCustPartNum
String
The Customer Part Number to stored on the quote line.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
responseAutoCrtPart
Boolean
Answer to the question presented to user about auto creating a part.
newPartAlreadyExists
Boolean@
Returns true a new part was not created because it already exists.
OnChangeMktgCamp Call this method when the value of MktgCamp changes. Parameters Name
Type
Description
mktgCampID
String
The CampID
ds
The updated dataset
OnChangeMktgEvnt Call this method when the value of MktgCamp changes. Parameters Name
Type
Description
mktgEvntSeq
Int32
The EvntSeq
ds
The updated dataset
OnChangeofBTCustID This method returns the Bill To customer info. Parameters Name
Type
Description
newBillToCustID
String
Proposed bill to custid
ds
The Quote data set
OnChangeofEngineered This method Check the number of reference designators are equal to the Required Ref Designators defined on JobMtl Parameters Name
Type
Description
newReadyToQuote
Boolean
Proposed ReadyToQuote
ds
Epicor 9.05 | 9.05.605
The Quote data set
1753
M-R
Business Object Reference Guide
OpenCloseQuote This method either opens or closes a Quote and returns the updated object Parameters Name
Type
Description
quoteNum
Int32
QuoteNum to be opened or closed
closeQuote
Boolean
Yes to close Quote, no to open Quote
Returns Returns the newly opened/closed Quote
PreOpenCloseQuote This method is to be run befor the OpenCloseQuote method so that any questions that need to be asked before the OpenCloseQuote method can run can be asked Parameters Name
Type
Description
quoteNum
Int32
The current QuoteHed.QuoteNum field
closeQuote
Boolean
Yes to close Quote, no to open Quote
vMessage
String@
Returns a string containing the question to be asked
PreRefreshQty Procedure to find if the app needs to ask the user to refresh the Quantity Breaks. Parameters Name
Type
Description
strquestion
String@
Returns the Question string
RecalcKitPriceAfterConfig When configuring a part, the QuoteDtl unit price may change during the configuration process. This method is to be called after running product configurator to recalculate the kit pricing. Parameters
1754
Name
Type
Description
iQuoteNum
Int32
Quote Number for configured part
iQuoteLine
Int32
Quote Line for configured part
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
recalcKitPricing This procedure is used to recalculate the unit price of the kit parent and the parent Quote Qty record if the KitPricing field is set to 'C' then the procedure will add the unit price of each component and the total value will be the unit price of the kit parent line.
RecalcWorksheet Each part class can have its own material markup percentage This method calculates the Material Markup from the Qtmmkup table Parameters Name
Type
Description
quoteNum
Int32
Quote Num
quoteLine
Int32
Quote Line
qtyNum
Int32
Quote Qty Number
ds
The Quote dataset
RemoveKitComponents To delete the QuoteDtl records created as components for a Parent Sales Kit. Parameters Name
Type
Description
iPartNum
String
Parent Sales Kit number
quoteNum
Int32
Quote number of the QuoteDtl record (0 if an Order is being processed)
quoteLine
Int32
Quote Line of the QuoteDtl record (0 if an Order is being processed
ds
Quote DataSet
SetOrderDefaults This method updates Order Defaults. Parameters Name
Type
Description
quoteNum
Int32
The current QuoteHed.QuoteNum field
setReqShipDt
Boolean
Yes to set the QuoteDtl.ReqShipDate to the specified date
setOrdQty
Boolean
Yes to set the Order Qty equal to the Expected Qty
reqShipDate
Nullable{System.DateTime}
Requested Ship Date
Epicor 9.05 | 9.05.605
1755
M-R
Business Object Reference Guide
Returns Updated Quote
ValReqRefDes Public method to call ValidateReqRefDes method and check the number of reference designators are equal to the Required Ref Designators defined on QuoteMtl. Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number to validate
ipQuoteLine
Int32
Quote Line of the Quote Number to validate
WhatIfGetDate Set a default date for scheduling starting from Today Parameters Name
Type
Description
schedDate
Nullable{System.DateTime}@
The calculated start date for scheduling
WhatIfScheduling This method runs the whatif Scheduling code. Parameters Name
Type
Description
quoteNum
Int32
The current QuoteHed.QuoteNum field
quoteLine
Int32
The QuoteLine to schedule
prodQty
Decimal
Production Qty to schedule
schedDate
Nullable{System.DateTime}
Schedule Start date
schedFinite
Boolean
Schedule Finitely flag
considerLeadTime
Boolean
Consider Material Lead Times flag
completionDate
Nullable{System.DateTime}@
Returns the schedule completion date
QuoteAdt Epicor.Mfg.BO.QuoteAdt: This business object contains 7 methods.
GetNewQuoteAdt Inserts a new row in the DataSet with defaults populated.
1756
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1757
M-R
Business Object Reference Guide
QuoteAnalysisExp Epicor.Mfg.BO.QuoteAnalysisExp: This business object contains 4 methods.
BuildAnalysis Call this method when the user already selected quote lines to process. This method expects a LIST-DELIM delimited string of RowIds of all selected QuoteDtl records. Parameters Name
Type
Description
vRowList
String
A RowId list of selected QuoteDtl records.
vMessage
String@
Returns message indicating number of records processed.
ClearAllAnalysis Call this method to delete or clear all QuoteAnalysis records. This method expects that the user already confirmed that records will be deleted. Parameters Name
Type
Description
vMessage
String@
Returns message indicating process completion.
GetByQuoteLine This method finds the QuoteDtl record by QuoteNum/QuoteLine. Parameters Name
Type
Description
ipQuoteNum
Int32
The Quote Number
ipQuoteLine
Int32
The Quote Line Number
Returns Returns Epicor.Mfg.BO.QuoteAnalysisExpDataSet
GetQuoteDtlBrw This method assembles the QuoteDtl browse for the main data set. Parameters
1758
Name
Type
Description
whereClauseQuoteDtl
String
Where clause to specify set of QuoteDtlBrw records to return
pageSize
Int32
Page Size
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages
Returns Returns Epicor.Mfg.BO.QuoteAnalysisExpDataSet
QuoteAsm Epicor.Mfg.BO.QuoteAsm: This business object contains 95 methods.
GetNewQuoteAsm Inserts a new row in the DataSet with defaults populated.
GetNewQuoteAsmAttch Inserts a new row in the DataSet with defaults populated.
GetNewQuoteAsmInsp Inserts a new row in the DataSet with defaults populated.
GetNewQuoteMtl Inserts a new row in the DataSet with defaults populated.
GetNewQuoteMtlInsp Inserts a new row in the DataSet with defaults populated.
GetNewQuoteMtlRefDes Inserts a new row in the DataSet with defaults populated.
GetNewQuoteOpr Inserts a new row in the DataSet with defaults populated.
GetNewQuoteOprInsp Inserts a new row in the DataSet with defaults populated.
GetNewQuoteOpDtl Inserts a new row in the DataSet with defaults populated.
GetNewQuoteAsmRefDes Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
1759
M-R
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field.
1760
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
AddRefDesRange Creates new QuoteMtlRefDes records based on the QuoteMtl dataset fields. Parameters Name
Type
Description
ipQuoteNum
Int32
The Quote Number
ipQuoteLine
Int32
The Quote Line Number
ipAsmSeq
Int32
The Quote Assembly
ipMtlSeq
Int32
The Quote Material Seq
ipPrefix
String
The Prefix to be used to delete Reference Designators
ipStartNum
Int32
The Starting Number to delete Reference Designators
ipEndNum
Int32
The Ending Number to delete Reference Designators
ipSuffix
String
The Suffix to be used to delete Reference Designators
ds
The Quote Asm data set
AppendDetails This method takes the records built in BuildAppendDetails that are marked as append and writes them to the database. It will return the updated dataset. Parameters Name
Type
Description
targetQuote
Int32
Target Quote
targetLine
Int32
Target QuoteLine
targetAsm
Int32
Target Quote AssemblySeq
sourceFile
String
Indicates where the details are being appended from. Either Quote, Job or Method
keyOne
String
Unique key field one for Job or Method source
keyTwo
String
Unique key field two for Method source
keyThree
String
Unique key field two for Method source
ds
Epicor 9.05 | 9.05.605
1761
M-R
Business Object Reference Guide
Name
Type
Description
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
errorList
String@
Returns a message listing any parts in error
Returns Results of the append detail
BuildAppendDetails This method returns the information that can be appended for approval Parameters Name
Type
Description
sourceFile
String
Source of the append details, Quote, Job or Method
keyOne
String
First key field of source
keyTwo
String
Second key field of source
keyThree
String
Third key field of source
targetQuote
Int32
Target Quote Num
targetLine
Int32
Target Line Number
targetAsm
Int32
Target Assembly
Returns
ChangeOpDtlCapability Method to call when changing the Capability ID. This method will update QuoteOpDtl to see if the labor and burden rates need to be reset. Blank is a valid entry for Capability ID. Parameters Name
Type
Description
proposedCapID
String
The proposed Capability ID
ds
The QuoteAsm data set
ChangeOperAutoReceive Verification when changing the AutoReceive field Parameters Name
Type
Description
iAutoReceive
Boolean
Proposed value for AutoReceive field
ds
1762
The QuoteAsm data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangeOperLaborEntryMethod Verification when changing the LaborEntryMethod field Parameters Name
Type
Description
iLaborEntryMethod
String
Proposed value for LaborEntryMethod field
ds
The QuoteAsm data set
ChangeOpDtlOverrideRates Method to call when changing the Override Rates Flag. This method will update QuoteOpDtl with the default labor and burden rates from the appropriate resource or resource group if the QuoteOpDtl.OverrideRates is set to false. Parameters Name
Type
Description
ds
The QuoteAsm data set
ChangeOpDtlResourceGrpID Method to call when changing the Resource Group ID. This method will update QuoteOpDtl with the default labor and burden rates from the new resource group. Blank is a valid entry for Resource Group ID. Parameters Name
Type
Description
proposedResGrpID
String
The proposed Resource Group ID
ds
The QuoteAsm data set
ChangeOpDtlResourceID Method to call when changing the Resource ID. This method will update QuoteOpDtl with the default labor and burden rates from the new resource. Blank is a valid entry for Resource ID. Parameters Name
Type
Description
proposedResourceID
String
The proposed Resource ID
ds
The QuoteAsm data set
ChangeOperPrimaryProdOpDtl This method defaults/resets the production standards when selecting Primary Production Operation Detail. This method should run when the QuoteOpr.PrimaryProdOpDtl field changes.
Epicor 9.05 | 9.05.605
1763
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
The QuoteAsm data set
ChangeOperPrimarySetupOpDtl This method defaults/resets the setup values when selecting Primary Setup Operation Detail. This method should run when the QuoteOpr.PrimarySetupOpDtl field changes. Parameters Name
Type
Description
ds
The QuoteAsm data set
ChangeOperPurPoint This method updates the vendor related information when the Vendor/Purchase Point field changes. It updates the vendor price breaks as well. This method should run when the field ttQuoteOpr.PurPoint changes. Parameters Name
Type
Description
proposedPurPoint
String
The proposed Purchase Point
ds
The QuoteAsm data set
ChangeOperVendorID This method updates the vendor related information when the Vendor/Purchase Point field changes. It updates the vendor price breaks as well. This method should run when the field ttQuoteOpr.VendorNumVendorID changes. Parameters Name
Type
Description
proposedVendorID
String
The proposed Vendor ID
ds
The QuoteAsm data set
ChangeOpMtlReqQty Method to call when changing the OpMtlReqQty. Parameters Name ds
1764
Type
Description The QuoteAsm data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangeQuoteAsmblQtyPer This methods updates the QuoteAsmbl Required Quantity. This method should run when the QuoteAsmbl.QtyPer field changes. Parameters Name
Type
Description
ds
The Quote Asm data set
ChangeQuoteAsmblValRefDes Verify that there are no other QuoteMtlRefDes records in the assembly having the same RefDes value if the QuoteAsmbl.ValRefDes = true. This method should run before changing the QuoteAsmbl.ValRefDes. Parameters Name
Type
Description
ipProposedValResDes
Boolean
The new proposed QuoteAsmbl.ValRefDes value
ds
The Quote Asm data set
ChangeQuoteAsmReqRefDes This methods assigns QuoteAsm.RDEndNum field when QuoteAsm.ReqRefDes changes. This method should run when the QuoteAsm.ReqRefDes changes. Parameters Name
Type
ds
Description Quote Asm dataset
ChangeQuoteMtlEstUnitCost This methods recalculates the Est Mtl Burden Unit Cost when the Est Unit Cost value changes. This method should run when the QuoteMtl.EstUnitCost changes. Parameters Name
Type
Description
ipProposedEstUnitCost
Decimal
The new proposed QuoteMtl.MtlBurRate value
ds
QuoteAsmDataSet
ChangeQuoteMtlMtlBurRate This methods recalculates the Est Mtl Burden Unit Cost when the Mtl Burden Rate value changes. This method should run when the QuoteMtl.MtlBurRate changes.
Epicor 9.05 | 9.05.605
1765
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipProposedMtlBurRate
Decimal
The new proposed QuoteMtl.MtlBurRate value
ds
QuoteAsmDataSet
ChangeQuoteMtlReqRefDes This methods assigns QuoteMtl.RDEndNum field when QuoteMtl.ReqRefDes changes. This method should run when the QuoteMtl.ReqRefDes changes. Parameters Name
Type
Description
ds
Quote Asm dataset
ChangeQuoteMtlSalvageMtlBurUnitRate This methods recalculates the Salvage Mtl Burden Unit Cost when the Salvage Mtl Burden Rate value changes. This method should run when the ECOMtl.SalvageMtlBurRate changes. Parameters Name
Type
Description
ipProposedSalvageMtlBurRate
Decimal
The new proposed ECOMtl.SalvageMtlBurRate value
ds
QuoteAsmDataSet
ChangeQuoteMtlSalvagePartNum This methods assigns associated fields when ECOMtl.SalvagePartNum changes. This method should run when the ECOMtl.SalvagePartNum changes. Parameters Name
Type
Description
ipProposedSalvagePartNum
String
The new proposed ECOMtl.SalvagePartNum value
ds
The QuoteAsm data set
ChangeQuoteMtlSalvageUnitCredit This methods recalculates the Salvage Mtl Burden Unit Cost when the Salvage Unit Credit value changes. This method should run when the ECOMtl.SalvageUnitCredit changes. Parameters
1766
Name
Type
Description
ipProposedSalvageUnitCredit
Decimal
The new proposed ECOMtl.SalvageUnitCredit value
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
ds
Description QuoteAsmDataSet
ChangeQuoteOprOprSeq This method will update all of the associated records to the QuoteOpr if the OprSeq field is changing. This method should run before changing the QuoteOpr.OprSeq and not when a new record. Parameters Name
Type
Description
ipProposedOprSeq
Int32
The new proposed QuoteOpr.OprSeq value
ds
The QuoteAsm data set
CheckConfiguration This method checks if a part must be configured prior to a GetDetails. Parameters Name
Type
Description
quoteNum
Int32
Quote Number of the target Assembly
quoteLine
Int32
Quote Line of the target Assembly
sourcePart
String
Part Num to get details from (populated when sourceFile = "Method")
sourceRev
String
Revision number to get details from (populated when sourceFile = "Method")
targetAssembly
Int32
Target Assembly
findRevision
Boolean
If true the revision number will be looked up rather than using the sourceRev
canGetDetails
Boolean@
If false, GetDetails will fail for a configuration reason that can't be resolve by reconfiguring now
needsConfiguration
Boolean@
If true the configurator should be run on the Job for the Part/Rev
configureRevision
String@
The revision that should be configured (if configuration is needed)
reasonMessage
String@
The reason or for the failure or need for configuration. This should be displayed to the user.
CheckExistingConfiguration This method will check to see if an existing configuration exists for a configured part. This method should be called prior to calling the CheckConfiguration method. If the configurationExists is set to "true", then the reasonMessage should be displayed to the user.
Epicor 9.05 | 9.05.605
1767
M-R
Business Object Reference Guide
Parameters Name
Type
Description
quoteNum
Int32
Quote Number of the target Assembly
quoteLine
Int32
Quote Line of the target Assembly
sourcePart
String
Part Num to get details from (populated when sourceFile = "Method")
sourceRev
String
Revision number to get details from (populated when sourceFile = "Method")
targetAssembly
Int32
Target Assembly
findRevision
Boolean
If true the revision number will be looked up rather than using the sourceRev
configurationExists
Boolean@
If true the configurator should be run on the Job for the Part/Rev
configureRevision
String@
The revision that should be configured (if configuration is needed)
reasonMessage
String@
The reason or for the failure or need for configuration. This should be displayed to the user.
CheckOperPrimaryProdOpDtl This method validated the value of Primary Production Operation Detail. This method should run when the QuoteOpr.PrimaryProdOpDtl is changing. Parameters Name
Type
ds ipPrimaryProdOpDtl
Description The QuoteAsm data set
Int32
The new PrimaryProdOpDtl value to change to
CheckOperPrimarySetupOpDtl This method validated the value of Primary Setup Operation Detail. This method should run when the QuoteOpr.PrimarySetupOpDtl is changing. Parameters Name
Type
ds ipPrimarySetupOpDtl
Description The QuoteAsm data set
Int32
The new PrimarySetupOpDtl value to change to
CheckPartErrors This method runs through a quote's BOM and returns a list of assembly and/or materials that are on hold or inactive. Quote cannot be engineered or Quoted until these errors are taken care of
1768
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
quoteNum
Int32
Quote Number
quoteLine
Int32
QuoteLine, 0 for all lines, otherwise only looks a specific line
runOutWarnings
String@
Warning Message about RunOut Parts on Job. Client to display this as a warning only
CheckPrePartInfo The method is to be run on leave of the PartNum, Revision fields before the GetPartInfo or Update methods are run. This returns all the questions that need to be asked before a part can be changed. Parameters Name
Type
Description
partNum
String@
The new PartNum if a substitute part is found, partNum will be the substitute part
vMessage
String@
Asks if the user wants to use a substitute part
vSubAvail
Boolean@
Indicates other substitute parts besides the default exist
vMsgType
String@
Type of message returned. Values can be; "Question" (asking if they want to use the substitute part) "Warning" (Warns them that a part is onhold or runout). "Error" (Part in Inactive, or Onhold/Runout parts are not accepted in this case) . "Question" is asking if they want to use the substitute part.
DeleteAllAssembly The method deletes all assemblys and their subassemblys, materials and operations while leaving the base assembly sequence alone. Parameters Name
Type
Description
quoteNum
Int32
Quote Number of the assemblys
quoteLine
Int32
Quote Assembly Line Number
Returns
DeleteRefDesRange Deletes QuoteMtlRefDes records based on the QuoteMtl dataset fields. Parameters Name
Type
Description
ipQuoteNum
Int32
The Quote Number
Epicor 9.05 | 9.05.605
1769
M-R
Business Object Reference Guide
Name
Type
Description
ipQuoteLine
Int32
The Quote Line Number
ipAsmSeq
Int32
The Quote Assembly
ipMtlSeq
Int32
The Quote Material Seq
ipPrefix
String
The Prefix to be used to delete Reference Designators
ipStartNum
Int32
The Starting Number to delete Reference Designators
ipEndNum
Int32
The Ending Number to delete Reference Designators
ipSuffix
String
The Suffix to be used to delete Reference Designators
ds
The Quote Asm data set
EnableSupplierPriceList This method returns whether or not the supplier price list option is enabled. This is based on security rights for the user. Parameters Name
Type
Description
lEnableSupplierPriceList
Boolean@
GetAsmOprInfo This method updates the related operation description when the RelatedOperation field changes. To be run before update. Parameters Name
Type
ds
Description The QuoteAsm data set
relatedOperation
Int32
Value of the RelatedOperation that is being tested
GetAsmPartInfo This method updates the dataset with Part Defaults when the PartNum or Revision field changes. To be run before update. CheckPrePartInfo should be run first Parameters Name
Type
ds defaultRev
1770
Description The QuoteAsm data set
Boolean
Indicates if the system should try and find the correct RevisionNum (yes) or use the value in the dataset (no)
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetBasePartForConfig This method will retrieve the base configured part number to be passed to configuration entry Parameters Name
Type
Description
quoteNum
Int32
Quote Number of the target Assembly
quoteLine
Int32
Quote Line of the target Assembly
targetAssembly
Int32
target Assembly
sourcePartNum
String
Indicates the source part number to get details from
sourceRevisionNum
String
Indicates the source revision number to get details from
basePartNum
String@
Returns the Base Part Number to use for configuration
baseRevisionNum
String@
Returns the Base Revision Number to use for configuration
curPartNum
String@
Returns the Current Part Number to use for configuration
curRevNum
String@
Returns the Current Revision Number to use for configuration
siValues
Boolean@
Returns whether the configuration is set to save input values
GetDatasetForTree This methods will return the dataset for QuoteAsm. The method will return the records related to the assembly provided and the first child level assemblies related to the input inputted assembly. Parameters Name
Type
Description
ipQuoteNum
Int32
The Quote Number to return data for.
ipQuoteLine
Int32
The Quote Line Number to return data for.
ipStartAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCurrentAssemblySeq
Int32
The Assembly Sequence to return data for.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this job number?
Returns Quote Asm Data Set
GetDetails This method retrieves the manufacturing details from a source file. The source file will either be a Quote, a Job, or a Method (Part). The assembly records will be created regardless if the part is in error or not. If there are errors, the quote cannot be "quoted" unless all parts are fixed. To find the parts in error run CheckPartErrors
Epicor 9.05 | 9.05.605
1771
M-R
Business Object Reference Guide
Parameters Name
Type
Description
quoteNum
Int32
Quote Number of the target Assembly
quoteLine
Int32
Quote Line of the target Assembly
targetAsm
Int32
Sequence of the target Assembly
sourceFile
String
Source (Quote, Job, or Method) of the details to copy
sourceQuote
Int32
Quote Number to get details from (populated when sourceFile = "Quote")
sourceLine
Int32
Quote Line to get details from (populated when sourceFile = "Quote")
sourceJob
String
Job Number to get details from (populated when sourceFile = "Job")
sourceAsm
Int32
Quote Assembly to get details from (populated when sourceFile = "Quote" or "Job")
sourcePart
String
Part Num to get details from (populated when sourceFile = "Method")
sourceRev
String
Revision number to get details from (populated when sourceFile = "Method")
sourceAltMethod
String
Alternate Method to get details from (populated when sourceFile = "Method")
useMethodForParts
Boolean
If true use the method passed in for all parts in assemblies, if false use the assembly part's default method.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
partErrors
String@
Message of any bad parts that were copied
Returns Results of the get details
GetMtlBuyItInfo This method updates Vendor and LeadTime when BuyIt is checked Parameters Name
Type
ds
Description The QuoteAsm data set
GetMtlDirectInfo This method updates Vendor and LeadTime when BuyIt is checked Parameters Name ds
1772
Type
Description The QuoteAsm data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetMtlOprInfo This method defaults the EstScrap fields when the QuoteMtl.RelatedOperation changes Parameters Name
Type
Description
relatedOperation
Int32
Value of the RelatedOperation that is being tested
ds
The QuoteAsm data set
CheckQuoteMtlPartNum Parameters Name
Type
ds
Description The QuoteAsm data set
ipProposedPartNum
String
Identifies the PartNum to validate
GetMtlPartInfo This method updates the dataset with Part Defaults when the PartNum field changes. To be run after partNum changes but before update. CheckPrePartInfo should be run first Parameters Name
Type
ds partName
Description The QuoteAsm data set
String
Identifies the PartNum field to validate either PartNum or SalvagePartNum
GetMtlVendorInfo This method defaults the Vendor fields when the VendorNumVendorID field is changed Parameters Name
Type
ds vendorID
Description The QuoteAsm data set
String
Proposed Vendor ID
GetNewAssembly This method creates a new Assembly after prompting for the AsemblySeq and BOMLevel as well as the QuoteLine and QuoteNum fields. This is to replace the standard GetNewQuoteAsm
Epicor 9.05 | 9.05.605
1773
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
The QuoteAsm data set
quoteNum
Int32
Assembly's parent Quote
quoteLine
Int32
Assmebly's parent Quote detail Line
assemblySeq
Int32
Assembly's parent assembly Seq
bomLevel
Int32
Assembly's parent BOMLevel
priorAssemblySeq
Int32
If adding a sub-assembly record, this value is 0. If insterting after a specific assembly then use that record's assembly seq (must be different from the parent assembly seq)
GetNewOperation This method creates a new Operation after prompting for the SubConType as well as the AssemblySeq, QuoteLine and QuoteNum fields. This is to replace the standard GetNewQuoteOpr Parameters Name
Type
ds
Description The QuoteAsm data set
quoteNum
Int32
Operations's parent Quote
quoteLine
Int32
Operations's parent Quote detail Line
assemblySeq
Int32
Operations's parent assembly Seq
subContract
Boolean
Operations's sub contract type
GetOprOpCodeInfo This method defaults the OpStd information when the OpCode field changes. Updates the burden rates as well. Parameters Name
Type
Description
proposedOpCode
String
The proposed Operation Code
refreshMessage
String@
The refresh message text
ds
The Quote Assembly data set
GetOprOpStdInfo This method defaults Operation Standard information when OpStdId changes
1774
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The QuoteAsm data set
GetOprPartInfo This method updates the dataset with Part Defaults when the PartNum field changes. To be run after partNum changes but before update. CheckPrePartInfo should be run first Parameters Name
Type
ds partName
Description The QuoteAsm data set
String
Identifies the PartNum field to validate either PartNum or SalvagePartNum
GetOprStdFormatInfo This method updates the dataset after the StdFormat field changes. Can be run on the ColumnChanged event Parameters Name
Type
ds
Description The QuoteAsm data set
InsertBOMAsm This methods allows for the insertion of an engineering assembly for drag/drop functionality, Parameters Name
Type
Description
ipParentQuoteAsmRowid
String
The rowid of the parent quoteasm to add to
ipSourceRowid
String
The rowid of source record could be jobasmbl or quoteasm to be added to the parent quoteasm
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipDroppedAs
String
The character value to determine where to drop and to drop as what. valid values: JobAsmbl, JobAsmbl-AsMtl, QuoteAsm, QuoteAsm-AsMtl
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
Returns Quote Asm Data Set
Epicor 9.05 | 9.05.605
1775
M-R
Business Object Reference Guide
InsertBOMMtl This methods allows for the insertion of an engineering material for drag/drop functionality, Parameters Name
Type
Description
ipParentQuoteAsmRowid
String
The rowid of the quoteasm record to add the material to
ipSourceRowid
String
The rowid of source record could be partmtl, jobmtl, or quotemtl to be added to the parent quoteasm
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipMtlSeq
Int32
The material seq to use
ipBeforeMtlRowid
String
The material rowid to insert material before
ipDroppedAs
String
The character value to determine where to drop and to drop as what. valid values: PartMtl, PartMtl-AsAsm, JobMtl-AsAsm, JobMtl, QuoteMtl-AsAsm, QuoteMtl
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
Returns Quote Asm Data Set
InsertBOMOper This methods allows for the insertion of an engineering operation for drag/drop functionality, Parameters Name
Type
Description
ipParentQuoteAsmRowid
String
The rowid of the parent jobasmbl to add to
ipSourceRowid
String
The rowid of source record could be joboper, partopr, or quoteopr to be added to the parent jobasmbl
ipNewOperSeq
Int32
The new operation seq
ipBeforeOperRowid
String
The operation rowid to insert operation before
ipDroppedAs
String
The character value to determine where to drop and to drop as what. valid values: PartOpr, JobOper, QuoteOpr
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
Returns Quote Asm Data Set
1776
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
InsertMaterial This methods allows for the insertion on a material for drag/drop functionality, validates a QuoteAsm record exists and the part is valid. Parameters Name
Type
Description
ipQuoteAsmRowID
String
The rowid of the QuoteAsm record to add the material to
ipPartNum
String
The part number being added
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipMtlSeq
Int32
The material seq to use
ipBeforeMtlRowid
String
The material rowid to insert material before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
Returns Quote Asm Data Set
InsertOpDtlCapability This method allows for the insertion of Capability on an operation to create operation detail for drag/drop functionality. Parameters Name
Type
Description
ipQuoteOprRowID
String
The rowid of the QuoteOpr record to add the operation detail to
ipCapabilityID
String
The Capability ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
Returns Quote Asm Data Set
InsertOpDtlResource This method allows for the insertion of Resource on an operation to create operation detail for drag/drop functionality.
Epicor 9.05 | 9.05.605
1777
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipQuoteOprRowID
String
The rowid of the QuoteOpr record to add the operation detail to
ipResourceID
String
The Resource ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
Returns Quote Asm Data Set
InsertOpDtlResourceGrp This method allows for the insertion of Resource Group on an operation to create operation detail for drag/drop functionality. Parameters Name
Type
Description
ipQuoteOprRowID
String
The rowid of the QuoteOpr record to add the operation detail to
ipResourceGrpID
String
The Resource Group ID being added
ipNewOpDtlSeq
Int32
The new operation detail seq
ipBeforeOpDtlRowid
String
The operation detail rowid to insert operation detail before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
Returns Quote Asm Data Set
InsertOperationOP This methods allows for the insertion of an operation for drag/drop functionality using operation code as input. This would eventually replace the original InsertOperation method where work center code is the input. Parameters
1778
Name
Type
Description
ipQuoteAsmRowID
String
The rowid of the QuoteAsm record to add the operation to
ipOpCode
String
The operation code being added
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
ipNewOprSeq
Int32
The new operation seq
ipBeforeOperRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Returns Quote Asm Data Set
InsertOperCapability This method allows for the insertion of Capability on an assembly to create QuoteOpr/QuoteOpDtl for drag/drop functionality. Parameters Name
Type
Description
ipQuoteAsmRowID
String
The rowid of the QuoteAsm record to add the operation detail to
ipCapabilityID
String
The Capability ID being added
ipNewOprSeq
Int32
The new operation seq
ipBeforeOprRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Returns Quote Asm Data Set
InsertOperResGroup This method allows for the insertion of ResourceGroup on an assembly to create QuoteOpr/QuoteOpDtl for drag/drop functionality. Parameters Name
Type
Description
ipQuoteAsmRowID
String
The rowid of the QuoteAsm record to add the operation detail to
ipResourceGrpID
String
The Resource Group ID being added
Epicor 9.05 | 9.05.605
1779
M-R
Business Object Reference Guide
Name
Type
Description
ipNewOprSeq
Int32
The new operation seq
ipBeforeOprRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Returns Quote Asm Data Set
InsertOperResource This method allows for the insertion of Resource on an assembly to create QuoteOpr/QuoteOpDtl for drag/drop functionality. Parameters Name
Type
Description
ipQuoteAsmRowID
String
The rowid of the QuoteAsm record to add the operation detail to
ipResourceID
String
The Resource ID being added
ipNewOprSeq
Int32
The new operation seq
ipBeforeOprRowid
String
The operation rowid to insert operation before
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
opMessage
String@
Warning message to let the user know that a subcontract operation will be created with no vendor information.
Returns Quote Asm Data Set
InsertSubAssembly This methods allows for the insertion of a subassembly for drag/drop functionality, validates a QuoteAsm record exists and the part is valid. Parameters
1780
Name
Type
Description
ipQuoteAsmRowID
String
The rowid of the QuoteAsm record to add the material to
ipPartNum
String
The part number being added
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
ipOperSeq
Int32
The related operation seq (or 0 if unrelated)
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
Returns Quote Asm Data Set
CheckChangeJobAsmblParent This method validates validates the new Parent field Parameters Name
Type
Description
ipNewParent
Int32
New Parent value to check against
ds
Job Entry data set
ChangeJobAsmblParent This method validates the new Parent field and populates defaults assoicated witht the Parent. This method should run when the JobAsmbl.Parent field changes. Parameters Name
Type
ds
Description Job Entry data set
QuoteOprInitSNReqSubCon Method required to set the initial value of QuoteOpr.SNRequiredSubConShip Parameters Name ds
Type
Description The Quote data set
ValidateSNReqValues This method updates the columns SNRequiredOpr and SNRequiredSubConShip when the main Part changes. If the new part number is not serial tracked and those fields were set as true previuosly, they must be set to false.
Epicor 9.05 | 9.05.605
1781
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipQuoteLine
Int32
Quote Line
ipQuoteAsmSeq
Int32
Assembly Seq
ipPartNum
String
Part Number
ds
The QuoteAsm data set
ValidateInspection Method to validate the Inspection control fields. (EQM) Parameters Name
Type
Description
ipProposedInspPlan
String
The new proposed InspPlanPartNum value
ipProposedSpecId
String
The new proposed SpecID value
iptable
String
table name
setRev
Boolean
if set default revision
ds
The QuoteAsm entry Dataset.
RefreshMtlPriceBreak This method refreshes the QuoteMtl PBrkQty and PBrkCost fields after VendPart and VendPBrk tables have been udpated. It will also update the LeadTime and Unit Cost fields as well. Parameters Name
Type
ds
Description The QuoteAsm data set
quoteNum
Int32
Material Quote
quoteLine
Int32
Material Quote Line
assemblySeq
Int32
Material Assembly
mtlSeq
Int32
Material Sequence
vendorNum
Int32
Vendor Number from vendor price break
effectiveDate
Nullable{System.DateTime} Effective date from vendor price break
RefreshOprPriceBreak This method refreshes the QuoteOpr PBrkQty and PBrkCost fields after VendPart and VendPBrk tables have been udpated. It will also update the LeadTime and Unit Cost fields as well.
1782
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The QuoteAsm data set
quoteNum
Int32
Operation Quote
quoteLine
Int32
Operation Quote Line
assemblySeq
Int32
Operation Assembly
oprSeq
Int32
Operation Sequence
vendorNum
Int32
Vendor Number from vendor price break
effectiveDate
Nullable{System.DateTime} Effective date from vendor price break
ResequenceMaterial This method resequences Material for an assembly by sequence, part or bubble Parameters Name
Type
Description
quoteNum
Int32
Quote Number
quoteLine
Int32
Quote Line
assemblySeq
Int32
Assembly Sequences
reseqOption
String
"M" for Material, "P" for Part, or "B" for Bubble
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
Returns Quote Asm Data Set
ResequenceOperations This method resequences the operations of an assembly by 10's Parameters Name
Type
Description
quoteNum
Int32
Quote Number
quoteLine
Int32
Quote Line
assemblySeq
Int32
Assembly Sequence
ipCompleteTree
Boolean
Would you like to retun a complete dataset for this QuoteAsm?
Returns Quote Asm Data Set
Epicor 9.05 | 9.05.605
1783
M-R
Business Object Reference Guide
ChangeQuoteOprIUM procedure for changing QuoteOpr.IUM field Parameters Name
Type
ds
Description The QuoteAsm data set
ChangeQuoteOprQtyPer procedure for changing QuoteOpr.QtyPer field Parameters Name
Type
ds
Description The QuoteAsm data set
ChangeQuoteMtlIUM procedure for changing QuoteMtl.IUM field Parameters Name
Type
ds
Description The QuoteAsm data set
ChangeQuoteOprSNRequiredOpr Validates SNRequiredOpr flag to avoid to set it false if the prior operation has the flag set to true The flag cannot be set to true if the part is not serial tracked also. Parameters Name
Type
Description
ipProposedSNRequired
Boolean
The new proposed QuoteAsm.SNRequiredOpr value
ds
The QuoteAsm data set
ChangeSubcontractPartNum Check if SNRequiredOpr column is enabled/disabled on Subcontract Detail panel on UI Parameters Name
Type
Description
ipProposedPartNum
String
The new proposed QuoteOpr.PartNum value
ds
1784
The QuoteAsm data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Validates if JobHead.PartNum is serial tracked, additionals JobParts cannot be added. Returns list of Project Roles
QuoteAsmSearch Epicor.Mfg.BO.QuoteAsmSearch: This business object contains 1 methods.
GetRows This methods will return all of the QuoteAsmSearch records which will be a subset of the QuoteAsm records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table (QuoteAsmSearch) we need our own public method. Parameters Name
Type
Description
whereClauseQuoteAsmSearch
String
The where clause to restrict data for
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Returns The dataset with pupolated key values
QuoteDtlSearch Epicor.Mfg.BO.QuoteDtlSearch: This business object contains 9 methods.
GetNewQuoteDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1785
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListFromSelectedKeys This methods will return all of the QuoteDtlSearch records which will be a subset of the QuoteHed records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table we need our own public method. Parameters Name
Type
ds
1786
Description The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetRowsFromSelectedKeys This methods will return all of the QuoteDtlSearch records which will be a subset of the QuoteHed records that meet the selection criteria. This method will try to mirror the functionality of the base GetRows method but since we are populating a temp table we need our own public method. Parameters Name
Type
ds
Description The dataset with pupolated key values
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Epicor 9.05 | 9.05.605
1787
M-R
Business Object Reference Guide
Chapter 18: R RASchedCd Epicor.Mfg.BO.RASchedCd: This business object contains 8 methods.
GetNewRASchedCd Inserts a new row in the DataSet with defaults populated.
GetNewRASchedCdAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1788
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
RateType Epicor.Mfg.BO.RateType: This business object contains 7 methods.
GetNewRateType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
1789
M-R
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Rating Epicor.Mfg.BO.Rating: This business object contains 7 methods.
GetNewRating Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1790
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
RcvDtlSearch Epicor.Mfg.BO.RcvDtlSearch: This business object contains 7 methods.
GetNewRcvDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
1791
M-R
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Reason Epicor.Mfg.BO.Reason: This business object contains 9 methods.
GetNewReason Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
1792
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1793
M-R
Business Object Reference Guide
This method returns the list of Reason codes and descriptions . ReasonTypeCode ReasonTypeDesc Returns The output ReasonType data set
Rebate Epicor.Mfg.BO.Rebate: This business object contains 20 methods.
GetNewRebateHdr Inserts a new row in the DataSet with defaults populated.
GetNewRebateHdrAttch Inserts a new row in the DataSet with defaults populated.
GetNewRebateCust Inserts a new row in the DataSet with defaults populated.
GetNewRebateCustDtl Inserts a new row in the DataSet with defaults populated.
GetNewRebateDtl Inserts a new row in the DataSet with defaults populated.
GetNewRebateBrk Inserts a new row in the DataSet with defaults populated.
GetNewRebatePymt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1794
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeDetailPartNum This method validates and populates the Part related fields when the
Epicor 9.05 | 9.05.605
1795
M-R
Business Object Reference Guide
Parameters Name
Type
Description
inPartNum
String
The proposed Part Num
ds
Rebate Dataset
ChangeHdrCustID This method validates and populates the Customer fields when the Parameters Name
Type
Description
inCustID
String
The proposed Customer ID
ds
Rebate Dataset
ChangePymtDate This method should run before changing the RebatePymt.PymtDate. Parameters Name
Type
Description
ipProposedPymtDate
Nullable{System.DateTime}
The new proposed RebatePymt.PymtDate value
ds
Rebate Dataset
ChangeRCCustomer This method validates and populates the Customer fields when the Parameters Name
Type
Description
inCustID
String
The proposed Customer ID
ds
Rebate Dataset
CopyRebate This method copies one rebate to a new rebate. The user can change either the dates of the rebate or the customers for the rebate. If changing the dates, then custNum and groupCode fields will be ignored If date fields are null, then either custID or groupCode must be populated Parameters
1796
Name
Type
Description
fromRebateID
String
RebateID to copy from
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
newRebateID
String
RebateID to create
newRebateDesc
String
New description for rebate
optionType
String
Flag to indicate if Date or Customer copy
startDate
Nullable{System.DateTime}
Rebate Start date
endDate
Nullable{System.DateTime}
Rebate End date
custID
String
Customer to be used for rebate
groupCode
String
Customer Group Code to be used for rebate
Returns Rebate Dataset
GetCustGroup This method generates RebateCust records for the specified Rebate and Customer Group. Parameters Name
Type
Description
rebateID
String
Rebate ID
groupCode
String
Customer Group Code
Returns Rebate Dataset
RebateTrans Epicor.Mfg.BO.RebateTrans: This business object contains 9 methods.
GetNewRebateTrans Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1797
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DeleteAll This method deletes all the selected rebate transactions. Parameters Name ds
Type
Description Contains the records to be delete
ImportRebateTrans Call this method to import rebate transactions into the database. This method expects an input data table ttImportRebateTrans with data coming from an external comma delimited file.
1798
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds opMessage
Description The ImportRebateTrans data set
String@
If not all records imported successfully, alert the user
Returns The RebateTrans data set
Receipt Epicor.Mfg.BO.Receipt: This business object contains 95 methods.
GetNewRcvHead Inserts a new row in the DataSet with defaults populated.
GetNewRcvHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewRcvDtl Inserts a new row in the DataSet with defaults populated.
GetNewRcvDtlAttch Inserts a new row in the DataSet with defaults populated.
GetNewRcvDuty Inserts a new row in the DataSet with defaults populated.
GetNewRcvMisc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1799
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
1800
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AutoSetToLocation This procedure sets RcvDtl.SetToLocation to yes in given data set. Parameters Name
Type
ds
Description The Receipt data set
CheckCompliance . Parameters Name
Type
Description
vendorNum
Int32
Vendor Number
purPoint
String
Purchase Point Number
packSlip
String
Receipt Packing Slip Number
compliant
Boolean@
Indicates if the current Pack is compliant.
ds
The Receipt data set
CheckContainersBeforeUpdate This method is to be called right before the update of a ContainerReceipt. If there is a discrepancy between the quantities, serial numbers the user is asked if they are sure they want to continue. qQuestion and sQuestion are provided so the UI can format the message box and make it easier for the end user to read the text. Parameters Name
Type
ds
Description The Receipt data set
qMessageStr
String@
Quantity Question to ask user before update. If no, update method is not run
qQuestion
String@
Question asked when there is a quantity discrepancy.
Epicor 9.05 | 9.05.605
1801
M-R
Business Object Reference Guide
Name
Type
Description
sMessageStr
String@
Serial Number Question to ask users before update. If no, update method is not run
sQuestion
String@
Question asked when there is a serial number discrepancy.
lMessageStr
String@
Lot Number error message
CheckDtlBeforeUpdate This method is to be called right before the update method is called. If there is a discrepancy between the vendorqty and ourqty, the user will be asked if they're sure they want to continue. Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packLine
Int32
Receipt Line to check
packSlip
String
Receipt Packing Number
qMessageStr
String@
Quantity Question to ask user before update. If no, update method is not run
sMessageStr
String@
Serial Number Question to ask users before update. If no, update method is not run
lcMessageStr
String@
Landed Cost Question to ask users before update. If no, update method is not run
CheckDtlCompliance . Parameters Name
Type
ds
1802
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packLine
Int32
Receipt Line to check
packSlip
String
Receipt Packing Number
qMessageStr
String@
Quantity Question to ask user before update. If no, update method is not run
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
CheckDtlJobStatus This method is to be run before the GetDtlPOLine and GetDtlPORel and GetDtlJobInfo methods are called If the Job/PO to a closed or complete job, a question or a warning will be returned Parameters Name
Type
Description
poNum
Int32
Purchase Order Number for Receipt
poLine
Int32
Purchase Order Line
poRelNum
Int32
Purchase Order Release
jobNum
String
Job Number
poQuestion
String@
Question if the PORelease is closed. If the user answers no then the next 2 messages never need to be displayed
questionMsg
String@
Question to continue if job is closed
warnMsg
String@
Warning if job is complete
CheckDtlLotInfo This method returns an error or question if the LotNum field does not exist depending upon the security of the user Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
lotNum
String
New Lot Number to validate
questionMsg
String@
Asks if user want to create new lot
errorMsg
String@
Tells user if they can't create a new lot
CheckDtlSeqChange This method is run when the JobSeq field is changed along with GetSeqInfo. If the JobMtl is marked as IssuedComplete, the user is asked whether they are sure they want to change the sequence number. Only move forward if the answer is yes. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The Receipt data set
1803
M-R
Business Object Reference Guide
Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
jobSeq
Int32
The proposed JobSeq value
vMessage
String@
This is the question that the user needs to answer
CheckDtlSSN This method tests to see if Serial Numbers exist that may be deleted if the ReceivedTo field or PartNum changes. The update method assumes the user answered yes and will delete the Serial Numbers. Parameters Name
Type
Description
vendorNum
Int32
Vendor Number
purPoint
String
Vendor Purchase Point ID
packSlip
String
Packing Slip Number
packLine
Int32
Packing Slip Line
receivedTo
String
Receipt ReceivedTo field (proposed or current)
partNum
String
Proposed Receipt Part Number (proposed or current)
vMessage
String@
Question if ReceivedTo has changed and Serial Numbers will be deleted
vWMessage
String@
Warning if Part Number has changed
This method is to be run right after the form opens to determine whether the default receiving warehouse and bin have been populated for the cur-plant. If not, the form will close.
CheckHdrBeforeUpdate This method will return three warning messages if the Receipt Header changes any of the UpliftPercent, ReceiptDate and ArrivedDate. The user will be asked if the changes should be applied to all the Receipt Details as well. This method should be called before the Update method is called. Parameters Name
Type
Description
opUpliftWarnMsg
String@
The warning message about the change in uplift percent.
opReceiptWarnMsg
String@
The warning message about the change in receipt date.
opArriveWarnMsg
String@
The warning message about the change in arrival date.
ds
1804
The Receipt data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
CheckIssuedComplete This method is to be run after the IssuedComplete flag is changed. Any questions returned require a yes/no response from the user. Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
issuedComplete
Boolean
vMessage
String@
Question asking if the user is sure they want to set/clear the flag
CheckLCAmtBeforeUpdate This method will return a warning message if any of the partial receipt lines needs to recalculate container landed costs. The user will be asked if he wants to continue to receive the line(s) or undo update to review the container landed costs first. Parameters Name
Type
Description
ipVendorNum
Int32
Receipt Vendor Number
ipPurPoint
String
Receipt Purchase Point
ipPackSlip
String
Receipt Packing Number
ipPackLine
Int32
Receipt Line to check
opMessage
String@
Question asking if the user will continue with update or review landed costs first
ds
The Receipt data set
CheckOnLeaveHead This method needs to be run when leaving the RcvHead record either by going to another RcvHead record or leaving the screen. It checks that the landed cost has been evenly disbursed between all the lines. If not, the landed cost needs to be corrected before leaving It also verifies that attachements have been entered for all the parts which require them. Parameters Name
Type
Description
vendorNum
Int32
Vendor Number of the Receipt
Epicor 9.05 | 9.05.605
1805
M-R
Business Object Reference Guide
Name
Type
Description
purPoint
String
Purchase Point of the Receipt
packSlip
String
Packing Slip number of the Receipt
CheckPOClosedInfo This method checks how many numbers of PO Releases are closed in the current PONum Parameters Name
Type
Description
vendorNum
Int32
Vendor Number of Receipt
purPoint
String
Purchase Point of Receipt
packSlip
String
Packing Slip number of Receipt
warnMsg
String@
Warning message to display the number of POReleases closed
CheckReceivedComplete This method is to be run after the ReceivedComplete flag is changed. Any questions returned require a yes/no response from the user. Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
receivedComplete
Boolean
vMessage
String@
Question asking if the user is sure they want to set/clear the flag
CheckSupplierPrice This method validates that if Supplier Price was change it satisfies Company options. Parameters Name
Type
ds vendorNum
1806
Description The Receipt data set
Int32
Receipt Vendor Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
suppPrice
Decimal
new Supplier Price
warningMsg
String@
Reason the Supplier Price is invalid
CommitRcvDtl This method creates the Lines Received from MassReceipt option directly into the DB. This was done for performance purposes. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
ds
The Receipt data set
CreateMassReceipts This method is used to populate the ShipDtl datatable for Mass Receipts and Intercompany Receipt linking Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
intQueId
Decimal
Intercompany Queue ID for Intercompany Receipts
poNum
String
PO Number for Purchase Order Receipts
ds
The Receipt data set
CreatePartLot Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
1807
M-R
Business Object Reference Guide
DisburseLandedCost This method is used to disburse the Total Landed Cost across the receipt details. The RcvDtl records will be updated to distribute the receipt Indirect Costs according to the specified disburse method. The Specific DutyAmt if available will be divided equally among lines or by the percentage of the line's duties against total duties. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
GetDtlAssemblyInfo This method updates the dataset when the AssemblySeq number changes Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
GetDtlJobInfo This method default the Job Information when the RcvDtl.JobNum field changes Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
jobNum
String
The new Job Number
ds
The Receipt data set
GetDtlLotInfo This method updates the unitCost when the LotNum field changes
1808
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
lotNum
String
New Lot Number to validate
questionMsg
String@
Asks if user want to create new lot
errorMsg
String@
Tells user if they can't create a new lot
GetDtlPartInfo This method updates the dataset when the part number has changed. CheckDtlSSN should be run first. Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
partNum
String
Proposed partNum value
GetDtlPOInfo This method updates the dataset when the detail Line PONum field has changed. Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
poNum
Int32
New PO Number
Epicor 9.05 | 9.05.605
1809
M-R
Business Object Reference Guide
GetDtlPOLineInfo This method updates the dataset when the detail Line POLine field has changed. Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
poLine
Int32
New POLine Number
serialWarning
String@
Warning message if the receipt line contains serial numbers
GetDtlPORelInfo This method updates the dataset when the detail Line PORelNum field has changed. Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
poRelNum
Int32
New PO Release Number
GetDtlQtyInfo This method updates the dataset when the InputOurQty field changes Parameters Name
Type
ds
1810
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
inputOurQty
Decimal
Proposed change to the Input qty field
inputIUM
String
Proposed change to the IUM field
whichField
String
Indicates either 'QTY' or 'UOM' field changed
warnMsg
String@
A warning message for users. Does not stop processing
GetDtlRcvdToInfo This method is run when the ReceivedTo field is changed after the CheckSSN method is called Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
rcvdTo
String@
Proposed ReceivedTo value
GetDtlSeqInfo This method updates the dataset when the JobSeq field changes. Fields will be defaulted from JobMtl for PUR-MTL and from JobOper for PUR-SUB. Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Vendor Number
purPoint
String
Purchase Point
packSlip
String
Packing slip number
packLine
Int32
Receipt Line to check
jobSeq
Int32
Proposed JobSeq change
serialWarning
String@
Warning message if the receipt line contains serial numbers
GetDtlVenQtyInfo This method updates the dataset when the VendorQty field changes
Epicor 9.05 | 9.05.605
1811
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
The Receipt data set
vendorNum
Int32
Vendor Number
purPoint
String
Purchase Point
packSlip
String
Packing slip number
packLine
Int32
Receipt Line to check
vendorQty
Decimal
Proposed VendorQty value
warnMsg
String@
A warning message for users. Does not stop processing
GetListReceipts Parameters Name
Type
Description
whereClauseRcvDtl
String
Whereclause for RcvDtl table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.InvcCustTrkDataSet
GetLotImportInfo This method should be called from Container Receipt Entry and Receipt Entry when the ImportNumber or ImportedFromDesc values have changed for a receipt line. Parameters Name
Type
Description
inPartNum
String
PartNum
inLotNum
String
LotNum
outImportNum
String@
ImportNum
outImportedFromDesc
String@
ImportedFromDesc
GetNewRcvDtlMisc This method creates a new Miscellaneous receipt line entry
1812
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ds
The Receipt data set
vendorNum
Int32
purPoint
String
packSlip
String
GetPartTranPKs Updates Receipt data set with PendingDtl. Parameters Name
Type
Description
packSlip
String
The PackSlip number
partTranPKs
String@
The PartTranPKs number
GetPendingDtl Updates Receipt data set with PendingDtl. Parameters Name
Type
ds inPONum
Description The Receipt data set
Int32
The PO number
GetPOInfo This method returns default information for the PO Number and the new Vendor ID information. Parameters Name
Type
ds
Description The Receipt data set
poNum
Int32
Proposed Purchase Order Number
vendorNum
Int32@
Numeric Vendor ID assigned to the PO
purPoint
String@
Default Purchase Point assigned to the PO
GetPurPointInfo This method returns default information for the Vendor Purchase Point.
Epicor 9.05 | 9.05.605
1813
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds purPoint
The Receipt data set String@
Proposed Purchase Point value
GetSelectSerialNumbersParams Parameters Name
Type
Description
ipPartNum
String
ipPartNum
ipQuantity
Decimal
ipQuantity
ipUOM
String
ipUOM
ipVendNum
Int32
ipVendNum
ipVendPP
String
ipVendPP
ipPackSlip
String
ipPackSlip
ipPackSlipLine
Int32
ipPackSlipLine
ipJobNum
String
ipJobNum
ipAsmSeq
Int32
ipAssmSeq
ipSubOprSeq
Int32
ipSubOprSeq
ipReceivedTo
String
ipReceivedTo
Returns
GetVendorInfo This method returns default information for the Vendor. Parameters Name
Type
ds
Description The Receipt data set
vendorID
String
Proposed Vendor ID value
vendorNum
Int32@
Numeric Vendor ID
purPoint
String@
default Purchase Point for Vendor
HHCanEditPackSlip This method was developed for HandHeld version to validate if a pack slipt exist. In the handheld version users can't edit the lines.
1814
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
piPONum
Int32
A valid PONumber
pcPackSlip
String
Packing slip to check if this one was received
pbIsEdit
Boolean@
HHValRecDocReq This method is to be called by the Hand Held PO Receipt program. It can be called before or after calling the update for the RcvDtl. It checks to see if receipt documents are required for a given Part/Lot number. If they are then message text is returned in the infoMsg parameter. The client displays this in a message box. Note: For Hand Held this is only an informational and not an exception. Parameters Name
Type
Description
partNum
String
Part number
lotNum
String
Part Lot number
infoMsg
String@
Contains the text for the message box
ImportReceipt This method imports the Receipt Head record from the IMRcvHead table. It returns the unique key information on the newly created Receipt header needed to import the detail lines. The detail records are imported by processing Mass Receipts for the same IntQueId as indicated here. Parameters Name
Type
Description
intQueId
Decimal
Unique key of IMRcvHead
vendorNum
Int32@
Vendor Number of Receipt
purPoint
String@
Purchase Point of Receipt
packSlip
String@
Packing Slip number of Receipt
InitializeLandedCost This method is used to populate the MassReceipt dataset for use in Landed Costs it also returns the default recovery account information Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
Epicor 9.05 | 9.05.605
1815
M-R
Business Object Reference Guide
Name
Type
Description
packSlip
String
Receipt Packing Number
lcComment
String@
Landed Cost Comments
lcReference
String@
Landed Cost Reference
Returns Result Set
LCChangeLCAmt This method updates the dataset record when the LCAmt field changes Parameters Name
Type
ds
Description MassRecieptDataSet
packSlip
String
Receipt Pack Number
packLine
Int32
Receipt Line Number
OnChangeContainerImportFld This method is to be run from Container Receipt Entry when import Number or Imported From values are changed on the Container. Parameters Name
Type
ds
Description The Receipt data set
OnChangedDtlPOTransValue This method should be invoked when the POTransValue of RcvDtl has changed. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
ds
The Receipt data set
OnChangeDtlCommodity This method should be invoked when the CommodityCode in RcvDtl changes. This method will validate the commodity code and get defaults.
1816
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
ipCommCode
String
Proposed Commodity Code to be validated
ds
The Receipt data set
OnChangeDtlCountryNum This method should be invoked when the OrigCountryNum in RcvDtl changes. This method will validate country of origin. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
ipCountryNum
Int32
Proposed Country of Origin to be validated
ds
The Receipt data set
OnChangeDtlLCIndCost This method should be invoked when the LCIndCost in RcvDtl changes. This method will validate the manually disbursed indirect cost. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
ipLCIndCost
Decimal
Proposed LC Indirect Cose to be validated
ds
The Receipt data set
OnChangeDtlReceived This method should be invoked when the Received flag in RcvDtl has changed.
Epicor 9.05 | 9.05.605
1817
M-R
Business Object Reference Guide
Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
ipReceived
Boolean
Received flag
ds
The Receipt data set
OnChangeDtlSupplierPrice This method should be invoked when the Supplier Price in RcvDtl changes. This method calculates Base and Reporting values. Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
OnChangeDtlUpliftPercent This method should be invoked when the UpliftPercent in RcvDtl changes. This method will validate the UpliftPercent and calculate the Uplift Indirect Cost. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
ipUpliftPercent
Decimal
Proposed Uplift Percentage to be validated
ds
The Receipt data set
OnChangeDutyTariffCode This method should be invoked when the Tariff Code changes. This method will validate the tariffcode and defaults the duty amount.
1818
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
packLine
Int32
Receipt Line to check
dutySeq
Int32
Receipt Duty Sequence
ipTariffCode
String
Proposed Tariff Code to be validated
ds
The Receipt data set
OnChangeHdrReceived This method should be invoked when the Received flag in RcvHead has changed. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
ipReceived
Boolean
Received flag
ds
The Receipt data set
OnChangeInspReq This method updates the dataset when the Inspection Required flag changes Parameters Name
Type
ds
Description The Receipt data set
vendorNum
Int32
Vendor Number
purPoint
String
Purchase Point
packSlip
String
Packing slip number
packLine
Int32
Receipt Line
OnChangeMiscApplyDate This method should be invoked when the Apply Date in RcvMisc changes. This method will validate the date and get new exchange rate.
Epicor 9.05 | 9.05.605
1819
M-R
Business Object Reference Guide
Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
ipApplyDate
Nullable{System.DateTime}
Proposed Apply Date to be validated
ds
The Receipt data set
OnChangeMiscCharge This method should be invoked when the Miscellaneous Charge ID changes. This method will validate the misc. charge and pull in the new default information. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
ipChargeID
String
Proposed PurMisc ID to be validated
ds
The Receipt data set
OnChangeMiscCurrencyCode This method should be invoked when the Currency Code in RcvMisc changes. This method will validate the currency code and pull in the new default information. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
ipCurrCode
String
Proposed Currency Code to be validated
ds
1820
The Receipt data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
OnChangeMiscDocActualAmt This method should be invoked when the RcvMisc.ActualAmt changes. This method will validate the amount and convert it to the base currency. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
ipDocActualAmt
Decimal
Proposed Actual Amount in document currency
ds
The Receipt data set
OnChangeMiscExchangeRate This method should be invoked when the Currency Exchange Rate in RcvMisc changes. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
ipExchangeRate
Decimal
Proposed Currency Exchange Rate to be validated
ds
The Receipt data set
OnChangeMiscInvoiceLine This method should be invoked when the Invoice Line in RcvMisc changes. This method will validate the invoice line and pull in the new default information. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
ipInvLine
Int32
The AP Invoice Line to be validated
ds
Epicor 9.05 | 9.05.605
The Receipt data set
1821
M-R
Business Object Reference Guide
OnChangeMiscInvoiceNum This method should be invoked when the Invoice Number in RcvMisc changes. This method will validate the invoice number and pull in the new default information. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
ipInvNum
String
The AP Invoice Number to be validated
ds
The Receipt data set
OnChangeMiscMscNum This method should be invoked when the MscNum in RcvMisc changes. This method will validate the MscNum and pull in the new default information. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
ipMscNum
Int32
The AP Invoice Line Miscellaneous Sequence Number to be validated
ds
The Receipt data set
OnChangeMiscPercent This method should be invoked when the RcvMisc.Percentage changes. This method will calculate the amount and convert it to the base currency. Parameters
1822
Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
ipPercent
Decimal
Proposed Actual Amount in document currency
ds
The Receipt data set
OnChangeMiscRateGrp This method should be invoked when the Currency Rate Group in RcvMisc changes. This method will validate the rate group and get new exchange rate. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
ipRateGrpCode
String
Proposed Currency Rate Group Code to be validated
ds
The Receipt data set
OnChangeMiscVendor This method should be invoked when the vendor ID in RcvMisc changes. This method will validate the vendor and pull in the new default vendor information. Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
miscSeq
Int32
Receipt Indirect Cost Sequence
vendID
String
Proposed vendor ID to be validated
ds
The Receipt data set
PreUpdate This method will return a record in the LegalNumberGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called.
Epicor 9.05 | 9.05.605
1823
M-R
Business Object Reference Guide
Parameters Name
Type
ds requiresUserInput
Description The Receipt data set
Boolean@
Indicates if the legal number requires user input
processIM Finish processing a successful IC import Parameters Name
Type
Description
pintQueId
Decimal
A valid IntQueId
curpackSlip
String
Packing slip number
ds
The Receipt data set
ProcessLandedCosts This method is used to process the Landed Costs into the RcvHead and RcvDtl tables All the MassReceipt records need to be marked as modified for this Parameters Name
Type
Description
vendorNum
Int32
Receipt Vendor Number
purPoint
String
Receipt Purchase Point
packSlip
String
Receipt Packing Number
Returns Result Set
ReceiveAll This method updates the Quantity for the lines created from MassReceipt Parameters Name ds
Type
Description The Receipt data set
ReceiveAllLines Sets ttRcvDtl.Received to true in all lines selected for MassReceipt.
1824
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipReceived
Boolean
Received flag
ds
The Receipt data set
ReceiveContainer Parameters Name
Type
Description
ds inContainerID
Epicor.Mfg.BO.ReceiptDataSet Int32
ContainerID
Returns Epicor.Mfg.BO.ContainerTrackingDataSet
ReceiveContainerUpdate Mass Receive the po lines on a container. Parameters Name
Type
Description
ds
Epicor.Mfg.BO.ReceiptDataSet
inContainerID
Int32
inCreateNewPoRels
String
outEshReceived
Boolean@
outPartialReceipt
Boolean@
outReceiveAll
Boolean@
ResetLandedCostDisbursements Initialize landed cost amounts to 0 and updates the landed cost disburse method. Parameters Name
Type
Description
ipVendorNum
Int32
Vendor Number to reset
ipPurPoint
String
Purchase Point to reset
ipPackSlip
String
Packing Slip Number to reset
ipDisburseMethod
String
Landed Cost Disbursment method
Epicor 9.05 | 9.05.605
1825
M-R
Business Object Reference Guide
SetPrimaryBin Set the Part Warehouse's Primary Bin when the Warehouse is changed. Parameters Name
Type
Description
ds
The Receipt data set
SetToLocation This method gets the Warehouse and Bin to the defaults for the Part/Job Parameters Name
Type
Description
vendorNum
Int32
Vendor Number
purPoint
String
Purchase Point Number
packSlip
String
Receipt Packing Slip Number
packLine
Int32
Receipt Line number
ds
The Receipt data set
ValidateMRPONum This method validates that the PO Number is a valid PO before the UI calls CreateMassReceipts. Does not need to be run for Intercompany Receipts. Parameters Name
Type
Description
poNum
Int32
The PO Number to validate
vendorNum
Int32
The Receipt Header Vendor's Number
errorMsg
String@
Reason the PO Number is invalid
ValidateSN Parameters
1826
Name
Type
Description
ipPartNum
String
Part Number
ipSerialNo
String
Serial Number
ipVendorNum
Int32
Vendor Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
IsContainerReceived Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ReceiptsFromMfg Epicor.Mfg.BO.ReceiptsFromMfg: This business object contains 35 methods.
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
1827
M-R
Business Object Reference Guide
Returns
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
EnableSerialMatching Validates if the option Serial Matching should be enabled. Parameters Name
Type
Description
ds plEnable
Epicor.Mfg.BO.ReceiptsFromMfgDataSet Boolean@
Set by the BL. It is used to tell the UI if it should enable Serial Matching option or not.
EnableSerialNumbers Validates if the option to enter Serial Numbers should be anabled. Parameters Name
Type
Description
ds
Epicor.Mfg.BO.ReceiptsFromMfgDataSet
pcProcessID
String
Set from UI. It is used to tell the BL which process called this public procedure.
plEnable
Boolean@
Set by the BL. It is used to tell the UI if it should enable Serial Matching option or not.
GetList List of jobs that can be selected for Mass Issue. Parameters
1828
Name
Type
Description
whereClauseJobHead
String
Where condition without the where word
whereClauseJobAsmbl
String
Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
morePages
Boolean@
Are there more pages ? Yes/No
Returns Returns Epicor.Mfg.BO.ReceiptsFromMfgJobAsmblDataSet
GetNewJobAsmblMultiple This method creates a new ttSelectedJobAsmbl row entry. Parameters Name
Type
Description
ds pcTranType
Epicor.Mfg.BO.SelectedReceiptsJobAsmblDataSet String
Tran Type. Determines the nature of Receipts
Returns Epicor.Mfg.BO.ReceiptsFromMfgDataSet
GetNewJobAsmblSearch This method creates a new ttSelectedJobAsmbl row entry. Parameters Name
Type
Description
ds
SelectedReceiptsJobAsmblDataSet
GetNewReceiptsFromMfg This method creates a new ttPartTran row entry. Parameters Name
Type
Description
pcTranType
String
Tran Type. Determines the nature of Receipts
ds
Epicor.Mfg.BO.ReceiptsFromMfgDataSet
GetNewReceiptsFromMfgJobAsm This method creates a new ttSelectedJobAsmbl row entry. Parameters Name
Type
Description
pcJobNum
String
Job Number
piAssemblySeq
Int32
Assembly Sequence
Epicor 9.05 | 9.05.605
1829
M-R
Business Object Reference Guide
Name
Type
Description
pcTranType
String
Tran Type. Determines the nature of Receipts
ds
Epicor.Mfg.BO.ReceiptsFromMfgDataSet
GetNewReceiptsFromMfgMtlQueue This method creates a new ReceiptsFromMfgDataSet using MtlQueue RowIdent. Parameters Name
Type
Description
pcMtlQueueRowIdent
String
RowIdent of MtlQueue record
ds
Epicor.Mfg.BO.ReceiptsFromMfgDataSet
GetRows List of jobs that can be selected for Mass Issue. Parameters Name
Type
Description
whereClauseJobHead
String
Where condition without the where word
whereClauseJobAsmbl
String
Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns Returns Epicor.Mfg.BO.ReceiptsFromMfgJobAsmblDataSet
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds pcProcessID
Description ReceiptsFromMfg data set
String
The name of the calling process (UI Application).
Returns The SelectSerialNumbersParams dataset
IsValidAssembly Returns logical true if the assembly is valid and false otherwise.
1830
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
pcJobNum
String
The job number
piAssemblySeq
Int32
The assembly sequence number.
plFound
Boolean@
True if the assembly exist, false otherwise
OnChangeActTranQty Change the PartTran values based on the new value of PartTran.ActTranQty. Parameters Name
Type
ds pcMessage
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
String@
Information passed back from the business logic.
OnChangeActTransUOM Call this method when the value of Epicor.Mfg.BO.PartTran.ActTransUOM changes. Parameters Name
Type
Description
pUOM
String
Transaction UOM
ds
ReceiptsFromMfgDataSet
pcMessage
String@
Information passed back from the business logic.
OnChangeAssemblySeq Change the PartTran values based on the new PartTran.AssemblySeq. Parameters Name
Type
ds pcMessage
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
String@
Information passed back from the business logic.
OnChangeAssemblySeq2 Change the PartTran values based on the new value of PartTran.AssemblySeq2.
Epicor 9.05 | 9.05.605
1831
M-R
Business Object Reference Guide
Parameters Name
Type
ds pcMessage
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
String@
Information passed back from the business logic.
OnChangeBinNum Call this method when the value of Epicor.Mfg.BO.ReceiptsFromMfgDataSet.BinNum changes. Parameters Name
Type
ds
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
OnChangeJobNum When the user enters the Job# in ReceiptsFromMfgJobsDataSet call this method. Parameters Name
Type
ds
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
OnChangeJobNum2 Change the PartTran values based on the new value of PartTran.JobNum2. Parameters Name
Type
ds pcMessage
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
String@
Information passed back from the business logic.
OnChangeJobSeq2 Change the PartTran values based on the new value of PartTran.JobSeq2. Parameters Name
Type
ds pcMessage
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
String@
Information passed back from the business logic.
OnChangeLotNum Change the PartTran values based on the new value of PartTran.LotNum.
1832
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
messageasked
Boolean
Set by the UI. If set to true then lot messages will not be returned. If false, either pcMessage or errormsg will be set if there is an error.
proposedLotNumber
String
Lot number the user entered.
pcMessage
String@
Set when a new lot is going to be created. Asks user to create Y/N.
errormsg
String@
Set when the user does not have permissions to create lots. Or null.
OnChangeOverrideCost Recalculate the PartTran unit cost values when the user unchecks the Override Cost toggle box. Parameters Name
Type
ds
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
proposedOverride
Boolean
Override Cost value that the user selected.
OnChangePartNum When the user changes the PartNum in ReceiptsFromMfgJobsDataSet call this method. Parameters Name
Type
ds
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
OnChangePlant When the user changes the Plant2 in ReceiptsFromMfgJobsDataSet call this method. Parameters Name
Type
ds
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
OnChangeSalvageJobSeq Change the PartTran values based on the new PartTran.JobSeq. This method is used while receiving Salvaged material to Inventory.
Epicor 9.05 | 9.05.605
1833
M-R
Business Object Reference Guide
Parameters Name
Type
ds pcMessage
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
String@
Information passed back from the business logic.
OnChangeSalvagePartNum Change the PartTran values based on the new PartTran.PartNum. This method is used while receiving Salvaged material to Inventory. Parameters Name
Type
ds pcMessage
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
String@
Information passed back from the business logic.
OnChangeTranQty Change the PartTran values based on the new value of PartTran.TranQty. Parameters Name
Type
ds pcMessage
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
String@
Information passed back from the business logic.
PreUpdate This method will return a record in the LegalNumberGenerate datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds requiresUserInput
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
Boolean@
Indicates if the legal number requires user input
ReceiveMfgPartToInventory Update the Receipts from Manufacturing to Inventory.
1834
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
pdSerialNoQty
Decimal
The quantity of Serialized parts. This value is returned by Serial # selector object.
plNegQtyAction
Boolean
When TranQty changes, perform NegativeInventoryTest. Provide the answer of that test here.
pcMessage
String@
Non error, informational message passed back from the business logic.
pcPartTranPKs
String@
PartTran primary keys generated for this operation.
pcProcessID
String
The name ID of the UI process that's calling this procedure.
ReceiveMfgPartToJob Update the Receipts from Manufacturing to Job. Parameters Name
Type
ds
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
pdSerialNoQty
Decimal
The quantity of Serialized parts. This value is returned by Serial # selector object.
plNegQtyAction
Boolean
When TranQty changes, perform NegativeInventoryTest. Provide the answer of that test here.
plIssuedComplete
Boolean
Issue Complete
pcMessage
String@
Non error, informational message passed back from the business logic.
pcPartTranPKs
String@
PartTran primary keys for this operation.
pcProcessID
String
The name ID of the UI process that's calling this procedure.
ReceiveSalvagedPartToInventory Update Salvaged Material to Inventory. Parameters Name
Type
ds
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
pcMessage
String@
Non error, informational message passed back from the business logic.
pcPartTranPKs
String@
Part Tran primary keys of the generated partTran records
pcProcessID
String
The name ID of the UI process that's calling this procedure.
Epicor 9.05 | 9.05.605
1835
M-R
Business Object Reference Guide
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
Description
ds
ReceiptFromMfg data set
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
pcProcessID
String
The ID of the calling process in UI
VerifySerialMatch Verifies if the user should enter child serial numbers for the serial numbers being received depending on the setting of the Serial Number Matching before save. Parameters Name
Type
ds
Description Epicor.Mfg.BO.ReceiptsFromMfgDataSet
pcMsg
String@
Set by the BL. It is used to send warining or error messages to the UI.
piMsgType
Int32@
The type of the message being returned. when 1 - it is a warning msg, when 2 - it is an error msg, when 0 - no msg should be displayed.
RecurringJournal Epicor.Mfg.BO.RecurringJournal: This business object contains 24 methods.
GetNewGLRecHed Inserts a new row in the DataSet with defaults populated.
GetNewGLRecDtl Inserts a new row in the DataSet with defaults populated.
GetNewGLRecSched Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1836
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
Epicor 9.05 | 9.05.605
Description
1837
M-R
Business Object Reference Guide
Name
Type
fieldName
String
Description
Returns
AutoBalance This method does Auto Balance for Recurring Journal record with number recurNum and with line recurLine. Parameters Name
Type
Description
recurNum
Int32
Recurring Journal record number
recurLine
Int32
Recurring Journal record line number
ds
The Recurring Journal data set
ChangeBookID This method updates the Fiscal Calendar when the book changes. Book can be blank. A blank book indicates use of the company fiscal calendar. Parameters Name
Type
Description
proposedBookID
String
The proposed Book
ds
The Recurring Journal data set
ChangeEntryMode Method to call when changing the Entry Mode. Parameters Name
Type
Description
proposedBookMode
String
The proposed Entry Mode
ds
The Recurring Journal DataSet to update the Header related data.
ChangeGlAcct This method resets the G/L Reference Type and Code when the G/L Account changes. Depending on the new GL account, the Reference Type/Code can become mandatory or optional. Make sure to call the GetMaskRefCodes method of the GLRefTypBusiness Object to get the new list of all GL Reference Codes related to the entered Account number. This method will also return values for GlRecDtl.RefCodeStatus and GlRecDtl.RefAcctDiv/RefAcctDept/RefAcctChart. Enable update of GlRecDtl.GLRefCode if the value returned for RefCodeStatus is either "M" for Mandatory or "O" for Optional.
1838
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
proposedDispAcct
String
The proposed G/L Display Account
ds
The Recurring Journal data set
ChangeRateType Method to call when changing the Rate Type. Parameters Name
Type
Description
proposedRateType
String
The proposed Rate Type
ds
The Recurring Journal DataSet to update the Header related data.
CheckBalance Before updating the GlRecHed record, CheckBalance will have to be called. The CheckBalance method will check to make sure the TotCredit and TotDebit fields are equal. Parameters Name
Type
ds recurNum
Description The Recurring Journal data set
Int32
The current recurring journal number
CheckCurrencyAccount This procudura validata if the Account is a currency Account Parameters Name
Type
Description
ipCOACode
String
The current COACode
ipSegValue
String
The current segment value one
opCurr
Boolean@
The Currency accont Flag
CheckGroupPrefixChange This method checks if the group prefix on the recurring journal header changed and if there are other recurring journals created for the book/multi-book. If there are the group prefix on those records will be updated to the new value, but check with user before performing this action.
Epicor 9.05 | 9.05.605
1839
M-R
Business Object Reference Guide
Parameters Name
Type
Description
inRecurNum
Int32
The recurring journal entry number
inBookID
String
The book id
inGroupPrefix
String
The proposed group prefix
outMessage
String@
Message to the user
ConvertCreditAmount This method convert the document currency to the journal currency. Parameters Name
Type
Description
proposedAmount
Decimal
The proposed Amount
ds
The GL Journal Entry data set
ConvertDebitAmount This method convert the document currency to the journal currency. Parameters Name
Type
Description
proposedAmount
Decimal
The proposed Amount
ds
The GL Journal Entry data set
CreateSchedForYear This method created GLRecSched records given a fiscal year. Parameters Name
Type
ds cOutMessage
Description The generate schedule parameters data set
String@
Output message
Returns The Recurring Journal data set
GetGLRecSchedGenerate This method returns the generate schedule dataset.
1840
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
inRecurNum
Int32
The GLRecHed number
Returns The Recurring Journal data set
Renumber This method renumbers lines in Recurring Journal record with number recurNum. Parameters Name
Type
Description
recurNum
Int32
Recurring Journal record number
ds
The Recurring Journal data set
ValidateCurrencyAccount This procedure validate it the currency is allowed. Parameters Name
Type
Description
ipCOACode
String
The current COACode
ipSegValue
String
The current segment value one
ipCurrency
String
The proposed Currency value
RefCategory Epicor.Mfg.BO.RefCategory: This business object contains 7 methods.
GetNewRefCategory Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
1841
M-R
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Region Epicor.Mfg.BO.Region: This business object contains 7 methods.
GetNewRegion Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
1842
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
1843
M-R
Business Object Reference Guide
ReminderGroup Epicor.Mfg.BO.ReminderGroup: This business object contains 8 methods.
GetNewReminderGroup Inserts a new row in the DataSet with defaults populated.
GetNewReminderSequence Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1844
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ReminderLetter Epicor.Mfg.BO.ReminderLetter: This business object contains 14 methods.
GetNewReminderLetter Inserts a new row in the DataSet with defaults populated.
GetNewInvcReminder Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
1845
M-R
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CreateReminderInvoices Purpose: run the calcCombinedFinanceCharge.p that will create fin charge invoices Parameters Name
Type
ds
Description Reminder Letter Data Set
ipAsOfDate
Nullable{System.DateTime}
As of Date
ipCustomerList
String
Customer List
ipGroupID
String
Invoice Group
GenerateReminderLetters Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCompanySetup Purpose: returns the "Combined with Reminder Letter" company setting
1846
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
opCombined
Boolean@
opCombined
PostReminders This method posts reminder letters to the DB. Parameters Name
Type
ds
Description Reminder Letter Data Set
PrePrintReminders Purpose: put temp records into DB, so that they can be updated in case of successfull printing. Parameters Name
Type
ds
Description Reminder Letter Data Set
RefreshLetters Purpose: Get Printed field value for all generated letters. Parameters Name
Type
ds
Description Reminder Letter Data Set
RenewalCode Epicor.Mfg.BO.RenewalCode: This business object contains 12 methods.
GetNewRenewalCode Inserts a new row in the DataSet with defaults populated.
GetNewRenewalCodeAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
1847
M-R
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeOfIncreaseMeth This method should be called to set Increase Method.
1848
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipRenewalCode
String
Renewal Code.
ipIncreaseMethNew
Int32
New Increase Method.
ds
Renewal Code data set.
OnChangeOfQuoted This method should be called to set Quoted. Parameters Name
Type
Description
ipQuoted
Boolean
Quoted.
ds
Renewal Code data set.
ValidatePriceList Performs required logic when RenewalCode.PriceListCode is modified. Parameters Name
Type
Description
ipPriceListCode
String
Proposed input value of PriceListCode
ds
Renewal Code data set
ValidateTaskSet Performs required logic when RenewalCode.TaskSetID is modified. Parameters Name
Type
Description
ipTaskSet
String
Proposed input value of TaskSetID
ds
Renewal Code data set
Replication Epicor.Mfg.BO.Replication: This business object contains 10 methods.
GetNewReplCompany Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1849
M-R
Business Object Reference Guide
GetNewReplProfile Inserts a new row in the DataSet with defaults populated.
GetNewReplProfilePerCompany Inserts a new row in the DataSet with defaults populated.
GetNewReplSetting Inserts a new row in the DataSet with defaults populated. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
1850
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ReplProfile Epicor.Mfg.BO.ReplProfile: This business object contains 8 methods.
GetNewReplProfile Inserts a new row in the DataSet with defaults populated.
GetNewReplProfileTable Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
1851
M-R
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Report Epicor.Mfg.BO.Report: This business object contains 12 methods.
GetNewReport Inserts a new row in the DataSet with defaults populated.
GetNewReportStyle Inserts a new row in the DataSet with defaults populated.
GetNewRptStylePrinters Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1852
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
OnChangeOutputEDI Set Defaut OutputEDI after change RptTypeID
Epicor 9.05 | 9.05.605
1853
M-R
Business Object Reference Guide
Parameters Name
Type
Description
newRptTypeID
String
New Report Type.
ds
Report data set.
Use to get a sub delimited list of ReportType.RptTypeID and ReportType.RptTypeDescription. The Code/Desc pairs are delimited by the ~ character. The Code/Desc element is subdelimited by the ` character.
ReportMonitor Epicor.Mfg.BO.ReportMonitor: This business object contains 12 methods.
GetNewSysRptLst Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1854
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetReportData Get a report's data from the server Parameters Name
Type
Description
sysRowID
String
The row ID of the report to get the data for
Returns Report data
GetReportDefinition Get a report's data from the server Parameters Name
Type
Description
sysRowID
String
The row ID of the report to get the data for
Returns Report data
GetRowsKeepIdleTime This method reverts the last used time so that we don't prevent time-out from working. After that call base GetRows. Parameters Name
Type
Description
whereClauseSysRptLst
String
The where clause to restrict data for
Epicor 9.05 | 9.05.605
1855
M-R
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The page size
absolutePage
Int32
The absolute page
morePages
Boolean@
More pages?
Returns The dataset with populated values Call context dataset Constructor Parameters Name
Type
connPool
Description Connection pool
ReportQty Epicor.Mfg.BO.ReportQty: This business object contains 12 methods.
CheckInspResults This method validates if InspResults has been entered when the Inspection Data is allowed for the current OprSeq. Parameters Name
Type
Description
ipJobNum
String
Current Job
ipAssemblySeq
Int32
Current AssembleSeq
ipOprSeq
Int32
Current OprSeq
inspectionOK
Boolean@
Returns true if InspResults records are found
DeleteLaborEquip This method should call when EquipID is changed Parameters
1856
Name
Type
Description
empID
String
Current Employee ID
equipID
String
Current Labor Equipment ID
hedSeq
Int32
Current LaborDtl.LaborHedSeq value
dtlSeq
Int32
Current LaborDtl.LaborDtlSeq value
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
M-R
Type
Description
ds
Epicor.Mfg.BO.ReportQtyDataSet
GetNewLaborEquip This method returns the new Labor Equipment Parameters Name
Type
Description
empID
String
Current Employee ID
ds
Epicor.Mfg.BO.ReportQtyDataSet
GetNewReportQty This method returns the new ReportQty dataset in place of the standart GetNew method. Parameters Name
Type
Description
empID
String
Current Employee ID
dtlLaborHedSeq
Int32
Current LaborDtl.LaborHedSeq value if record is available
dtlLaborDtlSeq
Int32
Current LaborDtl.LaborDtlSeq value if record is available
Returns Report Qty Dataset
OnChangeAsmSeq This method validates the Assembly sequence. Parameters Name
Type
Description
assemblySeq
Int32
Assembly Sequence
ds
Report Qty Dataset
OnChangeEquipID This method should call when EquipID is changed Parameters Name
Type
Description
equipID
String
equipID
dtlLaborHedSeq
Int32
Current LaborDtl.LaborHedSeq value
Epicor 9.05 | 9.05.605
1857
M-R
Business Object Reference Guide
Name
Type
Description
dtlLaborDtlSeq
Int32
Current LaborDtl.LaborDtlSeq value
ds
Report Quantity DataSet
OnChangeJobNum This method validates the Operation sequence. Parameters Name
Type
Description
jobNum
String
Job Number
ds
Report Qty Dataset
OnChangeNextOprSeq This method validates the Next Operation sequence. Parameters Name
Type
Description
nextOprSeq
Int32
Next Operation Sequence
ds
Report Qty Dataset
OnChangeOprSeq This method validates the Operation sequence. Parameters Name
Type
Description
oprSeq
Int32
Operation Sequence
ds
Report Qty Dataset
OnChangeResource This method validates the ResourceID. Parameters Name
Type
Description
resourceID
String
Resource ID
ds
1858
Report Qty Dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ReportQuantity This method reports the quantity changes to the database Parameters Name
Type
ds
Description Report Qty Dataset
UpdateLaborEquip This method should call when EquipID is changed Parameters Name
Type
Description
empID
String
Current Employee ID
equipID
String
Current Labor Equipment ID
hedSeq
Int32
Current LaborDtl.LaborHedSeq value
dtlSeq
Int32
Current LaborDtl.LaborDtlSeq value
ds
Epicor.Mfg.BO.ReportQtyDataSet
ReportStyleSearch Epicor.Mfg.BO.ReportStyleSearch: This business object contains 7 methods.
GetNewReportStyle Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1859
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Req Epicor.Mfg.BO.Req: This business object contains 30 methods.
GetNewReqHead Inserts a new row in the DataSet with defaults populated.
GetNewReqHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewReqDetail Inserts a new row in the DataSet with defaults populated.
1860
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetNewReqDetailAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
1861
M-R
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
1862
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
BuildNextDispatcher This methods builds next Dispatcher. Returns list of user ids and list of user names. Parameters Name
Type
Description
nextActionID
String
The next action ID
dispIDList
String@
Users ID list
dispNmList
String@
Users Name list
CheckJobNum This method checks to see if the proposed Job Number is a valid Job Parameters Name
Type
Description
jobNum
String
The proposed Job Number
CheckPartStatus Perform Part Inactive, Obsolete, Runout validation.
Epicor 9.05 | 9.05.605
1863
M-R
Business Object Reference Guide
Parameters Name
Type
Description
partNum
String@
Part number to be validated
vMessage
String@
String of questions UI needs to ask the user
vSubAvail
Boolean@
var indicating if substitute parts exist to choose from
vMsgType
String@
output parameter used by the client logic to determine what action to take for the given message.
CloseRequisition This method closes Requisition. Parameters Name
Type
Description
reqNum
Int32
The number of Requisition to close
reqUserId
String
The ID of user
Returns The Req dataset
DeleteReqLog This method deletes Requisition log with given type changedate and changetime. Parameters Name
Type
Description
reqNum
Int32
The number of Requisition
changeDate
Nullable{System.DateTime}
The ChangeDate of log to delete
changeTime
Int32
The ChangeTime of log to delete
reqLogType
String
The LogType of log to delete
GetCostInfo This method sets Unit Cost and Extended Cost. Parameters Name
Type
ds
Description The Req dataset
GetExchangeRate This method gets the Exchange Rate by the given date.
1864
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ds reqDate
The Req dataset Nullable{System.DateTime}
The last date a rate is valid
GetPartCrossRef This method defaults ShipDtl fields when the PartNum field changes Parameters Name
Type
ds
Description Requisition data set
reqLine
Int32
Detail Line Number to update
partNum
String@
Proposed PartNumber change
uomCode
String@
Proposed UOM Code
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetPartInfo This method defaults ReqDetail part fields. Parameters Name
Type
ds uomCode
Description ReqDataSet
String
Proposed Part Cross Reference UOM Code
GetQtyInfo This method applies PurchasingFactor to Qties by given field that was changed OrderQty or XOrderQty. Parameters Name
Type
ds fieldName
Epicor 9.05 | 9.05.605
Description ReqDataSet
String
Indicates field that was changed. Possible values OrderQty or XOrderQty
1865
M-R
Business Object Reference Guide
GetReqLogList Public method to get the ReqLog dataset. Parameters Name
Type
Description
whereClause
String
The where clause to restrict data for
pageSize
Int32
The page size, used only for UI adaptor
absolutePage
Int32
The absolute page, used only for the UI adaptor
morePages
Boolean@
More pages?, used only for the UI adaptor
Returns ReqLogDataSet
GetVendorInfo This method update Vendor related field. Parameters Name
Type
ds
Description ReqDataSet
RDMenuFlags returns flags indicating whether Reset Dispatching or Dispatch Requisiton should be enabled or disabled Parameters Name
Type
Description
reqNum
Int32
The number of Requisition to close
reqUserId
String
The ID of user
resetDispatch
Boolean@
Logical flag indicating Reset Dispatching should be enabled or disabled
dispatchReq
Boolean@
Logical flag indicating Dispatch Requisiton should be enabled or disabled
ResetDispatching This method resets Dispatching. UI needs to ask before running method "WARNING: This will delete all entries in the action log and delete all previous Dispatching steps. Do you wish to continue?" Parameters
1866
Name
Type
Description
reqNum
Int32
The number of Requisition
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
reqUserId
String
The user ID
Returns ReqDataSet
ReqActs Epicor.Mfg.BO.ReqActs: This business object contains 6 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1867
M-R
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ReservePri Epicor.Mfg.BO.ReservePri: This business object contains 7 methods.
GetNewReservePri Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1868
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Resource Epicor.Mfg.BO.Resource: This business object contains 7 methods.
GetNewResource Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
1869
M-R
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ResourceCollection Epicor.Mfg.BO.ResourceCollection: This business object contains 7 methods.
GetNewResourceCollection Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
1870
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ResourceGroup Epicor.Mfg.BO.ResourceGroup: This business object contains 23 methods.
GetNewResourceGroup Inserts a new row in the DataSet with defaults populated.
GetNewResourceGroupAttch Inserts a new row in the DataSet with defaults populated.
GetNewResource Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1871
M-R
Business Object Reference Guide
GetNewCapResLnk Inserts a new row in the DataSet with defaults populated.
GetNewResourceCal Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
1872
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
BuildRsrcGrpResourceCalList This method will populate the ttResourceCal table using the resource group that was passed in. Parameters Name
Type
Description
cResourceGrpID
String
The current Resource GroupID
Returns The ResourceGroup data set
BuildRsrcResourceCalList This method will populate the ttResourceCal table using the resource group that was passed in. Parameters Name
Type
Description
cResourceGrpID
String
The current Resource Group ID
cResourceID
String
The current Resource ID
Returns The ResourceGroup data set
CheckRGPlant This method will verify that the Resource Group ID entered is from the Current plant.
Epicor 9.05 | 9.05.605
1873
M-R
Business Object Reference Guide
Parameters Name
Type
Description
cResourceGrpID
String
The current Resource GroupID
CustomizeResourceCalRsrc This method will get a current ResourceCal record or create a temporary ResourceCal record to be modified for a RESOURCE. The ProdHours will be defaulted from the weekday of the selected date. If any changes are made to the ttResourceCal record, the UpdateResourceCal method will have to be called to write the temporary ResourceCal record to the database. Parameters Name
Type
Description
cResourceID
String
The current Resource ID
cResourceGrpID
String
The current Resource Group ID
daDate
Nullable{System.DateTime}
The selected date to be customized
ds
The ResourceGroup data set
CustomizeResourceCalRsrcGrp This method will get a current ResourceCal record or create a temporary ResourceCal record to be modified for a RESOURCE GROUP. The ProdHours will be defaulted from the weekday of the selected date. If any changes are made to the ttResourceCal record, the UpdateResourceCal method will have to be called to write the temporary ResourceCal record to the database. Parameters Name
Type
Description
cResourceGrpID
String
The current Resource Group ID
daDate
Nullable{System.DateTime}
The selected date to be customized
ds
The ResourceGroup data set
InsertNewResource This method creates a new Resource after prompting for the ResourceID and ResourceGrpID. This is to replace the standard GetNewResource . Parameters Name
Type
Description
ipResourceID
String
The new resource id value.
ipResourceGrpID
String
The resourcegrp id value that you are adding this resource to
ds
1874
The ResourceGroup data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
MoveResource This method creates a new Resource after prompting for the ResourceID and ResourceGrpID. This is to replace the standard GetNewResource . Parameters Name
Type
Description
ipResourceID
String
The moving resource id value.
ipFromResourceGrpID
String
The resourcegrp id value that you are moving the resource from.
ipToResourceGrpID
String
The resourcegrp id value that you are moving the resource to.
Returns The ResourceGroup data set
SetInactiveFlag Call this method when the Inactive Flag on the Resource Group changes and the user answer "Yes" to set the inactive flag on the Resources. All of the Resources Inactive flags will be set to equal to the new inactive setting on the Resource Group. Parameters Name
Type
Description
ds
The ResourceGroup data set
UpdateResourceCal This method will check to see if the current ttResourceCal record was modified. If it was modified then it compares the capacity from the ttResourceCal the capacity of the production calendar for that day of the week. If they are different, or if it is a special working day or non-working day then it save the ttResourceCal record to the database. Parameters Name
Type
Description
ds
The ResourceGroup data set
ValidateInspection Parameters Name
Type
Description
ipProposedInspPlan
String
The new proposed InspPlanPartNum value
ipProposedSpecId
String
The new proposed SpecID value
Epicor 9.05 | 9.05.605
1875
M-R
Business Object Reference Guide
ValidateResource This method validates that the Resource exists and that it isn't assigned to another Resource Group. Parameters Name
Type
Description
ipResourceID
String
The resource id value to validate.
ipResourceGrpID
String
The resourcegrp id value to validate.
ResourceType Epicor.Mfg.BO.ResourceType: This business object contains 6 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
1876
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
RestrictedFcts Epicor.Mfg.BO.RestrictedFcts: This business object contains 7 methods.
GetNewRestrictedFcts Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
1877
M-R
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
RestrictFcts Epicor.Mfg.BO.RestrictFcts: This business object contains 7 methods.
GetNewRestrictFcts Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1878
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ReturnRequest Epicor.Mfg.BO.ReturnRequest: This business object contains 16 methods.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
1879
M-R
Business Object Reference Guide
Returns
CheckEmployee This method needs to be called from the main menu only. if the object is being called from the shop floor menu then the employee id has already been determined and validated and is passed in Parameters Name
Type
Description
empID
String
Employee ID
empName
String@
Employee Name
GetNewAssyMtlInfo Call this method to create a new Epicor.Mfg.BO.ReturnRequestDataSet with Job# Parameters Name
Type
Description
jobNum
String
Job Number
ds
ReturnRequestDataSet
GetNewMiscInfo Call this method to create a new Epicor.Mfg.BO.ReturnRequestDataSet with Part# Parameters Name
Type
Description
partNum
String
Part Number
ds
ReturnRequestDataSet
GetNewSalvageInfo Call this method to create a new Epicor.Mfg.BO.ReturnRequestDataSet with Job# Parameters Name
Type
Description
jobNum
String
Job Number
ds
ReturnRequestDataSet
OnChangeAssembly Call this method to update the dataset when the ReturnRequest.AssemblySeq is changed RowMod must be "A" or "U" for this method to work
1880
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
assemblySeq
Int32
AssemblySeq
ds
ReturnRequestDataSet
OnChangeFromBin Call this method to update the dataset when the RequestLines.FromBinNum is changed RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
binNum
String
BinNum
cRowIdent
String
RequestLines RowIDent
ds
ReturnRequestDataSet
OnChangeFromWhse Call this method to update the dataset when the RequestLines.FromWhse is changed RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
whseCode
String
From Warehose
cRowIdent
String
RequestLines RowIDent
ds
ReturnRequestDataSet
OnChangeIUM Call this method when the value of Epicor.Mfg.BO.ReturnRequest.IUM changes. Parameters Name
Type
Description
pUM
String
Transaction UOM
ds
IssueReturnDataSet
OnChangeJobNum Call this method to update the dataset when the ReturnRequest.JobNum is changed RowMod must be "A" or "U" for this method to work
Epicor 9.05 | 9.05.605
1881
M-R
Business Object Reference Guide
Parameters Name
Type
Description
jobNum
String
JobNum
ds
ReturnRequestDataSet
OnChangeMtlSeq Call this method to update the dataset when the ReturnRequest.MtlSeq is changed RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
mtlSeq
Int32
MtlSeq
ds
ReturnRequestDataSet
OnChangePartNum Call this method to update the dataset when the ReturnRequest.PartNum is changed RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
partNum
String
PartNum
ds
ReturnRequestDataSet
OnChangeRequestQty Call this method when the value of Epicor.Mfg.BO.ReturnRequest.RequestQty changes. Parameters Name
Type
Description
requestQty
Decimal
Request Quantity
ds
IssueReturnDataSet
OnChangeToBin Call this method to update the dataset when the RequestLines.ToBinNum is changed RowMod must be "A" or "U" for this method to work Parameters
1882
Name
Type
Description
binNum
String
BinNum
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
cRowIdent
String
RequestLines RowIDent
ds
ReturnRequestDataSet
OnChangeToWhse Call this method to update the dataset when the RequestLines.ToWhse is changed RowMod must be "A" or "U" for this method to work Parameters Name
Type
Description
whseCode
String
To Warehose
cRowIdent
String
RequestLines RowIDent
ds
ReturnRequestDataSet
ProcessLines Run this method when done updating all the detail lines (currently OK button in 6.1) clear screen when done Must set the ReturnRequest RowMod to "U" for this method to work Parameters Name
Type
ds
Description ReturnRequestDataSet
ReverseCashReceipt Epicor.Mfg.BO.ReverseCashReceipt: This business object contains 10 methods.
GetNewCashHead Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1883
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
GroupID
keyValue2
String
HeadNum
PreUpdate This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does,
1884
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds
Description Reverse Cash Receipt data set
inputDate
Nullable{System.DateTime}
The date of Cash Receipt Reverse
requiresUserInput
Boolean@
Indicates if the legal number requires user input
ReverseCashReceipt Reverse Cash Receipt Parameters Name
Type
ds
Description Reverse Cash Receipt data set
headNum
Int32
Head number
reverseDate
Nullable{System.DateTime}
Reverse Date
postErrorLog
String@
Error log
legalNumberMessage
String@
The legal number message to display to the user. Can be blank
ReviewJrn Epicor.Mfg.BO.ReviewJrn: This business object contains 17 methods.
GetNewRvJrn Inserts a new row in the DataSet with defaults populated.
GetNewRvJrnTr Inserts a new row in the DataSet with defaults populated.
GetNewRvJrnTrDtl Inserts a new row in the DataSet with defaults populated.
GetNewWError Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
1885
M-R
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
1886
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetJournalHeader Parameters Name
Type
Description
ipRvJrnUID
Int32
RvJrnUID
ipRecLimitPerTr
Int32
RecLimitPerTr
Returns The DataSet.
GetJournalTreeLeaf Parameters Name
Type
Description
ipRvJrnUID
Int32
RvJrnUID
ipRvJrnTrUID
Int32
RvJrnTrUID
ipBookID
String
BookID
ipTreeLeafUID
Int32
TreeLeafUID
ipRecLimitPerTr
Int32
RecLimitPerTr
ds
Review Jrn Data Set
RestoreTmpJournalLine Parameters Name
Type
Description
ipRvJrnUID
Int32
RvJrnUID
ipRvJrnTrUID
Int32
RvJrnTrUID
ipBookID
String
BookID
ipTreeLeafUID
Int32
TreeLeafUID
ds
Review Jrn Data Set
ExcludeFromList Exclude journals from the list with do not conform search criteria. Parameters Name
Type
Description
intRvJrnUID
Int32
Journal number
intACTTypeUID
Int32
Search criteria for RvJrnTr table
Epicor 9.05 | 9.05.605
1887
M-R
Business Object Reference Guide
Name
Type
Description
strGroupID
String
Search criteria for RvJrnTrDtl table
lExclude
Boolean@
True if journal should be excluded from the list
GetRefTypeList Get list of reference types. Returns strList
ProcessJournal Confirm or cancel journal entry. Parameters Name
Type
Description
bConfirm
Boolean
True if confirm
inrvJrnUID
Int32
journal number
TransValidate Validate Transactions for current journal. Parameters Name
Type
Description
rvJrnUID
Int32
journal number
isValid
Boolean@
is Valid journal
RevisionCompare Epicor.Mfg.BO.RevisionCompare: This business object contains 4 methods.
GetComparison Parameters
1888
Name
Type
Description
pcMOM1PartNum
String
Item1 Part number (applies to Part comparison).
pcMOM1RevisionNum
String
Item1 RevisionNum (applies to Part comparison).
pcMOM1AltMethod
String
(optional) Item1 AltMethod (applies to Part comparison).
pcMOM1JobNum
String
Item1 JobNum (applies to Job comparison).
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
piMOM1QuoteNum
Int32
Item1 QuoteNum (applies to Quote comparison).
piMOM1QuoteLine
Int32
Item1 QuoteLine (applies to Quote comparison).
piMOM1AssemblySeq
Int32
Item1 AssemblySeq (applies to Job or Quote comparison).
pdMOM1AsOfDate
Nullable{System.DateTime} (optional) Item1 "as of" date for Revisions to be used (applies to Job or Part comparison).
pcMOM2PartNum
String
Item2 Part number (applies to Part comparison).
pcMOM2RevisionNum
String
Item2 RevisionNum (applies to Part comparison).
pcMOM2AltMethod
String
(optional) Item2 AltMethod (applies to Part comparison).
pcMOM2JobNum
String
Item2 JobNum (applies to Job comparison).
piMOM2QuoteNum
Int32
Item2 QuoteNum (applies to Quote comparison).
piMOM2QuoteLine
Int32
Item2 QuoteLine (applies to Quote comparison).
piMOM2AssemblySeq
Int32
Item2 AssemblySeq (applies to Job or Quote comparison).
pdMOM2AsOfDate
Nullable{System.DateTime} (optional) Item2 "as of" date for Revisions to be used (applies to Job or Part comparison).
pcFrameTitle
String@
Description of Comparison being made.
Returns RevComparison dataset
GetJobMOM To retrieve the Assemblies, Materials and Operations that make up the Method of Manufacturing for the given Job (or optionally, the given assembly within that Job's MOM). The set of fields in the dataset is NOT COMPLETE, it only contains fields that are in common with the MOM definitions corresponding to all three of Quote, Job and Part. (Actually, only the fields that are present in Vantage 6.10 Revision Compare; it is possible there are fields have been omitted.) Parameters Name
Type
Description
pcJobNum
String
Job ID of MOM (Bill of Materials + Bill of Operations) to be retrieved.
piAssemblySeq
Int32
(optional) Assembly number of MOM to be retrieved.
Returns RevisionCompare dataset
GetPartMOM To retrieve the Assemblies, Materials and Operations that make up the Method of Manufacturing for the given Part Revision. The set of fields in the dataset is NOT COMPLETE, it only contains fields that are in common with the MOM definitions corresponding to all three of Quote, Job and Part. (Actually, only the fields that are present in Vantage 6.10 Revision Compare; it is possible there are fields have been omitted.)
Epicor 9.05 | 9.05.605
1889
M-R
Business Object Reference Guide
Parameters Name
Type
Description
pcPartNum
String
Part number of MOM (Bill of Materials + Bill of Operations) to be retrieved.
pcRevisionNum
String
Revision ID of MOM to be retrieved.
pcAltMethod
String
Alt Method of MOM to be retrieved.
pdAsOfDate
Nullable{System.DateTime} (optional) Revisions that were current as of this date to be used.
Returns RevisionCompare dataset
GetQuoteMOM To retrieve the Assemblies, Materials and Operations that make up the Method of Manufacturing for the given QuoteLine (or optionally, the given assembly within that QuoteLine's MOM). The set of fields in the dataset is NOT COMPLETE, it only contains fields that are in common with the MOM definitions corresponding to all three of Quote, Job and Part. (Actually, only the fields that are present in Vantage 6.10 Revision Compare; it is possible there are fields have been omitted.) Parameters Name
Type
Description
piQuoteNum
Int32
Quote number of MOM (Bill of Materials + Bill of Operations) to be retrieved.
piQuoteLine
Int32
Quote Line of MOM to be retrieved.
piAssemblySeq
Int32
(optional) Assembly number of MOM to be retrieved.
pdAsOfDate
Nullable{System.DateTime} (optional) Revisions that were current as of this date to be used.
Returns RevisionCompare dataset
RFQDecisionWizard Epicor.Mfg.BO.RFQDecisionWizard: This business object contains 7 methods.
Accept This method will do the following (text from 6.1 procedure): Find Related JobMtl/JobOper/QuoteMtl/QuoteOpr (must be avail), and update estunitcost. Note, if related to Job, the JobMtl write trigger was changed to fire off and create a POSuggestion - like it should have done when you marked it "Purchase/direct" but we changed it so that if you flag RFQNeeded also, would create an RFQSuggestion INSTEAD of a POSuggestion. Once the RFQ has been created and vendor responds, the trigger will create a POSuggestion. Set rest of vendor responses for this rfq to status = NO, close rfqLine/item
1890
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
ipRFQNum
Int32
The rfq number to accept for.
ipRFQLine
Int32
The rfq line number to accept for.
ipVendorNum
Int32
The vendor num to accept for.
ipPurPoint
String
The purchase point to accept for.
ipAnswer
Boolean
The user answer to PreAccept potential message.
ds
RFQDecisionWizardDataSet
Apply This method will create the RFQReadyVend records associated with the RFQFilterDW record and the selected filter and sort options. Parameters Name
Type
ds
Description RFQDecisionWizardDataSet
CheckBeforeCreatePO Asks user before create the PO for a Quoted Item Parameters Name
Type
Description
iQuoteNum
Int32
Quote Number on RFQItem. Can be zero
oMsg
String@
Message to be displayed. Don't display if blank.
CreatePO This method create the purchase order for this rfqitem. Parameters Name
Type
Description
ipRFQNum
Int32
The rfq number to create po for.
ipRFQLine
Int32
The rfq line number to create po for.
ipVendorNum
Int32
The vendor num to create po for.
ipPurPoint
String
The purchase point to create po for.
ipLineQty
Decimal
The line quantity.
ipDueDate
Nullable{System.DateTime}
The due date.
ipPromiseDate
Nullable{System.DateTime}
The promise date.
Epicor 9.05 | 9.05.605
1891
M-R
Business Object Reference Guide
Name
Type
Description
opStatusMsg
String@
The message if PO created successfully.
ds
RFQDecisionWizardDataSet
GetHeaderRecord This method will create a RFQFilterDW record with information from the RFQ and populate the attributes to include/exclude and sort options. The record created here will then be used for the Apply method to generate the RFQReadyVend records. Run this as the first method. Parameters Name
Type
Description
ipRFQNum
Int32
The rfq number to get data for.
ipRFQLine
Int32
The rfq line number to get data for.
Returns RFQDecisionWizardDataSet
GetLineQty This method gets the Job Qty (if job related) and sets a flag to tell the UI to update the Qty, duedate and promise date fields. Run this before CreatePO. Parameters Name
Type
Description
ipRFQNum
Int32
RFQ Number
ipRFQLine
Int32
RFQ Line Number
ipVendorNum
Int32
Vendor Number
ipPurPoint
String
Vendor Purchase Point
opTmpLineQty
String@
Calculated Line Quantity
opPromptQty
Boolean@
If yes, the Quantity and date fields need to be updated
PreAccept This method will potentially produce a message that will provide the user with a choice of continuing with the Accept. Call this before the Accept method and then pass into the Accept method the logical choice from the user's response to the potential message from this method. Parameters
1892
Name
Type
Description
ipRFQNum
Int32
The rfq number to validate for.
ipRFQLine
Int32
The rfq line number to validate for.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
ipVendorNum
Int32
The vendor num to validate for.
ipPurPoint
String
The purchase point to validate for.
opStatusMsg
String@
The potential message to ask user.
RFQEntry Epicor.Mfg.BO.RFQEntry: This business object contains 30 methods.
GetNewRFQHead Inserts a new row in the DataSet with defaults populated.
GetNewRFQItem Inserts a new row in the DataSet with defaults populated.
GetNewRFQPart Inserts a new row in the DataSet with defaults populated.
GetNewRFQQty Inserts a new row in the DataSet with defaults populated.
GetNewRFQSourcing Inserts a new row in the DataSet with defaults populated.
GetNewRFQVend Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1893
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AddRFQItemFromJob This method adds RFQItem from Job Parameters Name
Type
Description
piRFQNum
Int32
RFQ Number
pcJobNum
String
Job Number
pcGlbCompany
String
GlbCompany Number
ds pcMessage
1894
Epicor.Mfg.BO.RFQEntryDataSet String@
Return Message
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
AddRFQItemFromQuote This method adds RFQItem from Qoute Parameters Name
Type
Description
piRFQNum
Int32
RFQ Number
piQuoteNum
Int32
Quote Number
pcGlbCompany
String
GlbCompany Number
ds pcMessage
Epicor.Mfg.BO.RFQEntryDataSet String@
Return Message
AddRFQItemJob This method adds RFQItem with SugNumList Parameters Name
Type
Description
piRFQNum
Int32
RFQ Number
pcSugNumList
String
SugNumList
ds pcMessage
Epicor.Mfg.BO.RFQEntryDataSet String@
Return Message
AddRFQItemQuote This method adds RFQItem with SugNumList from Qoute Parameters Name
Type
Description
pcSugNumList
String
SugNumList
piRFQNum
Int32
RFQ Number
ds pcMessage
Epicor.Mfg.BO.RFQEntryDataSet String@
Return Message
AddSupplierFromSearch Call this method when UI uses Add (search).
Epicor 9.05 | 9.05.605
1895
M-R
Business Object Reference Guide
Parameters Name
Type
ds
Description Epicor.Mfg.BO.RFQEntryDataSet
pcVendorID
String
VendorID
pcPurPoint
String
PurPoint
CheckComplianceFail Check for every vendor of the RFQ if it requires to be compliant. Parameters Name
Type
Description
rfqNum
Int32
Current RFQ.
rfqLine
Int32
Current RFQ Line.
vendorNum
Int32
Current Vendor.
purPoint
String
Current Purchase Point.
compliant
Boolean@
Indicates if the current RFQ is compliant.
CreateNewRFQQty Create RFQQty record. Please use this method instead of GetNewRFQQty. Parameters Name
Type
Description
ds
Epicor.Mfg.BO.RFQEntryDataSet
rfqNum
Int32
RFQ Number
rfqLine
Int32
RFQ Line Number
DuplicateRFQ Duplicates RFQ. Parameters Name
Type
Description
piSourceRFQNum
Int32
Source RFQ Number
Returns Epicor.Mfg.BO.RFQEntryDataSet
GetSourcingInfo get UserName, Password and SourcingURL
1896
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
username
String@
Field Exists
password
String@
Field Exists
sourcingURL
String@
Field Exists
GetSourcingStatus Checks if sourcing is enabled Parameters Name
Type
Description
oStatus
Boolean@
Output parameter that will tell if sourcing is enabled in this company.
OnChangeofBuyerID Call this method when the value of BuyerID changes. Parameters Name
Type
Description
piRFQNum
Int32
RFQ Number
newBuyerID
String
RFQ line Number
rtnMessage
String@
Populated when the current user is not an authorized user.
ds
Epicor.Mfg.BO.RFQEntryDataSet
OnChangePartNum Call this method when the value of PartNum changes. Parameters Name
Type
Description
piRFQNum
Int32
RFQ Number
piRFQLine
Int32
RFQ line Number
ds
Epicor.Mfg.BO.RFQEntryDataSet
OnChangePurPoint Call this method when the value of PurPoint changes.
Epicor 9.05 | 9.05.605
1897
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds
Epicor.Mfg.BO.RFQEntryDataSet
pcVendorID
String
VendorID
pcVendorPP
String
VendorPP
OnChangeRFQItemPUM Call this method when the value of RFQItem.PUM changes. Parameters Name
Type
ds ipPUM
Description Epicor.Mfg.BO.RFQEntryDataSet
String
PUM
OnChangeVendorID Call this method when the value of VendorID changes. Parameters Name
Type
ds pcVendorID
Description Epicor.Mfg.BO.RFQEntryDataSet
String
VendorID
OpenRFQ Close/Open the RFQ. Parameters Name
Type
Description
piRFQNum
Int32
The RFQ number
piOpenRFQ
Boolean
True/False open RFQ
Returns The RFQ Data Set
ReOpenRFQLine Reopens the RFQ line.
1898
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
piRFQNum
Int32
The RFQ number
piRFQLine
Int32
The RFQ Line number
ds
Epicor.Mfg.BO.RFQEntryDataSet
VendorWizard This procedures generates a list of potential Vendors for the RFQItem.PartNum. Parameters Name
Type
Description
piRFQNum
Int32
The RFQ number
piRFQLine
Int32
The RFQ Line number
plCheckPOs
Boolean
The CheckPOs
plCheckPriceBreaks
Boolean
The CheckPriceBreaks
plCheckRFQs
Boolean
The CheckRFQs
pcIncludeVendAttrList
String
The include vendor attributes list
pcExcludeVendAttrList
String
The exclude vendor attributes list
pcComplianceList
String
The Compliances the vendor must accomplish
ds pcMessage
Epicor.Mfg.BO.RFQEntryDataSet String@
The message
RFQEntryJobSearch Epicor.Mfg.BO.RFQEntryJobSearch: This business object contains 7 methods.
GetNewJobHead Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1899
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
RFQEntryQuoteSearch Epicor.Mfg.BO.RFQEntryQuoteSearch: This business object contains 7 methods.
GetNewQuoteHed Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1900
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
RFQSugg Epicor.Mfg.BO.RFQSugg: This business object contains 7 methods.
GetNewRFQSugg Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1901
M-R
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
1902
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
RFQVend Epicor.Mfg.BO.RFQVend: This business object contains 16 methods.
GetNewRFQVend Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1903
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AvailableResponses Return list of available responses. Parameters Name
Type
Description
responseList
String@
The list of available responses.
ChangeDetailCalcOurQty Run this method when our quantity on the detail changes. Parameters Name
Type
Description
newCalcOurQty
Decimal
New Quantity
ds
The RFQVend dataset
ChangeDetailCalcVendQty Run this method when supplier quantity on the detail changes. Parameters Name
Type
Description
newCalcVendQty
Decimal
New Quantity
ds
The RFQVend dataset
CheckPOCreation This method checks if everything is okay before creating a PO. If there are any questions to be asked they will be returned in the 2 message parameters. If the user answers yes to both questions, then CreatePO can be run Parameters
1904
Name
Type
Description
rfqNum
Int32
RFQ Number
rfqLine
Int32
RFQ Line Number
vendorNum
Int32
Vendor Number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
purPoint
String
Vendor Purchase Point Number
vMessage
String@
Ask user if okay to create a PO for a Quoted Item
vendMessage
String@
Ask user if they want to use an unapproved vendor
vWarningMessage
String@
Warn user that not enough responses have been received
CreatePO This method Creates a PO for the current RFQVend Line. If a PO is above a person's approval limit, then the PO will be created but not approved Parameters Name
Type
Description
rfqNum
Int32
RFQ Number
rfqLine
Int32
RFQ Line Number
vendorNum
Int32
Vendor Number
purPoint
String
Vendor Purchase Point
lineQty
String
Line Quantity
dueDate
Nullable{System.DateTime}
Due Date
promDate
Nullable{System.DateTime}
Promised Date
msgString
String@
Status of PO created
Returns The RFQVend dataset
GetLineQty This method gets the Job Qty (if job related) and sets a flag to tell the UI to update the Qty, duedate and promise date fields Parameters Name
Type
Description
rfqNum
Int32
RFQ Number
rfqLine
Int32
RFQ Line Number
vendorNum
Int32
Vendor Number
purPoint
String
Vendor Purchase Point
tmpLineQty
String@
Calculated Line Quantity
promptQty
Boolean@
If yes, the Quantity and date fields need to be updated
Epicor 9.05 | 9.05.605
1905
M-R
Business Object Reference Guide
ListOfRFQVend This is a copy of GetList modified to have the RFQ Source and RFQ Status search values be passed as parameters instead of being in the where clause. Run This instead of GetList. UI - DO NOT include 'RFQ source' and 'RFQ status' in the where clause. Instead, pass them as parameters per the following: Parameters Name
Type
Description
whereClause
String
Where clause to filter the query results.
pageSize
Int32
page size.
absolutePage
Int32
absolute page
morePages
Boolean@
more pages.
rfqSourcein
String
If 'all' -> input 'A', if 'jobs' -> input 'J', if 'Quotes' -> input 'Q'.
rfqStatusin
String
If "all' -> input 'A', if 'closed' -> input 'C', if "open" -> input 'O'.
Returns Returns RFQVendListDataSet data set.
RefreshDataset This method does refresh for each loaded recodrs. Parameters Name
Type
ds
Description The RFQVend dataset
RowsOfRFQVend This is a copy of GetRows modified to have the RFQ Source and RFQ Status search values be passed as parameters instead of being in the where clause. can be run instead of GetRows. UI - DO NOT include 'RFQ source' and 'RFQ status' in the where clause. Instead, pass them as parameters per the following: Parameters
1906
Name
Type
Description
whereClause
String
Where clause to filter the query results.
pageSize
Int32
page size.
absolutePage
Int32
absolute page
morePages
Boolean@
more pages.
rfqSourcein
String
If 'all' -> input 'A', if 'jobs' -> input 'J', if 'Quotes' -> input 'Q'.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
rfqStatusin
String
If 'all' -> input 'A', if 'closed' -> input 'C', if 'open' -> input 'O'.
Returns Returns RFQVendDataSet data set.
RlsClass Epicor.Mfg.BO.RlsClass: This business object contains 8 methods.
GetNewRlsClass Inserts a new row in the DataSet with defaults populated.
GetNewRlsLevel Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1907
M-R
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
RMADisp Epicor.Mfg.BO.RMADisp: This business object contains 21 methods.
GetNewRMARcpt Inserts a new row in the DataSet with defaults populated.
GetNewRMADisp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1908
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last
Epicor 9.05 | 9.05.605
1909
M-R
Business Object Reference Guide
• Columns - List of columns
ChangeBinNum Method to call when changing the bin number. Provides the bin description. Parameters Name
Type
ds cBinNum
Description The RMADisp data set
String
The proposed bin number
ChangeDispType Method to call when changing the Disposition Type. Provides default values for the RMADisp record. Parameters Name
Type
ds
Description The RMADisp data set
cDispType
String
The proposed Disposition Type
cMessage
String@
Warning message returned to UI
ChangeJob Method to call when changing the job number. Provides default values for the RMADisp record. Parameters Name
Type
ds
Description The RMADisp data set
cJobNum
String
The proposed Job number
cMessage
String@
Warning message returned to UI
ChangeWarehouse Method to call when changing the warehouse. Provides default values for the RMADisp record. Parameters Name
Type
ds
1910
Description The RMADisp data set
cWarehouseCode
String
The proposed warehouse code
cMessage
String@
Warning message returned to UI
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
CheckClosedJob This method checks to see if the job is closed. Returns text of a question to be asked of the user if it is. This method should be called when entering a job number. Parameters Name
Type
Description
cJobNum
String
The Job number
cQuestionText
String@
The text of the question to ask the user
CheckSerialNumbers This method returns text of a message to be asked if the number of serial numbers selected does not match the quantity entered for the RMADisp record. The user has the option of continuing with the mismatch quantities or canceling. This method should be called before the update method and should be called only when the RMARcpt.TrackSerialNum = true and RMADisp.DispQty > 0. If the user answers yes, the change can occur; otherwise the change shouldn't occur. Parameters Name
Type
ds cMessageText
Description The RMADisp data set
String@
The text of the message to ask the user
CheckWithInspResults Method to check the Inspection Results Qty (EQM) Parameters Name
Type
Description
totPassed
Int32@
Total Passed
totFailed
Int32@
Total Failed
inspDataEntered
Boolean@
InspectioN data entered
ds
The RMADisp entry Dataset.
GetLegalNumGenOpts Returns the legal number generation options. Parameters Name
Type
ds requiresUserInput
Epicor 9.05 | 9.05.605
Description The RMADispDataSet dataset
Boolean@
Requires User Input
1911
M-R
Business Object Reference Guide
GetPartTranPKs Return Primary Keys for generated PartTran records. Parameters Name
Type
Description
ipRMANum
Int32
RMANum field
ipRMALine
Int32
RMALine field
ipRMAReceipt
Int32
RMAReceipt field
ipRMADisp
Int32
RMADisp field
partTranPKs
String@
The PartTranPKs number
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds
Description RMADisp data set
Returns The SelectSerialNumbersParams dataset
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
ds
Description RMA Disposition data set
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
RMADtlSearch Epicor.Mfg.BO.RMADtlSearch: This business object contains 8 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1912
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsContactTracker Calls the normal GetRows method and then if a customer ID has been passed, it screens out only the appropriate rows.
Epicor 9.05 | 9.05.605
1913
M-R
Business Object Reference Guide
Parameters Name
Type
Description
whereClauseRMADtl
String
Whereclause for RMADtl table.
contactName
String
The contact to return data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.RMADtlSearchDataSet
GetRowsCustomerTracker Calls the normal GetRows method and then if a customer ID has been passed, it screens out only the appropriate rows. Parameters Name
Type
Description
whereClauseRMADtl
String
Whereclause for RMADtl table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.RMADtlSearchDataSet
RMAProc Epicor.Mfg.BO.RMAProc: This business object contains 40 methods.
GetNewRMAHead Inserts a new row in the DataSet with defaults populated.
GetNewRMAHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewRMADtl Inserts a new row in the DataSet with defaults populated.
GetNewRMADtlAttch Inserts a new row in the DataSet with defaults populated.
1914
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetNewInvcDtl Inserts a new row in the DataSet with defaults populated.
GetNewRMARcpt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1915
M-R
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
1916
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeContact Update RMA header contact information when the ConNum Contact is changed.
Epicor 9.05 | 9.05.605
1917
M-R
Business Object Reference Guide
Parameters Name
Type
ds iConNum
Description The RMAProc data set
Int32
The proposed contact number
ChangeContactRMADtl Update RMA header contact information when the ConNum Contact is changed. Parameters Name
Type
ds iConNum
Description The RMAProc data set
Int32
The proposed contact number
ChangeCustomer This populates the customer information in the RMAHead datatable. Parameters Name
Type
ds cCustID
Description The RMAProc data set
String
The proposed customer id
ChangeOrderLine This method validates the order line and updates the RMADtl record with values from the line. Parameters Name
Type
ds iOrderLine
Description The RMAProc data set
Int32
The proposed order line
ChangeOrderNumber This method validates that the order number entered exists and the customer on the order matches the customer on the RMAHead record. Parameters Name
Type
ds iOrderNum
1918
Description The RMAProc data set
Int32
The proposed order number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangeOrderRelNum This method validates the order release and updates the RMADtl record. Parameters Name
Type
ds
Description The RMAProc data set
iOrderRelNum
Int32
The proposed order release number
ChangePartNum This method validates the part number and updates the RMADtl record with values from the part. Parameters Name
Type
Description
ds
The RMAProc data set
cPartNum
String@
The proposed part number
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
ChangeReceivedQty This method validates the ReceivedQty and ReceivedQtyUOM and updates the RMARcpt record. Parameters Name
Type
ds
Description The RMAProc data set
iReceivedQty
Decimal
The proposed received quantity
iReceivedQtyUOM
String
The proposed received quantity UOM
ChangeRMADtlInvoiceLine Update RMA Header InvoiceLine it is changed.
Epicor 9.05 | 9.05.605
1919
M-R
Business Object Reference Guide
Parameters Name
Type
Description
ds ipInvoiceLine
The RMAProc data set Int32
The proposed InvoiceNum
ChangeRMADtlLegalNumber Update RMA Header LegalNumber it is changed. Parameters Name
Type
Description
ds ipLegalNumber
The RMAProc data set String
The proposed LegalNumber
ChangeRMAHeadLegalNumber Update RMA Header LegalNumber when it is changed. Parameters Name
Type
ds ipLegalNumber
Description The RMAProc data set
String
The proposed LegalNumber
ChangeShipTo This method validates the ShipToNum and updates the RMADtl record. Parameters Name
Type
ds iShipTo
Description The RMAProc data set
String
The proposed ship to number
ChangeShipToCustID This method validates the order release and updates the RMADtl record. Parameters Name
Type
ds ipShipToCustID
1920
Description The RMAProc data set.
String
The proposed ShipToCustID.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
ChangeWarehouse This method updates values in RMARcpt based on the new selling received quantity. Parameters Name
Type
ds
Description The RMAProc data set
cMessageText
String@
The text of the message to ask the user
CheckSerialNumbers This method returns text of a message to be asked if the number of serial numbers selected does not match the quantity entered for the RMARcpt or RMADtl record. The user has the option of continuing with the mismatch quantities or canceling. This method should be called before the update method and should be called only when part is serial number tracked and the quantity is greater than zero. If the user answers yes, the change can occur; otherwise the change shouldn't occur. Parameters Name
Type
ds
Description The RMAProc data set
cTableName
String
The table name to check against; values are 'RMADtl' or 'RMARcpt'
cMessageText
String@
The text of the message to ask the user
GetDateUser This method puts a date/time/user stamp in the Note box for the user Parameters Name
Type
ds
Description Returns the new RMAProc DataSet
GetSelectedSerialNumbers This method will retrieve the serial numbers for an RMADtl or RMARcpt record and update the SelectedSerialNumbers table with these records. Parameters Name
Type
Description
cTableName
String
The table to retrieve the serial numbers for. Valid values are: RMADtl or RMARcpt
iRMANum
Int32
The RMA Number
iRMALine
Int32
The RMA Detail line number
Epicor 9.05 | 9.05.605
1921
M-R
Business Object Reference Guide
Name
Type
Description
iRMAReceipt
Int32
The RMA Receipt number; will be 0 when cTableName = RMADtl
ds
The RMAProc data set
GetSelectSerialNumbersParams Get all the parameters needed for launching Select Serial Numbers Parameters Name
Type
ds ipTableName
Description RMA Processing Dataset
String
Table Name RMADtl or RMARcpt
Returns The SelectSerialNumbersParams dataset
PreUpdate This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
Description
Boolean@
Indicates if the legal number requires user input
ds requiresUserInput
RMACreditAdd This method creates an RMA Credit record from the RMA Number and Line passed in. The RMA Credit is stored in the InvcHead and InvcDtl tables. Once the invoice is created, the user has the option of updating the header and invoice line information. It is expected that the A/R Invoice business object will be called to handle the update of the header and/or line. Parameters
1922
Name
Type
Description
iRMANum
Int32
The RMA Number to create the invoice from
iRMALine
Int32
The RMA Line to create the invoice line from
iCorrection
Boolean
True will create a correction invoice, false will create a credit memo
iInvoiceNum
Int32@
The invoice number of the RMA line
iInvoiceLine
Int32@
The invoice line of the RMA line
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Name
Type
Description
opErrMsg
String@
Error message from invoice processing
ds
The RMAProc data set
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
Description
ds
RMA Processing data set
serialNumber
String
Serial number to validate.
ipTableName
String
RMA TableName
isVoided
Boolean@
Serial Number Voided flag
warningMsg
String@
Warning Message
RoleCd Epicor.Mfg.BO.RoleCd: This business object contains 11 methods.
GetNewRoleCd Inserts a new row in the DataSet with defaults populated.
GetNewPrjRoleRt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
1923
M-R
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeSupervisorRole Method to call when changing supervisor role. Parameters Name
Type
Description
proposedSupervisorRole
Boolean
The proposed supervisor role value
ds
The EmpExpense data set
CheckCapabilityBefUpd Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
1924
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ValidateOKDelete Method used to validate if the Role Code is currently in use by operations, employees or projects Parameters Name
Type
Description
ipRoleCode
String
The role code value
opOKDelete
Boolean@
OkDelite value
RoughCutParam Epicor.Mfg.BO.RoughCutParam: This business object contains 7 methods.
GetNewRoughCutParam Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
1925
M-R
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
RptDataDef Epicor.Mfg.BO.RptDataDef: This business object contains 27 methods.
GetNewRptDataDef Inserts a new row in the DataSet with defaults populated.
GetNewRptRelation Inserts a new row in the DataSet with defaults populated.
GetNewRptRelationField Inserts a new row in the DataSet with defaults populated.
GetNewRptLiterals Inserts a new row in the DataSet with defaults populated.
GetNewRptRule Inserts a new row in the DataSet with defaults populated.
GetNewRptRuleCond Inserts a new row in the DataSet with defaults populated.
GetNewRptTable Inserts a new row in the DataSet with defaults populated.
1926
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
GetNewRptCalcField Inserts a new row in the DataSet with defaults populated.
GetNewRptExclude Inserts a new row in the DataSet with defaults populated.
GetNewRptLinkTable Inserts a new row in the DataSet with defaults populated.
GetNewRptLinkField Inserts a new row in the DataSet with defaults populated.
GetNewRptWhereItem Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1927
M-R
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeReportType Validate new Report Type Parameters Name
Type
Description
rptDefID
String
Data Definition ID
rptTypeID
String
Report Type ID
success
Boolean@
Indicates whether the new Report Type validation was successful or not.
ds
Report Data Definition Dataset
ChangeRuleField Validate and update the data type of the proposed Condition field.
1928
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Parameters Name
Type
Description
proposedField
String
Proposed Field value
ds
Report Data Definition Dataset
ChangeUseFromToday Validate external fields for Row Rules when changing the UseFromToday field Parameters Name
Type
Description
ds
Report Data Definition Dataset
DuplicateRpt To create a new report data definition by duplicating from another. Typically this is used to duplicate a system report definition so that it can be modified. Parameters Name
Type
Description
sourceRptDefID
String
Id of report that will be duplicated.
targetRptDefID
String
ID for the new report.
targetRptDescription
String
Description that will be used for the new report. if blank, the source description will be used.
Returns RptDataDef DataSet
GetDataDefUsedTables Returns a DataSet with a list of tables and their fields in use on a Report Data Definition given a Report Definition ID. Parameters Name
Type
Description
rptDefID
String
Report Definition ID
onlyDBTables
Boolean
Return Only DataBase Tables
Returns Report Definition DataSet
GetOperatorList Gets the Operator List to compare FieldName against a constant or another field
Epicor 9.05 | 9.05.605
1929
M-R
Business Object Reference Guide
Parameters Name
Type
Description
fieldType
String
Field Data-Type
operatorList
String@
Operator List
GetRptDataDefList Gets the Report Data Definition List for a specific ReportID Parameters Name
Type
Description
whereClause
String
Whereclause.
reportID
String
ReportID.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The RptDataDef List data set
ImportReport Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
RptStyleExt Epicor.Mfg.BO.RptStyleExt: This business object contains 7 methods.
GetNewRptStyleExt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
1930
Epicor 9.05 | 9.05.605
Business Object Reference Guide
M-R
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
RptStylePrintersList Epicor.Mfg.BO.RptStylePrintersList: This business object contains 7 methods.
GetNewRptStylePrintersList Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1931
M-R
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
1932
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Part IV: S-Z Chapter 19: S SaleAuthSearch Epicor.Mfg.BO.SaleAuthSearch: This business object contains 7 methods.
GetNewSaleAuth Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1933
S-Z
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
SalesCat Epicor.Mfg.BO.SalesCat: This business object contains 8 methods.
GetNewSalesCat Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1934
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
SalesOrder Epicor.Mfg.BO.SalesOrder: This business object contains 176 methods.
GetNewOrderHed Inserts a new row in the DataSet with defaults populated.
GetNewOrderHedAttch Inserts a new row in the DataSet with defaults populated.
GetNewOHOrderMsc Inserts a new row in the DataSet with defaults populated.
GetNewOrderDtl Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
1935
S-Z
Business Object Reference Guide
GetNewOrderDtlAttch Inserts a new row in the DataSet with defaults populated.
GetNewOrderMsc Inserts a new row in the DataSet with defaults populated.
GetNewOrderRel Inserts a new row in the DataSet with defaults populated.
GetNewOrderRelTax Inserts a new row in the DataSet with defaults populated.
GetNewOrderHedUPS Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
1936
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
Epicor 9.05 | 9.05.605
1937
S-Z
Business Object Reference Guide
Name
Type
Description
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage
ApplyOrderBasedDiscounts Apply order based discounts to an order. Parameters Name
Type
Description
iOrderNum
Int32
The order to apply the discounts to
Returns The SalesOrder data set
CCClear Procedure to Clear the Credit Card Information Parameters Name
Type
ds
Description The SalesOrder data set
CCLoadTranData Procedure to be called when selecting a record in the Transaction history grid, the data selected is loaded in the OrderHed table Parameters Name
Type
inTranDate
Description TranDate from the CreditTran table
inTranTime
Nullable{System.DateTime}
TranTime from the CreditTran table
inTranNum
Int32
TranNum from the CreditTran table
ds
Int32
The SalesOrder data set
CCProcessCard Procedure to attempt to process transaction for the amount specified in the "Total" field.
1938
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
inTranType
String
The transaction type to apply to the credit card. Valid transaction types : D (Deposit), S (Sale), A (Authorize), C (Credit - 803), V (Void).
ds
String@
The SalesOrder data set
opMessage
opMessage
ChangeBTCustIDMaster This method returns the Bill To customer info. Parameters Name
Type
Description
newBillToCustID
String
Proposed bill to custid
lchkCustCredHold
Boolean
flag to determine if we run CheckCustomerCreditHold
iOrderNum
Int32
The Order Number - optional
cCreditLimitMessage
String@
The over credit limit message text
lCustomerAllowed
Boolean@
Flag to indicate if using the customer on the order is valid
ds
The SalesOrder data set
ChangeCardNumber Procedure to validate the Credit Card Number. Validations to be performed: MOD10, Lenght and Prefix (according to the credit card type) Parameters Name
Type
Description
inCardNumber
String
Proposed Card Number
ds
The SalesOrder data set
ChangeCCAmounts This procedure should be called when any of the Credit Card amounts change (from the Column Changed event in the UI) to calculate the total to be charged to the credit card Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The SalesOrder data set
1939
S-Z
Business Object Reference Guide
ChangeCommissionable Update Order Detail commission information when the Commissionable flag is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeContractNum Update Order Detail information when the contract is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeContractNumMaster Validates the entered ContractNum value. Parameters Name
Type
Description
iOrderNum
Int32
Order number whose field is getting modified
iOrderLine
Int32
Order Line number that is getting modified
iContractNum
Int32
Proposed Contract Number
outMsg
String@
contains warning messages for UI
ds
The SalesOrder data set
ChangeCounterSale Update Order Header information when the counter sale flag changes. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeCreditExp Procedure to validate Credit Card Expiration Date
1940
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ipExpMonth
Int32
Expiration Month
ipExpYear
Int32
Expiration Year
ds
The Sales Order data set
ChangeCurrencyCode Update Order Header Exchange Rate when the currency code changes. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeCustomer Update Order Header Credit Card Customer information when the Customer is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangedCardNumber Procedure to encrypt and mask the Credit Card Number. This method should be called in the Column Changed event, assuming that the validation performed in ChangeCardNumber was successful. Parameters Name
Type
ds
Description The Sales Order data set
ChangeDiscBreakListCode Change the DiscBreakListCode Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The SalesOrder data set
1941
S-Z
Business Object Reference Guide
ChangeDiscountAmount Update Order Detail information when the price discount percent is changed. Parameters Name
Type
Description
ds
The SalesOrder data set
ChangeDiscountPercent Update Order Detail information when the price discount percent is changed. Parameters Name
Type
Description
ds
The SalesOrder data set
ChangeERSOrder Update Order Header information when the ERS Order changes. Parameters Name
Type
Description
proposedERSOrder
Boolean
The proposed ERS Order
ds
The SalesOrder data set
ChangeGroup Update Order Detail information when the Group is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeHedUseOTS Method to call when changing the OrderHed.UseOTS field. Refreshes the address list and contact info Parameters Name ds
1942
Type
Description SalesOrder Dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ChangeKitPricing Recalculates the parent line's unit price when the kit pricing is set to "P", if the kit pricing is set to "C" the price will be calculated on the AfterUpdate procedure. Parameters Name
Type
Description
ds
SalesOrder Dataset
ChangeKitQtyPer Used to recalculate the SellingQty of the component kit line using the parent's SellingQuantity Parameters Name
Type
Description
ds
The SalesOrder data set
ChangeMake Update Order Release information when the Make value is changed. Parameters Name
Type
Description
ds
The SalesOrder data set
ChangeManualTaxCalc Parameters Name
Type
Description
ipOrderNum
Int32
Order Number.
ipLineNum
Int32
Order line number.
ipRelNum
Int32
Order Rel number.
ipTaxCode
String
Release tax code.
ipRateCode
String
Release rate code.
ds
Sales Order data set.
ChangeMiscAmount Update Order Miscellaneous information when the amount changes.
Epicor 9.05 | 9.05.605
1943
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The SalesOrder data set
tableName
String
name of table being passed in
ChangeMiscCode This method returns default information for the MiscChrg. Method must use parameters instead of the dataset due to the problem with changing the primary key field. Also allows OrderMsc and OHOrderMsc to use the same code Parameters Name
Type
ds
Description The SalesOrder data set
tableName
String
name of table being passed in
ChangeMiscPercent Update Order Miscellaneous information when the percentage changes. Parameters Name
Type
ds
Description The SalesOrder data set
tableName
String
name of table being passed in
ChangeNeedByDate Update Order Header information based on the NeedByDate changing. Parameters Name
Type
ds cTableName
Description The SalesOrder data set
String
The table that is changed: OrderHed,OrderDtl, or OrderRel
ChangeNewNeedByDate Update Global PO information based on the New Need By Date changing. Parameters Name ds
1944
Type
Description The GlbSugPOChgDataSet data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ChangeNewSellingQuantity Update Global PO information based on the New Selling Quantity changing. Parameters Name
Type
Description
ds
The GlbSugPOChgDataSet data set
ChangeODtlWarehouse Update Order Detail information when the Warehouse changes. This needs to be called only for Counter Sales. Parameters Name
Type
Description
ds
The SalesOrder data set
ChangeOrderRelBuyToOrder Update Order Release information when the Buy To Order value is changed. Parameters Name
Type
Description
ipBuyToOrder
Boolean
The new Buy To Order value.
ds
The SalesOrder data set
ChangeOrderRelDropShip Update Order Release information when the Buy To Order value is changed. Parameters Name
Type
Description
ipDropShip
Boolean
The new DropShip value.
ds
The SalesOrder data set
ChangeOrderRelMarkForNum Update OrderRel information with values from the Mark For when the Mark For is changed. Parameters Name
Type
Description
proposedMarkForNum
String
The Proposed ShipToNum
Epicor 9.05 | 9.05.605
1945
S-Z
Business Object Reference Guide
Name
Type
ds
Description The Sales Order data set
ChangeOrderRelMFCustID Method to call when changing the Mark For Customer ID on the OrderRel record. Validates the Mark For Customer ID and ressets the ShipToNum to the Customer default. Parameters Name
Type
Description
ipMFCustID
String
The proposed Mark For Customer ID
ds
The Sales Order data set
ChangeOrderRelShipTo Update Order Release information with values from the Ship To when the Ship To is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeOrderRelShipToContact Update Order Release ship to contact information when the Release Ship To Contact is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeOrderRelShipToCustID Update Order Rel information with values from the Third Party Ship To when the Ship To is changed. Parameters Name
Type
Description
iShipToCustID
String
Proposed Third-Party Ship To
ds
The SalesOrder data set
ChangeOrderRelUseOTMF Method to call when changing the UseOTMF field the OrderRel record. Refreshes the address list and contact info
1946
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The Sales Order data set
ChangeOrderRelVendorID Update Order Release information when the Vendor ID is changed. Parameters Name
Type
Description
ipVendorID
String
The new Vendor ID value.
ds
The SalesOrder data set
ChangeORelWarehouse Update Order Release information when the Warehouse changes. This needs to be called only for Counter Sales. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeOverrideDiscPriceList Rerun the price break calculation if the override price list flag is changed from true to false. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeOverridePriceList Rerun the price break calculation if the override price list flag is changed from true to false. Parameters Name ds
Type
Description The SalesOrder data set
ChangePartNum Update Order Detail information when the Part Number is changed.
Epicor 9.05 | 9.05.605
1947
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The SalesOrder data set
lSubstitutePartsExist
Boolean
Flag to indicate if a substitute part exists
uomCode
String
UOM Code (only used for Product Codes)
Name
Type
Description
partNum
String@
proposed PartNum
lSubstitutePartExist
Boolean@
bool which identifies whether a substitute part exists. set in 'checkPartRevisionChange' logic
lIsPhantom
Boolean@
bool which identifies whether this is a phantom part. set in 'getPartXRefInfo' logic
uomCode
String@
associated uomCode for this part. maybe overwritten in chkPartXRefInfo
sysRowID
String
sysRowID for current row
rowType
String
current rowType
salesKitView
Boolean
flag to identify whether this OrderDtl record is from salesKitView (or OrderDtlView)
removeKitComponents
Boolean
flag (set by user unless suppressUserPrompts is true) to ok removing kit components if kit parent changes
suppressUserPrompts
Boolean
flag to determine is user wants to be able to respond to messages and return to UI
getPartXRefInfo
Boolean
flag to determine whether a particular part of validation logic is run
checkPartRevisionChange
Boolean
flag to determine whether a particular part of validation logic is run
checkChangeKitParent
Boolean
flag to determine whether a particular part of validation logic is run
cDeleteComponentsMessage
String@
message to display to the user
questionString
String@
message to display to user
cWarningMessage
String@
message to display to user
multipleMatch
Boolean@
indicates there are multiple matches for this part
promptToExplodeBOM
Boolean@
request input from user - display message
cConfigPartMessage
String@
message to display to user
cSubPartMessage
String@
message to display to user
explodeBOMerrMessage
String@
message to display to user
ChangePartNumMaster Parameters
1948
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
cMsgType
String@
type of message...warning, question, error
multiSubsAvail
Boolean@
indicates if there are multiple substitutes available for this part
runOutQtyAvail
Boolean@
indicates if there is enough run out available for this part to fulfill order
ds
The SalesOrder data set
ChangePlant Update Order Release information when the Plant is changed. Parameters Name
Type
Description
proposedPlant
String
The proposed plant
ds
The SalesOrder data set
ChangePriceList Update Order Detail information when the price list is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangePricePerCode Update Order Detail information when the price per code is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeQuickEntryOption Update Order Detail Quick Entry options. This method is called whenever the CreateNewJob, GetDtls, or SchedJob option is changed. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The SalesOrder data set
1949
S-Z
Business Object Reference Guide
ChangeQuoteLine Update Order Detail information when selecting a quote line. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeQuoteQtyNum Update the Order Detail line with values from the selected QuoteQty record. This method should be called whenever the action to select a quote quantity occurs. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeRelUseOTS Method to call when changing the OrderRel.UseOTS field. Refreshes the address list and contact info Parameters Name
Type
ds
Description SalesOrder Dataset
ChangeRenewalNbr Update Order Detail information when the renewalnbr is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeRenewalNbrMaster Validates the entered RenewalNbr value. Parameters
1950
Name
Type
Description
iOrderNum
Int32
Order number whose field is getting modified
iOrderLine
Int32
Order Line number that is getting modified
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
iContractNum
Int32
Contract Number
iRenewalNbr
Int32
Proposed Renewal Number
ds
The SalesOrder data set
ChangeRevisionNum Update Order Detail information when the Part Revision Number is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeRevNumMaster Update Order Detail information when the Part Revision Number is changed. Parameters Name
Type
Description
checkPartRevChange
Boolean
bool to determine whether we run the CheckPartRevChange logic
suppressUserPrompts
Boolean
flag to determine is user wants to be able to respond to messages and return to UI
proposedRev
String
proposed RevisionNum
cConfigPartMessage
String@
message to display to user
ds
The SalesOrder data set
ChangeRMANum Update Order Detail RMALine field when the RMA Number is changed. This method needs to be called only if the RMA Number was not selected via a lookup. Parameters Name ds
Type
Description The SalesOrder data set
ChangeSalesRep Update rep rate and rep split when the salesrep changes.
Epicor 9.05 | 9.05.605
1951
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
cSalesRepCode
String
The SalesRep code
dRepRate
Decimal@
The Sales Rep commission rate
iRepSplit
Int32@
The Sales Rep split percentage
cRepName
String@
The Sales Rep name
ChangeSalesUOM Update Order Detail information when the SalesUM changes Parameters Name
Type
ds
Description The SalesOrder data set
ChangeSellingQtyMaster Update Order Detail information when the selling quantity is changed. Parameters Name
Type
ds
1952
Description The SalesOrder data set
ipSellingQuantity
Decimal
New value for SellingQuantity
chkSellQty
Boolean
flag to determine if we run checkSellingQuantityChange logic
negInvTest
Boolean
flag to determine if we run negativeInventoryTest logic
chgSellQty
Boolean
flag to determine if we run changeSellingQuantity logic
chgDiscPer
Boolean
flag to determine if we run changeDiscountPercent logic
suppressUserPrompts
Boolean
flag to determine if we suppress any user input
lKeepUnitPrice
Boolean
Keep the current unit price even if it will be recalcuated based on the new quantity
pcPartNum
String
partNum for negativeInventoryTest
pcWhseCode
String
whseCode for negativeInventoryTest
pcBinNum
String
binNum for negativeInventoryTest
pcLotNum
String
lotNum for negativeInventoryTest
pcDimCode
String
dimcode for negativeInventoryTest
pdDimConvFactor
Decimal
dimConvFactor for negativeInventoryTest
pcMessage
String@
pcMessage for negativeInventoryTest
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
pcNeqQtyAction
String@
pcNegQtyAction for negativeInventoryTest
opWarningMsg
String@
Warning message for BTO releases
cSellingQuantityChangedMsgText String@
message to be displayed to user regarding quantity change
ChangeSellingQuantity Update Order Detail information when the selling quantity is changed. Parameters Name
Type
ds
Description The SalesOrder data set
lKeepUnitPrice
Boolean
Keep the current unit price even if it will be recalcuated based on the new quantity
ipSellingQuantity
Decimal
New value for SellingReqQty
opWarningMsg
String@
Warning message for BTO releases
ChangeSellingReqQty Update Order Release information when the selling quantity is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ipSellingReqQty
Decimal
New value for SellingReqQty
opWarningMsg
String@
Warning message for BTO releases
ChangeShipToContact Update Order Header ship to contact information when the Ship To Contact is changed. Parameters Name ds
Type
Description The SalesOrder data set
ChangeShipToCustID Update Order Header information with values from the Third Party Ship To when the Ship To is changed.
Epicor 9.05 | 9.05.605
1953
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
iShipToCustID
String
Proposed Third-Party Ship To
ds
The SalesOrder data set
ChangeShipToID Update Order Header information with values from the Ship To when the Ship To is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeSoldToContact Update Order Header sold to contact information when the Sold To Contact is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeSoldToID Update Order Header information with values from the Sold To when the Sold To is changed. Parameters Name
Type
ds
Description The SalesOrder data set
ChangeUnitPrice Update Order Detail information when the unit price changes. Parameters Name ds
Type
Description The SalesOrder data set
ChangeVendorChange Update the suggestion status when the "Ready to Send" box is checked or unchecked. In the GlbSugPOChg dataset, this is field VendorChange.
1954
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ds
The GlbSugPOChgDataSet data set
ChangeWhseCodeMaster Update Order Detail information when the selling quantity is changed. Parameters Name
Type
ds
Description The SalesOrder data set
negInvTest
Boolean
flag to determine if we run negativeInventoryTest logic
chgDtlWhse
Boolean
flag to determine if we run changeODtlWarehouse logic
suppressUserPrompts
Boolean
flag to determine if we suppress any user input
pcPartNum
String
partNum for negativeInventoryTest
pcWhseCode
String
whseCode for negativeInventoryTest
pcBinNum
String
binNum for negativeInventoryTest
pcLotNum
String
lotNum for negativeInventoryTest
pcDimCode
String
dimcode for negativeInventoryTest
pdDimConvFactor
Decimal
dimConvFactor for negativeInventoryTest
pdSellingQuantity
Decimal
sellingQty for negativeInventoryTest
pcMessage
String@
pcMessage for negativeInventoryTest
pcNeqQtyAction
String@
pcNegQtyAction for negativeInventoryTest
ChangeXPartNum Update Order Detail information when the xpart changes. Parameters Name
Type
ds
Description The SalesOrder data set
CheckComplianceFail Check for every line of the Pack if it requires if it is compliant. Parameters Name
Type
Description
orderNum
Int32
Current Order Number.
Epicor 9.05 | 9.05.605
1955
S-Z
Business Object Reference Guide
Name
Type
Description
orderLine
Int32
Current Order Line.
orderRelNum
Int32
Current Order Release.
compliant
Boolean@
Indicates if the current Order is compliant.
CheckComplianceOrderFail Check for every line of the Order if it is compliant. Parameters Name
Type
Description
orderNum
Int32
Current Order Number
compliantMsg
String@
Indicates if the current Order is compliant.
CheckConfiguration Checks is part should be configured on a given OrderLine Parameters Name
Type
Description
orderNum
Int32
Order number to be searched
orderLine
Int32
Order Line to be checked
sourcePart
String
Part Num to get details from (populated when sourceFile = "Method")
sourceRev
String
Revision number to get details from (populated when sourceFile = "Method")
findRevision
Boolean
If true the revision number will be looked up rather than using the sourceRev
canGetDetails
Boolean@
If false, GetDtls will fail for a configuration reason that can't be resolve by reconfiguring now
needsConfiguration
Boolean@
If true the configurator should be run on the Job for the Part/Rev
configureRevision
String@
The revision that should be configured (if configuration is needed)
reasonMessage
String@
The reason or for the failure or need for configuration. This should be displayed to the user.
Returns Part Dataset
CheckContractNum Validates the entered ContractNum value.
1956
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
iOrderNum
Int32
Order number whose field is getting modified
iOrderLine
Int32
Order Line number that is getting modified
iContractNum
Int32
Proposed Contract Number
CheckCustomerCreditLimit This method should be called before the Update method is called for a detail record. The method returns a character string if the customer will go over their credit limit and the user is given the choice of continuing or not. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
iCustNum
Int32
The Customer Number
cCreditLimitMessage
String@
The over credit limit message text
lContinue
Boolean@
Indicates if the user is allowed to continue with processing
ds
The SalesOrder data set
CheckCustomerCreditRelease This method should be called before the Update method is called for a release record. The method returns a character string if the customer will go over their credit limit and the user is given the choice of continuing or not. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
iOrderDtlNum
Int32
The line number.
iCustNum
Int32
The Customer Number
cCreditLimitMessage
String@
The over credit limit message text
lContinue
Boolean@
Indicates if the user is allowed to continue with processing
ds
The SalesOrder data set
CheckCustOnCreditHold On selection of an order or customer, checks to see if the customer is on credit hold and returns a message string if they are. iOrderNum and cCustID are optional, but one or the other should be passed.
Epicor 9.05 | 9.05.605
1957
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
iOrderNum
Int32
The Order Number - optional
cCustID
String
The Customer ID - optional
cCreditLimitMessage
String@
The over credit limit message text
lCustomerAllowed
Boolean@
Flag to indicate if using the customer on the order is valid
CheckICPO Method to call when trying to determine whether there are any incoming ICPO entries. This method will return true or false. . Parameters Name
Type
Description
icpoFound
Boolean@
Indicates if there are any incoming ICPO records.
CheckICPOReadyToSend Checks to see if there are any Intercompany PO's not ready to send for the order. If there are, returns message text that should be presented to the user asking if they would like to continue or not. This method should be called before calling the VerifySendICPOSugg and SendICPOSuggestions methods. Parameters Name
Type
Description
iOrderNum
Int32
The order number to check against
cReadyToSendMsgText
String@
The message text
CheckKitRevision Checks the current selected revision of a kit parent line to see if it has any components to be generated. If no revision is selected, or there are no mfg details then a return message will be returned to notify the user about it. Parameters
1958
Name
Type
Description
iPartNum
String
Part number
iRevisionNum
String
Revision number
outMsg
String@
Output message
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
CheckLtrOfCrdt Parameters Name
Type
Description
iOrderNum
Int32
Sales Order number
cARLOCID
String
Letter of Credit ID
dTotalCharges
Decimal
OrderHed.TotalCharges
outMsg
String@
Output message
Returns The SalesOrder data set
CheckMakeDirectReleases Validate whether all make direct releases have jobs if and OrderDtl is checked. Parameters Name
Type
Description
ipOrderNum
Int32
Order Number
opIssueWarning
Boolean@
Flag to indicate if make direct releases exist without job link
CheckOrderHedChanges Checks to see if certain fields changed on the order header. If they did, Parameters Name
Type
ds cOrderChangedMsgText
Description The SalesOrder data set
String@
The message text
CheckOrderLinkToInterCompanyPO Checks to see if the order is linked to a PO. If it is, an informational message is presented Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
cICPOLinkMessage
String@
The message text
Epicor 9.05 | 9.05.605
1959
S-Z
Business Object Reference Guide
CheckPartRevisionChange The method is to be run on leave of the PartNum and Revision fields before the ChangePart, ChangeRevision, or Update methods are run. When run before CreateOrderFromQuote, the Part Number expected is the part number from the quote. This returns all the questions that need to be asked before a part can be changed. Parameters Name
Type
Description
iOrderNum
Int32
The current OrderHed.OrderNum field
iOrderLine
Int32
The current OrderDtl.OrderLine field
cFieldName
String
The name of the field you are leaving
cPartNum
String@
The new PartNum if a substitute part is found, partNum will be the substitute part
cConfigPartMessage
String@
If the part is configured, asks if it's okay to delete the configuration inputs. No means the part cannot be changed
cSubPartMessage
String@
Asks if the user wants to use a substitute part
lSubAvail
Boolean@
Indicates other substitute parts besides the default exist
cMsgType
String@
Type of message returned. Values can be; "Question" (asking if they want to use the substitute part) "Warning" (Warns them that a part is onhold or runout). "Error" (Part in Inactive, or Onhold/Runout parts are not accepted in this case). "Question" is asking if they want to use the substitute part.
CheckProjectID Validate Projec ID value Parameters Name
Type
Description
ipProjectID
String
The Project ID value
ds
The SalesOrder data set
CheckQuoteLinesNoQuantity The method is to be run after a Quote Number is obtained for creating an order from a quote, but before the CreateOrderFromQuote method is executed. This method returns the text of the question to be asked to the user if quote lines are found without an order quantity. Parameters
1960
Name
Type
Description
iQuoteNum
Int32
The Quote Number
cQuoteLineWOQtyMsgText
String@
The message text
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
CheckRateGrpCode Update Check if Rate Group Code entered is valid. Parameters Name
Type
Description
ipRateGrpCode
String
Currency Rate Group Code
ds
Quote dataset
CheckRenewalNbr Validates the entered RenewalNbr value. Parameters Name
Type
Description
iOrderNum
Int32
Order number whose field is getting modified
iOrderLine
Int32
Order Line number that is getting modified
iContractNum
Int32
Contract Number
iRenewalNbr
Int32
Proposed Renewal Number
CheckSellingFactorDirection OBSOLETE METHOD..... Validate Selling Factor Direction value Parameters Name
Type
Description
ipSellingFactorDirection
String
The Selling Factor Direction value
ds
The SalesOrder data set
CheckSellingQuantityChange The method is to be run on leave of the SellingQuantity field before the ChangeSellingQuantity or Update methods are run. If the unit price will be different based on the new quantity, this returns the question asking if user would like to use the new unit price or keep the current one. Calling this method is necessary only if the Quote Number on the detail record is not zero. Parameters Name
Type
ds
Description The SalesOrder data set
dSellingQuantity
Decimal
The proposed selling quantity
cSellingQuantityChangedMsgText
String@
The message text
Epicor 9.05 | 9.05.605
1961
S-Z
Business Object Reference Guide
CheckSONum Method to call when entering proposed Sales Order Number. This method will return two output variables. One is a logical field to indicate if the SO number entered is existing or not. The other variable is for the error message in case the proposed SO number is invalid. Parameters Name
Type
Description
proposedSONum
Int32
The proposed SO Number
opFoundSO
Boolean@
Indicates if the proposed SO number is already existing.
opMessage
String@
Error message for the user to see.
CloseOrder Checks to see if the order can be closed and closes it if it is allowed. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number to close
Returns The SalesOrder data set
CloseOrderLine Checks to see if the order can be closed and closes it if it is allowed. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number of the Order Line to close
iOrderLine
Int32
The Order Line Number to close
Returns The SalesOrder data set
CloseRelease Checks to see if the order release can be closed and closes it if it is allowed. Parameters
1962
Name
Type
Description
iOrderNum
Int32
The Order Number of the Order Release to close
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
iOrderLine
Int32
The Order Line of the Release to close
iOrderRelNum
Int32
The Order Release Number of the release to close
Returns The SalesOrder data set
CopyOrder Copy an order. Parameters Name
Type
Description
orderNum
Int32
The order to apply the discounts to
ipPONum
String
ipOpenRel
Boolean
ipReNbr
Boolean
ipPreserve
Boolean
ipCalc
Boolean
newOrderNum
Int32@
outMessage
String@
CreateGlbSugPOChg Create a new ttGlbSugPOChg record for processing. Parameters Name
Type
ds
Description The GlbSugPOChgDataSet data set
iOrderNum
Int32
The Order Number
iOrderLine
Int32
The Order Line Number
iOrderRel
Int32
The Order Release Number
CreateLineMiscChargesFromQuote Method to call to create Line Misc Charges when adding a new OrderDtl record from a quote Parameters Name
Type
Description
ipOrderNum
Int32
The Order Number
Epicor 9.05 | 9.05.605
1963
S-Z
Business Object Reference Guide
Name
Type
Description
ipOrderLine
Int32
The Line Number
ipQuoteNum
Int32
The Quote Number
ipQuoteLine
Int32
The Quote Line
ipQtyNum
Int32
The Quote Quantity
ds
The SalesOrder data set
CreateLinesFromHistory Create new lines for every Order Lines selected from History, Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
ds
The SalesOrder data set
CreateOrderDtlComplements Create new lines for every complement selected for a given Line, Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
ds
The SalesOrder data set
CreateOrderFromQuote Creates an order from a quote. Parameters Name
Type
Description
iQuoteNum
Int32
The Quote Number with which to create the order
Returns The SalesOrder data set
CreateOrderFromQuoteSaveOTS Creates an order from a quote and saves the OTS.
1964
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
iQuoteNum
Int32
The Quote Number with which to create the order
ds
Save OTS parameters DataSet
Returns The SalesOrder data set
ETCValidateAddress Call tax integration and loads temp tables from the results. Parameters Name
Type
Description
orderNum
Int32
OrderHed.OrderNum
orderLine
Int32
OrderDtl.OrderLine
orderRelNum
Int32
OrderRel.OrderRelNum
statusFlag
Boolean@
Set to true if the integration is up, false if down.
errorFlag
Boolean@
If true, an error occured.
errorMsg
String@
If Error Flag is true, this is the associated message.
exceptionFlag
Boolean@
This parameter is only used by the UI, it should not be modified here.
Returns The ETCAddrValidationDataSet data set
GetByIDLinkedOrder Update Order Header information with values from the Ship To when the Ship To is changed. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number of the order to get
Returns The SalesOrder data set
GetCalcQtyPref Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
Epicor 9.05 | 9.05.605
1965
S-Z
Business Object Reference Guide
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetGlbSugPOChg Get the GlbSugPOChg records for an Order Release. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
iOrderLine
Int32
The Order Line Number
iOrderRelNum
Int32
The Order Release Number
pageSize
Int32
The Page Size
absolutePage
Int32
The absolute page
morePages
Boolean@
More Pages
Returns The GlbSugPOChgDataSet data set
GetJobProd Get the JobProd records for an Order Release. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
iOrderLine
Int32
The Order Line Number
iOrderRelNum
Int32
The Order Release Number
pageSize
Int32
The Page Size
absolutePage
Int32
The absolute page
morePages
Boolean@
More Pages
Returns The OrdRelJobProdDataSet data set
GetKitComponents Calls GetKitComponents from SalesKitting.p, which creates a list of OrderDtl records that will be treated as kit components of the given OrderLine. Parameters
1966
Name
Type
Description
iPartNum
String
Part Number of the given OrderLine
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
iRevisionNum
String
Revision Number selected for the given PartNum
iAltMethod
String
Aletrnate Method of the given Part number
iTargetAsm
Int32
Target assembly to be exploded (usually asm 0)
orderNum
Int32
Order number to be exploded
orderLine
Int32
Order line which will be the Kit Parent
iUseMethodForParts
Boolean
-
regenerateKit
Boolean
If true this will cause the previous loaded components to be deleted
errorMsg
String@
Text message returned in case an error/warning was found
errorType
Int32@
1 = No components on Revision, 2 = Cannot Get Details, 3 = Missing configuration
ds
The sales order data set
GetNewSalesKit Creates a new OrderDtl and sets it as a kit component for the given OrderLine Parameters Name
Type
Description
orderNum
Int32
Order number where the Kit Parent resides
orderLine
Int32
Order line that has the SalesKit and to which the kit component will be added
ds
Order Dataset with the new OrderDtl record as a Sales Kit
GetPayBTFlagDefaults Parameters Name
Type
Description
ds
The sales order data set
GetPlantConfCtrlInfo Retrieves specific data from PlantConfCtrl for sale order form Parameters Name
Type
Description
opSuppressWarning
Boolean@
The message text
Epicor 9.05 | 9.05.605
1967
S-Z
Business Object Reference Guide
GetQuoteQty Get the QuoteQty records for an Order Release. Parameters Name
Type
Description
iQuoteNum
Int32
The Quote Number
iQuoteLine
Int32
The Quote Line Number
pageSize
Int32
The Page Size
absolutePage
Int32
The absolute page
morePages
Boolean@
More Pages?
Returns The OrdDtlQuoteQtyDataSet data set
GetRowsCustomerTracker Calls the normal GetRows method and then constructs a custom data set combining Hed/Dtl fields for the customer tracker. Parameters Name
Type
Description
whereClauseOrderHed
String
Whereclause for OrderHed table.
whereClauseOrderHedAttch
String
Whereclause for OrderHedAttch table.
whereClauseOHOrderMsc
String
Whereclause for OHOrderMsc table.
whereClauseOrderDtl
String
Whereclause for OrderDtl table.
whereClauseOrderDtlAttch
String
Whereclause for OrderDtlAttch table.
whereClauseOrderMsc
String
Whereclause for OrderMsc table.
whereClauseOrderRel
String
Whereclause for OrderRel table.
whereClauseOrderRepComm
String
Whereclause for RepComm table.
whereClauseSelectedSerialNumbers
String
Whereclause for SelectedSerialNumbers table.
whereClauseSerialNumberSearch
String
Whereclause for SerialNumberSearch table.
whereClauseSNFormat
String
Whereclause for SNFormat table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The OrderCustTrkDataSet data set
1968
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetSelectSerialNumbersParams Parameters Name
Type
Description
ipPartNum
String
ipPartNum
ipWhseCode
String
ipWhseCode
ipBinNum
String
ipBinNum
ipQuantity
Decimal
ipQuantity
ipTranType
String
ipTranType
ipRowID
String
ipRowID
Returns
GetSmartString Parameters Name
Type
Description
orderNum
Int32
Kit component order number
orderLine
Int32
Kit component order line
partNum
String
The part being configured
revisionNum
String
The revision being configured
smartString
String@
The generated smartstring of the configuration
createPart
Boolean@
True if a new part should be created
promptForPartNum
Boolean@
True if the user should be prompted for the part number
notifyOfExistingPart
Boolean@
If true the user should be warned if the new part number already exists
newPartNum
String@
The generated portion of the new part number
createCustPart
Boolean@
If true the user should be asked if they want the Customer Part Number assigned
promptForCustPartNum
Boolean@
If true the user should be prompted to update the new Customer Part Number
newCustPartNum
String@
The generated customer part number
promptForAutoCreatePart
Boolean@
True if the user should be prompted to create part
Get the parameters needed for the UI on startup. Returns The SO entry UI Params data set
Epicor 9.05 | 9.05.605
1969
S-Z
Business Object Reference Guide
GlbSugPOChgDelete Delete a new GlbSugPOChg record. Parameters Name
Type
Description
cRowIdent
String
The row ident of the record to delete
Returns The GlbSugPOChgDataSet data set
GlbSugPOChgUpdate Update/Add a new GlbSugPOChg record. Parameters Name
Type
Description
ds
The GlbSugPOChgDataSet data set
JobProdDelete Delete JobProd records. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
iOrderLine
Int32
The Order Line Number
iOrderRelNum
Int32
The Order Release Number
cJobNum
String
Job Number
KitCompPartCreate Parameters
1970
Name
Type
Description
orderNum
Int32
Kit component order number
orderLine
Int32
Kit component order line
partNum
String
The part being configured
revisionNum
String
The revision being configured
smartString
String
The generated smartstring of the configuration
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
newPartNum
String
The Part Number to be used for a new part creation. If blank, a part will not be created.
newCustPartNum
String
The Customer Part Number to stored on the order line.
responseAutoCrtPart
Boolean
Answer to the question presented to user about auto creating a part.
newPartAlreadyExists
Boolean@
Returns true a new part was not created because it already exists.
MasterUpdate Parameters Name
Type
Description
lcheckForResponse
Boolean
bool to determine whether to run code that may require user input
cTableName
String
identifies which table was modified
iCustNum
Int32
The current custNum
iOrderNum
Int32
The current orderNum
lweLicensed
Boolean
whether the WE module is licensed
lContinue
Boolean@
Return bool to identify whether a stop condition was reached
cResponseMsg
String@
Return message which requires a user response
cDisplayMsg
String@
Return message to display to user from ChkLtrOfCrdt routine
cCompliantMsg
String@
Return check compliance message to display to user
ds
The SalesOrder data set
OnChangeARLOCID Validate ARLOCID value Parameters Name
Type
Description
ipARLOCID
String
The Letter of Credit ID value
opOverwriteValue
String@
The value to put in the field
opFieldName
String@
The name of the field that the overwrite value goes in
opMsg
String@
Message to the user
ds
Epicor 9.05 | 9.05.605
The SalesOrder data set
1971
S-Z
Business Object Reference Guide
OnChangeCreditCardOrder This method validates field CreditCardOrder Parameters Name
Type
Description
ipCreditCardOrder
Boolean
Proposed CreditCardOrder value
ds
The SalesOrder data set
OnChangeofBTConNum This method returns the Bill To Contact info. Parameters Name
Type
Description
newBillToConNum
Int32
Proposed bill to custid
ds
The SalesOrder data set
OnChangeofBTCustID This method returns the Bill To customer info. Parameters Name
Type
Description
newBillToCustID
String
Proposed bill to custid
ds
The SalesOrder data set
OnChangeOfFixedAmount This method should be called when the taxable amount on the invoice tax record is changed. Parameters Name
Type
Description
orderNum
Int32
Order Number.
orderLine
Int32
Order line number.
orderRel
Int32
Order Rel number.
taxCode
String
Release tax code.
rateCode
String
Release rate code.
newFixedAmount
Decimal
Proposed Fixed AMount.
ds
1972
SalesOrder dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
OnChangeOfMktgCampaign This method should be called when MktgCampaign changes. It will validate to select an Active MktgCampaign. This method defaults the Marketing Event field Parameters Name
Type
Description
mktgCampaignID
String
The MktgCampaign Id
ds
The SalesOrder data set
OnChangeOfMktgEvnt This method should be called when MktgEvent changes. It will validate to select an Active MktgEvent. Parameters Name
Type
Description
mktgCampaignID
String
The MktgCampaign Id
mktgEvntSeq
Int32
The MktgCampaign Id
ds
The SalesOrder data set
OnChangeofSoldToCreditCheck This method should be called when the sold to customer changes. It will validate the default bill to customer credit. The method returns a character string if the customer will go over their credit limit and the user is given the choice of continuing or not. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
iCustID
String
The Sold To Customer ID
cCreditLimitMessage
String@
The over credit limit message text
lContinue
Boolean@
Indicates if the user is allowed to continue with processing
ds
The SalesOrder data set
OnChangeOfTaxAmt This method should be called when the taxable amount on the invoice tax record is changed.
Epicor 9.05 | 9.05.605
1973
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
orderNum
Int32
Order Number.
orderLine
Int32
Order line number.
orderRel
Int32
Order Rel number.
taxCode
String
Release tax code.
newTaxAmt
Decimal
Proposed Taxable amount.
ds
SalesOrder dataset
OnChangeOfTaxPercent This method should be called when the taxable amount on the invoice tax record is changed. Parameters Name
Type
Description
orderNum
Int32
Order Number.
orderLine
Int32
Order line number.
orderRel
Int32
Order Rel number.
taxCode
String
Release tax code.
newPercent
Decimal
Proposed Percent.
ds
SalesOrder dataset
OnChangeofTaxRgn Validate Tax Region Code entered by the user. Parameters Name
Type
Description
iTaxRegionCode
String
Proposed tax region code.
ds
Sales Order data set.
OnChangeRateCode Parameters Name
Type
Description
proposedRateCode
String
Release tax rate code.
ds
1974
Sales Order data set.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
OnChangeTaxableAmt This method should be called when the taxable amount on the invoice tax record is changed. Parameters Name
Type
Description
orderNum
Int32
Order Number.
orderLine
Int32
Order line number.
orderRel
Int32
Order Rel number.
taxCode
String
Release tax code.
rateCode
String
Release rate code.
newTaxableAmt
Decimal
Proposed Taxable amount.
ds
SalesOrder dataset
OnChangeTaxCode Parameters Name
Type
Description
ipOrderNum
Int32
Order Number.
ipLineNum
Int32
Order line number.
ipRelNum
Int32
Order Rel number.
ipTaxCode
String
Release tax code.
ds
Sales Order data set.
OrderDtlGetNewContracts Method to call when adding a new OrderDtl record for a Contract or a Service Contract Parameters Name
Type
ds iOrderNum
Description The SalesOrder data set
Int32
The order number to add the line to
OrderDtlGetNewCounterSale Method to call when adding a new OrderDtl record for a counter sale
Epicor 9.05 | 9.05.605
1975
S-Z
Business Object Reference Guide
Parameters Name
Type
ds iOrderNum
Description The SalesOrder data set
Int32
The order number to add the line to
OrderDtlGetNewFromQuote Method to call when adding a new OrderDtl record from a quote Parameters Name
Type
ds iOrderNum
Description The SalesOrder data set
Int32
The order number to add the line to
OverCreditLimitUpdateAllowed This should be called whenever the user selects an order either by typing the order number on the screen or picking it via a lookup. This method checks to see if the order is over the credit limit, and if it is it then checks a system setting to see if orders over the credit limit can be updated. If they cannot, it returns a value of false and updates cannot occur. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
lUpdateAllowed
Boolean@
Update allowed flag; true if update allowed, false if not.
phantomComponents This procedure will explode the BOM of a part set as Phantom Parameters Name
Type
Description
phPartNum
String
The phantom part number
orderNum
Int32
Order number where the lines will be saved
orderLine
Int32
Order line of the parent line
errMessage
String@
Returns any error messages found during the process
ProcessCounterSale Process the counter sale by generating the packing slip and/or the invoice for the order.
1976
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
iOrderNum
Int32
The Order Number of the counter sale order to process
lGeneratePackingSlip
Boolean
Flag to indicate if the packing slip should be generated
lGenerateInvoice
Boolean
Flag to indicate if the invoice should be generated
lReadyToShip
Boolean
Indicates if the packing slip should be marked as ready to ship
cPackNum
String@
The number of the packing slip that was generated
iInvoiceNum
Int32@
The number of the invoice that was generated
opMessage
String@
Message to display to user when processing is done
ds
The SalesOrder data set
ProcessQuickEntry Process the Quick Entry job options on the order detail lines. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number of the order to process
lProcessComplete
Boolean@
Indicates if the process completed without error
ds
The SalesOrder data set
RebuildShipUPS Parameters Name
Type
Description
ipCustNum
Int32
Customer to update
ipShipToNum
String
Ship To Num
ds
The Order Entry dataSet
RecalcKitPriceAfterConfig When configuring a part, the OrderDtl unit price may change during the configuration process. This method is to be called after running product configurator to recalculate the kit pricing. Parameters Name
Type
Description
iOrderNum
Int32
Sales Order Number for configured part
Epicor 9.05 | 9.05.605
1977
S-Z
Business Object Reference Guide
Name
Type
Description
iOrderLine
Int32
Sales Order Line for configured part
RemoveICPOLink Removes a PO Link from this order. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number of the Order to remove the link from
Returns The SalesOrder data set
ReopenOrder Reopens an order. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number of the Order to reopen
Returns The SalesOrder data set
ReopenOrderLine Reopens an order line. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number of the Order Line to reopen
iOrderLine
Int32
The Order Line Number to close
Returns The SalesOrder data set
ReopenRelease Reopens an order release. Parameters
1978
Name
Type
Description
iOrderNum
Int32
The Order Number of the Order Release to reopen
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
iOrderLine
Int32
The Order Line Number of the Release to close
iOrderRelNum
Int32
The Release Number of the Release to close
Returns The SalesOrder data set Send a linked IC PO Suggestion.
SetCalcQtysPref Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
SetReadyToCalc Parameters Name
Type
Description
ipOrderNum
Int32
The Order Number of the Order to remove the link from
ds
ARInvoice dataset
SetUPSQVEnable Parameters Name
Type
Description
ipQVEnable
Boolean
logical indicating if the quantum view is to enabled/disabled
ds
The sales order data set
ValidateInvQty Validate that the order detail line transaction does not cause the part to result in negative onhand quantity. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number of the counter sale order to process
opNegInvMessage
String@
pcMessage for negativeInventoryTest
Epicor 9.05 | 9.05.605
1979
S-Z
Business Object Reference Guide
Name
Type
Description
opNeqQtyAction
String@
pcNegQtyAction for negativeInventoryTest
ds
The SalesOrder data set
ValidateSNs Validate serial numbers are entered for each part before calling generatepackslip. Parameters Name
Type
Description
ds
The SalesOrder data set
VerifySendICPOSugg Returns the text of the message to be presented to the user asking if they are sure they want to continue with the SendICPOSuggestions process or not. This method should be called after CheckICPOReadyToSend if the user chose to continue and before the SendICPOSuggestions method. Parameters Name
Type
Description
cVerifySendMsgText
String@
The message text
hasMultipleSubs Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
isRunOutOnHand Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
1980
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
SalesOrdHedDtl Epicor.Mfg.BO.SalesOrdHedDtl: This business object contains 10 methods.
GetNewOrderHed Inserts a new row in the DataSet with defaults populated.
GetNewOrderDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
1981
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsContactTracker Calls the normal GetRows method and then constructs a custom data set combining Hed/Dtl fields for the customer tracker. Parameters Name
Type
Description
whereClauseOrderHed
String
Whereclause for OrderHed table.
whereClauseOrderDtl
String
Whereclause for OrderDtl table.
contactName
String
The contact name to return orders for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Order Customer Trk DataSet
GetRowsCustomerTracker Calls the normal GetRows method and then constructs a custom data set combining Hed/Dtl fields for the customer tracker. Parameters Name
Type
Description
whereClauseOrderHed
String
Whereclause for OrderHed table.
whereClauseOrderDtl
String
Whereclause for OrderDtl table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Order Customer Trk DataSet
1982
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
SalesRep Epicor.Mfg.BO.SalesRep: This business object contains 12 methods.
GetNewSalesRep Inserts a new row in the DataSet with defaults populated.
GetNewSalesRepAttch Inserts a new row in the DataSet with defaults populated.
GetNewSaleAuth Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1983
S-Z
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DefaultDefaultUser Used to determine the default setting for the DefaultUser flag when creating a new SaleAuth record. This method can be called after the SaleAuth.DCDUserId field has been assigned but prior to calling the Update method. Will return as true when 1. SalesRep is not already a default for a user and 2. The user does not have a primary salesrep. Parameters Name
Type
Description
salesRepCode
String
The SalesRep code
dcDUserID
String
User ID
defaultUser
Boolean@
Is User Default for this SalesRep
GetPerConData Used to validate the PerCon. Parameters Name
Type
Description
perConID
Int32
Proposed PerConID.
ds
SalesRep data set.
OnChangeUserID This method should be called when the Terms Code changes.
1984
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
salesRepCode
String
SalesRepCode.
newUserID
String
Proposed DcdUserID.
ds
SalesRep data set.
SalesRepQuota Epicor.Mfg.BO.SalesRepQuota: This business object contains 16 methods.
GetNewSRepQHed Inserts a new row in the DataSet with defaults populated.
GetNewSRepQDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
1985
S-Z
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
Description
tableName
String
fieldName
String
Returns
ChangeDtlQuotaAmt This method updates the DispTotalQuotaAmt and the QuotaAmt of the SRepQHed when the SRepQDtl.QuotaAmt changes. Parameters Name
Type
ds
Description The SalesRepQuota dataset
ChangePerCodeOrAmount This method updates the DispTotalQuotaAmt when the QuotaPerCode or QuotaAmt changes. Parameters Name ds
1986
Type
Description The SalesRepQuota dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ChangeSalesRepCode This method validates if sales quota exists when changing the Salesperson field. Parameters Name
Type
Description
proposedSalesRepCode
String
The proposed Salesperson code.
ds
The SalesRepQuota data set
CopySalesQuota This method copies the entire Sales Quota from a valid fiscal year to a new Fiscal Year. Parameters Name
Type
Description
fromFiscalYear
Int32
The Fiscal Year of the Sales Quota to copy.
fromFiscalYearSuffix
String
The Fiscal Year Suffix of the Sales Quota to copy.
adjustmentPct
Decimal
The Adjustment Percentage by which to adjust the numbers for the Target Fiscal Year. If 0 then quota will be copied as is.
toFiscalYear
Int32
The Target Fiscal Year for the new quota.
toFiscalYearSuffix
String
The Target Fiscal Year Suffix for the new quota.
Returns Returns the new Salesperson Quota
DeleteSalesQuota This method deletes the entire Sales Quota of a valid fiscal year. Parameters Name
Type
Description
inpFiscalYear
Int32
The Fiscal Year of the Sales Quota to delete.
inpFiscalYearSuffix
String
The Fiscal Year Suffix of the Sales Quota to delete.
Returns The SalesRepQuota dataset
GetFiscalYear This method returns fiscal year/suffix based on todays date
Epicor 9.05 | 9.05.605
1987
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
fiscalCalendarID
String@
Fiscal Calendar
fiscalYear
Int32@
Fiscal Year
fiscalYearSuffix
String@
Fiscal Year Suffix
ValidateFiscalYear This method checks to see if the FiscalYear/FiscalYearSuffix selected is a valid year Parameters Name
Type
Description
fiscalYear
Int32
Fiscal Year to test
fiscalYearSuffix
String
Fiscal Year Suffix to test
SalesTax Epicor.Mfg.BO.SalesTax: This business object contains 20 methods.
GetNewSalesTax Inserts a new row in the DataSet with defaults populated.
GetNewLangDesc Inserts a new row in the DataSet with defaults populated.
GetNewSalesTRC Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewSalesTxc Inserts a new row in the DataSet with defaults populated.
GetNewTaxBox Inserts a new row in the DataSet with defaults populated.
GetNewTaxRate Inserts a new row in the DataSet with defaults populated.
1988
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetNewTaxGRate Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
1989
S-Z
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeCollectionType This method resets appropriate values when taxConnectCalc is true. Parameters Name
Type
Description
proposedCollectionType
Int32
The proposed Tax Collection Type.
ds
The Sales Tax data set.
ChangeDiscountType This method resets appropriate values when taxConnectCalc is true. Parameters Name
Type
Description
proposedDiscountType
Int32
The proposed Discount Type value.
ds
The Sales Tax data set.
ChangeTaxBoxCode This method validates BoxCode entered and populates the record from TaxBoxDefault. Parameters Name
Type
Description
proposedBoxCode
String
The proposed BoxCode value.
ds
The Sales Tax data set.
ChangeTaxConnectCalc This method resets appropriate values when taxConnectCalc is true. Parameters Name
Type
Description
proposedTaxConnectCalc
Boolean
The proposed TaxConnectCalc value.
ds
1990
The Sales Tax data set.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ChangeTiming This method resets appropriate values ServiceTaxPoint when Timing is 0. Parameters Name
Type
Description
proposedTiming
Int32
The proposed Timing.
ds
The Sales Tax data set.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
SalesTer Epicor.Mfg.BO.SalesTer: This business object contains 20 methods.
GetNewSalesTer Inserts a new row in the DataSet with defaults populated.
GetNewSalesTBD Inserts a new row in the DataSet with defaults populated.
GetNewSalesTRP Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
1991
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AdjustTerritory This method sets PendingTerritoryies to new Territory boundaries Parameters Name
Type
Description
cTerritoryID
String
Blank for All, otherwise specify the territory to adjust
vMessage
String@
Success Message
CheckSecurity We want to know if the user has the permissions to retrieve the territory
1992
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
cTerritoryID
String
Territory to validate
CheckTerrSalesperson This method checks that the territory has at least one Salesperson before allowing the user to leave the territory record Parameters Name
Type
Description
cTerritoryID
String
Territory to validate
This method clears the pending territory updates from all customer/shipto's
GetByIDCustom This method returns a single Territory (which can be inactive) Parameters Name
Type
Description
territoryID
String
The territory code
Returns Returns a single Territory (which can be inactive)
GetListCustom This method returns a list of Territories, including inactive ones. Parameters Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of Territories including inactive ones.
GetListPlusRO This method returns a list of Territories, including the Read-Only ones.
Epicor 9.05 | 9.05.605
1993
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of Territories including Read-Only ones.
GetRowsCustom This method returns a list of Territories, including inactive ones Parameters Name
Type
Description
whereClauseSalesTer
String
The criteria
whereClauseSalesTBD
String
The TBD criteria
whereClauseSalesTRP
String
The TRP criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of Territories including inactive
GetSalesRepInfo This method defaults the role code field in SalesTRP once salesRepCode is selected This method posts the PendingTerritoryID to the actual TerritoryID for all Customer/ShipTo's.
ReassignTerritory This method reassigns SalesPeople and Tasks to their new Territory or SalesPerson Parameters
1994
Name
Type
Description
cTerritoryId
String
Territory Id to update
cSalesRepCode
String
Current SalesPerson
cNewSalesRepCode
String
New SalesPerson
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
cActionType
String
lReassignTasks
Boolean
Description
If yes, then Tasks will be reassigned to the new SalesPerson
SalesTRCSearch Epicor.Mfg.BO.SalesTRCSearch: This business object contains 7 methods.
GetNewSalesTRC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
1995
S-Z
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
SchedPri Epicor.Mfg.BO.SchedPri: This business object contains 7 methods.
GetNewSchedPri Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
1996
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ScheduleEngine Epicor.Mfg.BO.ScheduleEngine: This business object contains 13 methods.
AcceptChanges This method commits a job. Move Whatif to scheduled. Parameters Name
Type
Description
jobsMoved
String
The string, contains list of Jobs(separates "~~"), each Job contains JobData,JobNum,AssemblySeq,OprSeq, OpDtlSeq, AllocNum (separates "`")
ds
The ScheduleEngine dataset
ChangeProductionComplete This method does stuff. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The ScheduleEngine dataset
1997
S-Z
Business Object Reference Guide
ChangeResource This method will change the resource on a resourcetimeused record. Parameters Name
Type
ds
Description The ScheduleEngine DataSet
ipAllocNum
Int32
The ResourceTimeUsed AllocNum
ipResourceID
String
The ResourceTimeUsed ResourceID
ipBlocksChanged
Boolean
Determines wether the number of scheduling blocks changed or not
warnLogTxt
String@
String for warning messages
ChangeSetupComplete This method does stuff. Parameters Name
Type
Description
ds
The ScheduleEngine DataSet
GetLoadLevelDflts This method does stuff . Parameters Name
Type
Description
ds
The ScheduleEngine DataSet
GetSchedTypeCodes Returns the list of Schedule Type Code and Descriptions . Two lists are return the SchedTypecodes are used when moving a job, assembly and operation. OperationOnlySchedTypecodes are used in addition to the previous codes, but only for operations. Parameters
1998
Name
Type
Description
schedTypecodes
String@
The list of Schedule Type Code and Descriptions
operationOnlySchedTypecodes
String@
OperationOnlySchedTypecodes are used in addition only for operations
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetScheduleRecord This method allows the UI to retrieve a blank Schedule record. Parameters Name
Type
ds
Description The ScheduleEngine DataSet
LoadLeveling Load method. Parameters Name
Type
ds
Description The ScheduleEngine DataSet
MoveJobItem Procedure to move an Operation Detail. Parameters Name
Type
ds
Description The ScheduleEngine DataSet
l_finished
Boolean@
The indication that the procedure was successful
c_WarnLogTxt
String@
The string with warning messages
MoveSchedBoardItem Procedure to move an Operation Detail, used for moving a scheduling board item, allows the movement of a locked job. Parameters Name
Type
ds
Description The ScheduleEngine DataSet
l_finished
Boolean@
The indication that the procedure was successful
c_WarnLogTxt
String@
The string with warning messages
SaveSchedule This method does stuff .
Epicor 9.05 | 9.05.605
1999
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The ScheduleEngine DataSet
SetMachines This method does stuff. Assign JobOper.WIMachines from ScheduleEngine.Machines. Parameters Name
Type
ds
Description The ScheduleEngine DataSet
UndoChanges This method commits a job. Move Whatif to scheduled . Parameters Name
Type
Description
jobsMoved
String
The string, contains list of Jobs(separates "~~"), each Job contains JobData,JobNum,AssemblySeq,OprSeq, OpDtlSeq, AllocNum (separates "`")
ds
The ScheduleEngine DataSet
SchedulingBoard Epicor.Mfg.BO.SchedulingBoard: This business object contains 6 methods.
BuildJobLine This methods will return all of the JobLine Header type records. This will be a JobLine record that would represent the JobHead and JobAsmbl.AssemblySeq = 0 information. To retrieve the details run the ExpandJobLine publice method. If ipJobNum and ipProjectID are both blank or unknown you will get all jobs for the current plant, or if ipJobNum is not blank then just that job, or if ipjobnum is blank and ipProjectID is not, then all jobs associated with that projectid. Parameters Name ds
Type
Description The SchedulingBoard DataSet
BuildResourceLine This methods will return all of the Resource Header type records. This will be a SchedulingBoard record that would represent the ResourceTimeUsed and it's assoc information.
2000
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ipResourceGrpID
String
The resource group id to schedule for.
ipResourceID
String
The resource id or a list of resource id to schedule for
ipJobNum
String
The job number to schedule for.
startDate
Nullable{System.DateTime}
The StartDate to schedule for.
endDate
Nullable{System.DateTime}
The EndDate to schedule for.
Returns The SchedulingBoard DataSet This methods will create new record of the SchedulingBoard. Returns The SchedulingBoard DataSet
Restore This method will restore the schedule based on the schedule id and return and potential errors or warings with the restore in the SchedRestoreLog table. Parameters Name
Type
Description
ipScheduleID
Int32
The Schedule ID
opJobList
String@
The Restored Schedule Job List
Returns The SchedulingBoard DataSet
ReturnCalendarID This methods will return the calendar id information along with whether or not this calendar information can be used. Parameters Name
Type
Description
ipResourceGrpID
String
The resource group id locate calendar for.
ipResourceID
String
The resource id or a list of resource id locate calendar for.
opCalendarID
String@
The calendar id that is returned based on inputs.
opValidCalendar
Boolean@
The resource id or a list of resource id to schedule for.
Epicor 9.05 | 9.05.605
2001
S-Z
Business Object Reference Guide
SetLockSched This method locks/unlocks the schedule of a specific jobnum. Parameters Name
Type
Description
inLockedStatus
Boolean
The locked status of the schedule.
ds
The SchedulingBoard DataSet
Schema Epicor.Mfg.BO.Schema: This business object contains 8 methods.
GetFieldByID This method returns a field dataset for the given table/field Parameters Name
Type
Description
pcFile
String
name of the table
pcField
String
name of the field
Returns The dataset represents the field object
GetFieldList This method returns a list of fields for the given table Parameters Name
Type
Description
pcFile
String
name of the table
Returns The dataset represents the field object
GetFileByID This method returns a fileSchema dataset for the given table Parameters
2002
Name
Type
Description
pcFile
String
name of the table
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The dataset represents the file object
GetFileList This method returns a fileSchema dataset for the given criteria Parameters Name
Type
Description
pcWhere
String
where clause
Returns The file records that meet the criteria
GetIndexByID This method returns an index dataset for the given table/index Parameters Name
Type
Description
pcFile
String
name of the table
pcIndex
String
name of the index
Returns The dataset represents the index object
GetIndexFieldByID This method returns an index field dataset for the given table/index/sequence Parameters Name
Type
Description
pcFile
String
name of the table
pcIndex
String
name of the index
piSeq
Int32
the sequence number in the index
Returns The dataset represents the index field object
GetIndexFieldList This method returns a list of index fields for the given table/index Parameters Name
Type
Description
pcFile
String
name of the table
Epicor 9.05 | 9.05.605
2003
S-Z
Business Object Reference Guide
Name
Type
Description
pcIndex
String
name of the index
Returns The index fields in the index
GetIndexList This method returns a list of indexes in a table Parameters Name
Type
Description
pcFile
String
name of the table
Returns The indexes for the table
SecColumn Epicor.Mfg.BO.SecColumn: This business object contains 7 methods.
GetNewSecColumn Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2004
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
SecGroup Epicor.Mfg.BO.SecGroup: This business object contains 7 methods.
GetNewSecGroup Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
2005
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Security Epicor.Mfg.BO.Security: This business object contains 15 methods.
GetNewSecurity Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
2006
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DenyAccess This method deny token access to a particular user or group
Epicor 9.05 | 9.05.605
2007
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
pcSecCode
String
The security token
pcUser
String
The user id or a group code
pbCurrentCompanyOnly
Boolean
yes = no particular company
ds
Returns the dataset representing Security object
GetByIDEx This method returns a dataset representing a Security with a blank CompanyID Parameters Name
Type
Description
pcSecCode
String
The security code
Returns Returns the dataset representing the Security row
GetGroupUserList This method returns a double-delimited list of value-name pairs of all Users and Groups. This could be used to provide a "picker list" as a starting point when adding a new Security record related to a method. These would look the same as a Security record for an object, but with a SecCode field that has been appended with "." + MethodName. For example, a security record for the Parameters Name
Type
Description
pcGroupUserList
String@
The double-delimited list of Group and User codes and names.
GetListEx This method returns a list of Security, including those with blank Company ID Parameters
2008
Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns Returns the list of Securities
GetMethodList This method returns a delimited list of the public methods for the given object. This could be used to provide a "picker list" as a starting point when adding a new Security record related to a method. These would look the same as a Security record for an object, but with a SecCode field that has been appended with "." + MethodName. For example, a security record for the Parameters Name
Type
Description
pcSecCode
String
The security code for which you want the list of methods.
pcMethodList
String@
The delimited list of method names.
GetNewSubSecurity This method creates a new sub security row Parameters Name
Type
ds
Description Returns the created subsecurity row
pcParentSecCode
String
The parent security code
pcSecCode
String
The security code
GetRowsEx This method returns a list of Security, including those with blank Company ID Parameters Name
Type
Description
whereClause
String
The criteria
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns Returns the list of Securities
GrantAccess This method Grant security token access to a particular user or group
Epicor 9.05 | 9.05.605
2009
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
pcSecCode
String
The Security token
pcColumn
String
The Column
pcUser
String
The user id or a group code
pbCurrentCompanyOnly
Boolean
yes = only for current company
ds
Returns the dataset representing Security object
SelectedSerialNumbers Epicor.Mfg.BO.SelectedSerialNumbers: This business object contains 6 methods.
AddSerialNum This method is used for adding an existing SerialNo record to the Selected Serial Numbers dataset. Parameters Name
Type
ds
Description The SelectedSerialNumbers dataset
partNum
String
Part number for the serial number.
xrefPartNum
String
XRef Part Number.
xrefPartType
String
XRef Part Type (C=Customer/I=Internal Xref).
xrefCustNum
Int32
XRef Customer Number.
serialNum
String
Serial Number to be added.
sourceRowID
String
RowID from the source transaction record.
transType
String
Transaction Type from the source transaction record.
plantID
String
Plant associated with the transaction.
Type
Description
CheckSN Parameters Name ds
2010
The SelectedSerialNumbers dataset
ipPartNum
String
Part number for the serial number.
ipXrefPartNum
String
XRef Part Number.
ipXrefPartType
String
XRef Part Type (C=Customer/I=Internal Xref).
ipXrefCustNum
Int32
XRef Customer Number.
ipBaseSerialNum
String
Serial Number to be used as the base serial number.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
ipSourceRowID
String
RowID from the source transaction record.
ipTransType
String
Transaction Type from the source transaction record.
ipPlantID
String
Plant associated with the transaction.
ipFullSerialNum
String
Full Serial Number including prefixs, suffix, subs, etc - used with generate masks
opExists
Boolean@
Returns whether the SN already exists or not.
CreateSerialNum Add a serial number temporary record to the Selected Serial Number dataset. Parameters Name
Type
ds
Description The SelectedSerialNumbers dataset
partNum
String
Part number for the serial number.
xrefPartNum
String
XRef Part Number.
xrefPartType
String
XRef Part Type (C=Customer/I=Internal Xref).
xrefCustNum
Int32
XRef Customer Number.
baseSerialNum
String
Serial Number to be used as the base serial number.
sourceRowID
String
RowID from the source transaction record.
transType
String
Transaction Type from the source transaction record.
plantID
String
Plant associated with the transaction.
fullSerialNum
String
Full Serial Number including prefixs, suffix, subs, etc - used with generate masks
CreateSerialNumRange Create multiple serial number temporary records in the Selected Serial Numbers dataset. Parameters Name
Type
ds
Description The SelectedSerialNumbers dataset
partNum
String
Part number for the serial number.
xrefPartNum
String
XRef Part Number.
xrefPartType
String
XRef Part Type (C=Customer/I=Internal Xref).
xrefCustNum
Int32
XRef Customer Number.
numToAdd
Decimal
Number of serial numbers to create.
Epicor 9.05 | 9.05.605
2011
S-Z
Business Object Reference Guide
Name
Type
Description
baseBeginNum
String
The beginning base serial number.
sourceRowID
String
RowID from the source transaction record.
transType
String
Transaction Type from the source transaction record.
plantID
String
Plant associated with the transaction.
GetNextSN Gets the next serial number based on the format for the part number passed in. Parameters Name
Type
ds
Description The SelectedSerialNumbers DataSet
snPartNum
String
Part number to create serial numbers for.
xrefPartNum
String
XRef Part Number.
xrefPartType
String
XRef Part Type (C=Customer/I=Internal Xref).
xrefCustNum
Int32
XRef Customer Number.
plantID
String
Plant associated with the transaction.
nextBaseSN
String@
The next base serial number to create.
snPrefix
String@
The serial number prefix.
nextFullSN
String@
The next full serial number to create.
snCounterMax
Boolean@
Indicate if the Serial Number counter has hit its max value.
GetSerialNumFormat Gets the next serial number format based on the part number passed in. Parameters Name
Type
ds
2012
Description The SelectedSerialNumbers DataSet
partNum
String
Part number to create serial numbers for.
xrefPartNum
String
XRef Part Number.
xrefPartType
String
XRef Part Type (C=Customer/I=Internal Xref).
xrefCustNum
Int32
XRef Customer Number.
plantID
String
Plant associated with the transaction.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
SerialMatch Epicor.Mfg.BO.SerialMatch: This business object contains 9 methods.
GetNewSerialMatch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2013
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsLLSerialNumberTracker Calls the normal GetRows method and then constructs a custom data set for the Serial Number tracker. Parameters Name
Type
Description
serialNumber
String
Serial Number.
partNumber
String
Part Number.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.SerialMatchLLSerTrkData
GetRowsWUSerialNumberTracker Calls the normal GetRows method and then constructs a custom data set for the Serial Number tracker. Parameters Name
Type
Description
serialNumber
String
Serial Number.
partNumber
String
Part Number.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.SerialMatchWUSerTrkData
2014
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
SerialMatching Epicor.Mfg.BO.SerialMatching: This business object contains 17 methods.
AutoMatch Parameters Name
Type
Description
ipJobNum
String
JobHead.JobNum
ipAssemblySeq
Int32
JobAsmbl.AssemblySeq
ipSerialNo
String
SerialNo.SerialNumber
ipPartNum
String
Part.PartNum
ipRevNum
String
PartRev.RevisionNum
ipCrtHdr
Boolean
ipCrtHdr
opRevMsg
String@
revision
ds
The Serial Matching data set
ChangeSerialNum Parameters Name
Type
Description
ipSerialNo
String
SerialNo.SerialNumber
ipPartNum
String
SerialNo.PartNum
ipRevNum
String
PartRev.RevisionNum
ipJobNum
String
JobHead.JobNum
ipAssemblySeq
Int32
JobAsmbl.AssemblySeq
opRevMsg
String@
revision
opnoBOMMsg
String@
bommessage
ChangeFullyMatched Parameters Name
Type
Description
ipFullyMatched
Boolean
ttSerialMatchHdr.FullyMatched
ds
Epicor 9.05 | 9.05.605
The Serial Matching data set
2015
S-Z
Business Object Reference Guide
GetAvailableToMatch Parameters Name
Type
Description
ipType
String
ds
The Serial Matching data set
GetNewSerialMatchAsmbl Parameters Name
Type
Description
ds
The Serial Matching data set
GetNewSerialMatchMtl Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeAsmblSerialNo Parameters Name
Type
Description
ipMode
String
revision
ipSerialNum
String
bommessage
ipInt
Int32
ipInt
ds
The Serial Matching data set
UpdateSMAssembly Parameters
2016
Name
Type
ipMode
String
ipSerialNo
String
Description
SerialNo.SerialNumber
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
ipAsmSeqNum
Int32
ds
Description
The Serial Matching data set
UpdateONSaveAssembly Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeMtlSerialNo Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
UpdateSMMaterial Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangePartNum Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
2017
S-Z
Business Object Reference Guide
ValidateAssembly Parameters Name
Type
Description
ipJobNum
String
JobHead.JobNum
ipAssemblySeq
Int32
JobAsmbl.AssemblySeq
opQuestion
String@
ds
The Serial Matching data set
ValidateJob Parameters Name
Type
Description
ipJobNum
String
JobHead.JobNum
opQuestion
String@
ValidateTopSerialNumber Parameters Name
Type
Description
ipSerialNo
String
SerialNo.SerialNumber
ipJobNum
String
JobHead.JobNum
ipAssemblySeq
Int32
JobAsmbl.AssemblySeq
opErrMsg
String@
GetPlantLLSerTrk getMatchToParentAsmblSerialNo Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
2018
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
SerialNo Epicor.Mfg.BO.SerialNo: This business object contains 37 methods.
GetNewSerialNo Inserts a new row in the DataSet with defaults populated.
GetNewSerialNoAttch Inserts a new row in the DataSet with defaults populated.
GetNewSerialNoCondition Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
2019
S-Z
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
2020
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeAssemblySeq Method to call when changing the AssemblySeq. Parameters Name
Type
Description
proposedAsmSeq
Int32
The proposed Job Assembly Seq
ds
The Serial Number DataSet to update the Job Asm related data.
ChangeCustomerID Method to call when changing the CustID, passing a blank CustID clears the related fields.
Epicor 9.05 | 9.05.605
2021
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
proposedCustID
String
The proposed Customer ID
ds
The Serial Number DataSet to update the Customer related data.
ChangeDMRAction Method to call when changing the DMRAction. Parameters Name
Type
Description
proposedDMRAction
Int32
The proposed DMR Action
ds
The Serial Number DataSet to validate the DMR related data.
ChangeDMRNum Method to call when changing the DMRNum, passing a 0 clears the related fields. Parameters Name
Type
Description
proposedDMRNum
Int32
The proposed DMR Number
ds
The Serial Number DataSet to validate the DMR related data.
ChangeJobNum Method to call when changing the JobNum, passing a blank JobNum clears the related fields. Parameters Name
Type
Description
proposedJobNum
String
The proposed Job Number
ds
The Serial Number DataSet to update the Job related data.
ChangeMtlSeq Method to call when changing the MtlSeq. Parameters
2022
Name
Type
Description
proposedMtlSeq
Int32
The proposed Job Assembly Seq
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
S-Z
Type
ds
Description The Serial Number DataSet to update the JobMtl related data.
ChangePackLine Method to call when changing the Ship To PackLine. Parameters Name
Type
Description
proposedPackLine
Int32
The proposed Ship To Pack Line
ds
The Serial Number DataSet to validate the Pack Line.
ChangePackNum Method to call when changing the Ship To PackNum, passing 0 clears the PackLine. Parameters Name
Type
Description
proposedPackNum
Int32
The proposed Ship To Packing Number
ds
The Serial Number DataSet to update the PackNum related data.
ChangePackSlip Method to call when changing the Receiving PackSlip, passing a blank PackSlip clears the PackSlipLine. Parameters Name
Type
Description
proposedPackSlip
String
The proposed Receiving Packing Slip
ds
The Serial Number DataSet to update the PackSlip related data.
ChangePackSlipLine Method to call when changing the Receiving PackSlipLine. Parameters Name
Type
Description
proposedPackSlipLine
Int32
The proposed Receiving Packing Slip Line
ds
Epicor 9.05 | 9.05.605
The Serial Number DataSet to validate the Pack Slip Line.
2023
S-Z
Business Object Reference Guide
ChangePartNum Call this method when the SerialNo.PartNum changes. Parameters Name
Type
Description
pcProposedPartNum
String
The proposed Vendor Purchase Point
ds
The Serial Number DataSet to update the Part related data.
ChangeRMALine Method to call when changing the RMALine. Parameters Name
Type
Description
proposedRMALine
Int32
The proposed RMA Line
ds
The Serial Number DataSet to validate the DMR related data.
ChangeRMANum Method to call when changing the RMANum, passing a 0 clears the related fields. Parameters Name
Type
Description
proposedRMANum
Int32
The proposed RMA Number
ds
The Serial Number DataSet to validate the DMR related data.
ChangeRMAReceipt Method to call when changing the RMAReceipt. Parameters Name
Type
Description
proposedRMAReceipt
Int32
The proposed RMA Receipt
ds
The Serial Number DataSet to update the RMAReceipt.
ChangeShipToCustID Method to call when changing the ShipToCustID.
2024
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
proposedShipToCustID
String
/// The proposed Ship To CustID
ds
/// The Serial Number DataSet to update the ShipToCustID related data.
ChangeShipToNum Method to call when changing the ShipToNum. Parameters Name
Type
Description
proposedShipToNum
String
The proposed Ship To Number
ds
The Serial Number DataSet to update the ShipToNum related data.
ChangeVendorID Method to call when changing the VendorID, passing a blank VendorID clears the related fields. Parameters Name
Type
Description
proposedVendorID
String
The proposed Vendor ID
ds
The Serial Number DataSet to update the Vendor related data.
ChangeVendorPP Method to call when changing the VendorPP. Parameters Name
Type
Description
proposedPurPoint
String
The proposed Vendor Purchase Point
ds
The Serial Number DataSet to update the VendorPP related data.
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes
Epicor 9.05 | 9.05.605
2025
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetRowsPerPlant Gets the SerialNo dataset using a string with a WHERE clause and Plant as parameters to execute the query. Parameters Name
Type
Description
paramWhereClause
String
String Representing the WHERE Clause, Company = cur-comp is already assumed
paramPlant
String
Unique identifier of the Plant, if it's an empty string it will search for all Plants
PlantSerialTracking Verifies if the current login plant is set for Serial Tracking Parameters Name
Type
Description
plantTracking
Boolean@
Boolean indicating if the plant is set for Serial Tacking
SerialNumberExists Verifies if a Serial Number exists in the Database. Parameters
2026
Name
Type
Description
serialNumber
String
Serial Number
snExists
Boolean@
Boolean indicating if the Serial Number exists
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
SerialNoAssign Epicor.Mfg.BO.SerialNoAssign: This business object contains 4 methods.
GetSelectSerialNumbersParams Parameters Name
Type
Description
ipPartNum
String
ipPartNum
ipQuantity
Decimal
ipQuantity
ipJobNum
String
ipJobNum
ipAssemblySeq
Int32
ipAssemblySeq
Returns
GetSerialNoAssign Gets the default values for the Serial number assignment screen. Also populates the Selectedserialnumbers table for the job. Parameters Name
Type
Description
jobNum
String
Job number.
assemblySeq
Int32
Assembly sequence for the job.
ipPartNum
String
(Possible) Job Part
ipReqQtyOverride
Decimal
(Possible) Override to RequiredQty
trackSerialNo
Boolean@
Flag to indicate if part is S/N tracked
Returns
SetSerialNoAssign Validates the job number, assembly sequence and part number. Also validates the part is serial tracked. Updates the SerialNo table and the Part table for the SN Format fields. Calls the SNTran create subroutine. Parameters Name
Type
Description
ds
Epicor 9.05 | 9.05.605
2027
S-Z
Business Object Reference Guide
ValidateDelete Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
SerialNumberSearch Epicor.Mfg.BO.SerialNumberSearch: This business object contains 2 methods.
GetNewSerialNumberSearch Parameters Name ds
Type
Description The SerialNumberSearch DataSet
SerialNumberSearch To be whenever a search on the serial table is required. Depending on the contents of the tokens, a specific where clause is determined and returned. ProcessToken contains the Sonoma process name. GenericToken1 List of field names and corresponding values ~ delimited. The format of each value pair is (field name)=(value). GenericToken2 not used. The following is a list of processes supported by this object. xae65-jb SerialNoAssign ProcessToken = SerialNoAssign GenericToken1 = SortBy xae65-ct Customer transfer lib/brwsn ProcessToken = SerialNoAssign GenericToken1 = SortBy ime20-dg Issues and returns xae65-mi ProcessToken = IssuesandReturns GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode ime10-dg Receipts from manufacturing xae65-mi ProcessToken = ReceiptsfromManufacturing GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode ime30-dg Inventory transfers xae65-mi ProcessToken = InventoryTransfer GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode ime30-dg-vs Inventory transfers xae65-mi ProcessToken = InventoryTransfer GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode ime40-qa Inventory quantity adjust xae65-mi ProcessToken = InventoryQtyAdj GenericToken1 = TranType ~ TranQty ~ WareHseCode jce10-gj Processing of jobs xae65-mi ProcessToken = JobProcessing GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode jce10-js Job split xae65-mi ProcessToken = JobSplit GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode mse30-dg Receive from plant xae65-mi ProcessToken = PlantReceipt GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode qae10-in NonConformance Entry from Inventory xae65-qr ProcessToken = NonConf GenericToken1 = TranType ~ TranQty ~ WareHseCode qae10-ma NonConformance Entry from Job Material xae65-qr ProcessToken = NonConf GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode qae10-op NonConformance Entry from Operation xae65-qr ProcessToken = NonConf GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode qae40-iv DMR to stock/inventory xae65-mi ProcessToken = DMRtoInventory GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode qae40-jm DMR to job material xae65-mi ProcessToken = DMRtoJobMtl GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode qae40-op DMR to job operation xae65-mi ProcessToken = DMRtoJobOper GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode qae40-rm Rejecte material from DMR xae65-mi ProcessToken = RejectfromDMR GenericToken1 = JobNum ~ TranType ~ TranQty ~ WareHseCode xa/snleavetrig.i SN select from receipts xae65-pm ProcessToken = Receipts GenericToken1 = null xa/snleavetrig.i SN select from shipments xae65-sh ProcessToken = Shipment GenericToken1 = ShipFrom xa/snleavetrig.i SN select from transfer orders xae65-to ProcessToken = TransferOrder
2028
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GenericToken1 = ShipFrom xa/xam65-dg Serial Number Maintenance Process Token = SNMaint GenericToken1 = SortBy om/ome80-dt RMA detail maintentance xae65-rm ProcessToken = RMADTL GenericToken1 = RMANum ~ RMALine om/ome80-re RMA Receipt maintenance xae65-rm ProcessToken = RMARCPT GenericToken1 = RMANum ~ RMALine ~ RMAReceipt om/ome81-rd RMA Disposition xae65-rm ProcessToken = RMADISP GenericToken1 = RMANum ~ RMALine ~ RMAReceipt ~ RMADisp xa/xae65-sc Service Contract Maintenance Process Token = ServiceContract GenericToken1 = Null SubConShipEntry Subcontract Shipment Entry (NEW for 8.0) Process Token = SubConShipment GenericToken1 = null Receipt Entry Receipt Entry - (for Job Subcontract) (NEW for 8.0) Process Token = SubConReceipts GenericToken1 = null Parameters Name
Type
ds
Description The SerialNumberSearch DataSet
SerialNumMasking Epicor.Mfg.BO.SerialNumMasking: This business object contains 10 methods.
GetNewSerialMask Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
2029
S-Z
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ConstructExampleString TO BE CALLED ON CHANGE OF ttSerialMask.Mask Parameters Name
Type
Description
ipMask
String
SerialMask.Mask
ipPart
String
Part.PartNum
opExampleStr
String@
SerialMask.Example
OnChangeSNLastUsedSeq Parameters Name
Type
Description
ipGenSeqStr
String
SerialMask.GenerateSeqString
ipLastUsedSeq
String
SerialMask.SNLastUsedSeq
OnChangeOfMask TO BE CALLED ON CHANGE OF ttSerialMask.Mask
2030
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ipNewMask
String
SerialMask.Mask
ipMaskType
Int32
SerialMask.MaskType
opWarnMsg
String@
output warning message
ds
The Serial Mask data set
ServiceCallCenter Epicor.Mfg.BO.ServiceCallCenter: This business object contains 51 methods.
GetNewFSCallhd Inserts a new row in the DataSet with defaults populated.
GetNewFSCallhdAttch Inserts a new row in the DataSet with defaults populated.
GetNewFSCallDt Inserts a new row in the DataSet with defaults populated.
GetNewFSCallDtAttch Inserts a new row in the DataSet with defaults populated.
GetNewFsTech Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
2031
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
2032
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find
Epicor 9.05 | 9.05.605
2033
S-Z
Business Object Reference Guide
• QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ActivateServiceCall This method activates the Service Call. Parameters Name
Type
Description
ipCallNum
Int32
The Service Call Number to close
Returns The Service Call Center data set
AssignTechnician This method assigns a Service Technician to a service call. Parameters Name
Type
Description
ipCallNum
Int32
The Service Call Number
ipEmpID
String
The Employee ID of the service technician
ds
The Service Call Center data set
ChangeDtlContractLine Update Service Call Line Contract information when the Contract Line Number field changes. Parameters Name
Type
Description
ipContractLine
Int32
The proposed service contract line number
ds
The Service Call Center data set
ChangeDtlContractNum Update Service Call Line Contract information when the Contract Number field changes. Parameters
2034
Name
Type
Description
ipContractNum
Int32
The proposed service contract number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
S-Z
Type
ds
Description The Service Call Center data set
ChangeDtlDropShipPackLine Update Service Call Line Warranty information when the Drop Shipment PackLine Number field changes. Parameters Name
Type
Description
ipDropShipPackLine
Int32
The proposed drop shipment pack line number
ds
The Service Call Center data set
ChangeDtlDropShipPackSlip Update Service Call Line Warranty information when the Drop Shipment PackSlip field changes. Parameters Name
Type
Description
ipDropShipPackSlip
String
The proposed drop shipment pack slip
ds
The Service Call Center data set
ChangeDtlPackLine Update Service Call Line Warranty information when the Pack Line Number field changes. Parameters Name
Type
Description
ipPackLine
Int32
The proposed pack line number
ds
The Service Call Center data set
ChangeDtlPackNum Update Service Call Line Warranty information when the Pack ID field changes. Parameters Name
Type
Description
ipPackNum
Int32
The proposed pack ID
ds
Epicor 9.05 | 9.05.605
The Service Call Center data set
2035
S-Z
Business Object Reference Guide
ChangeDtlPartNum Update Service Call Line information when the Part Number field changes. Parameters Name
Type
ds
Description The Service Call Center data set
uomCode
String
UOM Code (only used for Product Codes)
ChangeDtlRevisionNum Update Service Call Line information when the Revision Number field changes. Parameters Name
Type
Description
ipRevNum
String
The proposed Revision Number
ds
The Service Call Center data set
ChangeDtlSerialNum Update Service Call Line Serial Number/Contract information when the Serial Number field changes. Parameters Name
Type
Description
ipPartNum
String
The part number for the proposed serial number
ipSerialNum
String
The proposed serial number
opMessage
String@
Warning message to tell the user if the serial number is not required and will not be validated.
ds
The Service Call Center data set
ChangeDtlXPartNum Update Service Call Line information when the Customer Part Number field changes. Parameters Name ds
2036
Type
Description The Service Call Center data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ChangeHdrBillToContact This method updates the related Customer Contact information when the Customer Bill To Contact field (FSCallHd.PrcConNum) changes. Parameters Name
Type
Description
ipPrcConNum
Int32
The proposed Customer Contact
ds
The Service Call Center data set
ChangeHdrCallCode This method gets the default Tax Category and Call Comment when the Service Call Type field (FSCallHd.CallCode) changes. Parameters Name
Type
Description
ipCallCode
String
The proposed Service Call Type Code
ds
The Service Call Center data set
ChangeHdrCurrencyCode This method gets the appropriate exchange rate for the new currency. Call this method when the field FSCallHd.CurrencyCode changes. Parameters Name
Type
Description
ipCurrencyCode
String
The proposed Currency Code
ds
The Service Call Center data set
ChangeHdrCustID This method updates the related Customer and ShipTo information when the Customer ID field (FSCallHd.CustNumCustID) changes. Parameters Name
Type
Description
ipCustID
String
The proposed Customer ID
ds
Epicor 9.05 | 9.05.605
The Service Call Center data set
2037
S-Z
Business Object Reference Guide
ChangeHdrRequestTime Validates the entered RequestTime. Parameters Name
Type
Description
ipRequestTime
Int32
The proposed Request Time as integer (number of minutes past midnight)
ds
The Service Call Center data set
ChangeHdrSchedTime This method validates the entered Scheduled Time. Call this method when the field FSCallHd.DispSchedTime changes. Parameters Name
Type
Description
ipSchedTime
Int32
The proposed Request Time as integer (number of seconds past midnight)
ds
The Service Call Center data set
ChangeHdrShipToContact This method updates the related Customer Ship To Contact information when the Customer Ship To Contact field (FSCallHd.ShpConNum) changes. Parameters Name
Type
Description
ipShpConNum
Int32
The proposed ShipTo Contact
ds
The Service Call Center data set
ChangeHdrShipToCustID This method updates the ShipTo information when the ShipToCustID field (Link) changes. Parameters Name
Type
Description
ipShipToCustID
String
The proposed Ship To Customer ID
ds
2038
The Service Call Center data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ChangeHdrShipToNum This method updates the related ShipTo information when the Customer ShipTo Number field (FSCallHd.ShipToNum) changes. Parameters Name
Type
Description
ipShipToNum
String
The proposed Customer ShipTo Number
ds
The Service Call Center data set
ChangeHdrUseOTS Method to call when changing the UseOTS field. Refreshes the address list and contact info Parameters Name
Type
ds
Description The Service Contract data set
CheckDtlSerialNum Check the serial number field and return messages about the serial number to the user. The method will check the following: The serial number exists The customer and ship to matches The part number on the line matches the serial part number The contract number and line matches (if applicable) The pack id matches (if appicable) If any of these conditions are met where the data in the service contract doesn not match the data for the serial number, the user is prompted with this information and asked if they would like to continue with the save. Parameters Name
Type
Description
opMessage
String@
Warning message to tell the user if the serial number data does not match.
ds
The Service Call Center data set
CheckPrePartInfo This method checks to see if there are any questions or issues with the part entered and returns a message, a part number and if any substitutes exist. Call this method first before calling the ChangeDtlPartNum method when the field FSCallDt.PartNum changes. Parameters Name
Type
Description
vPartNum
String@
The input-output part number to validate and it gets returned
vContractNum
Int32
The current Service Contract number associated with the call
Epicor 9.05 | 9.05.605
2039
S-Z
Business Object Reference Guide
Name
Type
Description
vPackNum
Int32
The current Pack id associated with the call
vContractMsg
String@
Warn the user if the Contract becomes invalid
vWarrantyMsg
String@
Warn the user if the Warranty becomes invalid
vSubPartMsg
String@
Asks if the user wants to use a substitute part
vSubAvail
Boolean@
Returned flag stating if substitutes exist for this part
vMsgType
String@
Type of vSubPartMsg message returned. Values can be; "Question" (asking if they want to use the substitute part) "Warning" (Warns them that a part is onhold or runout). "Error" (Part in Inactive, or Onhold/Runout parts are not accepted in this case).
CheckRateGrpCode Update Service Call information when the currency is changed. Parameters Name
Type
Description
ipRateGrpCode
String
Currency Rate Group Code
ds
Field Service dataset
CloseServiceCall This method closes the Service Call. Run this method after calling PreCloseServiceCall. Parameters Name
Type
Description
ipCallNum
Int32
The Service Call Number to close
Returns The Service Call Center data set
CreateServiceCallJob This method creates the Service Call Job for the service call line. A warning message is returned by this method if the service call plant and the current plant is not the same. Do not call the JobEntry object if the opMessage is not blank. Parameters
2040
Name
Type
Description
ipCallNum
Int32
The Service Call Number to create the job for.
ipCallLine
Int32
The Service Call Line Number to create the job for.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
opMessage
String@
Warning message for the user if the current plant and the service call plant are not the same.
ds
The Service Call Center data set
GetNewFSCallHd1 This method is to be used in place of GetNewFSCallHd. This method asks for customer number and shipto number to default the fields based on the customer/shipto. Parameters Name
Type
Description
ds
The ServiceCallCenter DataSet
ipCustNum
Int32
The Customer Number for this Service Call
ipShipToNum
String
The Customer ShipTo Number for this Service Call
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
uomCode
String@
UOM Code (only used for Product Codes)
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetRowsContactTracker Calls the normal GetRows method and then constructs a custom data set combining Hed/Dtl fields for the customer tracker. Parameters Name
Type
Description
whereClauseFSCallhd
String
Whereclause for FSCallhd table.
Epicor 9.05 | 9.05.605
2041
S-Z
Business Object Reference Guide
Name
Type
Description
whereClauseFSCallhdAttch
String
Whereclause for FSCallhdAttch table.
whereClauseFSCallDt
String
Whereclause for FSCallDt table.
whereClauseFSCallDtAttch
String
Whereclause for FSCallDtAttch table.
whereClauseFsTech
String
Whereclause for FsTech table.
contactName
String
Contact to return data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.FSCallCustTrkDataSet
GetRowsCustomerTracker Calls the normal GetRows method and then constructs a custom data set combining Hed/Dtl fields for the customer tracker. Parameters Name
Type
Description
whereClauseFSCallhd
String
Whereclause for FSCallhd table.
whereClauseFSCallhdAttch
String
Whereclause for FSCallhdAttch table.
whereClauseFSCallDt
String
Whereclause for FSCallDt table.
whereClauseFSCallDtAttch
String
Whereclause for FSCallDtAttch table.
whereClauseFsTech
String
Whereclause for FsTech table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.FSCallCustTrkDataSet
PreCloseServiceCall Checks to see if the service call can be closed and gives a warning message to let the user decide to continue closing or not. This method should be called prior to calling the CloseServiceCall method which does the actual closing logic. If a warning message returns with this method and the user chooses to continue or NO warning message then call CloseServiceCall method else cancel close request. Parameters
2042
Name
Type
Description
ipCallNum
Int32
The Service Call Number to close
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
opMessage
String@
Question to ask the user if to continue closing.
ReopenServiceCall This method reopens the Service Call. Parameters Name
Type
Description
ipCallNum
Int32
The Service Call Number to close
Returns The Service Call Center data set
VoidServiceCall This method voids the Service Call. Parameters Name
Type
Description
ipCallNum
Int32
The Service Call Number to close
Returns The Service Call Center data set
ServiceContract Epicor.Mfg.BO.ServiceContract: This business object contains 87 methods.
GetNewFSContHd Inserts a new row in the DataSet with defaults populated.
GetNewFSContDt Inserts a new row in the DataSet with defaults populated.
GetNewFSContSN Inserts a new row in the DataSet with defaults populated.
GetNewFSRenewal Inserts a new row in the DataSet with defaults populated.
GetNewFSRenewalDt Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
2043
S-Z
Business Object Reference Guide
GetNewFSRenewalSN Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
2044
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
ActivateContract Method to call when activating the contract. Parameters Name
Type
Description
activateContractNum
Int32
The contract number to activate
ds
The Service Contract data set
ChangeFSContDtBillEndDate Method to call when changing the billing end date on the contract detail record. Updates FSContDt with values based on the new billing start date.
Epicor 9.05 | 9.05.605
2045
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ipBillEndDate
Nullable{System.DateTime}
The proposed bill end date
ds
The Service Contract data set
ChangeFSContDtBillStartDate Method to call when changing the billing start date on the contract detail record. Updates FSContDt with values based on the new billing start date. Parameters Name
Type
Description
ipBillStartDate
Nullable{System.DateTime}
The proposed bill start date
ds
The Service Contract data set
ChangeFSContDtContractQty Method to call when changing the contract quantity on the contract detail record. Recalculates Ext Prices on FSContDt with values from the new quantity. Parameters Name
Type
Description
proposedContractQty
Decimal
The proposed contract quantity
ds
The Service Contract data set
ChangeFSContDtOrderLine Method to call when changing the order line on the contract detail record. Validates the line and updates FSContDt with values from the order line. Parameters Name
Type
Description
proposedOrderLine
Int32
The proposed order line number
ds
The Service Contract data set
ChangeFSContDtOrderNum Method to call when changing the order number on the contract detail record. Validates the number and updates FSContDt with values from the order.
2046
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
proposedOrderNum
Int32
The proposed order number
ds
The Service Contract data set
ChangeFSContDtPartNum Method to call when changing the part number on the contract detail record. Updates FSContDt with values from the part number. Prior to calling this method, the CheckPartNumChange method should be run to validate the part. Parameters Name
Type
Description
proposedPartNum
String
The proposed part number
ds
The Service Contract data set
ChangeFSContDtPricePerUnit Method to call when changing the price per unit on the contract detail record. Recalculates Ext Prices on FSContDt with values from the new price per unit. Parameters Name
Type
Description
proposedPricePerUnit
Decimal
The proposed price per unit
ds
The Service Contract data set
ChangeFSContDtProdCode Method to call when changing the product code on the contract detail record. Validates the code and updates FSContDt with values from the product code. Parameters Name
Type
Description
proposedProdCode
String
The proposed product code
ds
The Service Contract data set
ChangeFSContDtProjectID Method to call when changing the project id on the contract detail record. Validates the id and updates FSContDt with values from the project.
Epicor 9.05 | 9.05.605
2047
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
proposedProjectID
String
The proposed project id
ds
The Service Contract data set
ChangeFSContDtXPartNum Method to call when changing the customer part number (XPartNum) on the contract detail record. Updates FSContDt with values from the customer part. Parameters Name
Type
Description
proposedXPartNum
String
The proposed xref part number
ds
The Service Contract data set
ChangeFSContHdActiveDate Method to call when changing the effective date on the contract header record. Updates FSContHd with values based on the new effective date. Parameters Name
Type
Description
proposedActiveDate
Nullable{System.DateTime}
The proposed active date
ds
The Service Contract data set
ChangeFSContHdBTCusNum Method to call when changing the customer id on the contract header record. Validates the customer id and updates FSContHd with values from the customer. Parameters Name
Type
Description
proposedCustNum
Int32
The proposed Bill To customer Num
ds
The Service Contract data set
ChangeFSContHdContractCode Method to call when changing the contract code on the contract header record. Validates the code and updates FSContHd with values from the contract.
2048
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
proposedContractCode
String
The proposed contract code
ds
The Service Contract data set
ChangeFSContHdCurrencyCode Method to call when changing the currency code on the contract header record. Validates the code and updates FSContHd with values from the currency. Parameters Name
Type
Description
proposedCurrencyCode
String
The proposed currency code
ds
The Service Contract data set
ChangeFSContHdCustID Method to call when changing the customer id on the contract header record. Validates the customer id and updates FSContHd with values from the customer. Parameters Name
Type
Description
proposedCustID
String
The proposed customer id
ds
The Service Contract data set
ChangeFSContHdDeferredRev Method to call when changing the Deferred Revenue flag on the contract header record. Parameters Name
Type
Description
ipDeferredRev
Boolean
The proposed Deferred Revenue value
ds
The Service Contract data set
ChangeFSContHdDuration Method to call when changing the duration on the contract header record. Updates FSContHd with values based on the new duration.
Epicor 9.05 | 9.05.605
2049
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
proposedDuration
Int32
The proposed duration
ds
The Service Contract data set
ChangeFSContHdFiscalCalendarID Method to call when changing the Fiscal Calendar on the contract header record. Parameters Name
Type
Description
ipFiscalCalendarID
String
The proposed Fiscal Calendar ID value
ds
The Service Contract data set
ChangeFSContHdModifier Method to call when changing the Modifier on the contract header record. Updates FSContHd with values based on the new Modifier. Parameters Name
Type
Description
proposedModifier
String
The proposed Modifier
ds
The Service Contract data set
ChangeFSContHdPrcConNum Method to call when changing the customer contact number on the contract header record. Validates the number and updates FSContHd with values from the contact. Parameters Name
Type
Description
proposedConNum
Int32
The proposed contact number
ds
The Service Contract data set
ChangeFSContHdPricePer Method to call when changing the PricePer on the contract header record. Updates FSContHd with values based on the new PricePer.
2050
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ipPricePer
String
The proposed PricePer
ds
The Service Contract data set
ChangeFSContHdQuotedContract Method to call when changing the Quoted Contract flag on the contract header record. Parameters Name
Type
Description
ipQuotedContract
Boolean
The proposed Quoted Contract value
ds
The Service Contract data set
ChangeFSContHdRACode Method to call when changing the RACode on the contract header record. Parameters Name
Type
Description
ipRACode
String
The proposed Revenue Amortization Code value
ds
The Service Contract data set
ChangeFSContHdRecurringFreq Method to call when changing the RecurringFreq on the contract header record. Updates FSContHd with values based on the new RecurringFreq. Parameters Name
Type
Description
ipRecurringFreq
String
The proposed RecurringFreq
ds
The Service Contract data set
ChangeFSContHdShipToCustID Method to call when changing the ShipTo Customer ID on the contract header record. Validates the ShipTo Customer ID and updates FSContHd with values from the customer. Parameters Name
Type
Description
ipShipToCustID
String
The proposed ShipTo Customer ID
Epicor 9.05 | 9.05.605
2051
S-Z
Business Object Reference Guide
Name
Type
ds
Description The Service Contract data set
ChangeFSContHdShipToNum Method to call when changing the ship to on the contract header record. Validates the number and updates FSContHd with values from the ship to. Parameters Name
Type
Description
proposedShipToNum
String
The proposed ship to number
ds
The Service Contract data set
ChangeFSContHdShpConNum Method to call when changing the ship to contact on the contract header record. Validates the contact and updates FSContHd with values from the ship to contact. Parameters Name
Type
Description
proposedShpConNum
Int32
The proposed ship to number
ds
The Service Contract data set
ChangeFSContHdSuspended Method to call when changing the Suspended flag on the contract header record. This method determines if the contract has outstanding invoice revenue amortization schedules that need to be updated to be put on hold or not. If InvcDtlRASch records exist then a message will be returned to the user to let the user decide whether to continue the update of invoice revenue schedules or not. The FSContHd.Suspended is updated right away if no related invoice schedule exists. Parameters Name
Type
Description
ipSuspended
Boolean
The proposed Suspended value
opMessage
String@
Message to ask the user if update of invoice schedules is required
ds
The Service Contract data set
ChangeFSContHdTaskSetID Method to call when changing the Task Set ID on the contract header record.
2052
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ipTaskSetID
String
The proposed Task Set ID value
ds
The Service Contract data set
ChangeFSContHdTaxCatID Method to call when changing the tax category id on the contract header record. Validates the id and updates FSContHd with values from the tax category. Parameters Name
Type
Description
proposedTaxCatID
String
The proposed tax category id
ds
The Service Contract data set
ChangeFSContHDUseOTS Method to call when changing the UseOTS field the contract header record. Refreshes the address list and contact info Parameters Name
Type
ds
Description The Service Contract data set
ChangeFSRenewalContractCode Method to call when changing the contract code on the contract renewal header record. Validates the code and updates FSRenewal with values from the contract code defaults. Parameters Name
Type
Description
ipContractCode
String
The proposed contract code
ds
The Service Contract data set
ChangeFSRenewalDeferredRev Method to call when changing the Deferred Revenue flag on the contract renewal header record. Parameters Name
Type
Description
ipDeferredRev
Boolean
The proposed Deferred Revenue value
Epicor 9.05 | 9.05.605
2053
S-Z
Business Object Reference Guide
Name
Type
ds
Description The Service Contract data set
ChangeFSRenewalDtBillEndDate Method to call when changing the billing end date on the contract renewal detail record. Updates FSRenewalDt with values based on the new billing start date. Parameters Name
Type
Description
ipBillEndDate
Nullable{System.DateTime}
The proposed bill end date
ds
The Service Contract data set
ChangeFSRenewalDtBillStartDate Method to call when changing the billing start date on the contract renewal detail record. Updates FSRenewalDt with values based on the new billing start date. Parameters Name
Type
Description
ipBillStartDate
Nullable{System.DateTime}
The proposed bill start date
ds
The Service Contract data set
ChangeFSRenewalDtContractQty Method to call when changing the contract quantity on the contract renewal detail record. Recalculates Ext Prices on FSRenewalDt with values from the new quantity. Parameters Name
Type
Description
ipContractQty
Decimal
The proposed contract quantity
ds
The Service Contract data set
ChangeFSRenewalDtIncreasePct Method to call when changing the increase percent on the contract renewal detail record. Recalculates Prices on FSRenewalDt with values from the new increase percent. Parameters
2054
Name
Type
Description
ipIncreasePct
Decimal
The proposed increase percent
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
S-Z
Type
ds
Description The Service Contract data set
ChangeFSRenewalDtOrderLine Method to call when changing the order line on the contract renewal detail record. Validates the line and updates FSRenewalDt with values from the order line. Parameters Name
Type
Description
ipOrderLine
Int32
The proposed order line number
ds
The Service Contract data set
ChangeFSRenewalDtOrderNum Method to call when changing the order number on the contract renewal detail record. Validates the number and updates FSRenewalDt with values from the order. Parameters Name
Type
Description
ipOrderNum
Int32
The proposed order number
ds
The Service Contract data set
ChangeFSRenewalDtPartNum Method to call when changing the part number on the contract renewal detail record. Updates FSRenewalDt with values from the part number. Prior to calling this method, the CheckPartNumChange method should be run to validate the part. Parameters Name
Type
Description
ipPartNum
String
The proposed part number
ds
The Service Contract data set
ChangeFSRenewalDtPricePerUnit Method to call when changing the price per unit on the contract renewal detail record. Recalculates Ext Prices on FSRenewalDt with values from the new price per unit. Parameters Name
Type
Description
ipPricePerUnit
Decimal
The proposed price per unit
Epicor 9.05 | 9.05.605
2055
S-Z
Business Object Reference Guide
Name
Type
Description
ipBaseOrDoc
String
Indicates if calculating for Base ('B') or Doc ('D')
ds
The Service Contract data set
ChangeFSRenewalDtProdCode Method to call when changing the product code on the contract renewal detail record. Validates the code and updates FSRenewalDt with values from the product code. Parameters Name
Type
Description
ipProdCode
String
The proposed product code
ds
The Service Contract data set
ChangeFSRenewalDtProjectID Method to call when changing the project id on the contract renewal detail record. Validates the id and updates FSRenewalDt with values from the project. Parameters Name
Type
Description
ipProjectID
String
The proposed project id
ds
The Service Contract data set
ChangeFSRenewalDtXPartNum Method to call when changing the customer part number (XPartNum) on the contract renewal detail record. Updates FSRenewalDt with values from the customer part. Parameters Name
Type
Description
ipXPartNum
String
The proposed xref part number
ds
The Service Contract data set
ChangeFSRenewalDuration Method to call when changing the duration on the contract renewal header record. Updates FSRenewal with values based on the new duration.
2056
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ipDuration
Int32
The proposed duration
ds
The Service Contract data set
ChangeFSRenewalFiscalCalendarID Method to call when changing the Fiscal Calendar on the contract renewal header record. Parameters Name
Type
Description
ipFiscalCalendarID
String
The proposed Fiscal Calendar ID value
ds
The Service Contract data set
ChangeFSRenewalModifier Method to call when changing the Modifier on the contract renewal header record. Updates FSRenewal with values based on the new Modifier. Parameters Name
Type
Description
ipModifier
String
The proposed Modifier
ds
The Service Contract data set
ChangeFSRenewalPricePer Method to call when changing the PricePer on the contract renewal header record. Updates FSRenewal with values based on the new PricePer. Parameters Name
Type
Description
ipPricePer
String
The proposed PricePer
ds
The Service Contract data set
ChangeFSRenewalQuotedRenewal Method to call when changing the Quoted Renewal flag on the contract renewal header record. Parameters Name
Type
Description
ipQuotedRenewal
Boolean
The proposed Quoted Renewal value
Epicor 9.05 | 9.05.605
2057
S-Z
Business Object Reference Guide
Name
Type
Description
ds
The Service Contract data set
ChangeFSRenewalRACode Method to call when changing the RACode on the contract renewal header record. Parameters Name
Type
Description
ipRACode
String
The proposed Revenue Amortization Code value
ds
The Service Contract data set
ChangeFSRenewalRecurringFreq Method to call when changing the RecurringFreq on the contract renewal header record. Updates FSRenewal with values based on the new RecurringFreq. Parameters Name
Type
Description
ipRecurringFreq
String
The proposed RecurringFreq
ds
The Service Contract data set
ChangeFSRenewalRenewEffDate Method to call when changing the renewal effective date on the contract renewal header record. Updates FSRenewal with values based on the new effective date. Parameters Name
Type
Description
ipRenewEffDate
Nullable{System.DateTime}
The proposed renewal effective date
ds
The Service Contract data set
ChangeFSRenewalTaskSetID Method to call when changing the Task Set ID on the contract renewal header record. Parameters Name
Type
Description
ipTaskSetID
String
The proposed Task Set ID value
ds
2058
The Service Contract data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ChangeFSRenewalTaxCatID Method to call when changing the tax category id on the contract renewal header record. Validates the id and updates FSRenewal with values from the tax category. Parameters Name
Type
Description
ipTaxCatID
String
The proposed tax category id
ds
The Service Contract data set
CheckPartNumChange The method is to be run on leave of the PartNum field before the ChangeFSContDtPartNum or Update methods are run. This returns all the questions that need to be asked before a part can be changed. Parameters Name
Type
Description
cPartNum
String@
The new PartNum if a substitute part is found, partNum will be the substitute part No means the part cannot be changed
cSubPartMessage
String@
Asks if the user wants to use a substitute part
lSubAvail
Boolean@
Indicates other substitute parts besides the default exist
cMsgType
String@
Type of message returned. Values can be; "Question" (asking if they want to use the substitute part) "Warning" (Warns them that a part is onhold or runout). "Error" (Part in Inactive, or Onhold/Runout parts are not accepted in this case) . "Question" is asking if they want to use the substitute part.
CheckSerialNumbers This method returns text of a message to be asked if the number of serial numbers selected does not match the quantity entered for the FSContDt record. The user has the option of continuing with the mismatch quantities or canceling. This method should be called before the update method and should be called only when part is serial number tracked and the quantity is greater than zero. If the user answers yes, the change can occur; otherwise the change shouldn't occur. Parameters Name
Type
ds
Description The ServiceContract data set
contractQty
Decimal
Quantity of Serial Numbers required for the Contract Line
cMessageText
String@
The text of the message to ask the user
Epicor 9.05 | 9.05.605
2059
S-Z
Business Object Reference Guide
CreateContractRMA Call this method to create RMA for a given service contract. Parameters Name
Type
Description
ipContractNum
Int32
The contract number to create the RMA for.
ipReasonCode
String
The Reason Code for the RMA.
ds
The Service Contract data set
ExpireContract Call this method to expire a service contract. Allow the user to confirm the intention to expire the contract before calling this method. Warn the user that expiring the contract cannot be undone. Parameters Name
Type
Description
ipContractNum
Int32
The contract number to expire
ds
The Service Contract data set
FrequencyList Method to call to get the list for the Frequency options. The list is returned in code1`code desc1~code2`code desc2 format. Parameters Name
Type
Description
frequencyList
String@
The list of options for the frequence
GenerateRenewal Call this method to generate Contract Renewal (FSRenewal and FsRenewalDt) from a given Contract or Renewal. Parameters Name
Type
Description
ipContractNum
Int32
The source contract number.
ds
The Service Contract data set
GenerateRenewalLines Call this method to generate Contract Renewal Lines (FsRenewalDt) for a given Contract Renewal Header.
2060
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ipContractNum
Int32
The target contract number.
ipRenewalNbr
Int32
The target renewal number.
ds
The Service Contract data set
GetListCustom Custom GetList method. Retrieves records based on a delimited list of Contract Numbers. Parameters Name
Type
Description
contractNumList
String
The contract number list
pageSize
Int32
The pageSize number list
absolutePage
Int32
The absolutePage number list
morePages
Boolean@
The morePages number list
Returns The Service Contract list data set
GetNewFSContHdFromOrder Method to call when adding a contract from an order. Parameters Name
Type
Description
orderNum
Int32
The order number
ds
The Service Contract data set
GetRowsContactTracker Calls the normal GetRows method and then constructs a custom data set combining Hd/Dt fields for the contact tracker. Parameters Name
Type
Description
whereClauseFSContHd
String
Whereclause for FSContHd table.
whereClauseFSContDt
String
Whereclause for FSContDt table.
whereClauseFSContSN
String
Whereclause for FSContSN table.
whereClauseSelectedSerialNumbers
String
Whereclause for SelectedSerialNumbers.
Epicor 9.05 | 9.05.605
2061
S-Z
Business Object Reference Guide
Name
Type
Description
whereClauseSerialNumberSearch
String
Whereclause for SerialNumberSearch
whereClauseSNFormat
String
Whereclause for SNFormat table.
contactName
String
Contact to return data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.FSContCustTrkDataSet
GetRowsCustom Custom GetList method. Retrieves records based on a delimited list of Contract Numbers. Parameters Name
Type
Description
contractNumList
String
The contract number list
pageSize
Int32
The pageSize number list
absolutePage
Int32
The absolutePage number list
morePages
Boolean@
The morePages number list
Returns The Service Contract data set
GetRowsCustomerTracker Calls the normal GetRows method and then constructs a custom data set combining Hd/Dt fields for the customer tracker. Parameters
2062
Name
Type
Description
whereClauseFSContHd
String
Whereclause for FSContHd table.
whereClauseFSContDt
String
Whereclause for FSContDt table.
whereClauseFSContSN
String
Whereclause for FSContSN table.
whereClauseSelectedSerialNumbers
String
Whereclause for SelectedSerialNumbers.
whereClauseSerialNumberSearch
String
Whereclause for SerialNumberSearch
whereClauseSNFormat
String
Whereclause for SNFormat table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns Epicor.Mfg.BO.FSContCustTrkDataSet
GetSelectedSerialNumbers This method will retrieve the serial numbers for a service contract line and update the SelectedSerialNumbers table with these records. Parameters Name
Type
Description
iContractNum
Int32
The Contract Number
iContractLine
Int32
The Contract Detail line number
iPartNum
String
The Part Num
ds
The Service Contract data set
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds
Description Service Contract data set
Returns The SelectSerialNumbersParams dataset
isPlantSerialTracking Verifies if the current login plant is set for Serial Tracking Parameters Name
Type
Description
isSerialTracking
Boolean@
Boolean indicating if the plant is set for Serial Tacking
PricePerList Method to call to get the list for the Price Per options. The list is returned in code1`code desc1~code2`code desc2 format. Parameters Name
Type
Description
pricePerList
String@
The list of options for the price per
Epicor 9.05 | 9.05.605
2063
S-Z
Business Object Reference Guide
SuspendContract Call this method after the user answered yes to the warning message returned by SuspendContract method. This logic updates all related InvcDtlRASch records for this service contract. Based on the input contract status, the related invoice revenue schedules will be put on hold/unhold. Parameters Name
Type
Description
ipSuspend
Boolean
The requested Suspend or Unsuspend status change.
ipReasonCode
String
The Reason Code for the hold request.
ds
The Service Contract data set
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
Description
ds
Service Contract data set
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
VoidContract Method to call when voiding the contract. Parameters Name
Type
Description
voidContractNum
Int32
The contract number to void
ds
The Service Contract data set
ServiceContractDtSearch Epicor.Mfg.BO.ServiceContractDtSearch: This business object contains 10 methods.
GetNewFSContDt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
2064
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process. This procedure uses in ServiceContactSearch
Epicor 9.05 | 9.05.605
2065
S-Z
Business Object Reference Guide
This procedure uses in ServiceContactSearch This procedure uses in ServiceContactSearch
ServiceContractSearch Epicor.Mfg.BO.ServiceContractSearch: This business object contains 10 methods.
GetNewServiceContractSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2066
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetContractsRenewals Returns the service contracts as the GetRows does but filtering them out by one with renewals Parameters Name
Type
Description
renewalsOnly
Boolean
Indicates if only those contracts with renewals are returned
whereClause
String
WhereClause to filter the Parent records.
sortByClause
String
To sort by the detail records.
partDescContains
String
The part contains filter
pageSize
Int32
Page Size.
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages
Returns The Service Contract Search list data set
GetListCustom Custom GetList method. Parameters Name
Type
Description
whereClause
String
WhereClause to filter the Parent records.
sortByClause
String
To sort by the detail records.
partDescContains
String
The part contains filter
pageSize
Int32
Page Size.
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages
Epicor 9.05 | 9.05.605
2067
S-Z
Business Object Reference Guide
Returns The Service Contract Search list data set
GetRowsCustom Custom GetList method. Parameters Name
Type
Description
whereClause
String
WhereClause to filter the Parent records.
sortByClause
String
To sort by the detail records.
partDescContains
String
The part contains filter
pageSize
Int32
Page Size.
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages
Returns The Service Contract Search list data set
SetupGrp Epicor.Mfg.BO.SetupGrp: This business object contains 7 methods.
GetNewSetupGrp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2068
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ShipDtlSearch Epicor.Mfg.BO.ShipDtlSearch: This business object contains 10 methods.
GetNewShipDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
2069
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListCase Calls the normal GetList method and then constructs a custom data set combining Hed/Dtl fields for the case entry. Parameters
2070
Name
Type
Description
whereClauseShipDtl
String
Whereclause for ShipDtl table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns Epicor.Mfg.BO.ShipDtlListDataSet
GetRowsContactTracker Calls the normal GetRows method and then constructs a custom data set combining Hed/Dtl fields for the contact tracker. Parameters Name
Type
Description
whereClauseShipDtl
String
Whereclause for ShipDtl table.
contactName
String
Contact to return data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.ShipDtlSearchDataSet
GetRowsCustomerTracker Calls the normal GetRows method and then constructs a custom data set combining Hed/Dtl fields for the customer tracker. Parameters Name
Type
Description
whereClauseShipDtl
String
Whereclause for ShipDtl table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.ShipDtlSearchDataSet
ShipTo Epicor.Mfg.BO.ShipTo: This business object contains 9 methods.
GetNewShipTo Inserts a new row in the DataSet with defaults populated.
GetNewShipToAttch Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
2071
S-Z
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
2072
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ShipVia Epicor.Mfg.BO.ShipVia: This business object contains 11 methods.
GetNewShipVia Inserts a new row in the DataSet with defaults populated.
GetNewShipViaAttch Inserts a new row in the DataSet with defaults populated.
GetNewLangDesc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
2073
S-Z
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeCarrier Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
2074
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ShipWhseSearch Epicor.Mfg.BO.ShipWhseSearch: This business object contains 7 methods.
GetNewPartWhseSearch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2075
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ShopLoad Epicor.Mfg.BO.ShopLoad: This business object contains 7 methods.
GetNewShopLoad Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
2076
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ShopWrn Epicor.Mfg.BO.ShopWrn: This business object contains 8 methods.
GetNewShopWrn Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
2077
S-Z
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MoveToHistory Set MoveToHistory flag Parameters Name
Type
ds
Description Results of the Move
SkipLotCtl Epicor.Mfg.BO.SkipLotCtl: This business object contains 7 methods.
GetNewSkipLotCtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
2078
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
SNTranSearch Epicor.Mfg.BO.SNTranSearch: This business object contains 7 methods.
GetNewSNTran Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
2079
S-Z
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
2080
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
SOPOLink Epicor.Mfg.BO.SOPOLink: This business object contains 26 methods.
GetNewIMOrderHed Inserts a new row in the DataSet with defaults populated.
GetNewIMOrderDtl Inserts a new row in the DataSet with defaults populated.
GetNewIMOrderRel Inserts a new row in the DataSet with defaults populated.
GetNewIMOrderMsc Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
2081
S-Z
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
Description
tableName
String
fieldName
String
Returns
ChangeMiscCode Update PO Link Misc Charge information when the MiscCode is changed. Parameters Name
Type
ds
Description The Sales Order/PO data set
ChangePartNum Update PO Link information with values from the Part Number when the Part Number is changed. Parameters Name
Type
ds lUsePartDefaults
2082
Description The Sales Order/PO data set
Boolean
Use part defaults
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
cReturnMessage
String@
The message returned if PO and SO currencies don't match
ChangeSoldToID Update PO Link information with values from the Sold To when the Sold To is changed. Parameters Name
Type
ds cReturnMessage
Description The Sales Order/PO data set
String@
The message returned if PO and SO currencies don't match
CheckCustomerCreditLimit This method should be called before the Update method is called for a detail record. The method returns a character string if the customer will go over their credit limit and the user is given the choice of continuing or not. Parameters Name
Type
Description
iCustNum
Int32
The Customer Number
cCreditLimitMessage
String@
The over credit limit message text
lContinue
Boolean@
Indicates if the user is allowed to continue with processing
CheckPartChange The method is to be run on leave of the PartNum and Revision fields before the ChangePart or Update methods are run. This returns all the questions that need to be asked before a part can be changed. Parameters Name
Type
Description
cPartNum
String@
The new PartNum if a substitute part is found, partNum will be the substitute part
cGlbPartNum
String
The global part number
cAction
String
The action field from IMOrderDtl
cSubPartMessage
String@
Asks if the user wants to use a substitute part
lSubAvail
Boolean@
Indicates other substitute parts besides the default exist
cGlbPartMessage
String@
Asks if the user wants to use local part defaults if the part is not a global part
Epicor 9.05 | 9.05.605
2083
S-Z
Business Object Reference Guide
Name
Type
Description
cUsingPODefaultsMessage String@
Returns message text if the PO Defaults will be used for the part related fields
cMsgType
Type of message returned. Values can be; "Question" (asking if they want to use the substitute part) "Warning" (Warns them that a part is onhold or runout). "Error" (Part in Inactive, or Onhold/Runout parts are not accepted in this case) . "Question" is asking if they want to use the substitute part.
String@
CheckReadyForOrder Validate/return questions to ask the user before marking a record ReadyForOrder. Parameters Name
Type
Description
dIntQueID
Decimal
The IntQueID of the IMOrderHed record
lChildUnitPricesDiffer
Boolean
Flag from IMOrderHed to indicate if the unit prices on the detail lines or miscellaneous charges differ
cGlbPartQuestionText
String@
The text of the part number question to ask the user
cPricesDifferQuestionText
String@
The text of the unit prices differ question to ask the user
CheckSOPODifferences Return text of messages to present to the user informing them unit prices differ on detail lines or miscellaneous charges, or the currencies are different on the SO and PO. Parameters Name
Type
Description
lChildUnitPricesDiffer
Boolean
Flag from IMOrderHed to indicate if detail or misc charges unit prices differ
dIntQueID
Decimal
IntQueID from the IMOrderHed record
cUnitPricesDifferMessage
String@
The message returned if PO and SO currencies don't match
cCurrenciesDifferMessage
String@
Returns message text if the PO Currency differs from the SO currency
cUOMDifferMessage
String@
Returns message text if the PO UOM is not a valid Part UOMs
CreateConfigKits Loops through the input ttOrderDtl records which should be configured kit parts and generates the components for each kit. This method is called after processing the ICPO Suggestions and once that the order has been created and the user had already answered the Configuration Q-A
2084
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
regenerateKit
Boolean
If true this will cause the previous loaded components to be deleted
ds
The SOPOOrderDtl DataSet
GetOrderDtl Get the OrderDtl record related to the IMOrderDtl record. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
iOrderLine
Int32
The Order Line Number
pageSize
Int32
The Page Size
absolutePage
Int32
The Absolute Page
morePages
Boolean@
The More Pages
Returns The SOPOOrderDtl DataSet
GetOrderMsc Get the OrderMsc record related to the IMOrderMsc record. Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
iOrderLine
Int32
The Order Line Number
iSeqNum
Int32
The Order Misc Sequence Number
pageSize
Int32
The Page Size
absolutePage
Int32
The Absolute Page
morePages
Boolean@
The More Pages
Returns The SOPOOrderMsc DataSet
GetOrderRel Get the OrderRel record related to the IMOrderRel record.
Epicor 9.05 | 9.05.605
2085
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
iOrderNum
Int32
The Order Number
iOrderLine
Int32
The Order Line Number
iOrderRelNum
Int32
The Order Release Number
pageSize
Int32
The Page Size
absolutePage
Int32
The Absolute Page
morePages
Boolean@
The More Pages
Returns The SOPOOrderRel DataSet
PreRejectICPOLink Checks to see if the po link can be rejected and returns a question to be asked of the user if necessary. Parameters Name
Type
Description
dIntQueID
Decimal
The IntQueID of the record to reject
cMessageText
String@
The text of the message to be asked of the user
ProcessSuggestions This method processes the suggestions and either creates/updates an order or rejects the suggestion. Parameters Name
Type
Description
needsConfig
Boolean@
Indicates if any of the created Order Lines need kits
Returns The SOPOOrderDtl DataSet
ReadyForOrderAll Mark a list of records as ready to order. Parameters
2086
Name
Type
Description
cIntQueIDList
String
A delimited list of IntQueIDs of the IMOrderHed records to mark as ReadyForOrder
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns
ValidateReadyForOrderAll Validation for marking all orders as Ready For Order. This method should be called before method ReadyForOrderAll is called. Parameters Name
Type
Description
cIntQueIDList
String
A delimited list of IntQueIDs of the IMOrderHed records to mark as ReadyForOrder
Specification Epicor.Mfg.BO.Specification: This business object contains 16 methods.
GetNewSpecHed Inserts a new row in the DataSet with defaults populated.
GetNewSpecHedAttch Inserts a new row in the DataSet with defaults populated.
GetNewSpecRev Inserts a new row in the DataSet with defaults populated.
GetNewSpecRevAttch Inserts a new row in the DataSet with defaults populated.
GetNewSpecAttr Inserts a new row in the DataSet with defaults populated.
GetNewSpecAttrAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
2087
S-Z
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
DuplicateRevision To create a new SpecRev by duplicating from another. Parameters
2088
Name
Type
Description
sourceSpecID
String
Existing Specfication ID that will be duplicated.
sourceRevNum
String
Existing Revision number that will be duplicated.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
targetRevNum
String
New Revision number that will be duplicated.
Returns The Specification Data Set
OnChangeAttributeID Used when the Inspection Attribute field of SpecAttr is being changed to a new value. It will validate the new AttributeID field. Parameters Name
Type
Description
newAttributeID
String
The new Attribute ID value.
ds
The Specification Dataset.
OnChangeFromRev To set if duplicate option is allowed. Parameters Name
Type
Description
sourceSpecID
String
Existing Specification that will be duplicated.
sourceRevNum
String
Existing Revision number that will be duplicated.
oKToDuplicate
Boolean@
OKToDuplicate.
OnChangeInspPlanNum Used when the Inspection Plan Num field of SpecRev is being changed to a new value. Parameters Name
Type
Description
newInspPlan
String
The Insp plan value.
ds
The Specification Dataset.
SpecRevSearch Epicor.Mfg.BO.SpecRevSearch: This business object contains 7 methods.
GetNewSpecRev Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
2089
S-Z
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
2090
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
SplitJob Epicor.Mfg.BO.SplitJob: This business object contains 15 methods.
GetNewJobProd Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2091
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckJob This method checks to see if it is valid to split the specified job. Parameters Name
Type
Description
jobNum
String
Job Number
GetNewJob This methods generates the next available job number from the JCSyst table. Parameters Name
Type
Description
opNextJobNum
String@
The outputted string of the next available job number
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
ds ipJobNum
Description Split Job data set
String
Job Num before split
Returns The SelectSerialNumbersParams dataset
PreProcessSplitJob This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called.
2092
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ds
The SplitJob dataSet
ipDueDate
Nullable{System.DateTime}
The due date
requiresUserInput
Boolean@
Indicates if the legal number requires user input
serialNumberQtyAlert
String@
Indicates if the legal number requires user input
PreProcessValidate This method will perform pre-update validations It validates whether the serial numbers selected for the Split are valid based on serail matching requirements. It will send message to inform the user if there is active labor for the job. Parameters Name
Type
Description
ipJobNum
String
The input jobnum to split.
ipDoLbrCheck
Boolean
Flag to indicate whether to check for active labor
ds
The SplitJob dataSet
opLbrMessage
String@
Serial Match error message
opSerialMatchMsg
String@
Serial Match error message
opSerialNumber
String@
Serial Match error message
opSerialMatchErr
Boolean@
Lower Level Serial Matching error flag
opLLTrkWarning
String@
Lower level tracking is not used but subassemblies have serial numbers assigned
ProcessSplitJob This method runs the split job process. This should be ran after updating and validating the jobprods that have been split. This will create a new job with associated records but with new quantities specified in the split quantities. Parameters Name
Type
Description
ipJobNum
String
The input jobnum to split.
ipNewJobNum
String
The input jobnum to split to.
ipDueDate
Nullable{System.DateTime} The input DueDate to split to.
opLegalNumberMessage
String@
ds
Epicor 9.05 | 9.05.605
The output legal number message. The SplitJob dataSet
2093
S-Z
Business Object Reference Guide
ValidateJobProd This method validates the JobProd record. Parameters Name
Type
Description
ipJobProdRowid
String
The character rowid value of the JobProd to validate
ds
The SplitJob dataSet.
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
ds
Description Split Job data set
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
SplitMergeUOM Epicor.Mfg.BO.SplitMergeUOM: This business object contains 16 methods.
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters
2094
Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns pcNeqQtyActionpcMessage
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
2095
S-Z
Business Object Reference Guide
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
CalculateRemainQty Calculates The Remaining Qty Parameters Name
Type
Description
partNum
String
Part number to split or merge.
ds
SplitMerge Dataset. If valid, the New BinNum and LotNum will be returned in the dataset
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GetSplitMergeHeadData Gets the default values for the ttSMHdr data table based on the part number entered.
2096
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
partNum
String
Part number to split or merge.
Returns Split Merge Dataset
OnChangeBinNum Used to verify if the selected Bin is valid for the selected warehouse Parameters Name
Type
Description
partNum
String
Part number to split or merge.
binNum
String
Bin Number.
ds
SplitMerge Dataset. If valid, the New BinNum and LotNum will be returned in the dataset
OnChangeLotNum Used to default the Lot Number when the BinNum has been changed Parameters Name
Type
Description
partNum
String
Part number to split or merge.
lotNum
String
Lot Number.
ds
SplitMerge Dataset. If valid, the New BinNum and LotNum will be returned in the dataset
OnChangeProcType Used to create the Split or Merge Records Parameters Name
Type
Description
partNum
String
Part number to split or merge.
processType
String
Process Type.
ds
Epicor 9.05 | 9.05.605
SplitMerge Dataset. If valid, the New BinNum and LotNum will be returned in the dataset
2097
S-Z
Business Object Reference Guide
OnChangeQuantity Used to verify that quantity to split or merge Parameters Name
Type
Description
partNum
String
Part number to split or merge.
dQuantity
Decimal
Quantity.
ds
SplitMerge Dataset. If valid, the New BinNum and LotNum will be returned in the dataset
OnChangeUOM Used to return a list of valid UOM to process the split or merge Parameters Name
Type
Description
partNum
String
Part number to split or merge.
uOMCode
String
Unit of Messure.
ds
SplitMerge Dataset. If valid, the New BinNum and LotNum will be returned in the dataset
OnChangeWarehouse Used to verify that selected warehouse is valid for the part and current plant and to default the Bin and Lot Number when the Warehouse has been changed Parameters Name
Type
Description
partNum
String
Part number to split or merge.
whseCode
String
Warehouse Code.
ds
SplitMerge Dataset. If valid, the New BinNum and LotNum will be returned in the dataset
ProcessType Runs the Split or Merge Process Parameters
2098
Name
Type
Description
partNum
String
Part number to split or merge.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
S-Z
Type
Description
ds
SplitMerge Dataset. If valid, the New BinNum and LotNum will be returned in the dataset
SRTSearch Epicor.Mfg.BO.SRTSearch: This business object contains 2 methods.
GetList This method returns a list of Substance Restriction Types available. The RelatedTo parameter allows the user to search for SRT related to Part or Operation to use them on a BOM, or leave blank to search for all available. Parameters Name
Type
Description
whereClause
String
WhereClause to perform the search
pageSize
Int32
page Size
absolutePage
Int32
absolute Page
morePages
Boolean@
more Pages: true/false
Returns SRTSearch DataSet
GetRows This method returns a list of Substance Restriction Types available. The RelatedTo parameter allows the user to search for SRT related to Part or Operation to use them on a BOM, or leave blank to search for all available. Parameters Name
Type
Description
whereClause
String
WhereClause to perform the search
pageSize
Int32
page Size
absolutePage
Int32
absolute Page
morePages
Boolean@
more Pages: true/false
Returns SRTSearch DataSet
StageNo Epicor.Mfg.BO.StageNo: This business object contains 7 methods.
GetNewStageNo Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
2099
S-Z
Business Object Reference Guide
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
2100
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
StageShipConfirm Epicor.Mfg.BO.StageShipConfirm: This business object contains 16 methods.
GetNewCartonStage Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2101
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage
backoutPartTran Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
2102
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ChangePackStage Parameters Name
Type
ds
Description Carton Stage DataSet
CheckOrder This method check releases related with this pack were refused to close because non shipped pack existing. Parameters Name
Type
Description
packNum
Int32
The Pack Number to check out
msg
String@
releases weren't closed message
ShipConfirm This method runs the ship confirm logic Parameters Name
Type
Description
dateShift
String
The date shift
ds opMessage
Carton Stage DataSet String@
Lists the cartons that failed to ship and why
StageCarton This method runs the unstage logic. Parameters Name
Type
ds
Description Carton Stage DataSet
UnShipConfirm This method runs the Unship logic Parameters Name
Type
Description
dateShift
String
The date shift
Epicor 9.05 | 9.05.605
2103
S-Z
Business Object Reference Guide
Name
Type
Description
ds opMessage
Carton Stage DataSet String@
Lists the cartons that failed to unship and why
UnShipPackingSlip This methods assigns the TFShipHead.Shipped field and updates/deletes all of the associated records (parttran) when a Packing Slip is unshipped. Also potentially creates partbin and partdtl records. Parameters Name
Type
Description
ipTFShipHeadRowid
String
The rowid of the TFShipHead to unship
Returns
Unstage This method runs the unstage logic. Parameters Name
Type
Description
workStationID
String
Workstation ID.
ds
Carton Stage DataSet
StockProvisionFormat Epicor.Mfg.BO.StockProvisionFormat: This business object contains 11 methods.
GetNewStockProvisionFormat Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2104
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
2105
S-Z
Business Object Reference Guide
Returns
GetTranTypeList This method provides a list of values and description for Tran Types. Returns TranTypeList - list of Tran Types and translated desc for the front end UI
OnChangeActive Parameters Name
Type
ds
Description The StockProvisionFormat data set
OnChangeType This method validates the StockProvisionFormat.Type when changed in UI form. Parameters Name
Type
Description
ipType
String
Proposed Type value
ds
The StockProvisionFormat data set
SubConShipEntry Epicor.Mfg.BO.SubConShipEntry: This business object contains 47 methods.
GetNewSubShipH Inserts a new row in the DataSet with defaults populated.
GetNewSubShipD Inserts a new row in the DataSet with defaults populated.
GetNewShipCOO Inserts a new row in the DataSet with defaults populated.
GetNewSubShipUPS Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
2106
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
2107
S-Z
Business Object Reference Guide
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AssignLegalNumber Assigns a legal number to the subcontract shipment. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
String@
Legal number
ds opLegalNumMsg Returns The Subcontract Shipment data set
CalculateWeight Parameters Name
Type
Description
cartonNumber
Int32
Carton Number
calculatedWeight
Decimal@
Shipment weight based upon part values
CancelVoidCarton Checks to see if the carton void can be cancelled and re-opens it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to open
Returns The Subcontract Ship data set
ChangeSubShipDAssemblySeq This methods updates associated fields. This method should run when the SubShipD.AssemblySeq field changes.
2108
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The SubConShipEntry dataSet
ChangeSubShipDJobNum This methods updates associated fields. This method should run when the SubShipD.JobNum field changes. Parameters Name
Type
ds
Description The SubConShipEntry dataSet
ChangeSubShipDOprSeq This methods validates the SubShipD.OprSeq and updates associated fields. This method should run when the SubShipD.OprSeq field changes. Parameters Name
Type
ds
Description The SubConShipEntry dataSet
ChangeSubShipDPONum This method validates the SubShipD.PONum field. This method should run when the SubShipD.PONum chages. Parameters Name
Type
ds
Description The SubConShipEntry dataSet
ChangeSubShipHPurPoint This methods validates the SubShipH.PurPoint and updates some variables and DspShipAddr. This method should run when the SubShipH.PurPoint field changes. Parameters Name
Type
Description
cProposedPurPoint
String
The new proposed SubShipH.PurPoint value
ds
Epicor 9.05 | 9.05.605
The SubConShipEntry dataSet
2109
S-Z
Business Object Reference Guide
ChangeSubShipHVendorNumVendorID This methods updates the vendornum and purpoint fields based on validating the SubShipH.VendorNumVendorID field. This method should run when the SubShipH.VendorNumVendorID field changes. Parameters Name
Type
Description
cProposedVendorNumVendorID
String
The new proposed SubShipH.VendorNumVendorID value
ds
The SubConShipEntry dataSet
CheckCOOPercents Checks to see if the Qty percent and value percent fields total 100 percent. Parameters Name
Type
Description
iPackNum
Int32
The current PackNum
iPackLine
Int32
The current PackLine
CheckShipCOOOrigCountry This method validates the ShipCOO.OrigCountry field. This method should run before changing the ShipCOO.OrigCountry field. Parameters Name
Type
Description
ipProposedCountry
Int32
The new proposed ShipCOO.OrigCountry value
ds
The SubConShipEntry dataSet
CheckSubShipDAssemblySeq This method validates the SubShipD.AssemblySeq field. This method should run before changing the SubShipD.AssemblySeq field. Parameters Name
Type
Description
ipProposedAssemblySeq
Int32
The new proposed SubShipD.AssemblySeq value
serialWarning
String@
Warning message if the shipdtl line contains serial numbers
ds
2110
The SubConShipEntry dataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
CheckSubShipDJobNum This method validates the SubShipD.JobNum field. This method should run before changing the SubShipD.JobNum field. Parameters Name
Type
Description
ipProposedJobNum
String
The new proposed SubShipD.JobNum value
serialWarning
String@
Warning message if the shipdtl line contains serial numbers
ds
The SubConShipEntry dataSet
CheckSubShipDOprSeq This method validates the SubShipD.OprSeq field. This method should run before changing the SubShipD.OprSeq field. Parameters Name
Type
Description
ipProposedOprSeq
Int32
The new proposed SubShipD.OprSeq value
serialWarning
String@
Warning message if the shipdtl line contains serial numbers
ds
The SubConShipEntry dataSet
CheckSubShipDPOLine This method validates the SubShipD.POLine field. This method should run before changing the SubShipD.POLine field. Parameters Name
Type
Description
ipProposedPOLine
Int32
The new proposed SubShipD.POLine value
ds
The SubConShipEntry dataSet
CheckSubShipDPONum This method validates the SubShipD.PONum field. This method should run before changing the SubShipD.PONum field. Parameters Name
Type
Description
ipProposedPONum
Int32
The new proposed SubShipD.PONum value
ds
Epicor 9.05 | 9.05.605
The SubConShipEntryDataSet dataSet
2111
S-Z
Business Object Reference Guide
CheckSubShipDPORelNum This method validates the SubShipD.PORelNum field. This method should run before changing the SubShipD.PORelNum field. Parameters Name
Type
Description
ipProposedPORelNum
Int32
The new proposed SubShipD.PORelNum value
ds
The SubConShipEntry dataSet
ClearConvertedManifest Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to clear Manifest fields
CloseCarton Checks to see if the carton can be closed and closes it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to close
Returns The SalesOrder data set
ConvertToManifestUOM Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to populate Manifest fields
GetLegalNumGenOpts Returns the legal number generation options. Parameters
2112
Name
Type
Description
ipPackNum
Int32
Packing Slip number
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
GetPackageClass Parameters Name
Type
Description
ipPkgClass
String
package class to validate
ds
Subcontract shipment dataset
GetPackaging Parameters Name
Type
Description
ipPkgCode
String
package code
ds
Sub Contractor Shipment data set
GetPayBTFlagDefaults Parameters Name
Type
Description
ds
The subcontract shipment data set
GetScale Parameters Name
Type
Description
workstationID
String
workstation ID
scaleID
String@
Scale ID
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers
Epicor 9.05 | 9.05.605
2113
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The SubShipD dataSet
Returns The SelectSerialNumbersParams dataset
GetTranDocTypeID Sets default values when the TranDocTypeID changes Parameters Name
Type
Description
ipTranDocTypeID
String
TranDocTypeID supplied
ds
Subcontract Shipment data set
OpenCarton Checks to see if the carton can be opened and opens it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to open
Returns The SalesOrder data set
PreSubShipDUpdate This method is to be run before update of SubShipD to ask the user any question that need to be answered before the record can be saved. If the user answers no to any one of the questions, then the update method should not be called. Parameters Name
Type
ds
2114
Description SubConShipEntry data set
lotMessage
String@
If the lot doesn't exist, ask the user if they'd like to create it
qtyMessage
String@
Qty message
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
RebuildShipUPS Parameters Name
Type
Description
ipPackNum
Int32
Packnum to update
ds
The SubConShipEntry dataSet
SetUPSQVEnable Parameters Name
Type
Description
ipQVEnable
Boolean
logical indicating if the quantum view is to enabled/disabled
ds
The subcontract shipment data set
SetUPSQVShipStatus Parameters Name
Type
Description
ipShipStatus
String
shipment status
ds
The subcontract shipment data set
StageCarton Checks to see if the carton can be voided and voids it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to Stage
Returns The SubConShipEntry data set
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description SubContract Shipment Entry data set
2115
S-Z
Business Object Reference Guide
Name
Type
Description
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
VoidCarton Checks to see if the carton can be voided and voids it if it is allowed. Parameters Name
Type
Description
iPackNum
Int32
The carton number of the carton to void
Returns The SalesOrder data set
VoidLegalNumber Voids the legal number. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
ipVoidedReason
String
Reason for the void
Returns The Subcontract Shipment data set
Substance Epicor.Mfg.BO.Substance: This business object contains 7 methods.
GetNewSubstance Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
2116
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
SubstanceRestriction Epicor.Mfg.BO.SubstanceRestriction: This business object contains 11 methods.
GetNewRestrictionType Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
2117
S-Z
Business Object Reference Guide
GetNewRestrictionSubstance Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
2118
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeSubstance This method should be called when ValidateCompliance change. Parameters Name
Type
Description
validaSubstance
String
Valida SubstanceID
typeID
String
Restriction Type
ds
SubstanceRestriction data set.
OnChangeThreshold This method should be called when ValidateCompliance change. Parameters Name
Type
Description
validaThreshold
Decimal
Valida Threshold
OnChangeValidateCompliance This method should be called when ValidateCompliance change. Parameters Name
Type
Description
checkCompliance
Boolean
Proposed Compliance.
ds
SubstanceRestriction data set.
SubstanceSearch Epicor.Mfg.BO.SubstanceSearch: This business object contains 2 methods.
GetList This method returns a list of Restricted Substances available. The RelatedTo parameter allows the user to search for Substances related to Part or Operation to use them on a BOM, or leave blank to search for all available.
Epicor 9.05 | 9.05.605
2119
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
WhereClause to perform the search
pageSize
Int32
page Size
absolutePage
Int32
absolute Page
morePages
Boolean@
more Pages: true/false
Returns SubstanceSearch DataSet
GetRows This method returns a list of Restricted Substances available. The RelatedTo parameter allows the user to search for Substances related to Part or Operation to use them on a BOM, or leave blank to search for all available. Parameters Name
Type
Description
whereClause
String
WhereClause to perform the search
pageSize
Int32
page Size
absolutePage
Int32
absolute Page
morePages
Boolean@
more Pages: true/false
Returns SubstanceSearch DataSet
SupplierConnectSetup Epicor.Mfg.BO.SupplierConnectSetup: This business object contains 8 methods.
GetNewSRMCfg Inserts a new row in the DataSet with defaults populated. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2120
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Epicor 9.05 | 9.05.605
Description
2121
S-Z
Business Object Reference Guide
Returns
SupplierPart Epicor.Mfg.BO.SupplierPart: This business object contains 9 methods.
GetNewSupplierPart Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2122
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeSupplierPartMfgNum When Changing SupplierPart.MfgtNum field. Parameters Name
Type
Description
iMfgNum
Int32
Manufacturer Number
ds
SupplierPart dataset
ChangeSupplierPartMfgPartNum When Changing SupplierPart.MfgPartNum field. Parameters Name
Type
Description
iMfgPartNum
String
Manufacturer Part Number
ds
SupplierPart dataset
SupplierXRef Epicor.Mfg.BO.SupplierXRef: This business object contains 1 methods.
GetSupplierXRefParts This method gets the XRef information for a given supplier part Parameters Name
Type
Description
partNum
String
Receipt Part Number
vendorNum
Int32
Receipt Supplier Number
poNum
Int32
PO Number
Epicor 9.05 | 9.05.605
2123
S-Z
Business Object Reference Guide
Name
Type
Description
poLine
Int32
PO Line
purPoint
String
Purchase Point
packSlip
String
packing Slip
packLine
Int32
packing Line
Returns
SysActivityLog Epicor.Mfg.BO.SysActivityLog: This business object contains 13 methods.
GetNewSysActivityLog Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
2124
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsByCompanyByType This method returns Activity Log for a particular Company and Type Parameters Name
Type
Description
pcActivityCompany
String
The Company ID
pcActivityType
String
The Activity Type - Created, Updated, Deleted
Returns Returns the dataset representing the list
GetRowsByDate This method returns Activity Log after the specified date Parameters Name
Type
Description
pcActivityDate
Nullable{System.DateTime}
The Date for Activities after
Returns Returns the dataset representing the list
GetRowsByTableByCompany This method returns Activity Log for a specified Activity Type and Company
Epicor 9.05 | 9.05.605
2125
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
pcActivityTable
String
The Table Name
pcActivityCompany
String
The Activity Company
Returns Returns the dataset representing the list
GetRowsByTableByDate This method returns Activity Log for a particular Table Parameters Name
Type
Description
pcActivityTable
String
The TableName
pcActivityDate
Nullable{System.DateTime}
The Date that the Activities occurred after
Returns Returns the dataset representing the list
GetRowsByTypeByCompany This method returns Activity Log for a specified Activity Type and Company Parameters Name
Type
Description
pcActivityType
String
The Activity Type
pcActivityCompany
String
The Activity Company
pcActivityDate
Nullable{System.DateTime}
The date that the Activities occurred after
Returns Returns the dataset representing the list
GetRowsByUserByCompany This method returns Activity Log for a specified User and Company Parameters
2126
Name
Type
Description
pcActivityUser
String
The Activity User
pcActivityCompany
String
The Activity Company
pcActivityDate
Nullable{System.DateTime}
The date that the activities occurred after
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns Returns the dataset representing the list
SysAgent Epicor.Mfg.BO.SysAgent: This business object contains 13 methods.
GetNewSysAgent Inserts a new row in the DataSet with defaults populated.
GetNewSysAgentSched Inserts a new row in the DataSet with defaults populated.
GetNewSysAgentTask Inserts a new row in the DataSet with defaults populated.
GetNewSysAgentTaskParam Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
2127
S-Z
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetAgentSchedList To return a dataset of SysAgentSched records for a given agent id. Parameters Name
Type
Description
agentID
String
Agent ID which you want the schedules for.
Returns The SysAgentSchedList dataSet
GetDefaultTaskAgentID Returns the default Task Agent ID.
2128
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
defaultAgentID
String@
Default Agent ID.
SysConfig Epicor.Mfg.BO.SysConfig: This business object contains 8 methods.
GetNewSysConfig Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2129
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetValue Get a system configuration value
SysMonitor Epicor.Mfg.BO.SysMonitor: This business object contains 6 methods.
CancelTask Use to terminate a running task. Parameters Name
Type
Description
sysTaskNum
Int32
System Task Number to be terminated.
GetScheduledTasks To return the SysMonitorSchedDataSet which contains the scheduled tasks for a user. Parameters Name
Type
Description
userIDent
String
User ID for which you want the schedule tasks. Leave blank to consider all users.
Returns The SysMonitorSched dataSet
GetTaskHistory To return Task history records for the current user for a specified number of days.
2130
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
taskNumOfDays
Int32
The number of days from today you wish to retrieve task history for.
rptUserID
String
User ID for which you want SysRptLst and SysTask records. Leave this blank to consider all users for available reports.
Returns The SysMonitorTaskHist dataSet
GetTasksNReports To return the SysMonitorDataSet which contains the SysTask and SysRptLst tables. Parameters Name
Type
Description
rptUserID
String
User ID for which you want SysRptLst and SysTask records. Leave this blank to consider all users for available reports.
rptWorkStationID
String
Computer/Workstation name for which you want SysRptLst records. Leave this blank to consider ALL workstations for available reports
Returns The SysMonitor dataSet
UpdateSysMonitorDS Use to commit updates and deletions of the SysMonitor dataset to the database. Does NOT support adding new records. Does NOT support deletion of SysTask records. Parameters Name
Type
ds
Description The SysMonitor dataSet
UpdateSysMonitorSched Use to commit deletions of the SysMonitor dataset to the database. Does NOT support adding or updating of records. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The SysMonitorSched dataSet
2131
S-Z
Business Object Reference Guide
SysPrinter Epicor.Mfg.BO.SysPrinter: This business object contains 7 methods.
GetNewSysPrinter Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2132
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
SysTag Epicor.Mfg.BO.SysTag: This business object contains 7 methods.
GetNewSysTag Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
2133
S-Z
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
SysTaskRule Epicor.Mfg.BO.SysTaskRule: This business object contains 7 methods.
GetNewSysTaskRule Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2134
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
2135
S-Z
Business Object Reference Guide
Chapter 20: T Tariff Epicor.Mfg.BO.Tariff: This business object contains 9 methods.
GetNewTariff Inserts a new row in the DataSet with defaults populated.
GetNewTariffComm Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
2136
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnCommCodeChange Validates the Commodity Code. Parameters Name
Type
Description
ipCommCodeID
String
The Commodity Code ID
ds
The Import Tariff Data Set.
Task Epicor.Mfg.BO.Task: This business object contains 31 methods.
GetNewTask Inserts a new row in the DataSet with defaults populated.
GetNewTaskCnt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
2137
S-Z
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
2138
Name
Type
tableName
String
fieldName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns
AssignDefaultsFromQuote Assigns defaults for the task when is created from a Quote. Parameters Name
Type
Description
quoteNum
Int32
Num of quote to assign values
ds
The Task data set
ChangeComplete Assigns defaults for the task when the complete field is checked. Parameters Name
Type
ds
Description The Task data set
lProposedComplete
Boolean
The proposed value for the complete flag
cMessage
String@
The message to display if not blank
ChangeConclusion Assigns defaults for the task when the conclusion is changed. Parameters Name
Type
ds
Description The Task data set
ChangeConName Update TaskCnt information when the contact Name is changed. Parameters Name
Type
Description
pName
String
Proposed Name
ds
The Task data set
ChangeConPerConLnkRowID Update TaskCnt information when the contact PerConLnkRowID is changed.
Epicor 9.05 | 9.05.605
2139
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
pPerConLnkRowID
String
Proposed PerConLnkRowID
ds
The Task data set
ChangeCustomer Assigns defaults for the task when the customer changes. Parameters Name
Type
ds
Description The Task data set
ChangeCustomerContact Assigns defaults for the task when the customer contact changes. Parameters Name
Type
ds
Description The Task data set
ChangeCustomerShipTo Assigns defaults for the task when the customer ship to changes. Parameters Name
Type
ds
Description The Task data set
ChangeNextTaskSeq Get the Next Task Description when the NextTaskSeq changes. Parameters Name ds
Type
Description The Task data set
ChangeSalesRep Assigns defaults for the task when the salesRep changes.
2140
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ds
The Task data set
ChangeTaskID Assigns defaults for the task when the task id changes. Parameters Name
Type
Description
ds
The Task data set
ChangeTaskTimeDisp Assigns the format for the task Start and End Time fields when their value changes. Parameters Name
Type
Description
ds
The Task data set
ChangeTEApprovalAction Assigns defaults for the task when the time or expense approval action changes. Parameters Name
Type
Description
ds
The Task data set
lProposedTEApprovalAction
String
The proposed value for approval action
ChangeVendor Assigns defaults for the task when the vendor changes. Parameters Name ds
Type
Description The Task data set
ChangeVendorContact Assigns defaults for the task when the vendor contact changes.
Epicor 9.05 | 9.05.605
2141
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The Task data set
ChangeVendorPP Assigns defaults for the task when the vendor purchase point changes. Parameters Name
Type
ds
Description The Task data set
GetCreditHoldMessageText Retrieve the customer on credit hold message text. Parameters Name
Type
Description
icCustID
String
The customer id
ocMessageText
String@
The text of the message returned
GetListApprovers This method returns a list of Tasks to be viewed in the Task List screen based a Sales Representative, Date Range, and sort options. This method builds the where clause instead of having the UI build the where clause on their end. Although either method could be used to build the Tree. Parameters
2142
Name
Type
Description
ipSalesRepCode
String
IPsalesRepCode
ipApprovalStatus
String
Stauts of Tasks
ipTime
Boolean
Include Time Transactions
ipExpense
Boolean
Include Expense transactions
ipSortby
String
Sort the data - currently not used
ipStartDate
String
Starting date of the results set, blank will return all dates
ipEndDate
String
Starting date of the results set, blank will return all dates
ipEmployeeNum
String
Search for time or expenses for a employee, blank for all
ipProject
String
Search for time or expenses for a project, blank for al
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
pageSize
Int32
The page size
absolutePage
Int32
the absolute page
morePages
Boolean@
The more pages
Returns The Task dataSet
GetQuoteLinesWOQtyMessageText This method returns the message text for the case where there aren't any quote lines with an order quantity. Parameters Name
Type
Description
ocMessageText
String@
Contains the message text to display
GetRowsContactTracker Called from Contact tracker instead of GetRows for better performance Parameters Name
Type
Description
whereClauseTask
String
Whereclause for Task table.
contactName
String
The contact to return data for.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.TaskDataSet
GetRowsCustomerTracker Called from Customer tracker instead of GetRows for better performance Parameters Name
Type
Description
whereClauseTask
String
Whereclause for Task table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Epicor 9.05 | 9.05.605
2143
S-Z
Business Object Reference Guide
Returns Epicor.Mfg.BO.TaskDataSet
GetTaskList This method returns a list of Tasks to be viewed in the Task List screen based a Sales Representative, Date Range, and sort options. This method builds the where clause instead of having the UI build the where clause on their end. Although either method could be used to build the Tree. Parameters Name
Type
Description
salesRepCode
String
Current SalesRep, blank to use default or code of SalesRep selected by user
includeComplete
Boolean
Include Complete Tasks or not
dateType
String
Options are startDate or dueDate
startDate
String
Starting date of the results set, blank will return everything upto the ending date
endDate
String
Ending date of the results set, blank will become the last day of the next month
filterStatus
String
A Specific Task Status to look for, blank for all
filterType
String
A specific Task Type to look for, blank for all
pageSize
Int32
The page size
absolutePage
Int32
the absolute page
morePages
Boolean@
The more pages
Returns The Task dataSet
TaskMast Epicor.Mfg.BO.TaskMast: This business object contains 8 methods.
GetNewTaskMast Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
2144
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeTypeCode This sets the TETaskType field when the TypeCode changes. Parameters Name
Type
Description
newTypeCode
String
The proposed TypeCode value
ds
Epicor 9.05 | 9.05.605
The TaskMast data set
2145
S-Z
Business Object Reference Guide
TaskSet Epicor.Mfg.BO.TaskSet: This business object contains 21 methods.
GetNewTaskSet Inserts a new row in the DataSet with defaults populated.
GetNewTaskSMilestone Inserts a new row in the DataSet with defaults populated.
GetNewTaskSDtl Inserts a new row in the DataSet with defaults populated.
GetNewTaskSNxt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
2146
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
BuildNextTaskList Returns a delimited list of next task sequences available in id`desc pairs Parameters Name
Type
Description
taskSetId
String
Task Set Id
taskSetSeq
Int32
Current Task Sequence
taskNextSeq
Int32
Existing Next Task to exclude from list
nextList
String@
Delimited list of available next tasks
BuildParentTaskList Returns a delimited list of available parent task sequences in id`desc pairs
Epicor 9.05 | 9.05.605
2147
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
cTaskSetId
String
Task Set Id
cParentList
String@
Delimited list of Parent(Milestone) tasks
BuildStageList Returns a delimited list of available stages in the format "ID`Desc~ID`Desc" Parameters Name
Type
Description
workflowType
String
Workflow Type to determine the list of stages
stageList
String@
Delimited list of available stages
CopyTaskSet Copies a task set to a new task set Parameters Name
Type
Description
sourceTaskSetID
String
The ID of the source task set (copy from)
targetTaskSetID
String
The ID of the new task set (copy to)
targetTaskSetDesc
String
The Description of the new task set
Returns The TaskSet DataSet
DefaultMilestoneInfo This method assigns the RoleCode and CurrentStage based on the task selected Parameters Name
Type
ds
Description Task Set Data set with changes
DefaultNextTaskInfo This method updates the TaskSNxt record after the next seq has been selected Parameters Name ds
2148
Type
Description Task Set Data set with changes to TaskSNxt
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
DefaultRelatedTaskInfo This method updates the RoleCode and Mandatory fields once the TaskId has been selected Parameters Name
Type
Description
ds
Task Set Data set with related task changes
GetCRMTaskSetList This method asks for a taskSetId and activeTaskId (currently found on QuoteHed) and it will only return TaskSets that are applicable to those inputs Parameters Name
Type
Description
taskSetId
String
QuoteHed.TaskSetId
activeTaskId
String
QuoteHed.ActiveTaskId
pageSize
Int32
The page size
absolutePage
Int32
The absolute page
morePages
Boolean@
The more pages
Returns TaskSet List dataset
GetListFilterTaskSet This method is used to filter the search results of TaskSet depending on the current Active TaskID. Parameters Name
Type
Description
whereClause
String
WorkflowType='HelpDesk' And Inactive=true
pageSize
Int32
PageSize
absolutePage
Int32
AbsolutePage
activeTaskID
String
HDCase.ActiveTaskID
morePages
Boolean@
MorePages
Returns TaskSet List
GetNewTaskDetail This method creates the new TaskSDtl record in place of the standard method
Epicor 9.05 | 9.05.605
2149
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description Task Set Data set with new record
taskSetID
String
Task Set Id
parentTaskSeq
Int32
TaskSetSeq of the parent milestone
TaskSetSearch Epicor.Mfg.BO.TaskSetSearch: This business object contains 7 methods.
GetNewTaskSet Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
2150
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TaskStat Epicor.Mfg.BO.TaskStat: This business object contains 7 methods.
GetNewTaskStat Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
2151
S-Z
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TaskType Epicor.Mfg.BO.TaskType: This business object contains 7 methods.
GetNewTaskType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2152
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TaxAlgrm Epicor.Mfg.BO.TaxAlgrm: This business object contains 20 methods.
GetNewTaxAlgrm Inserts a new row in the DataSet with defaults populated.
GetNewTaxAlDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
2153
S-Z
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters
2154
Name
Type
tableName
String
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
fieldName
String
Description
Returns
ChangeOperand1 Update multiple fields when the Operand1 changes. Parameters Name
Type
ds
Description The TaxAlgrm data set
ChangeOperand2 Update multiple fields when the Operand2 changes. Parameters Name
Type
ds
Description The TaxAlgrm data set
ChangeOperator Update multiple fields when the operator changes. Parameters Name
Type
ds
Description The TaxAlgrm data set
CheckBaseLine Uncheck the Base line flag if different line is flagged as BaseLine . Parameters Name
Type
Description
iBaseLine
Boolean
The proposed flag for Base Line
CheckTaxLine Uncheck the Tax Line flag if different line is flagged as TaxLine.
Epicor 9.05 | 9.05.605
2155
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
iTaxLine
Boolean
The proposed flag for Tax Line
ValidateOperand1 Validates the value of "Operand1" Parameters Name
Type
Description
proposedOperand1
String
Proposed Operand1 value
iLine
Int32
Line Number
iAlgorithm
String
Algorithm code
Name
Type
Description
proposedOperand2
String
Proposed Operand2 value
iLine
Int32
Line Number
iAlgorithm
String
Algorithm code
iOperator
String
Operator code
Name
Type
Description
proposedOperand3
String
Proposed Operand3 value
iLine
Int32
Line Number
iAlgorithm
String
Algorithm code
ValidateOperand2 Validates the value of "Operand2" Parameters
ValidateOperand3 Validates the value of "Operand3" Parameters
ValidateOperand4 Validates the value of "Operand4"
2156
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
proposedOperand4
String
Proposed Operand4 value
iLine
Int32
Line Number
iAlgorithm
String
Algorithm code
ValidateOperator Validates the value of "Operand2" Parameters Name
Type
Description
proposedOperator
String
Proposed Operator value
iOperand1
String
Operator code
ValidateTaxCode Validates the value of "Operand3TaxCode" and "Operand4TaxCode" Parameters Name
Type
Description
proposedTaxCode
String
Proposed Tax Code
TaxAuthorityCd Epicor.Mfg.BO.TaxAuthorityCd: This business object contains 8 methods.
GetNewTaxAuthorityCd Inserts a new row in the DataSet with defaults populated.
GetNewTaxAuthorityCdAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
2157
S-Z
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TaxBoxDefault Epicor.Mfg.BO.TaxBoxDefault: This business object contains 7 methods.
GetNewTaxBoxDefault Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
2158
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
2159
S-Z
Business Object Reference Guide
TaxCat Epicor.Mfg.BO.TaxCat: This business object contains 8 methods.
GetNewTaxCat Inserts a new row in the DataSet with defaults populated.
GetNewTaxCatD Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2160
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TaxCatDSearch Epicor.Mfg.BO.TaxCatDSearch: This business object contains 7 methods.
GetNewTaxCatD Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
2161
S-Z
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TaxCent Epicor.Mfg.BO.TaxCent: This business object contains 10 methods.
GetNewTaxCent Inserts a new row in the DataSet with defaults populated.
GetNewTaxCentD Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2162
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeCentTo Method to call when changing the CentTo. Parameters Name
Type
Description
proposedCentTo
Decimal
CentTo
pCentFrom
Decimal
CentFrom
ValidateCent Method to Validate that TaxCentD goes to the limit. Parameters Name
Type
Description
pCentCode
String
pCentCode
Epicor 9.05 | 9.05.605
2163
S-Z
Business Object Reference Guide
TaxExemptSearch Epicor.Mfg.BO.TaxExemptSearch: This business object contains 8 methods.
GetNewTaxExempt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
2164
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeTypeOnEntity Method to call to retrieve the Tax Type description for an entity. This method is called when adding types to entities to validate the type does not already exist for the entity and to return the description for display purposes. Parameters Name
Type
Description
inTaxCode
String
Tax Type
inRelatedToFile
String
Related To File
inKey1
String
Key1
inKey2
String
Key2
inRateCode
String
Rate Code
inEffectiveFrom
Nullable{System.DateTime}
Effective From Date
outDescription
String@
Description
TaxJuris Epicor.Mfg.BO.TaxJuris: This business object contains 7 methods.
GetNewTaxJuris Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
2165
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TaxReconciliation Epicor.Mfg.BO.TaxReconciliation: This business object contains 15 methods.
GetNewTaxSvcHead Inserts a new row in the DataSet with defaults populated.
GetNewTaxSvcDetail Inserts a new row in the DataSet with defaults populated.
GetNewTaxSvcJurDtl Inserts a new row in the DataSet with defaults populated.
2166
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetNewTaxSvcMessages Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
2167
S-Z
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
CalcTaxes Parameters Name
Type
Description
ipQuoteNum
Int32
Quote Number
ipOrderNum
Int32
Order Number.
ipInvoiceNum
Int32
Invoice Number.
ipAPInvKey
String
AP Invoice Number.
ipCashHeadNum
String
Cash Receipt Number.
ipPayHeadNum
Int32
Payment Number.
ipShipPackNum
Int32
Shipment Number.
ipEmpID
String
Employee ID.
ipEmpExpenseNum
Int32
Employee Expense Number.
opCommFailure
Boolean@
Comm Failure
opMessage
String@
Message
opTCStatus
Boolean@
TC Status
GetLastDocID Get the last doc id from taxsvcconfig.. Parameters Name
Type
Description
lastDocID
Int32@
Used to select TaxSvcHead records.
GetTaxHistory Performs reconcile tax history. Parameters
2168
Name
Type
Description
lastDocID
Int32
Used to select TaxSvcHead records.
statusFlag
Boolean@
Set to true if the tax service is up, false if down.
resultCode
String@
Could be either error or exception
resultMessage
String@
Message for result code.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
OnChangeofAction Called when the user chooses a new action. Parameters Name
Type
Description
action
String
Action
taxSvcID
String
TaxSvcID from TaxSvcHead.
docType
Int32
DocType from TaxSvcHead.
ds
TaxReconciliation data set
PerformReconciliation Performs reconcile tax history. Parameters Name
Type
Description
statusFlag
Boolean@
Set to true if the tax service is up, false if down.
resultStatus
Boolean@
True if an error occurred.
resultMessage
String@
Error message.
TaxResults Epicor.Mfg.BO.TaxResults: This business object contains 10 methods.
GetNewTaxSvcHead Inserts a new row in the DataSet with defaults populated.
GetNewTaxSvcDetail Inserts a new row in the DataSet with defaults populated.
GetNewTaxSvcJurDtl Inserts a new row in the DataSet with defaults populated.
GetNewTaxSvcMessages Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
2169
S-Z
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
2170
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
TaxRgn Epicor.Mfg.BO.TaxRgn: This business object contains 15 methods.
GetNewTaxRgn Inserts a new row in the DataSet with defaults populated.
GetNewTaxRgnSalesTax Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2171
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
MoveTaxOnePosition This method moves the TaxRgn/TaxRgnSalesTax Tax Type Up/Down one position in the grid and returns the whole updated datatable. Parameters Name
Type
Description
taxRegionCode
String
Tax Region Code
taxCode
String
Tax Code
taxNum
Int32
Tax Sequence number of tax type to move
moveDir
String
Direction to move task, "Up" or "Down"
Returns TaxRgn Dataset
OnChangeExemptType This method validates SalesTaxCode and populates description. Parameters Name
Type
ds iProposedExemptType
Description The TaxRgn data set
Int32
The proposed Exempt type value
OnChangeInPrice This method chnages the value of IncludeInAP when InPrice is true. Parameters Name
Type
ds iProposedInPrice
2172
Description The TaxRgn data set
Boolean
The proposed InPrice flag
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
OnChangeSalesTaxCode This method validates SalesTaxCode and populates description. Parameters Name
Type
ds iProposedSalesTaxCode
Description The TaxRgn data set
String
The proposed SalesTaxCode value
OnChangeTaxMethod This method validates SalesTaxCode and populates description. Parameters Name
Type
ds iProposedTaxMethod
Description The TaxRgn data set
String
The proposed Tax Method value
OnChangeUseInAR This method validates SalesTaxCode and populates description. Parameters Name
Type
Description
ds iProposedUseInAR
The TaxRgn data set Boolean
The proposed UseInAR flag
ValidateExemptPercent This method validates Exempt percent to be assign between 0 and 100. Parameters Name
Type
Description
ipExemptType
Int32
Exempt Type
ipExemptPercent
Decimal
Exempt Percent
Epicor 9.05 | 9.05.605
2173
S-Z
Business Object Reference Guide
TaxRptCat Epicor.Mfg.BO.TaxRptCat: This business object contains 7 methods.
GetNewTaxRptCat Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
2174
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TaxRptDtl Epicor.Mfg.BO.TaxRptDtl: This business object contains 8 methods.
GetNewTaxRptDtl Inserts a new row in the DataSet with defaults populated.
GetNewTaxRptDtlAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
2175
S-Z
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TaxText Epicor.Mfg.BO.TaxText: This business object contains 8 methods.
GetNewTaxText Inserts a new row in the DataSet with defaults populated.
GetNewTaxTextD Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2176
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TEApprovalTask Epicor.Mfg.BO.TEApprovalTask: This business object contains 11 methods.
GetNewTaskSet Inserts a new row in the DataSet with defaults populated.
GetNewTaskSMilestone Inserts a new row in the DataSet with defaults populated.
GetNewTaskSDtl Inserts a new row in the DataSet with defaults populated.
GetNewTaskSNxt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
2177
S-Z
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetByIDWAddlParams Returns a DataSet given the primary key. Contains additional parameter considerations for the data returned.
2178
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The DataSet.
Terms Epicor.Mfg.BO.Terms: This business object contains 17 methods.
GetNewTerms Inserts a new row in the DataSet with defaults populated.
GetNewTermsAttch Inserts a new row in the DataSet with defaults populated.
GetNewLangDesc Inserts a new row in the DataSet with defaults populated.
GetNewTermsDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
2179
S-Z
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangingDisDays Parameters Name
Type
Description
vDueOnDay
Int32
Propose Discount Days
ds
Temporary tables for Terms details
OnChangingDisPercent Parameters Name
Type
Description
vDiscountPercent
Decimal
Propose Discount Days
ds
2180
Temporary tables for Terms details
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
OnChangingNumOfDays Parameters Name
Type
Description
vNumOfDay
Int32
Propose Discount Days
ds
Temporary tables for Terms details
OnChangingNumOfMonths Parameters Name
Type
Description
vNumOfMonths
Int32
Propose Discount Days
ds
Temporary tables for Terms details
OnChangingTermDueOnDay Parameters Name
Type
Description
pDueOnDay
Int32
Propose Discount Days
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
TFOrdDtlSearch Epicor.Mfg.BO.TFOrdDtlSearch: This business object contains 9 methods.
GetNewTFOrdDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
2181
S-Z
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CustomGetByID This method GetDetail by ID
2182
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
tfOrdNum
String
The TFOrdNum code
tfOrdLine
Int32
The TFOrdLine code
Returns The TFOrdDtlSearch dataSet
GetOrdHedList This method is used to provide a list of OrderHed Parameters Name
Type
Description
whereClause
String
Whereclause.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The TFOrdDtlList dataSet
THLocAPTaxReceipt Epicor.Mfg.BO.THLocAPTaxReceipt: This business object contains 7 methods.
GetNewAPTran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
2183
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
TimePhas Epicor.Mfg.BO.TimePhas: This business object contains 15 methods. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2184
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
2185
S-Z
Business Object Reference Guide
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
EnableDisableWhatIfAndTFSugTogs SET Enable or Disable WhatIf And TFSugTogs
2186
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
enableBoth
Boolean@
EnableBoth
GetFrameTitle Geting of FrameTitle by Plant Parameters Name
Type
Description
inPlant
String
The Plant
inPart
String
The Partt
frameTitle
String@
Frame Title
mRPLastRunDate
Nullable{System.DateTime}@
MPRLastRunDate
frameLastSchedTitle
String@
Last schedule title
mRPLastScheduledDate
Nullable{System.DateTime}@
Date MRP last scheduled
GetPartXRefInfo This method defaults PartAdvisor fields when the PartNum field changes Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
GoProcessTimePhase Creating the TimePhase by PartNum and Plant Parameters Name
Type
Description
inputPartNum
String
Part Number
Epicor 9.05 | 9.05.605
2187
S-Z
Business Object Reference Guide
Name
Type
Description
ipplant
String
Plant
whatIfTog
Boolean
Suggestions
tFSug
Boolean
Transfer Order Suggestions
Returns Output Online TimePhase Dataset
TimeType Epicor.Mfg.BO.TimeType: This business object contains 7 methods.
GetNewTimeTypCd Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
2188
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Tip Epicor.Mfg.BO.Tip: This business object contains 8 methods.
GetNewTip Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
2189
S-Z
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetRowsTranslated Parameters Name
Type
Description
whereClauseTip
String
whereClauseSetupGrp">Where condition without the where word
pageSize
Int32
# of records returned. 0 means all
absolutePage
Int32
morePages
Boolean@
Are there more pages ? Yes/No
Returns The Tip data set
TopicChildSearch Epicor.Mfg.BO.TopicChildSearch: This business object contains 7 methods.
GetNewHDTopicChild Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
2190
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
2191
S-Z
Business Object Reference Guide
TrackingDtl Epicor.Mfg.BO.TrackingDtl: This business object contains 11 methods.
GetNewTrackingDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
2192
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetTrackingDetailsByOrderNum Retrieve TrackingDtl records for a given order number and shipment type. Parameters Name
Type
Description
orderNum
Int32
The OrderNum
shipmentType
String
The ShipmentType
Returns The TrackingDtl dataSet
GetTrackingDetailsByPackNum Retrieve TrackingDtl records for a given Packing Slip Number and shipment type. Parameters Name
Type
Description
packNum
Int32
The PackNum
shipmentType
String
The ShipmentType
Returns The TrackingDtl dataSet
GetTrackingDetailsByShipmentType Retrieve all TrackingDtl records for a given shipment type - CUST, XFER, MISC. Parameters Name
Type
Description
shipmentType
String
The ShipmentType
Returns The TrackingDtl dataSet
GetTrackingDetailsByTrackNum Retrieve TrackingDtl record for a given tracking number.
Epicor 9.05 | 9.05.605
2193
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
trackNum
String
The TrackNum
shipmentType
String
The ShipmentType
Returns The TrackingDtl dataSet
TranDocType Epicor.Mfg.BO.TranDocType: This business object contains 13 methods.
GetNewTranDocType Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
2194
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
DelTranDocTypeAuth Returns Epicor.Mfg.BO.TranDocTypeDataSet
NewTranDocTypeAuth Returns Epicor.Mfg.BO.TranDocTypeDataSet
OnChangeAllUsers This method validates All Users flag. Parameters Name
Type
ds pAllUsers
Epicor 9.05 | 9.05.605
Description The TranDocType data set
Boolean
The proposed All Users value
2195
S-Z
Business Object Reference Guide
OnChangeAuthUser This method check if the selected User has alreay default Transaction Document Type.for this type to update flag Default correctly. Parameters Name
Type
ds
Description The TranDocType data set
UpdTranDocTypeAuth This method save data about the authorized User. Returns Epicor.Mfg.BO.TranDocTypeDataSet
TranGLCDetail Epicor.Mfg.BO.TranGLCDetail: This business object contains 1 methods.
GetTransactionDetail Parameters Name
Type
Description
ipBookID
String
ipBookID
ipDocumentType
String
ARInvoice, APInvoice, etc
ipKey1
String
Key1
ipKey2
String
Key2
ipKey3
String
Key3
ipKey4
String
Key4
ipKey5
String
Key5
ipKey6
String
Key6
opMessage
String@
returns informational messages to the user when no records are found.
opNoData
Boolean@
if yes then no TranGLC records and no GLJrnDtl records were found.
opNoGLPosting
Boolean@
Yes indicates there are not GL Postings for this document.
Returns TranGLC and GLJrnDtl data set
2196
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
TranGLCJournal Epicor.Mfg.BO.TranGLCJournal: This business object contains 8 methods.
GetNewTranGLCDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
2197
S-Z
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetTranGLCDtl This method obtain the TranGLC record linked to GLJrnDtl. Parameters Name
Type
Description
vJournalCode
String
Journal Code
vJournalNum
Int32
Journal Code
vBookID
String
Book ID
Returns TranGLC DataSet
TransferChgSug Epicor.Mfg.BO.TransferChgSug: This business object contains 11 methods.
GetNewTFOrdDtl Inserts a new row in the DataSet with defaults populated.
GetNewTFOrdSug Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2198
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
ChangeReqValue This method is called when the required quantity or required UOM changes to convert quantities.
Epicor 9.05 | 9.05.605
2199
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The TransferChgSug dataSet
ProcessChgSuggestions This method updates existing transfer lines with the suggested changes from MRP. Suggested where statement for Search clause: (TFOrdDtl where) TFOrdDtl.Plant = ipPlant and TFOrdDtl.ToPlant = cur-plant and TFOrdDtl.Shipped = no and TFOrdDTl.NeedByDate less or = horizonDate Parameters Name
Type
ds
Description The TransferChgSug dataSet
TransferOrderEntry Epicor.Mfg.BO.TransferOrderEntry: This business object contains 22 methods.
GetNewTFOrdHed Inserts a new row in the DataSet with defaults populated.
GetNewTFOrdHedAttch Inserts a new row in the DataSet with defaults populated.
GetNewTFOrdDtl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2200
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record
Epicor 9.05 | 9.05.605
2201
S-Z
Business Object Reference Guide
• QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeFromPlant Sets the transfer ship via code base on fromplant Parameters Name ds
Type
Description The TransferOrderEntry dataSet
ChangeSellingQty This method is to be called when the Selling Quantity field changes
2202
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ds
Transfer Order Entry Dataset
ChangeSellingQtyUOM This method is to be called when the Selling Quantity UOM field changes Parameters Name
Type
Description
ds
Transfer Order Entry Dataset
GetListCustom Custom GetList method. Retrieves records based on a delimited list of Contract Numbers. Parameters Name
Type
Description
transferOrderList
String
The Transfer Order List
pageSize
Int32
The pageSize
absolutePage
Int32
The absolutePage
morePages
Boolean@
The morePages
Returns The Transfer Order list data set
GetNewTFOrdDtlOrdNum This method is to override the standard GetNewTFOrdDtl method since TFOrdDtl needs to be passed in and that is no longer the primary key. Parameters Name
Type
ds tfOrdNum
Description The TransferOrderEntry dataSet
String
Transfer Order Number
GetRowsCustom Custom GetList method. Retrieves records based on a delimited list of Contract Numbers.
Epicor 9.05 | 9.05.605
2203
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
transferOrderList
String
The Transfer Order number list
pageSize
Int32
The pageSize
absolutePage
Int32
The absolutePage
morePages
Boolean@
The morePages
Returns The Transfer Order data set
GetTransferShipDate Sets the transfer ship date base on fromplant, toplant, and needbydate. It's calculated using the needby date and subtracting the transfers days held in the PltTranDef Table. Parameters Name
Type
ds
Description The Transfer Order data set
OnChangePartNum This method is to be called when the Part Number field changes Parameters Name
Type
Description
partNum
String@
Part Number
ds
Transfer Order Entry Dataset
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
TransferWorkBench Epicor.Mfg.BO.TransferWorkBench: This business object contains 20 methods.
GetNewTFOrdDtl Inserts a new row in the DataSet with defaults populated.
2204
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
2205
S-Z
Business Object Reference Guide
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find
2206
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
• QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetTransferShipDate Sets the transfer ship date base on fromplant, toplant, and needbydate. It's calculated using the needby date and subtracting the transfers days held in the PltTranDef Table. Parameters Name
Type
ds
Description Transfer WorkBench Dataset
OnChangeFirmSuggestion This method is called when the Firm checkbox changes Parameters Name
Type
ds
Description Transfer WorkBench Dataset
OnChangePartNum This method is to be called when the Part Number field changes Parameters Name
Type
ds
Description Transfer WorkBench Dataset
partNum
String@
Part Number
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
Epicor 9.05 | 9.05.605
2207
S-Z
Business Object Reference Guide
Name
Type
Description
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
OnChangeQtyValue This method is called when the Quantity or Quantity UOM changes to convert quantities. Parameters Name
Type
Description
ds
Transfer WorkBench Dataset
OnChangingPlant Parameters Name
Type
Description
plantID
String
PlantID
success
Boolean@
Success
ProcessNewSuggestions This method converts unfirm to firm requirements, creates transfer orders . The suggested where clause: where TFOrdDtl.Plant = ipPlant and TFOrdDtl.ToPlant = cur-plant and TFOrdDtl.NeedByDate less or = horizonDate and TFOrdDtl.TFOrdNum = "":U and TFOrdDtl.Shipped = no Parameters Name
Type
ds
Description The TransferWorkBench dataSet
SetDefaultShipVia This method is to be called when the CreateOrder field changes Parameters Name ds
2208
Type
Description Transfer WorkBench Dataset
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
TransOrderReceipt Epicor.Mfg.BO.TransOrderReceipt: This business object contains 23 methods.
GetNewTFShipHead Inserts a new row in the DataSet with defaults populated.
GetNewTFShipDtl Inserts a new row in the DataSet with defaults populated.
GetNewPlantTran Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
2209
S-Z
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangePlantTranAssemblySeq This methods updates fields associated with PlantTran.AssemblySeq field. This method should run when the PlantTran.AssemblySeq field changes. Parameters Name
Type
Description
tranNum
Int32
Transaction line to check
ipProposedAssemblySeq
Int32
The new proposed PlantTran.AssemblySeq value
ds
The Transfer Order Shipment data set
ChangePlantTranJobMtl This methods assigns fields associated with PlantTran.JobMtl changing. This method should run before the PlantTran.JobMtl field changes. Parameters Name
Type
Description
tranNum
Int32
Transaction line to check
ds
The Transfer Order Shipment data set
ChangePlantTranJobNum This methods assigns fields associated with PlantTran.JobNum changing. This method should run before the PlantTran.JobNum field changes. Parameters
2210
Name
Type
Description
tranNum
Int32
Transaction line to check
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
S-Z
Type
ds
Description The Transfer Order Shipment data set
ChangePlantTranReceivedTo This methods updates fields associated with PlantTran.ReceiveTo field. This method should run when the PlantTran.ReceiveTo field changes. Parameters Name
Type
Description
tranNum
Int32
Transaction line to check
ipProposedReceiveTo
String
The new proposed PlantTran.ReceiveTo value (values: STOCK or JOB)
ds
The Transfer Order Shipment data set
ChangePlantTranReceivedToBinNum This methods changes the BinNumDescription when changing the PlantTran.BinNum This method should run before the PlantTran.BinNum field changes. Parameters Name
Type
Description
tranNum
Int32
Transaction line to check
ds
The Transfer Order Shipment data set
ChangePlantTranReceivedToWhseCode This methods changes the ReceiveToBinNum when changing the PlantTran.ReceiveToWhseCode This method should run before the PlantTran.ReceiveToWhseCode field changes. Parameters Name
Type
Description
tranNum
Int32
Transaction line to check
ipProposedWhseCode
String
The new proposed PlantTran.WhseCode value
ds
The Transfer Order Shipment data set
CheckPlantTranJobMtl This methods validates the JobMtl when changing the PlantTran.JobMtl This method should run before the PlantTran.JobMtl field changes.
Epicor 9.05 | 9.05.605
2211
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
tranNum
Int32
Transaction line to check
ipProposedJobMtl
Int32
The new proposed PlantTran.JobMtl value
ds
The Transfer Order Shipment data set
CheckPlantTranJobNum This methods validates the JobNum when changing the PlantTran.JobNum This method should run before the PlantTran.JobNum field changes. Parameters Name
Type
Description
tranNum
Int32
Transaction line to check
ipProposedJobNum
String
The new proposed PlantTran.JobNum value
ds
The Transfer Order Shipment data set
CheckPlantTranReceivedToBinNum This methods validates the BinNum when changing the PlantTran.BinNum This method should run before the PlantTran.BinNum field changes. Parameters Name
Type
Description
tranNum
Int32
Transaction line to check
ipProposedBinNum
String
The new proposed PlantTran.BinNum value
ds
The Transfer Order Shipment data set
CustomUpdate This is a custom version of the standard Update method. Parameters Name
Type
ds opLegalNumberMessage
Description The TransOrderReceipt data set
String@
The legal number message to display
GetListBasicSearch Returns the Transfer Orders as the GetList does but filtering them out by received or unreceived ones.
2212
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
received
Boolean
Flag to specify if we want to return Received Transfer Orders, false to return the Unreceived ones.
pageSize
Int32
Number of records to retrieve.
absolutePage
Int32
Page Number.
morePages
Boolean@
Output parameter to know if there are more pages to display.
Returns The TransOrderReceipt list data set
GetSelectSerialNumbersParams Parameters Name
Type
Description
ipPartNum
String
ipPartNum
ipQuantity
Decimal
ipQuantity
ipUOM
String
ipUOM
ipOrderNum
String
ipOrderNum
ipOrderLine
Int32
ipOrderLine
ipPackSlip
Int32
ipPackSlip
ipPackSlipLine
Int32
ipPackSlipLine
ipReceivedTo
String
ipReceivedTo
Returns
GetTransferOrders Returns the Transfer Orders as the GetRows does but filtering them out by received or unreceived ones. Parameters Name
Type
Description
received
Boolean
Flag to specify if we want to return Received Transfer Orders, false to return the Unreceived ones.
whereClauseTFShipHead
String
Where clause to filter the TFShipHead table.
whereClauseTFShipDtl
String
Where clause to filter the TFShipDtl table.
whereClausePlantTran
String
Where clause to filter the PlantTran table.
whereClauseLegalNumGenOpts
String
Where clause to filter the LegalNumGenOpts table.
whereClauseSelectedSerialNumbers String
Where clause to filter the SelectedSerialNumbers table.
whereClauseSNFormat
Where clause to filter the SNFormat table.
Epicor 9.05 | 9.05.605
String
2213
S-Z
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
Number of records to retrieve.
absolutePage
Int32
Page Number.
morePages
Boolean@
Output parameter to know if there are more pages to display.
Returns The TransOrderReceipt data set
PreUpdate This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds requiresUserInput
Description The TransOrderReceipt data set
Boolean@
Indicates if the legal number requires user input
TransOrderShip Epicor.Mfg.BO.TransOrderShip: This business object contains 82 methods.
GetNewTFShipHead Inserts a new row in the DataSet with defaults populated.
GetNewTFShipHeadAttch Inserts a new row in the DataSet with defaults populated.
GetNewTFShipDtl Inserts a new row in the DataSet with defaults populated.
GetNewShipCOO Inserts a new row in the DataSet with defaults populated.
GetNewTFShipUPS Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
2214
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field.
Epicor 9.05 | 9.05.605
2215
S-Z
Business Object Reference Guide
Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
NegativeInventoryTest To test on hand quantity of the bin - i.e. whether it will go negative. Call this method on change of Quantity. Parameters Name
Type
Description
pcPartNum
String
Part Number
pcWhseCode
String
Warehouse Code
pcBinNum
String
Bin Number
pcLotNum
String
Lot Number
pcDimCode
String
From UNIT OF MEASURE (old Dimension Code)
pdDimConvFactor
Decimal
Obsolete Dimension Conversion Factor
pdTranQty
Decimal
Quantity (in stocking uom)
pcNeqQtyAction
String@
Valid values are STOP, NONE or ASK User. If Ask User, the user can decide to go ahead with the update even if the qty is negative
pcMessage
String@
Error message passed back from the business logic.
Returns pcNeqQtyActionpcMessage
GetAvailTranDocTypes Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
AssignLegalNumber Assigns a legal number to the subcontract shipment.
2216
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
String@
Legal number message
ds opLegalNumMsg Returns The Subcontract Shipment data set
CalculateWeight calculate the weight of a carton based upon Part.Weight. Parameters Name
Type
Description
cartonNumber
Int32
Carton Number
calculatedWeight
Decimal@
Shipment weight based upon part values
ChangePackOutLotNum This methods validates PackOut.LotNum field Parameters Name
Type
Description
ds
ChangeStatus This method will be called to perform a change in the header status. Parameters Name
Type
Description
ipShipHedRowID
String
Unique Identifier for the Transfer Order Shipment
ipStatus
String
Selected Status. Valid Options: Open, Close, Void, UnVoid, Freight, UnFreight, Stage
Returns
ChangeTFOrdDtlLotNum This methods creates PartLot record if criteria is met in CheckTFOrdDtlLotNum This method should run when the TFOrdDtl.LotNum field changes AND after the running of CheckTFOrdDtlLotNum (which potentially returns questions/errors).
Epicor 9.05 | 9.05.605
2217
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
ChangeTFOrdDtlOurStockQty This methods updates fields associated with TFOrdDtl.OurStockQty. This method should run when the TFORdDtl.DisplayShipQty field changes. Parameters Name
Type
Description
ipProposedOurStockQty
Decimal
The new proposed TFOrdDtl.DisplayShipQty value
ds
ChangeTFOrdDtlOurStockQtyUOM This methods updates fields associated with TFOrdDtl.OurStockQty. This method should run when the TFORdDtl.SellingQtyUOM field changes. Parameters Name
Type
Description
ipProposedSellingQtyUOM
String
The new proposed TFOrdDtl.SellingQtyUOM value
ds
Transfer Direct Order Dataset
ChangeTFOrdDtlPartNum This method defaults fields associated with the partnum. This method should run when the TFOrdDtl.PartNum field changes. Parameters Name
Type
Description
ds
ChangeTFOrdDtlWarehouseCode This methods updates fields associated with TFOrdDtl.WarehouseCode. This method should run when the TFOrdDtl.WarehouseCode field changes. Parameters Name
Type
Description
ipProposedWarehouseCode
String
The new proposed TFOrdDtl.WarehouseCode value
ds
2218
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ChangeTFShipDtlLotNum This methods creates PartLot record if criteria is met in CheckTFShipDtlLotNum This method should run when the TFShipDtl.LotNum field changes AND after the running of CheckTFShipDtlLotNum (which potentially returns questions/errors). Parameters Name
Type
Description
ds
ChangeTFShipDtlOurStockShippedQty This methods updates fields associated with TFShipDtl.OurStockShippedQty. This method should run when the TFShipDtl.DisplayShipQty field changes. Parameters Name
Type
Description
packNum
Int32
Pack Number to be modified
packLine
Int32
Pack Line to be modified
ipProposedOurStockShippedQty
Decimal
The new proposed TFShipDtl.DisplayShipQty value
outMessage
String@
negative quantity message
outNegQtyAction
String@
action that needs to be taken if the quantity is negative
outNetWeight
Decimal@
total weight based upon part
ds
ChangeTFShipDtlPartNum This method defaults fields associated with the partnum. This method should run when the TFShipDtl.PartNum field changes. Parameters Name
Type
Description
ds
ChangeTFShipDtlTFOrderLine This methods updates TFShipDtl.ShippedQty if criteria is met in CheckTFShipDtlTFOrderLine This method should run when the TFShipDtl.TFOrdLine field changes AND after the running of CheckTFShipDtlTFOrderline (which potentially returns errors).
Epicor 9.05 | 9.05.605
2219
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
ChangeTFShipDtlTFOrderNum This methods validates the TFShipDtl.TFOrdNum field and updates associated fields. This method should run when the TFShipDtl.TFOrdNum field changes. Parameters Name
Type
Description
ipProposedTFOrdNum
String
The new proposed TFShipDtl.TFOrdNum value
ds
ChangeTFShipDtlWarehouseCode This methods updates fields associated with TFShipDtl.WarehouseCode. This method should run when the TFShipDtl.WarehouseCode field changes. Parameters Name
Type
Description
packNum
Int32
Pack Number to be modified
packLine
Int32
Pack Line to be modified
ipProposedWarehouseCode
String
The new proposed TFShipDtl.WarehouseCode value
ds
CheckDirectOrderLine This method is to be run before the CreateDirectOrderLine. Any message returned needs to be displayed to the user. If they answer no to any the messages then don't run the CreateDirectOrderLine method. Parameters Name
Type
Description
String@
If overriding allocations, ask user if they want to continue
ds allocationMessage
CheckOHQ This method is to be run before the CreateDirectOrderLine check the on hand quantity of the part. It will return a message in inventoryMessage if the on hand quantity is less than zero. If inventory message isn't null, then it needs to be displayed to the user. If they answer no to the question then don't run the CreateDirectOrderLine method.
2220
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
String@
If the inventory will go negative, ask user if they want to continue
ds inventoryMessage
CheckPackOutBinNum This methods validates PackOut.BinNum field Parameters Name
Type
ipBinNum ds
Description The new proposed BinNum value
String
CheckPackOutLotNum This methods validates PackOut.LotNum field Parameters Name
Type
ipLotNum
Description The new proposed LotNum value
vMsgText
String
Ouput Error Text value
vMsgType
String@
Output Error Type value
ds
String@
CheckPackOutOrderLine This methods validates PackOut.OrderLine field Parameters Name
Type
ipOrderLine ds
Description The new proposed OrderLine value
Int32
CheckPackOutPartNum This methods validates PackOut.PartNum field
Epicor 9.05 | 9.05.605
2221
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ipPartNum
The new proposed PartNum value
ds
String
CheckPackOutTFOrdNum This methods validates PackOut.TFOrdNum field Parameters Name
Type
Description
ipTFOrdNum
The new proposed TFOrdNum value
ds
String
CheckPackOutWarehousecode This methods validates PackOut.Warehousecode field Parameters Name
Type
ipWarehousecode
Description The new proposed Warehousecode value
ds
String
CheckPrePartInfo This method checks to see if there are any questions or issues with the part entered and returns a message, a part number and if any substitutes exist. Parameters Name
Type
Description
partNum
String@
The input-output part number to validate and it gets returned
vMsgText
String@
The returned message for the inputted part
vSubAvail
Boolean@
Returned flag stating if substitutes exist for this part
vMsgType
String@
Type of message returned. Values can be; "Question" (asking if they want to use the substitute part) "Warning" (Warns them that a part is onhold or runout). "Error" (Part in Inactive, or Onhold/Runout parts are not accepted in this case). "Question" is asking if they want to use the substitute part.
CheckTFOrdDtlLotNum This method checks to see if there are any questions or issues with the lotnum entered and returns a message, run this before ChangeTFOrdDtlLotNum
2222
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ipLotNum
String
The lotnum to validate
ipPartNum
String
The value of the TFOrdDtl.PartNum used to locate partlot records
vMsgText
String@
The returned message for the inputted lotnum
vMsgType
String@
Type of message returned. Values can be; "Question" (asking if they want to create new partlot) "Error" (Invalid LotNum if record doesn't exist and you don't have permissions to create new partlots) .
CheckTFShipDtl This method is to be run before update to ask the user any question that need to be answered before the record(s) can be saved. If the user answers no to any one of the questions, then the update method should not be called. Parameters Name
Type
ds
Description Transfer Order Ship data set
allocationMessage
String@
If this transaction overrides a allocation, ask user if they want to continue
CheckTFShipDtlLotNum This method checks to see if there are any questions or issues with the lotnum entered and returns a message, run this before ChangeTFShipDtlLotNum Parameters Name
Type
Description
ipLotNum
String
The lotnum to validate
ipPartNum
String
The value of the TFShipDtl.PartNum used to locate partlot records
vMsgText
String@
The returned message for the inputted lotnum
vMsgType
String@
Type of message returned. Values can be; "Question" (asking if they want to create new partlot) "Error" (Invalid LotNum if record doesn't exist and you don't have permissions to create new partlots) .
CheckTFShipDtlTFOrderLine This method validates the TFShipDtl.TFOrdLine and returns potential errors. Run this before running ChangeTFShipDtl.TFOrdLine.
Epicor 9.05 | 9.05.605
2223
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ipPackNum
Int32
The packnum value of the TFShipDtl to check
ipPackLine
Int32
The packline value of the TFShipDtl to check
ipProposedTFOrdLine
Int32
The proposed TFOrdline value
ds
ClearConvertedManifest Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to clear Manifest fields
ConvertToManifestUOM Parameters Name
Type
Description
ipPackNum
Int32
Pack Num to populate Manifest fields
ConvertUOM This method converts a qty from one UOM to another Parameters Name
Type
Description
partNum
String
Part number
baseQty
Decimal
Qty you wish to convert
baseUOM
String
UOM baseQty is specified in
convUOM
String
UOM to convert to
convQty
Decimal@
Qty converted to UOM specified in convUOM
CreateDirectOrder This method takes the the TranDirectOrder dataset and create the Transfer Order Header records. It will also create and send back a new TFShipHed record for the UI to update. The GetNewDirectOrder method must be called first.
2224
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The Transfer Order Dataset
Returns The Transfer Shipment DataSet
CreateDirectOrderLine This method takes the the TranDirectOrder dataset and creates the Transfer Order Detail record. It will also create and send back a new TFShipDtl record for the UI to update. The GetNewDirectOrderLine method must be called first. The update method to create the TFShipHed record must also be run before GetNewDirectOrderLine is called. Parameters Name
Type
Description
ipShipHeadRowID
String
Unique Identifier for the Transfer Order Shipment
ds ds1
The Transfer Order Dataset
Returns The Transfer Shipment DataSet
CreateMassShipDtl This methods creates TFShipDtl records based on the quantities remaining to be shipped from the transfer order. Parameters Name
Type
Description
packNum
Int32
Your existing packing slip number
orderNum
String
The transfer order number
ds
GetDirectOrderDS This method takes the direct transfer order number tied to the packing slip and returns the full Direct Order Dataset Parameters Name
Type
Description
tfOrdNum
String
Unique Identifier for the Transfer Order
ds
Epicor 9.05 | 9.05.605
The Transfer Order Dataset
2225
S-Z
Business Object Reference Guide
GetDirectShipDate Sets the transfer ship date base on fromplant, toplant, and needbydate. It's calculated using the needby date and subtracting the transfers days held in the PltTranDef Table. To be called when the TFOrdDtl.NeedByDate changes Parameters Name
Type
Description
ds
The Transfer Order Dataset
GetLegalNumGenOpts Returns the legal number generation options. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
opPromptForNum
Boolean@
Prompt for the number
Returns The Legal Number Generation Options dataset
GetNewDirectOrder This method creates the default empty Transfer Order Header for the user to update before calling the CreateShipmentDirectOrder (update Order, new Shipment) Parameters Name
Type
Description
ds
GetNewDirectOrderLine This method creates an empty Transfer Order Detail record for the user to update before calling the CreateShipmentDirectOrderLine (update TFOrdDtl, new tFShipDtl) This method replaces the GetNewShipDtl method for Direct Order Shipments The TFOrdHed record is sent back as well for constraint reasons Parameters Name
Type
Description
tfOrdNum
String
Transfer Order Number
needByDate
Nullable{System.DateTime}
NeedByDate
requestDate
Nullable{System.DateTime}
Ship Date
ds
2226
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetNewFromOrder This methods creates a new packing slip with header information pulled from the transfer order header. Parameters Name
Type
Description
ordNum
String
The transfer order number
ds
GetPackaging Parameters Name
Type
Description
ipPkgCode
String
package code
ds
Transfer Shipment data set
GetPackClass Parameters Name
Type
Description
ipPkgClass
String
package class
ds
Transfer Order Shipment data set
GetPayBTFlagDefaults Parameters Name
Type
ds
Description The transfer order data set
GetPOPackaging Parameters Name
Type
Description
ipPkgCode
String
package code
ds
Epicor 9.05 | 9.05.605
Transfer PackOut data set
2227
S-Z
Business Object Reference Guide
GetPOPackClass Parameters Name
Type
Description
ipPkgClass
String
package class
ds
Packout data set
GetScale Calls GetDefaultScale Parameters Name
Type
Description
workstationID
String
Workstation ID
scaleID
String@
Scale ID
GetSelectSerialNumbersParams Gets parameters required for launching Select Serial Numbers Parameters Name
Type
Description
ipPartNum
String
Part Number
ipWarehouseCode
String
Warehouse Code
ipBinNum
String
Bin Num
ipQuantity
Decimal
Quantity
ipUOM
String
UOM
ipTransType
String
TransType
ipSourceRowID
String
sourceRowID
Returns The SelectSerialNumbersParams data set
GetTranDocTypeID Sets default values when the TranDocTypeID changes Parameters Name
Type
Description
ipTranDocTypeID
String
TranDocTypeID supplied
ds
2228
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
POChangeStatus This method will be called to perform a change in the header status for the Pack Out screen. Parameters Name
Type
Description
ipStatus
String
Selected Status Valid Options: Open, Close, Void, UnVoid, Freight, UnFreight, Stage
ds
POCreateDtlList This method copies the available Order Release lines to the PackOut datatable for update Parameters Name
Type
Description
ipOrderNum
String
TFOrdNum value
ipPackNum
Int32
PackNum value
ds
Customer PackOut data set
POFindBuffer This method returns a count order of lines that match the incomming scanned criteria. If there is no unique match, logical fields are updated to que the UI as to what need to be prompted in order to find a matching order dtl. Parameters Name
Type
Description
found
Int32@
Number of matches to the entered line
rowident
String@
Rowident of unique match order dtl
ds
Customer PackOUt data set
POGetDtlList This method copies the available Carton Dtl lines to the PackOut datatable for update Parameters Name
Type
Description
ipPackNum
Int32
Carton to get the detail lines from
Epicor 9.05 | 9.05.605
2229
S-Z
Business Object Reference Guide
Returns
POGetNew This method creates a new packout record for the customer shipment packout screen Parameters Name
Type
Description
ipPackNum
Int32
Packing number
Returns
POUndo This methods simulates Undo. Parameters Name
Type
Description
ds
POUpdate This method creates a new packout record to create TFShiphed and TFshipdtl records Returns Customer Shipment data set
POUpdateHeader This methods simulates Undo. Parameters Name
Type
ds
Description PackOut Dataset
Returns TransOrderShip Dataset
PreDeleteDirectShip This method needs to be called before deleting line items. It asks the user if they want to delete the TFOrdDtl as well as the TFShipDtl. Parameters
2230
Name
Type
Description
packNum
Int32
Pack number.
packLine
Int32
Pack line number.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
cMessage
String@
Message for the user. Null if no question needs to be asked.
SetUPSQVEnable Parameters Name
Type
Description
ipQVEnable
Boolean
logical indicating if the quantum view is to enabled/disabled
ds
The transfer order data set
SetUPSQVShipStatus Parameters Name
Type
Description
ipShipStatus
String
Shipment status
ds
The transfer shipment data set
ShipPackingSlip This methods assigns the TFShipHead.Shipped field and updates/creates all of the associated records (partbin, parttran, tfordhed, etc.) when a Packing Slip is shipped. Parameters Name
Type
Description
ipTFShipHeadRowid
String
The rowid of the TFShipHead to ship
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
Returns
UnShipPackingSlip This methods assigns the TFShipHead.Shipped field and updates/deletes all of the associated records (parttran) when a Packing Slip is unshipped. Also potentially creates partbin and partdtl records. Parameters Name
Type
Description
ipTFShipHeadRowid
String
The rowid of the TFShipHead to unship
ipReturn
Boolean
Logical used to determine if you would like the dataset refreshed and brought back.
Epicor 9.05 | 9.05.605
2231
S-Z
Business Object Reference Guide
Returns
ValidateBinCode Parameters Name
Type
Description
ipWhse
String
Warehouse code used to edit bin
ipBinNum
String
Bin Code to validate
ValidatePartNum Parameters Name
Type
Description
ipPartNum
String
Part Number
ValidateSN Validates that a single serial number is valid for this transaction Parameters Name
Type
Description
ds
The TransOrderShip data set
ds1
The TranDirectOrder data set
ds2
The Packout data set
serialNumber
String
Serial number to validate.
isVoided
Boolean@
Serial Number Voided flag
VoidLegalNumber Voids the legal number. Parameters Name
Type
Description
ipPackNum
Int32
Packing Slip number
ipVoidedReason
String
Reason for the void
Returns The Subcontract Shipment data set
2232
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
WarnNegativeBinOH Parameters Name
Type
Description
ipBinNum
String
The new proposed TFShipDtl.BinNum value
outMessage
String@
The output Message value
outNegQtyAction
String@
The output Action value
ds
WarnNegativeLotOH Parameters Name
Type
Description
packNum
Int32
Pack Number to be modified
packLine
Int32
Pack Line to be modified
ipLotNum
String
The new proposed TFShipDtl.LotNum value
outMessage
String@
The output Message value
outNegQtyAction
String@
The output Action value
ds
isSerialTracked Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
TransSugSearch Epicor.Mfg.BO.TransSugSearch: This business object contains 1 methods.
GetSugList Get a list of all (changed and new) transfer order suggestions.
Epicor 9.05 | 9.05.605
2233
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
includeNew
Boolean
Include suggestions from TFOrdDtl.
includeOld
Boolean
Include suggestions from TFOrdSug.
plant
String
Plant for the search filter.
horizonDate
String
Horizon date for the search filter.
columnName
String
Column name (Part or Part Descriotion) for the search filter.
columnValue
String
Column value for the search filter.
pageSize
Int32
Size of a page
absolutePage
Int32
The absolute page
morePages
Boolean@
Indicating if there are more pages after this batch
Returns TransSugSearchDataSet
2234
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Chapter 21: U UD01 Epicor.Mfg.BO.UD01: This business object contains 9 methods.
GetNewUD01 Inserts a new row in the DataSet with defaults populated.
GetNewUD01Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
2235
S-Z
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD01 Get new for UD01. Parameters Name
Type
ds
Description User Defined Table1 Data set
UD02 Epicor.Mfg.BO.UD02: This business object contains 9 methods.
GetNewUD02 Inserts a new row in the DataSet with defaults populated.
GetNewUD02Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2236
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD02 Get new for UD02. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description User Defined Table2 Data set
2237
S-Z
Business Object Reference Guide
UD03 Epicor.Mfg.BO.UD03: This business object contains 9 methods.
GetNewUD03 Inserts a new row in the DataSet with defaults populated.
GetNewUD03Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2238
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD03 Get new for UD03. Parameters Name
Type
ds
Description User Defined Table3 Data set
UD04 Epicor.Mfg.BO.UD04: This business object contains 9 methods.
GetNewUD04 Inserts a new row in the DataSet with defaults populated.
GetNewUD04Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
2239
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD04 Get new for UD04. Parameters Name ds
2240
Type
Description User Defined Table4 Data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UD05 Epicor.Mfg.BO.UD05: This business object contains 9 methods.
GetNewUD05 Inserts a new row in the DataSet with defaults populated.
GetNewUD05Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2241
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD05 Get new for UD05. Parameters Name
Type
ds
Description User Defined Table5 Data set
UD06 Epicor.Mfg.BO.UD06: This business object contains 9 methods.
GetNewUD06 Inserts a new row in the DataSet with defaults populated.
GetNewUD06Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2242
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD06 Get new for UD06. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description User Defined Table6 Data set
2243
S-Z
Business Object Reference Guide
UD07 Epicor.Mfg.BO.UD07: This business object contains 9 methods.
GetNewUD07 Inserts a new row in the DataSet with defaults populated.
GetNewUD07Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2244
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD07 Get new for UD07. Parameters Name
Type
ds
Description User Defined Table7 Data set
UD08 Epicor.Mfg.BO.UD08: This business object contains 9 methods.
GetNewUD08 Inserts a new row in the DataSet with defaults populated.
GetNewUD08Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
2245
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD08 Get new for UD08. Parameters Name ds
2246
Type
Description User Defined Table8 Data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UD09 Epicor.Mfg.BO.UD09: This business object contains 9 methods.
GetNewUD09 Inserts a new row in the DataSet with defaults populated.
GetNewUD09Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2247
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD09 Get new for UD09. Parameters Name
Type
ds
Description User Defined Table9 Data set
UD10 Epicor.Mfg.BO.UD10: This business object contains 9 methods.
GetNewUD10 Inserts a new row in the DataSet with defaults populated.
GetNewUD10Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2248
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD10 Get new for UD10. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description User Defined Table10 Data set
2249
S-Z
Business Object Reference Guide
UD100 Epicor.Mfg.BO.UD100: This business object contains 11 methods.
GetNewUD100 Inserts a new row in the DataSet with defaults populated.
GetNewUD100Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD100A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
2250
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD100 Get new for UD100. Parameters Name
Type
Description
ds
User Defined Table100 Data set
GetaNewUD100a Get new for UD100A. Parameters Name
Type
ds
Description User Defined Table100 Data set
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
parentKey4
String
Parent key4
parentKey5
String
Parent key5
UD101 Epicor.Mfg.BO.UD101: This business object contains 11 methods.
GetNewUD101 Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
2251
S-Z
Business Object Reference Guide
GetNewUD101Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD101A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
2252
Type
Description The full DataSet.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD101 Get new for UD101. Returns
GetaNewUD101A Get new for UD101A. Parameters Name
Type
Description
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
parentKey4
String
Parent key4
parentKey5
String
Parent key5
ds
UD102 Epicor.Mfg.BO.UD102: This business object contains 11 methods.
GetNewUD102 Inserts a new row in the DataSet with defaults populated.
GetNewUD102Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD102A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
2253
S-Z
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD102 Get new for UD102. Parameters Name ds
2254
Type
Description User Defined Table102 Data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetaNewUD102a Get new for UD102A. Parameters Name
Type
Description
ds
User Defined Table102 Data set
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
parentKey4
String
Parent key4
parentKey5
String
Parent key5
UD103 Epicor.Mfg.BO.UD103: This business object contains 11 methods.
GetNewUD103 Inserts a new row in the DataSet with defaults populated.
GetNewUD103Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD103A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
2255
S-Z
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD103 Get new for UD103. Parameters Name
Type
Description
ds
User Defined Table103 Data set
GetaNewUD103a Get new for UD103A. Parameters Name ds
2256
Type
Description User Defined Table103 Data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
parentKey4
String
Parent key4
parentKey5
String
Parent key5
UD104 Epicor.Mfg.BO.UD104: This business object contains 11 methods.
GetNewUD104 Inserts a new row in the DataSet with defaults populated.
GetNewUD104Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD104A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
2257
S-Z
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD104 Get new for UD104. Parameters Name
Type
Description
ds
User Defined Table104 Data set
GetaNewUD104a Get new for UD104A. Parameters Name
Type
ds
2258
Description User Defined Table104 Data set
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
parentKey4
String
Parent key4
parentKey5
String
Parent key5
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UD105 Epicor.Mfg.BO.UD105: This business object contains 11 methods.
GetNewUD105 Inserts a new row in the DataSet with defaults populated.
GetNewUD105Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD105A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
2259
S-Z
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD105 Get new for UD105. Parameters Name
Type
Description
ds
User Defined Table105 Data set
GetaNewUD105a Get new for UD105A. Parameters Name
Type
ds
Description User Defined Table105 Data set
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
parentKey4
String
Parent key4
parentKey5
String
Parent key5
UD106 Epicor.Mfg.BO.UD106: This business object contains 11 methods.
GetNewUD106 Inserts a new row in the DataSet with defaults populated.
2260
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetNewUD106Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD106A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
2261
S-Z
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD106 Get new for UD106. Parameters Name
Type
Description
ds
User Defined Table106 Data set
GetaNewUD106a Get new for UD106A. Parameters Name
Type
ds
Description User Defined Table106 Data set
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
parentKey4
String
Parent key4
parentKey5
String
Parent key5
UD107 Epicor.Mfg.BO.UD107: This business object contains 11 methods.
GetNewUD107 Inserts a new row in the DataSet with defaults populated.
GetNewUD107Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD107A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
2262
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD107 Get new for UD107.
Epicor 9.05 | 9.05.605
2263
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
User Defined Table107 Data set
GetaNewUD107a Get new for UD107A. Parameters Name
Type
ds
Description User Defined Table107 Data set
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
parentKey4
String
Parent key4
parentKey5
String
Parent key5
UD108 Epicor.Mfg.BO.UD108: This business object contains 11 methods.
GetNewUD108 Inserts a new row in the DataSet with defaults populated.
GetNewUD108Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD108A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2264
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD108 Get new for UD108. Parameters Name ds
Type
Description User Defined Table108 Data set
GetaNewUD108a Get new for UD108A.
Epicor 9.05 | 9.05.605
2265
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
User Defined Table108 Data set
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
parentKey4
String
Parent key4
parentKey5
String
Parent key5
UD109 Epicor.Mfg.BO.UD109: This business object contains 11 methods.
GetNewUD109 Inserts a new row in the DataSet with defaults populated.
GetNewUD109Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD109A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2266
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD109 Get new for UD109. Parameters Name
Type
Description
ds
User Defined Table109 Data set
GetaNewUD109a Get new for UD109A. Parameters Name
Type
ds
Description User Defined Table109 Data set
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
Epicor 9.05 | 9.05.605
2267
S-Z
Business Object Reference Guide
Name
Type
Description
parentKey4
String
Parent key4
parentKey5
String
Parent key5
UD11 Epicor.Mfg.BO.UD11: This business object contains 9 methods.
GetNewUD11 Inserts a new row in the DataSet with defaults populated.
GetNewUD11Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
2268
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD11 Get new for UD11. Parameters Name
Type
ds
Description User Defined Table11 Data set
UD110 Epicor.Mfg.BO.UD110: This business object contains 11 methods.
GetNewUD110 Inserts a new row in the DataSet with defaults populated.
GetNewUD110Attch Inserts a new row in the DataSet with defaults populated.
GetNewUD110A Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
2269
S-Z
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD110 Get new for UD110. Parameters Name ds
2270
Type
Description User Defined Table110 Data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetaNewUD110a Get new for UD110A. Parameters Name
Type
Description
ds
User Defined Table110 Data set
parentKey1
String
Parent key1
parentKey2
String
Parent key2
parentKey3
String
Parent key3
parentKey4
String
Parent key4
parentKey5
String
Parent key5
UD12 Epicor.Mfg.BO.UD12: This business object contains 9 methods.
GetNewUD12 Inserts a new row in the DataSet with defaults populated.
GetNewUD12Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
Epicor 9.05 | 9.05.605
2271
S-Z
Business Object Reference Guide
Name
Type
Description
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD12 Get new for UD12. Parameters Name ds
Type
Description User Defined Table12 Data set
UD13 Epicor.Mfg.BO.UD13: This business object contains 9 methods.
GetNewUD13 Inserts a new row in the DataSet with defaults populated.
GetNewUD13Attch Inserts a new row in the DataSet with defaults populated.
2272
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
2273
S-Z
Business Object Reference Guide
GetaNewUD13 Get new for UD13. Parameters Name
Type
ds
Description User Defined Table13 Data set
UD14 Epicor.Mfg.BO.UD14: This business object contains 9 methods.
GetNewUD14 Inserts a new row in the DataSet with defaults populated.
GetNewUD14Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
2274
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD14 Get new for UD14. Parameters Name
Type
ds
Description User Defined Table14 Data set
UD15 Epicor.Mfg.BO.UD15: This business object contains 9 methods.
GetNewUD15 Inserts a new row in the DataSet with defaults populated.
GetNewUD15Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
2275
S-Z
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD15 Get new for UD15. Parameters Name ds
2276
Type
Description User Defined Table15 Data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UD16 Epicor.Mfg.BO.UD16: This business object contains 9 methods.
GetNewUD16 Inserts a new row in the DataSet with defaults populated.
GetNewUD16Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2277
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD16 Get new for UD16. Parameters Name
Type
ds
Description User Defined Table16 Data set
UD17 Epicor.Mfg.BO.UD17: This business object contains 9 methods.
GetNewUD17 Inserts a new row in the DataSet with defaults populated.
GetNewUD17Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2278
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD17 Get new for UD17. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description User Defined Table17 Data set
2279
S-Z
Business Object Reference Guide
UD18 Epicor.Mfg.BO.UD18: This business object contains 9 methods.
GetNewUD18 Inserts a new row in the DataSet with defaults populated.
GetNewUD18Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2280
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD18 Get new for UD18. Parameters Name
Type
ds
Description User Defined Table18 Data set
UD19 Epicor.Mfg.BO.UD19: This business object contains 9 methods.
GetNewUD19 Inserts a new row in the DataSet with defaults populated.
GetNewUD19Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
2281
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD19 Get new for UD19. Parameters Name ds
2282
Type
Description User Defined Table19 Data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UD20 Epicor.Mfg.BO.UD20: This business object contains 9 methods.
GetNewUD20 Inserts a new row in the DataSet with defaults populated.
GetNewUD20Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2283
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD20 Get new for UD20. Returns
UD21 Epicor.Mfg.BO.UD21: This business object contains 8 methods.
GetNewUD21 Inserts a new row in the DataSet with defaults populated.
GetNewUD21Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2284
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
UD22 Epicor.Mfg.BO.UD22: This business object contains 8 methods.
GetNewUD22 Inserts a new row in the DataSet with defaults populated.
GetNewUD22Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
2285
S-Z
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
UD23 Epicor.Mfg.BO.UD23: This business object contains 8 methods.
GetNewUD23 Inserts a new row in the DataSet with defaults populated.
GetNewUD23Attch Inserts a new row in the DataSet with defaults populated.
2286
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
2287
S-Z
Business Object Reference Guide
UD24 Epicor.Mfg.BO.UD24: This business object contains 8 methods.
GetNewUD24 Inserts a new row in the DataSet with defaults populated.
GetNewUD24Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2288
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
UD25 Epicor.Mfg.BO.UD25: This business object contains 8 methods.
GetNewUD25 Inserts a new row in the DataSet with defaults populated.
GetNewUD25Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
2289
S-Z
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
UD26 Epicor.Mfg.BO.UD26: This business object contains 8 methods.
GetNewUD26 Inserts a new row in the DataSet with defaults populated.
GetNewUD26Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2290
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
UD27 Epicor.Mfg.BO.UD27: This business object contains 8 methods.
GetNewUD27 Inserts a new row in the DataSet with defaults populated.
GetNewUD27Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
Epicor 9.05 | 9.05.605
2291
S-Z
Business Object Reference Guide
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
2292
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UD28 Epicor.Mfg.BO.UD28: This business object contains 8 methods.
GetNewUD28 Inserts a new row in the DataSet with defaults populated.
GetNewUD28Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2293
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
UD29 Epicor.Mfg.BO.UD29: This business object contains 8 methods.
GetNewUD29 Inserts a new row in the DataSet with defaults populated.
GetNewUD29Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
2294
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
UD30 Epicor.Mfg.BO.UD30: This business object contains 8 methods.
GetNewUD30 Inserts a new row in the DataSet with defaults populated.
GetNewUD30Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
Epicor 9.05 | 9.05.605
2295
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
UD31 Epicor.Mfg.BO.UD31: This business object contains 9 methods.
GetNewUD31 Inserts a new row in the DataSet with defaults populated.
GetNewUD31Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
2296
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD31 Get new for UD31.
Epicor 9.05 | 9.05.605
2297
S-Z
Business Object Reference Guide
Returns
UD32 Epicor.Mfg.BO.UD32: This business object contains 9 methods.
GetNewUD32 Inserts a new row in the DataSet with defaults populated.
GetNewUD32Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2298
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD32 Get new for UD32. Returns
UD33 Epicor.Mfg.BO.UD33: This business object contains 9 methods.
GetNewUD33 Inserts a new row in the DataSet with defaults populated.
GetNewUD33Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
2299
S-Z
Business Object Reference Guide
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD33 Get new for UD33. Returns
UD34 Epicor.Mfg.BO.UD34: This business object contains 9 methods.
GetNewUD34 Inserts a new row in the DataSet with defaults populated.
GetNewUD34Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
2300
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD34 Get new for UD34.
Epicor 9.05 | 9.05.605
2301
S-Z
Business Object Reference Guide
Returns
UD35 Epicor.Mfg.BO.UD35: This business object contains 9 methods.
GetNewUD35 Inserts a new row in the DataSet with defaults populated.
GetNewUD35Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2302
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD35 Get new for UD35. Returns
UD36 Epicor.Mfg.BO.UD36: This business object contains 9 methods.
GetNewUD36 Inserts a new row in the DataSet with defaults populated.
GetNewUD36Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
2303
S-Z
Business Object Reference Guide
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD36 Get new for UD36. Returns
UD37 Epicor.Mfg.BO.UD37: This business object contains 9 methods.
GetNewUD37 Inserts a new row in the DataSet with defaults populated.
GetNewUD37Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
2304
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD37 Get new for UD37.
Epicor 9.05 | 9.05.605
2305
S-Z
Business Object Reference Guide
Returns
UD38 Epicor.Mfg.BO.UD38: This business object contains 9 methods.
GetNewUD38 Inserts a new row in the DataSet with defaults populated.
GetNewUD38Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2306
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD38 Get new for UD38. Returns
UD39 Epicor.Mfg.BO.UD39: This business object contains 9 methods.
GetNewUD39 Inserts a new row in the DataSet with defaults populated.
GetNewUD39Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
2307
S-Z
Business Object Reference Guide
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD39 Get new for UD39. Returns
UD40 Epicor.Mfg.BO.UD40: This business object contains 9 methods.
GetNewUD40 Inserts a new row in the DataSet with defaults populated.
GetNewUD40Attch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
2308
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetaNewUD40 Get new for UD40.
Epicor 9.05 | 9.05.605
2309
S-Z
Business Object Reference Guide
Returns
UnpickTransaction Epicor.Mfg.BO.UnpickTransaction: This business object contains 23 methods. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
2310
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The dataset with list of errors occured during update process.
ChangeFromBin Validate the bin and populate description Parameters Name
Type
Description
ipProposedValue
String
Proposed Value
ds
Unpick Transaction data set
ChangeFromWhse Validate the whse and populate description Parameters Name
Type
Description
ipProposedValue
String
Proposed Value
ds
Unpick Transaction data set
ChangeJobAsm Validate the job assembly Parameters Name
Type
Description
ipProposedValue
Int32
Proposed Value
ds
Unpick Transaction data set
ChangeJobMtlSeq Validate the job mtl seqr and populate mtl data Parameters Name
Type
Description
ipProposedValue
Int32
Proposed Value
ds
Unpick Transaction data set
ChangeJobNum Validate the job number
Epicor 9.05 | 9.05.605
2311
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ipProposedValue
String
Proposed Value
ds
Unpick Transaction data set
ChangeLotNum Validate the part and set the description Parameters Name
Type
Description
ipProposedValue
String
Proposed Value
ds
Unpick Transaction data set
ChangeOrderLine Validate the order line Parameters Name
Type
Description
ipProposedValue
Int32
Proposed Value
ds
Unpick Transaction data set
ChangeOrderNum Validate the order number Parameters Name
Type
Description
ipProposedValue
Int32
Proposed Value
ds
Unpick Transaction data set
ChangeOrderRelNum Validate the order release number and populate release data Parameters Name
Type
Description
ipProposedValue
Int32
Proposed Value
opMessage
String@
Message
ds
2312
Unpick Transaction data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
ChangePartNum Validate the part and set the description Parameters Name
Type
Description
ipProposedValue
String
Proposed Value
ds
Unpick Transaction data set
ChangeTFOrdLine Validate the transfer order line number and populate line data Parameters Name
Type
Description
ipProposedValue
Int32
Proposed Value
ds
Unpick Transaction data set
ChangeTFOrdNum Validate the transfer order number Parameters Name
Type
Description
ipProposedValue
String
Proposed Value
ds
Unpick Transaction data set
ChangeToBin Validate the bin and populate description Parameters Name
Type
Description
ipProposedValue
String
Proposed Value
ds
Unpick Transaction data set
ChangeToWhse Validate the whse and populate description
Epicor 9.05 | 9.05.605
2313
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ipProposedValue
String
Proposed Value
ds
Unpick Transaction data set
GetNewUnpickTransaction Gets a new ttUnpickTransaction record Parameters Name
Type
Description
ipType
String
Type (O=Order/J=Job/T=TO)
ds
Unpick Transaction data set
PreUnpickTransaction PreUnpickTransaction - Validates unpick before any changes happen Parameters Name
Type
ds
Description Unpick Transaction data set
UnpickTransaction Unpicks a transaction 1) Validates Unpick 2) Updates PartAlloc Parameters Name ds
Type
Description Unpick Transaction data set
UOM Epicor.Mfg.BO.UOM: This business object contains 13 methods.
GetNewUOM Inserts a new row in the DataSet with defaults populated.
GetNewLangDesc Inserts a new row in the DataSet with defaults populated.
2314
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
2315
S-Z
Business Object Reference Guide
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
OnChangeAllowDecimals Execute necessary modifications when UOM.AllowDecimals is changed Parameters Name
Type
Description
proposedValue
Boolean
Proposed value for AllowDecimals
ds
The UOM data set
OnChangeNumOfDec Execute necessary modifications when UOM.NumOfDec is changed Parameters Name
Type
Description
proposedValue
Int32
Proposed value for NumOfDec
OnChangeUOMCode Do necessary modifications when UOMCode is changed Parameters Name
Type
Description
proposedValue
String
Proposed value for UOMCode
ds
The UOM data set
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
2316
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
UOMClass Epicor.Mfg.BO.UOMClass: This business object contains 13 methods.
GetNewUOMClass Inserts a new row in the DataSet with defaults populated.
GetNewUOMConv Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2317
S-Z
Business Object Reference Guide
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeAllowDecimal This method should be called when AllowDecimal changes. Parameters Name
Type
Description
uomClassID
String
UOMClassID
uomCode
String
UOMCode
newAllowDec
Boolean
Proposed value for AllowDec
ds
UOMClass data set.
OnChangeBaseUOM This method should be called when Base UOM changes. Parameters Name
Type
Description
uomClassID
String
UOMClassID.
uomCode
String
Old UOMCode
newBaseUOM
Boolean
Proposed BaseUOMCode
ds
UOMClass data set.
OnChangeClassType This method should be called when the ClassType changes. Parameters Name
Type
Description
uomClassID
String
UOMClassID.
newClassType
String
Proposed ClassType.
ds
2318
UOMClass data set.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
OnChangeUOMCode Called when the UOMCode is changed when creating a new UOMConv Record. Refreshes UOMConv.UOMDesc Fractions UOMSymbol AllowDecimals NumOfDec Rounding Parameters Name
Type
Description
uomCode
String
Proposed UOMCode.
ds
UOMClass data set.
GetCodeDescList An override to the standard GetCodeDescList Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
UOMSearch Epicor.Mfg.BO.UOMSearch: This business object contains 0 methods.
UOMStkSearch Epicor.Mfg.BO.UOMStkSearch: This business object contains 0 methods.
UserCodes Epicor.Mfg.BO.UserCodes: This business object contains 8 methods.
GetNewUDCodeType Inserts a new row in the DataSet with defaults populated.
GetNewUDCodes Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
2319
S-Z
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
UserCompSearch Epicor.Mfg.BO.UserCompSearch: This business object contains 7 methods.
GetNewUserComp Inserts a new row in the DataSet with defaults populated.
2320
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Epicor 9.05 | 9.05.605
2321
S-Z
Business Object Reference Guide
UserDefinedData Epicor.Mfg.BO.UserDefinedData: This business object contains 0 methods.
UserFile Epicor.Mfg.BO.UserFile: This business object contains 18 methods.
GetNewUserFile Inserts a new row in the DataSet with defaults populated.
GetNewUserComp Inserts a new row in the DataSet with defaults populated.
GetNewUserCompExt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
2322
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AddUserCompany This method will create a new row in the UserComp datatable related to the given UserID. Use this method instead of GetNewUserComp(), which is generated by the BL framework--so it can't be deleted--but is unusable due to its lack of input parameters. Without an input parameter for the UserID, a new row has a blank UserID and blank Company, which violates the dataset contraints. Parameters Name
Type
Description
uid
String
The UserId for which a Company will be added.
ds
The User data set
ChangePassword Implements change password logic Parameters Name
Type
Description
uid
String
User ID
currentPassword
String
current Password
newPassword
String
new Password
CheckForCompany This method is to be run when the user leaves the UserFile record. It will check to see that at least one UserComp record exists. If not the user must add one before continuing on.
Epicor 9.05 | 9.05.605
2323
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
uid
String
User ID
GetDefaults Get Defaults values by User ID Parameters Name
Type
Description
uid
String
User ID
companyID
String@
company ID
companyName
String@
company Name
plantID
String@
plant ID
plantName
String@
plant Name
GetExtCompanyList This method is to be run when the user leaves the UserFile record. It will check to see that at least one UserComp record exists. If not the user must add one before continuing on. Parameters Name
Type
Description
inAuthCompany
String
Authorized Company
extCompList
String@
List of CompanyID and ExtCompID
SaveSettings Save user settings Unlike the Update method, there is no optimistic locking performed. So the settings are saved in a last in wins basis Parameters
2324
Name
Type
uid
String
saveSettings
Boolean
curComp
String
viewFavoriteBar
Boolean
viewFullTree
Boolean
viewStatusBar
Boolean
viewStatusPanelCompany
Boolean
Description
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
viewStatusPanelLanguage
Boolean
viewStatusPanelPlant
Boolean
viewStatusPanelServer
Boolean
viewStatusPanelUserID
Boolean
viewStatusPanelWorkstationID
Boolean
winX
Int32
winY
Int32
winWidth
Int32
winHeight
Int32
listViewMode
Int32
curMenuID
String
plantID
String
workstationID
String
curFolderSeq
Int32
maxGroupsFavorites
Int32
maxGroupsSystemMenu
Int32
Description
Check payroll rights for current user and company
IsPasswordExpired Check if password is expired Parameters Name
Type
Description
uid
String
User ID
graceCount
Int32@
grace Count
Name
Type
Description
uid
String
User ID
password
String
Password
ValidatePassword Check if password is valid Parameters
Epicor 9.05 | 9.05.605
2325
S-Z
Business Object Reference Guide
Chapter 22: V VATTax Epicor.Mfg.BO.VATTax: This business object contains 16 methods.
GetNewTaxReport Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2326
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckDates Check Dates, return any warnings Parameters Name
Type
ds
Description Vat Tax data set
ipReportID
String
Report ID
cMessageText
String@
Warning messages
InitializeTaxRptDtl Call this method to manually refresh the TaxRptDtl records. This should be called after calling PreInitTaxRptDtl method and the user answered yes to to the output message of the PreInitTaxRptDtl if any. Parameters Name
Type
Description
ipReportID
String
The VAT Tax Report ID.
opErrlog
String@
Error log resulting of the operation
MexProcess Run Mexico Vat query and returns total values. Parameters Name ds
Type
Description VATTAXDataSet
PostReport To post the tax report, for a user selected tttaxreport record where taxreport.posted = no
Epicor 9.05 | 9.05.605
2327
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
inputReportDate
Nullable{System.DateTime} ReportDate(default to tttaxreport.reportdate, can be overridden).
inputReportID
String
report id of report to be posted.
inputUpdTaxRptDtl
Boolean
Indicates if the TaxRptDtl will be updated or not.
Returns VatTax DataSet
PreInitTaxRptDtl Call this method to check if there are TaxRptDtl records that have been manually updated or voided by the user. This is to warn them that these records will not be refreshed if they choose to continue with the InitializeTaxRptDtl method. If the opMessage is not blank then show this to the user and let the user decide whether to continue or not. If the user answers yes then call InitializeTaxRptDtl. Parameters Name
Type
Description
ipReportID
String
The VAT Tax Report ID.
opMessage
String@
Returns a warning message the user needs to respond yes or no to.
PrePostReport Call this method to check if there are TaxRptDtl records that have been manually updated or voided by the user. This is to warn them that these records will not be refreshed if they choose to continue with the InitializeTaxRptDtl method. If the opMessage is not blank then show this to the user and let the user decide whether to continue or not. If the user answers yes then call InitializeTaxRptDtl. Parameters Name
Type
Description
inputReportID
String
report id of report to be posted.
inputUpdTaxRptDtl
Boolean
Indicates if the TaxRptDtl will be updated or not.
opMessage
String@
Returns a warning message the user needs to respond yes or no to.
SetFiscalDates Fills From/To dates according selected calendar, year and period if that is possible. Parameters Name ds
2328
Type
Description VATTAXDataSet
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
TaiwanLocalizOn Returns Taiwan localization flag state. Returns True if Taiwan localization is ON
ValidateFiscalCal Validates Fiscal Calendar ID. Parameters Name
Type
ds fiscalCalID
Description VATTAXDataSet
String
The fiscal calendar ID
VBFormMap Epicor.Mfg.BO.VBFormMap: This business object contains 5 methods.
ClearVBFFormMap Method to call to clear the mapping between source and target. Parameters Name
Type
Description
sourceForm
String
The name of new VBForm.
targetForm
String
The name of current target VBForm.
ds
VB Form Map data set
GetSourceFieldComboList Method to call to get the combo list for a source field in the grid. The combolist is a "code`description" list separated by a ~. Parameters Name
Type
Description
targetField
String
The name of current target field.
targetVBForm
String
The name of current target field.
comboList
String@
Method to call to obtain the VB forms.
Epicor 9.05 | 9.05.605
2329
S-Z
Business Object Reference Guide
Returns VBForm Map Data Set
OnChangeofSourceField Method to call when he source field changes. Parameters Name
Type
Description
sourceVBForm
String
The name of Source VBForm.
targetForm
String
The name of current target VBForm.
newSourceField
String
The Source field.
targetField
String
The new target field.
ds
VBForm Map Data Set
SetVBFormMap Method to call when updating the target fields. Parameters Name
Type
Description
sourceForm
String
The new VBForm.
targetForm
String
The current target VBForm.
ds
VBForm Map Data Set
VendBankSearch Epicor.Mfg.BO.VendBankSearch: This business object contains 7 methods.
GetNewVendBank Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2330
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
VendCntSearch Epicor.Mfg.BO.VendCntSearch: This business object contains 7 methods.
GetNewVendCnt Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
Epicor 9.05 | 9.05.605
2331
S-Z
Business Object Reference Guide
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
VendGrup Epicor.Mfg.BO.VendGrup: This business object contains 8 methods.
GetNewVendGrup Inserts a new row in the DataSet with defaults populated.
2332
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetNewVendGrupAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
2333
S-Z
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
Vendor Epicor.Mfg.BO.Vendor: This business object contains 54 methods.
GetNewVendor Inserts a new row in the DataSet with defaults populated.
GetNewVendorAttch Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewTaxExempt Inserts a new row in the DataSet with defaults populated.
GetNewVendRestriction Inserts a new row in the DataSet with defaults populated.
GetNewVendBank Inserts a new row in the DataSet with defaults populated.
GetNewVendBankAttch Inserts a new row in the DataSet with defaults populated.
GetNewVendCntMain Inserts a new row in the DataSet with defaults populated.
GetNewVenMFBill Inserts a new row in the DataSet with defaults populated.
GetNewVendorPP Inserts a new row in the DataSet with defaults populated.
GetNewVenPPMFBill Inserts a new row in the DataSet with defaults populated.
GetNewVenPPUPSEmail Inserts a new row in the DataSet with defaults populated.
2334
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetNewVendPPRestriction Inserts a new row in the DataSet with defaults populated.
GetNewVendCnt Inserts a new row in the DataSet with defaults populated.
GetNewVendCntAttch Inserts a new row in the DataSet with defaults populated.
GetNewVenUPSEmail Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Epicor 9.05 | 9.05.605
2335
S-Z
Business Object Reference Guide
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
GetvendorGlobalFields To return the list of fields that are maintained by the "Master/Owner" of global record. The client can use this list to disable these fields on the UI.
GetvendorPPGlobalFields To return the list of fields that are maintained by the "Master/Owner" of global record. The client can use this list to disable these fields on the UI.
GetvendCntGlobalFields To return the list of fields that are maintained by the "Master/Owner" of global record. The client can use this list to disable these fields on the UI.
ChangeBankBranchCode Check if the Bank Branch code changed. Parameters
2336
Name
Type
Description
proposedBankBranchCode
String
The proposed Bank Branch code
Epicor 9.05 | 9.05.605
Business Object Reference Guide
Name
S-Z
Type
ds
Description Vendor data set
ChangeCalendar Change Calendar for new and updated vendors Parameters Name
Type
Description
ic_CalendarID
String
Calendar Code
ds
Vendor Data Set
ChangeTaxRegion This method validates TaxRegionCode and populates description for supplier. Parameters Name
Type
Description
iProposedTaxRgnCode
String
The proposed TaxCode value
ds
The Vendor data set
ChangeVendCountry Method to change related fields to the county. Run when the country changes. Parameters Name
Type
Description
i_CountryNum
Int32
Country Number
ds
Vendor Data Set
ChangeVendGlobalVendor Method to call when changing the global vendor flag on a vendor. Assigns the GlbFlag base on the new value. Parameters Name
Type
Description
proposedGlobalVendor
Boolean
The proposed global vendor value
ds
Epicor 9.05 | 9.05.605
The Vendor data set
2337
S-Z
Business Object Reference Guide
ChangeVendICTrader Method to call when changing the ICTrader flag on a vendor. Assigns the EnableGlobalVendor based on the new value. Parameters Name
Type
Description
proposedICTrader
Boolean
The proposed ICTrader value
ds
The Vendor data set
ChangeVendPPCountry Method to change related fields to the county. Run when the country changes. Parameters Name
Type
Description
i_CountryNum
Int32
Country Number
ds
The Vendor data set
CheckVATFormat This method test the validity of the VAT format Parameters Name
Type
Description
opMessage
String@
Message to display to user if not null
ds
The Vendor data set
DefaultName If the Vendor Contact name is updated this method will parse the name into firstname middlename and lastname fields. If one of the name components is updated the components will be assembled into the Vendor Contact name field The contact must exist in the database before this method can be run. This means that the update method must be run first. The rowmod column must be set to 'U' in order for the method to process the record. This procedure passes a dataset in and out, Parameters Name
Type
Description
targetField
String
Indicates which fields to populate either "Detail" or "Name"
ds
2338
The Vendor data set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
EnablePriceList This method checks to see if the price list option should be enabled or not based on security rights. Parameters Name
Type
Description
lEnablePriceList
Boolean@
Enable price list option
GetAddrElementList This method calculates Address Element List Parameters Name
Type
Description
addrElementList
String@
Address Element List
GetByVendID Get vendor by ID Parameters Name
Type
Description
vendorID
String
Vendor ID
Returns The Vendor data set
GetGlbVendorList This method returns the GlbVendor dataset based on a delimited list of GlbVendorNum values passed in. If GlbVendor.VendorNum = -1 that means the record has been skipped and should be shown at the bottom of the browser. (GlbVendor only) Parameters Name
Type
Description
glbVendorNumList
String
Delimited list of GlbVendorNum values
Returns Global Vendor Data Set
GetPerConData Gets the person contact information.
Epicor 9.05 | 9.05.605
2339
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
targetTable
String
The table to fill with the PerCon data. Use empty string to fill all contact tables.
perConID
Int32
Person Contact ID
ds
Supplier DataSet
GetVendorForLink This returns the Vendor dataset for linking. Parameters Name
Type
Description
vendorID
String
LinkVendorID field on the GlbVendor record to link
Returns Global Vendor Data Set
GetVendorPPForLink This returns the VendorPP record in the Vendor dataset for linking. Parameters Name
Type
Description
vendorID
String
vendorID field on the GlbVendor record
purPoint
String
LinkPurPoint field on the GlbVendorPP record
Returns Global Vendor Data Set
GlbVendorsExist This method checks if GlbVendor records exists or not. Can be used to determine if the option to link/unlink vendors is available. Parameters Name
Type
Description
glbVendorsExist
Boolean@
Yes - they do exist; No - they do not exist
LinkGlbVendCnt This method performs the actual logic to link VendCnt records for a linked vendor. It will only allow VendCnt's of linked vendors to be processed, otherwise an exception will be raised. The ability to link VendCnt's for a linked Vendor should be offered immediately after performing the update method on a Linked Vendor or a Linked Purchase Point but it does not have to be limited to that time only. If the Contact is for a VendCnt that already
2340
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
exists, the GlbVendCnt information is translated and then copied to the VendorDataSet as an update. If the Contact is for a new Vendor or Purchase Point, the GlbVendCnt information is translated and then copied to the VendorDataSet as an Add. Until the update method is run on the Contact record the Link process is not completed. If this link is for a contact on the Vendor, the contact data in the VendorDataSet will be returned in the VendCntMain datatable. If it is for a purchase point, the data will returned in the VendCnt datatable. This is determined by the value of glbPurPoint. If it is blank, it is processed as a contact for the vendor; otherwise it is process as a contact for the purchase point. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbVendorPP record to link
glbVendorNum
Int32
Global VendorNum field on the GlbVendCnt record to link
glbPurPoint
String
Global PurPoint field on the GlbVendCnt record to link
glbConNum
Int32
Global Contact Number field on the GlbVendCnt record to link
ds
Global Vendor Data Set
Returns The Vendor data set
LinkGlbVendor This method performs the actual logic behind linking a Vendor. It is run after the PreLinkGlbVendor method which determines the Vendor ID to link to. If the Vendor Id is for a Vendor that already exists, the GlbVendor information is translated and then copied to the VendorDataSet as an update. If the Vendor ID is for a new Vendor, the GlbVendor information is translated and then copied to the VendorDataSet as an Add. Until the update method is run on Vendor record the Link process is not completed. Once the Vendor record has been linked, the GlbVendorPP and GlbVendCnt records needs to be offered up to be linked as well. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbVendor record to link
glbVendorNum
Int32
Global VendorNum field on the GlbVendor record to link
ds
Global Vendor Data Set
ds1
Vendor Data Set
LinkGlbVendorPP This method performs the actual logic to link VendorPP records for a linked vendor. It will only allow VendorPP's of linked vendors to be processed, otherwise an exception will be raised. The ability to link VendorPP's for a linked Vendor should be offered immediately after performing the update method on a Linked Vendor but it does not have to be limited to that time only. It is run after the PreLinkGlbVendorPP method which determines the PurPoint to link to. If the PurPoint is for a VendorPP that already exists, the GlbVendorPP information is translated and then copied to the VendorDataSet as an update. If the PurPoint is for a new VendorPP, the GlbVendorPP information is translated and then copied to the VendorDataSet as an Add. Until the update method is run on the VendorPP record the Link process is not completed. Once the VendorPP record has been linked, the GlbVendCnt records need to be offered up to be linked as well.
Epicor 9.05 | 9.05.605
2341
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbVendorPP record to link
glbVendorNum
Int32
Global VendorNum field on the GlbVendorPP record to link
glbPurPoint
String
Global PurPoint field on the GlbVendorPP record to link
ds
Global Vendor Data Set
ds1
Vendor Data Set
PreLinkGlbVendor Linking a GlbVendor record ties a global record to a new or existing Vendor record so that any changes made to the GlbVendor record in another company are automatically copied to any linked Vendors. This method performs the pre link logic to check of okay to link or get the new vendid to create/link to. Will be run before LinkGlbVendor which actually creates/updates a Vendor record and will send the modified record back for update. When the Link "button" is originally selected, the LinkVendID will be defaulted to the GlbVendorId field. It will then check to see if this ID is available for Use. If available for use the system will return a question asking the user if they want to use this number. If the answer is no, then the user either needs to select an existing Vendor's ID to link to or enter a brand new ID. You will run this method until the user answer is yes. Then the LinkGlbVendor method is called. Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbVendor record to link
glbVendorNum
Int32
Global VendorNum field on the GlbVendor record to link
ds vMessage
Global Vendor Data Set String@
Returns a message the user needs to respond yes or no to. If the user answers no, then they need to update the LinkVendorId field and then run this method again to test the new VendorId they want to link to
PreLinkGlbVendorPP Linking a GlbVendorPP record ties a global record to a new or existing Purchase Point record so that any changes made to the GlbVendorPP record in another company are automatically copied to any linked purchase points. This method performs the pre link logic to check of okay to link or get the new PurPoint to create/link to. Will be run before LinkGlbVendorPP which actually creates/updates a purchase point record and will send the modified record back for update. When the Link "button" is originally selected, the LinkPurPoint will be defaulted to the glbPurPoint field. It will then check to see if this ID is available for use. If available for use the system will return a question asking the user if they want to use this number. If the answer is no, then the user either needs to select an existing PurPoint for the current customer to link to or enter a brand new PurPoint for the vendor. You will run this method until the user's answer is yes. Then the LinkGlbVendorPP method is called. Parameters
2342
Name
Type
Description
glbCompany
String
Global Company field on the GlbVendorPP record to link
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
glbVendorNum
Int32
Global VendorNum field on the GlbVendorPP record to link
glbPurPoint
String
Global PurPoint field on the GlbVendorPP record to link
ds vMessage
Global Vendor Data Set String@
Returns a message the user needs to respond yes or no to. If the user answers no, then they need to update the LinkPurPoint field and then run this method again to test the new PurPoint they want to link to
ResetPPIntl Parameters Name
Type
ds
Description The customer data set
SetUPSQVEnable Parameters Name
Type
Description
ipQVEnable
Boolean
logical indicating if the quantum view is to enabled/disabled
ipUpdVenUPS
Boolean
Yes, if the VenUPSEmail table is to be updated
ipUPDVenPPUPS
Boolean
Yes, if the VenUPSPPEmail talbe is to be updated
ds
The Vendor data set
SkipGlbVendor This method performs the logic behind the skip option for GlbVendor Skip - marks the VendorNum field with a -1 to move the record to the bottom of the list if the VendorNum field is not 0 will error out Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbVendor record to skip
glbVendorNum
Int32
Global VendorNum field on the GlbVendor record to skip
ds
Global Vendor Data Set
UnlinkGlbVendor This method performs the logic behind the unlink option for GlbVendor Unlink - clears the VendorNum and VendorID field in GlbVendor. Returns the Vendor DataSet
Epicor 9.05 | 9.05.605
2343
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
glbCompany
String
Global Company field on the GlbVendor record to unlink
glbVendorNum
Int32
Global VendorNum field on the GlbVendor record to unlink
ds
Global Vendor Data Set
Returns Vendor Data Set
ValidatePayBTFlag Parameters Name
Type
Description
ipPayBTFlag
String
requested pay bt flag to edit
ipValVen
Boolean
logical indicating if the pay flag on the venMFBill is to be checked
ipValVenPP
Boolean
logical indicating if the pay flag on the venPPMFBill is to be checked
ipVendorNum
Int32
Vendor Number
ipPurPoint
String
Purchase Point
VendorBankExists This method checks vendor bank existence. Parameters Name
Type
Description
vendorNum
Int32
Vendor Number
vendBankExists
Boolean@
True if vendor bank existence
VendorAging Epicor.Mfg.BO.VendorAging: This business object contains 1 methods.
GenerateVendorAging This method should be called to populate the dataset for the Vendor Aging Tracker. Parameters
2344
Name
Type
Description
vendID
String
Vendor ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns Vendor aging tracker data set
VendorPPSearch Epicor.Mfg.BO.VendorPPSearch: This business object contains 8 methods.
GetNewVendorPP Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2345
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetListForActiveSuppliers Called to retrieve Purchase Points for active vendors Parameters Name
Type
Description
whereClauseVendorPP
String
Whereclause for VendorPP table.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns Epicor.Mfg.BO.VendorPPListDataSet
VendPart Epicor.Mfg.BO.VendPart: This business object contains 28 methods.
GetNewVendPart Inserts a new row in the DataSet with defaults populated.
GetNewVendPBrk Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
2346
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
FindPartAndGetRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
2347
S-Z
Business Object Reference Guide
FindFirstPart Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetCustNumFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
GetMfgPartFromRowID Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
ChangeAprvSupplier .
2348
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description Vendor Part Data Set
ipAprvSupplier
Boolean
Proposed part number
opExistApprovedSupplier
Boolean@
Proposed part number
ChangeConvOverride This should be called on change of VendPart.ConvOverride when false it will refresh the Conversion fields to UOM Master values. Parameters Name
Type
Description
pConvOverride
Boolean
Proposed value for ConvOverride
ds
Vendor Part Data Set
ChangeEffectiveDays Method to call when changing the EffectiveDays, EffectiveDate, or ExpirationDate changes. This method will recalculate the ExpirationDate if the EffectiveDate or EffectiveDays change; it will recaculate the EffectiveDays if the ExpirationDate changes. Parameters Name
Type
ds cFieldModified
Description The VendPart data set
String
cFieldModified indicates which field was updated. Possible values are: blank - indicates we are just getting a value for days "days" - indicates the number of days changed; recalculate expiration date "eff" - indicates effective date changed; recalculate expiration date "exp" - indicates expiration date changed; recalculate effective date
ChangeImportExportVendorID This assignes the vendor name in the SupListImpExpParams datatable. Parameters Name
Type
cProposedSupplierID
String
ds
Description
Supplier List Dataset of candidates for import
ChangePart Run this method when Part Number on the detail screen changes (copied from SO)
Epicor 9.05 | 9.05.605
2349
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
partNum
String@
Proposed PartNumber change
sysRowID
String
RowID of the selected record. Skips find part logic if this has a value.
rowType
String
RowType of the selected record. Only used with sysRowID.
uomCode
String@
UOM Code (only used for Product Codes)
serialWarning
String@
Warning message if the InvTransfer line contains serial numbers
questionString
String@
If the part is being changed to something different than what was on the order, ask if the user wants to continue
multipleMatch
Boolean@
Multiple matches were found by FindPart
ds
Vendor Part Data Set
ChangePriceModifier Method to call when changing the price modifier on the vendor part break record. Recaculates the effective price based on the new price modifier. Parameters Name
Type
ds
Description The VendPart data set
ChangeVendPartPUM This method creates a new ttVendPart record and deletes the existing one when changing this component of the primary unique index and update the VendPart.PUM. This method should run before changing the VendPart.PUM. Parameters Name
Type
ds inPUM
Description Vendor Part Data Set
String
Proposed PUM
DefaultRFQInfo This method is called when the Supplier Price List object is called from Supplier Response. After a new VendPart record has been created, this method needs to be called to default the specific RFQ information Parameters
2350
Name
Type
Description
rfqRowIDent
String
Supplier Response RowIDent
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The Vendor Part data set
ExportSupplierList This method conditionally adds/overwrites supplier part records from an import file. Parameters Name
Type
Description
ds
Supplier List Dataset of candidates for import
dtEffectiveDate
Nullable{System.DateTime}
Effective Date
cSupplierID
String
Supplier Code
GetLastEffectiveVendPart Method to get the last effective VendPart record. Parameters Name
Type
Description
iVendorNum
Int32
The Vendor Number to retrieve the dataset for
cPartNum
String
The Part Number to retrieve the dataset for
cOpCode
String
The OpCode to retrieve the dataset for
cPUM
String
The UOM to retrieve the dataset for
dtEffDate
Nullable{System.DateTime} The Date to retrieve the dataset for
Returns The VendPart data set
GetNewSupListImpExpParams This method creates a record in SupListImpExpParams. This record is used to store the import/export parameters. Parameters Name
Type
cSupplierID
String
Description
Returns Supplier List Dataset of candidates for import
GetVendorNum Method to call get a VendorNum given a VendorID.
Epicor 9.05 | 9.05.605
2351
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
cVendorID
String
The Vendor ID
iVendorNum
Int32@
The Vendor Number
GetVendPartByPart Method to call to get the dataset based on a specific part. Parameters Name
Type
Description
cPartNum
String
The Part Number to retrieve the dataset for
Returns The VendPart data set
GetVendPartByVendNumPart Method to call to get the dataset based on a specific vendor and part. Parameters Name
Type
Description
iVendorNum
Int32
The Vendor Number to retrieve the dataset for
cPartNum
String
The Part Number to retrieve the dataset for
Returns The VendPart data set
ImportSupplierList This method conditionally adds/overwrites supplier part records from an import file. Parameters Name
Type
ds
2352
Description Supplier List Dataset of candidates for import
dtEffectiveDate
Nullable{System.DateTime}
Effective Date
cSupplierID
String
Supplier Code
numRecsImported
Int32@
Output number of records from import
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
VendPartRestriction Epicor.Mfg.BO.VendPartRestriction: This business object contains 13 methods.
GetNewVendPartRestriction Inserts a new row in the DataSet with defaults populated.
GetNewVendPartRestrictSubst Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2353
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeManual Used when Manual field of VendPartRestriction is being changed to a new value. Parameters Name
Type
Description
checkManual
Boolean
Manual value
ds
The VendPartRestrictionDataset.
ChangeRestrictionSubstance This methods assigns associated fields when VendPartRestrictSubst.SubstanceID changes. Parameters Name
Type
Description
ds
VendPartRestriction dataset
ChangeRestrictionType This methods assigns associated fields when VendPartRestriction.RestrictionTypeID changes. Parameters Name
Type
Description
ds
VendPartRestriction dataset
OnChangingRestrictionType Used when RestrictionTypeID field of VendPartRestriction is being changging to a new value. Parameters
2354
Name
Type
Description
checkRestrictionTypeID
String
RestrictionTypeID value
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
ds
The VendPartRestrictionDataset.
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
VoidPayment Epicor.Mfg.BO.VoidPayment: This business object contains 12 methods.
GetNewCheckHed Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
2355
S-Z
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckDocumentIsLocked Method to call when it is necessary to check if document is lock, before doing smth. Parameters Name
Type
Description
keyValue
String
HeadNum
CheckOnScreenLoad This method is called only on first build of the screen. If the GL is not interfaced the user will get a warning asking if they'd like to continue or not. If the user answers no or any exceptions were raised, then the screen is immediately shut down and the user is sent back to the main menu. Parameters Name
Type
Description
vQuestion
String@
Warning/Continue message if GL is not interfaced
GenerateLegalNumber This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called.
2356
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds inHeadNum
Description Bank Funds Transfer data set
Int32
HeadNum of current checkhed record
GetLegalNumGenOpts This method will return a record in the LegalNumGenOpts datatable if a legal number is required for this transaction. The RequiresUserInput flag will indicate if this legal number requires input from the user. If it does, the LegalNumberPrompt business objects needs to be called to gather that information. This method should be called when the user saves the record but before the Update method is called. Parameters Name
Type
ds
Description Bank Funds Transfer data set
inHeadNum
Int32
HeadNum of current checkhed record
requiresUserInput
Boolean@
Indicates if the legal number requires user input
VoidLegalNumbersOnClose This method will void legal numbers that have been generated for checks that were not voided. This can happen if legal numbers were generated, but the user never actually voided the check(s). Parameters Name
Type
ds
Description Bank Funds Transfer data set
VoidPRCheck Epicor.Mfg.BO.VoidPRCheck: This business object contains 9 methods.
GetNewPRCheck Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
Epicor 9.05 | 9.05.605
2357
S-Z
Business Object Reference Guide
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeEmployeeID Call this method after user enters the Employee ID. Parameters Name
Type
ds pcEmployeeID
2358
Description VoidPR Check PREmpMas Data Set
String
Employee ID
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns VoidPR Check Data Set
PreVoidCheck check if interface Parameters Name
Type
Description
interfacedText
String@
Contains text of the interface message to present to the user.
Epicor 9.05 | 9.05.605
2359
S-Z
Business Object Reference Guide
Chapter 23: W Warehse Epicor.Mfg.BO.Warehse: This business object contains 22 methods.
GetNewWarehse Inserts a new row in the DataSet with defaults populated.
GetNewWarehseAttch Inserts a new row in the DataSet with defaults populated.
GetNewEntityGLC Inserts a new row in the DataSet with defaults populated.
GetNewWarehseABC Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
2360
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
CheckPlant This method is used to verify Plant on current Warehouse. Parameters Name
Type
Description
ipWarehouseCode
String
Current Warehouse Code
opMessage
String@
Message to be displayed to user if not null
CheckWhseBin This method is used to verify that a bin exists for the current warehouse. It should be called before exiting Warehouse Maintenance or before selecting a different warehouse. If a bin doesn't exist for the current warehouse then a message will be returned in the output parameter opMessage. If opMessage isn't null then the message should be displayed to the user and they shouldn't be allowed to exit Warehouse maintenance or select a different warehouse until a bin is added. Parameters Name
Type
Description
ipWarehouseCode
String
Current Warehouse Code
opMessage
String@
Message to be displayed to user if not null
ETCAfterAddrVal After the tax integration has been called, update the WareHse address if it was changed.
Epicor 9.05 | 9.05.605
2361
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
The WareHse data set
ds1
The ETCAddrValidation data set
wareHouseCode
String
WareHse.WareHouseCode
ETCValidateAddress Call tax integration and loads temp tables from the results. Parameters Name
Type
Description
wareHouseCode
String
WareHse.WareHouseCode
statusFlag
Boolean@
Set to true if the integration is up, false if down.
errorFlag
Boolean@
If true, an error occured.
errorMsg
String@
If Error Flag is true, this is the associated message.
Returns The ETCAddrValidation data set
GetListNoActiveCount Filter warehouses that do not have an active cycle count or physical inventory. Call normal GetList method. Parameters Name
Type
Description
whereClause
String
Whereclause.
pageSize
Int32
Page size.
absolutePage
Int32
Absolute page.
morePages
Boolean@
More pages.
Returns The WarehseList data set
OnChangeOfAbcCode Parameters Name
Type
ds ipABCCode
2362
Description Warehse data set
String
Warehouse ABC code
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
OnChangeOfCountFreq Parameters Name
Type
Description
ipCountFreq
Int32
Cycle Count Frequency
ipOvrrideCountFreq
Boolean
Override count frequency
OnChangeOfPcntTolerance Parameters Name
Type
Description
ipPcntTolerance
Decimal
Percentage Tolerance
OnChangeOfQtyTolerance Parameters Name
Type
Description
ipQtyTolerance
Decimal
Quantity Tolerance Value
OnChangeOfStockValPcnt Parameters Name
Type
Description
ipStockValPcnt
Decimal
Stock Value Percent
Name
Type
Description
ipValTolerance
Decimal
Value of tolerance
OnChangeOfValueTolerance Parameters
RefreshHasBins This method will refresh the bin status for each warehouse. The Warehouse can be passed in as a parameter or if left blank, the bin status will be returned for all warehouses
Epicor 9.05 | 9.05.605
2363
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
iplant
String
Plant that is to have its bin status refreshed or blank for all plants
iWarehousecode
String
Warehouse code that is to have its bin status refreshed or blank for all warehouses
Returns Warehse Data Set
WarehseSearch Epicor.Mfg.BO.WarehseSearch: This business object contains 2 methods.
GetList This method returns a list of warehouses (including shared warehouses) available for a plant. The Plant parameter allows the user to search on just one plant or leave blank to search on all plants. Parameters Name
Type
Description
vPlant
String
Plant to search the warehouses for, blank for all plants
pageSize
Int32
page Size
absolutePage
Int32
absolute Page
morePages
Boolean@
more Pages: true/false
Returns WarehseSearch DataSet
GetRows This method returns a list of warehouses (including shared warehouses) available for a plant. The Plant parameter allows the user to search on just one plant or leave blank to search on all plants. Parameters Name
Type
Description
vPlant
String
Plant to search the warehouses for, blank for all plants
pageSize
Int32
page Size
absolutePage
Int32
absolute Page
morePages
Boolean@
more Pages: true/false
Returns WarehseSearch DataSet
2364
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Warning Epicor.Mfg.BO.Warning: This business object contains 7 methods.
GetNewWarning Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
2365
S-Z
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
Wave Epicor.Mfg.BO.Wave: This business object contains 8 methods.
GetNewWave Inserts a new row in the DataSet with defaults populated.
GetNewWaveOrder Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
2366
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
WebLog Epicor.Mfg.BO.WebLog: This business object contains 7 methods.
GetNewsrmIfLog Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
2367
S-Z
Business Object Reference Guide
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
WFGroup Epicor.Mfg.BO.WFGroup: This business object contains 13 methods.
GetNewWFGroup Inserts a new row in the DataSet with defaults populated.
GetNewWFGrpMbr Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause.
2368
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
DeleteWFGrpMbr Delete WFGroup record by parameters
Epicor 9.05 | 9.05.605
2369
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
cWorkflowType
String
Work Flow Type
cWFGroupID
String
Work Flow Group Code
cSalesRepCode
String
Sales Rep Code
GetAvailTaskSets This method gets the available TaskSets for the TaskSet combo in the WFGroupEntry. Parameters Name
Type
Description
cCurrentWorkflowType
String
cCurrent Work Flow Type
newList
String@
(output) A delimited list of TaskSet IDs and descriptions
OnChangeSalesRepCode Method to call when changing the SalesRepCode. Parameters Name
Type
Description
proposedSalesRep
String
The proposed SalesRepCode
ds
The QuickEntry data set
ReassignWorkflow Reassign Work Flow Parameters Name
Type
Description
cCurrentWorkflowType
String
cCurrent Work Flow Type
cCurrentWFGroupID
String
Current Work Flow Group Code
cCurrentSalesRepCode
String
Current Sales Rep Code
cNewSalesRepCode
String
New Sales Rep Code
cReassignOption
String
Reassign Option
lReassignOpenTasks
Boolean
Reassign Open Tasks:true/false
ds
2370
Work Flow Data Set
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
WFStage Epicor.Mfg.BO.WFStage: This business object contains 8 methods.
GetNewWFStage Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
2371
S-Z
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
WhseBin Epicor.Mfg.BO.WhseBin: This business object contains 20 methods.
GetNewWhseBin Inserts a new row in the DataSet with defaults populated.
GetNewWhseBinAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2372
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
AddNewWhseBinFormat Add a New record in WhseBinFormat table Parameters Name
Type
ds
Description The WhseBinWizard data set
CommitGeneratedBins Commit to database the proposed Bin Numbers selected Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The WhseBinWizard data set
2373
S-Z
Business Object Reference Guide
GenerateBinFormat Generates the Bin format according to the segments defined Parameters Name
Type
Description
ds
The WhseBinWizard data set
GenerateBins Create Bin numbers according to the specified format Parameters Name
Type
Description
totalBins
Int32
Number of Bin Numbers to be generated
ds
The WhseBinWizard data set
OnChangeCustID OnChangeCustId Parameters Name
Type
Description
newCustID
String
Customer.CustID
ds
The WhseBin data set
OnChangeSuppID OnChangeSuppId Parameters Name
Type
Description
newVendorID
String
Vendor.VendorID
ds
The WhseBin data set
OnChangeWhseBinWizardCustId OnChangeWhseBinWizardCustId
2374
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
newCustID
String
Customer.CustID
ds
The WhseBinWizard data set
OnChangeWhseBinWizardSuppId OnChangeWhseBinWizardSuppId Parameters Name
Type
Description
newVendorID
String
Vendor.VendorID
ds
The WhseBin data set
OnChangingSegmentMaximum Execute necessary modifications when Maximum value is changed for the segment Parameters Name
Type
Description
iSegment
Int32
Segment that is being modified
newValue
String
New Maximum value
ds
The WhseBinWizard data set
OnChangingSegmentMinimum Execute necessary modifications when Minimum value is changed for the segment Parameters Name
Type
Description
iSegment
Int32
Segment that is being modified
newValue
String
New Minimum value
ds
The WhseBinWizard data set
OnChangingSegmentPositions Execute necessary modifications when Number of Positions is changed for the Segment
Epicor 9.05 | 9.05.605
2375
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
iSegment
Int32
Segment that is being modified
newValue
Int32
New Positions value
ds
The WhseBinWizard data set
OnChangingSegmentType Execute necessary modifications when Segment Type is changed Parameters Name
Type
Description
iSegment
Int32
Segment that is being modified
newValue
String
New Type value
ds
The WhseBinWizard data set
WhseGroup Epicor.Mfg.BO.WhseGroup: This business object contains 20 methods.
GetNewWhseGroup Inserts a new row in the DataSet with defaults populated.
GetNewWhseGroupAttr Inserts a new row in the DataSet with defaults populated.
GetNewWhseGroupEmp Inserts a new row in the DataSet with defaults populated.
GetNewWhseGroupTrans Inserts a new row in the DataSet with defaults populated.
GetNewWhseGroupWhse Inserts a new row in the DataSet with defaults populated.
GetNewWhseGroupBin Inserts a new row in the DataSet with defaults populated.
GetNewWhseGroupBinZone Inserts a new row in the DataSet with defaults populated.
2376
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetNewWhseGroupItem Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Type
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods.
Epicor 9.05 | 9.05.605
2377
S-Z
Business Object Reference Guide
Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CreateUpdateAvailItems Creates or updates the records for WhseGroupItems according to what option was selected (Part, Group, or Class) Parameters Name
Type
Description
groupCode
String
Warehouse Group Code.
whseCode
String
Warehouse Code.
typeClass
String
Item Class.
ds
Available Items Dataset. creates the records for ttWhseGroupItems Records
ds1
Returns the records for ttWhseGroupItems created
CreateUpdateWhseGrpTrans Creates or updates the WhseGroupTrans records according to what is selected in the availTransTypes Parameters Name
Type
Description
groupCode
String
Warehouse Group Code.
ds
WhseGroup Dataset. creates the ttWhseGroupTrans Records
GetAvailEmployees Returns the list of available employees not assigned to any Warehouse Group yet Parameters
2378
Name
Type
Description
groupCode
String
Warehouse Group Code.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns Available employees
GetAvailTransTypes Creates and Returns the list of available Transactions Types Parameters Name
Type
Description
groupCode
String
Warehouse Group Code.
Returns List of Transactions Types
OnChangePriority Used to verify that Priority must be between the range of whole values 0 - 9 Parameters Name
Type
Description
priority
Int32
Priority.
WhseGroupEmpSearch Epicor.Mfg.BO.WhseGroupEmpSearch: This business object contains 7 methods.
GetNewWhseGroupEmp Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
Epicor 9.05 | 9.05.605
2379
S-Z
Business Object Reference Guide
Name
Type
Description
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
WhseZone Epicor.Mfg.BO.WhseZone: This business object contains 10 methods.
GetNewWhseZone Inserts a new row in the DataSet with defaults populated.
GetNewWhseZoneAttch Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key.
2380
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
Epicor 9.05 | 9.05.605
Description
2381
S-Z
Business Object Reference Guide
Name
Type
fieldName
String
Description
Returns
GetWhseInfo returns the default Warehouse info when the form is opened the first time, then it extracts the Warehouse Description Parameters Name
Type
Description
warehouseCode
String@
Default WarehouseCode
warehouseDesc
String@
Description of the WarehouseCode.
WorkforceSearch Epicor.Mfg.BO.WorkforceSearch: This business object contains 7 methods.
GetNewSalesRep Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2382
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
WorkQueue Epicor.Mfg.BO.WorkQueue: This business object contains 7 methods.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
Epicor 9.05 | 9.05.605
2383
S-Z
Business Object Reference Guide
Name
Type
Description
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetOpsInResourceGroup This method returns a WorkQueueDataSet containing the operations of the given ResourceGroup (formerly known as WorkCenter). Use this method in place of GetRows(). Parameters
2384
Name
Type
Description
pcResourceGrpID
String
The Code of the Resource Group for which the operations should be retrieved.
pcEmpID
String
The employee Code of the current employee.
pcwhereClauseWorkQueue
String
where Clause WorkQueue
pcwhereClausePartWip
String
where Clause PartWip
pageSize
Int32
Page Size
absolutePage
Int32
Absolute Page
morePages
Boolean@
More Pages: true/false
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns WorkQueue Data Set
Workstation Epicor.Mfg.BO.Workstation: This business object contains 13 methods.
GetNewWorkstation Inserts a new row in the DataSet with defaults populated.
GetNewDevice Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
Epicor 9.05 | 9.05.605
2385
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
GetCodeDescList To return the CodeDescriptionList values of a given table.field. Parameters Name
Type
tableName
String
fieldName
String
Description
Returns
CheckDeviceTypeCount Parameters Name
Type
Description
ipworkstationID
String
Workstation ID
ipdeviceType
String
Scale or Printer
ds deviceWarning
Work station data set String@
Warning message used to communicate information that does not prevent updates
CheckForDefaultDeviceType Parameters Name
Type
Description
workstationID
String
Workstation ID
deviceType
String
Scale or Printer
DuplicateStation To create a new part by duplicating from another.
2386
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
sourceStationID
String
Source Station ID
targetStationID
String
Target Station ID
Returns The Part Data Set
Remarks • QTableName - MANDATORY - Name of table to find • QLock - type of lock to put on record NO-LOCK (default) or EXCLUSIVE-LOCK • QWhere - MANDATORY - criteria to find record • QFind - type of find to perform, unique, first, next or last • Columns - List of columns
Epicor 9.05 | 9.05.605
2387
S-Z
Business Object Reference Guide
Chapter 24: X XAttachMetaData Epicor.Mfg.BO.XAttachMetaData: This business object contains 7 methods.
GetNewXAttachMetaData Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2388
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
XDocTypeCtrl Epicor.Mfg.BO.XDocTypeCtrl: This business object contains 7 methods.
GetNewXDocTypeCtrl Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses.
Epicor 9.05 | 9.05.605
2389
S-Z
Business Object Reference Guide
Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
XFileRef Epicor.Mfg.BO.XFileRef: This business object contains 8 methods.
GetNewXFileRef Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters
2390
Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
OnChangeOfDocType Call when DocTypeID is changed. Will reset the path portion of the file name with the BaseURL of the DocType. Note: It will not overlay a fully qualified filename. Parameters Name
Type
Description
ipDocTypeID
String
The Document Type ID (XFileRef.DocTypeID) that has been entered.
iO-FileName
String@
The fully qualified file name that the user is referencing for this attachment.
Epicor 9.05 | 9.05.605
2391
S-Z
Business Object Reference Guide
Chapter 25: Z zBODef Epicor.Mfg.BO.zBODef: This business object contains 8 methods.
GetNewzBODef Inserts a new row in the DataSet with defaults populated.
GetNewzBODataSets Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
2392
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
zDataFieldSearch Epicor.Mfg.BO.zDataFieldSearch: This business object contains 7 methods.
GetNewzDataFieldSearch Inserts a new row in the DataSet with defaults populated. Deletes a row given its ID. Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
Epicor 9.05 | 9.05.605
2393
S-Z
Business Object Reference Guide
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
zDataSet Epicor.Mfg.BO.zDataSet: This business object contains 18 methods.
GetNewzDataSet Inserts a new row in the DataSet with defaults populated.
GetNewzRelation Inserts a new row in the DataSet with defaults populated.
GetNewzRelationField Inserts a new row in the DataSet with defaults populated.
GetNewzSubDataSet Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
2394
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name
Type
ds
Description The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeRelationKeyID This method should be invoked when the KeyID in a parent table changes. This method will validate the KeyID and pull in the new relation fields information. Parameters Name
Type
Description
pcDataSetID
String
The DataSetID we want to change Key with
pcRelationID
String
The RelationID we want to change Key with
Epicor 9.05 | 9.05.605
2395
S-Z
Business Object Reference Guide
Name
Type
Description
newKeyID
String
Proposed KeyID
ds
zDataSet data set
DeleteRelationFields Delete all fields from the table of relation fields Parameters Name
Type
Description
pcSet
String
The DataSet Code
pcRel
String
The Relation Code
This method returns a list of attachment tables Returns AttachTableList data set
GetDataTables This method returns a list of tables in the dataset Parameters Name
Type
Description
pcSet
String
name of the dataset
Returns zDataTableList data set
GetNewRelation Add new Relation Parameters Name
Type
ds pcDataSetID
Description zDataSet data set
String
DataSet Code
GetRelationFields Get Relations Fields
2396
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
pcDataSetID
String
DataSet Code
pcRelationID
String
The Relation Code
Returns zDataSet data set
GetRelations Get Relations for DataSet Parameters Name
Type
Description
pcDataSetID
String
DataSet Code
Returns zDataSet data set
GetXsdDataSet This method returns the complete Datasets with all tables/fields that are needed for generating a class. Parameters Name
Type
Description
className
String
Class name
Returns The GenXsd data set returned
zDataTable Epicor.Mfg.BO.zDataTable: This business object contains 18 methods.
GetNewzDataTable Inserts a new row in the DataSet with defaults populated.
GetNewzLookupLink Inserts a new row in the DataSet with defaults populated.
GetNewzLinkColumn Inserts a new row in the DataSet with defaults populated.
GetNewzLookupField Inserts a new row in the DataSet with defaults populated.
Epicor 9.05 | 9.05.605
2397
S-Z
Business Object Reference Guide
GetNewzDataField Inserts a new row in the DataSet with defaults populated.
GetNewzKey Inserts a new row in the DataSet with defaults populated.
GetNewzKeyField Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store.
2398
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
Parameters Name
Type
Description
ds
The full DataSet.
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
ChangeLikeDataFieldName This method should be invoked when the LikeFieldName changes. Parameters Name
Type
dataTableID
String
fieldName
String
dbTableName
String
dbFieldName
String
likeDataFieldTableID
String
likeDataFieldName
String
defaultFormat
String@
defaultLabel
String@
defaultInitValue
String@
defaultFieldScale
Int32@
Description
GetKeyFields Get Key Fields Parameters Name
Type
Description
pcTableID
String
Table ID
pcKeyID
String
Proposed KeyID
Returns zData Table data set
GetKeys Get Key Fields for Table
Epicor 9.05 | 9.05.605
2399
S-Z
Business Object Reference Guide
Parameters Name
Type
Description
pcTableID
String
Table ID
Returns zData Table data set
Synchronize Synchronize one table Parameters Name
Type
Description
dataTableID
String
Table ID
SynchronizeClass Synchronize all the tables of a class Parameters Name
Type
Description
className
String
Class name
classNS
String
Class namespace
zDBTables Epicor.Mfg.BO.zDBTables: This business object contains 1 methods.
GetRows This method returns a list of db Tables Parameters Name
Type
Description
whereClause
String
Where Clause, blank for all
pageSize
Int32
page Size
absolutePage
Int32
absolute Page
morePages
Boolean@
more Pages: true/false
Returns DB Tables DataSet
2400
Epicor 9.05 | 9.05.605
Business Object Reference Guide
S-Z
zKey Epicor.Mfg.BO.zKey: This business object contains 7 methods.
GetNewzKey Inserts a new row in the DataSet with defaults populated.
DeleteByID Deletes a row given its ID.
GetByID Returns a DataSet given the primary key. Returns The DataSet.
GetList Returns a list of rows that satisfy the where clause. Parameters Name
Type
Description
whereClause
String
An expression used to filter the rows. Can be left blank for all rows.
pageSize
Int32
The maximum number of rows to return. Leave as zero for no maximum.
absolutePage
Int32
Page of rows to return.
morePages
Boolean@
Whether there are more pages of rows available.
Returns The list DataSet.
GetRows Returns a dataset containing all rows that satisfy the where clauses. Returns The full DataSet.
Update Commits the DataSet changes to the data store. Parameters Name ds
Epicor 9.05 | 9.05.605
Type
Description The full DataSet.
2401
S-Z
Business Object Reference Guide
UpdateExt Apply input data to BO by calling GetByID/GetNew/Update methods. Returns The dataset with list of errors occured during update process.
2402
Epicor 9.05 | 9.05.605
Additional information is available at the Education and Documentation areas of the EPICweb Customer Portal. To access this site, you need a Site ID and an EPICweb account. To create an account, go to http://support.epicor.com.