System-defined search templates

This appendix contains the definition details of the available system-defined search templates available only in accounting framework integration.

getAcquirerAccountNumber

This search template is used in the transformation of the ledger accounts of the input transaction. It retrieves the destination ledger account number from chart of accounts mapping.

  • Search Result: To account
  • Parameters:
    • Source entity
    • Source accounting book
    • Source ledger account
    • Destination entity
    • Destination accounting book
  • Filters:
    • Source entity == Rule - sender entity
    • AND Source accounting book == From accounting book or a fixed value 'NULL' if there was no From Accounting Book specified in general ledger mapping
    • AND Source ledger account == From account
    • AND Destination entity == Rule - receiver entity
    • AND Destination accounting book == Rule - receiver accounting book or a fixed value 'NULL' if there was no To Accounting Book specified in general ledger mapping.

getAcquirerAccountNumberList

This search template is used in the transformation of the ledger accounts of the input transaction. It retrieves the destination ledger account and its corresponding allocation rate from chart of accounts mapping.

  • Search Result: To account and allocation rate
  • Parameters:
    • Source entity
    • Source accounting book
    • Source ledger account
    • Destination entity
    • Destination accounting book
  • Filters:
    • Source entity == Rule - sender entity
    • AND Source accounting book == From accounting book or a fixed value 'NULL' if there was no From Accounting Book specified in general ledger mapping.
    • AND Source ledger account == From account
    • AND Destination entity == Rule - receiver entity
    • AND Destination accounting book == Rule - receiver accounting book or a fixed value 'NULL'

      if there was no To Accounting Book specified in general ledger mapping.

getAcquirerAcctChart

This search template is used in the transformation of the ledger accounts of the input transaction. It retrieves the destination accounting chart ID from general ledger mapping.

  • Parameters:
    • Source entity
    • Source accounting book
    • Destination entity
    • Destination accounting book
  • Filters:
    • Source entity == Rule - sender entity
    • AND Source accounting book == From accounting book or a fixed value 'NULL' if there was no From Accounting Book specified in general ledger mapping.
    • AND Destination entity == Rule - receiver entity
    • AND Destination accounting book == Rule - receiver accounting book or a fixed value 'NULL' if there was no To Accounting Book specified in general ledger mapping.

getCurrencyRateType

This search template is used in the transformation of the amounts and currencies of the input transaction. It retrieves the currency rate type from currency rate type assignment.

  • Search Result: Currency rate type
  • Parameters:
    • Source entity
    • Source accounting book
    • Source accounting journal
    • Destination entity
    • Destination accounting book
  • Filters:
    • Source entity == Rule - sender entity
    • AND Source accounting book == From accounting book or a fixed value 'NULL' if there was no From Accounting Book specified in general ledger mapping.
    • AND Source accounting journal = = From accounting journal
    • AND Destination entity == Rule - receiver entity
    • AND Destination accounting book == Rule - receiver accounting book or a fixed value 'NULL' if there was no To Accounting Book specified in general ledger mapping.

getTargetAccountNumberBySourceAcctChart

This search template is a variant of getAcquirerAccountNumber that has an additional parameter for source accounting chart.

  • Search Result: To account
  • Parameters:
    • Source entity
    • Source accounting book
    • Source accounting chart
    • Source ledger account
    • Destination entity
    • Destination accounting book
  • Filters:
    • Source entity == Rule - sender entity
    • AND Source accounting book == From accounting book or a fixed value 'NULL' if there was no From Accounting Book specified in general ledger mapping.
    • AND Source accounting chart == From accounting chart
    • AND Source ledger account == From account
    • AND Destination entity == Rule - receiver entity
    • AND Destination accounting book == Rule - receiver accounting book or a fixed value 'NULL' if there was no To Accounting Book specified in general ledger mapping.

getTargetAccountNumberListBySourceAcctChart

This search template is a variant of getAcquirerAccountNumberList that has an additional parameter for source accounting chart.

  • Search Result: To account and allocation rate
  • Parameters:
    • Source entity
    • Source accounting book
    • Source accounting chart
    • Destination entity
    • Destination accounting book
  • Filters:
    • Source entity == Rule - sender entity
    • AND Source accounting book == From accounting book or a fixed value 'NULL' if there was no From Accounting Book specified in general ledger mapping.
    • AND Source accounting chart == From accounting chart
    • AND Source ledger account == From account
    • AND Destination entity == Rule - receiver entity
    • AND Destination accounting book == Rule - receiver accounting book or a fixed value 'NULL' if there was no To Accounting Book specified in general ledger mapping.

getTargetAcctChartBySourceAcctChart

This search template is a variant of getAcquirerAcctChart that has an additional parameter for source accounting chart.

  • Search Result: To accounting chart
  • Parameters:
    • Source entity
    • Source accounting book
    • Source accounting chart
    • Destination entity
    • Destination accounting book
  • Filters:
    • Source entity == Rule - sender entity
    • AND Source accounting book == From accounting book or a fixed value 'NULL' if there was no From Accounting Book specified in general ledger mapping.
    • AND Source accounting chart == From accounting chart
    • AND Source accounting journal = = From accounting journal
    • AND Destination entity == Rule - receiver entity
    • AND Destination accounting book == Rule - receiver accounting book or a fixed value 'NULL' if there was no To Accounting Book specified in general ledger mapping.

getTargetCurrencyRateTypeBySourceAcctChart

This search template is a variant of getCurrencyRateType that has an additional parameter for source accounting chart.

  • Search Result: Currency rate type
  • Parameters:
    • Source entity
    • Source accounting book
    • Source accounting chart
    • Destination entity
    • Destination accounting book
  • Filters:
    • Source entity == Rule - sender entity
    • AND Source accounting book == From accounting book or a fixed value 'NULL' if there was no From Accounting Book specified in general ledger mapping.
    • AND Source accounting chart == From accounting chart
    • AND Destination entity == Rule - receiver entity
    • AND Destination accounting book == Rule - receiver accounting book or a fixed value 'NULL' if there was no To Accounting Book specified in general ledger mapping.

getDimensionCodeList

Note: Only the rule script is using this search template.

This search template retrieves the dimension codes from dimension code assignments.

  • Search Result:
    • Dimension type
    • Dimension sequence
    • Dimension code
  • Parameters:
    • Accounting chart
    • Entity
    • Ledger account number
    • xsdName
    • Accounting book
  • Filters:
    • Source entity == Rule - sender entity
    • AND Entity == Rule - receiver entity
    • AND Ledger account number == Account or a fixed value 'NULL' if there were no ledger account numbers specified in dimension code assignment.
    • AND xsdName == Transactional document name that is used as input, for example, PurchaseOrder, ReceiveDelivery
    • AND Accounting Book == Accounting Book or a fixed value 'NULL' if there were no specific accounting books defined in dimension code assignment.

getDimensionCodeListByTransType

This search template is a variant of getDimensionCodeList that has an additional parameter for transaction type.

  • Search Result:
    • Dimension type
    • Dimension sequence
    • Dimension code
  • Parameters:
    • Accounting chart
    • Entity
    • Ledger account number
    • xsdName
    • Transaction type
    • Accounting book
  • Filters:
    • Accounting chart == Accounting chart
    • AND Entity == Rule - receiver entity
    • AND Ledger account number == Account or a fixed value 'NULL' if there were no ledger account numbers specified in dimension code assignment.
    • AND xsdName == Transactional document name that is used as input, for example, PurchaseOrder, ReceiveDelivery
    • AND transType == Transaction type
    • AND Accounting Book == Accounting Book or a fixed value 'NULL' if there were no specific accounting books defined in dimension code assignment.

getJournalHeaderUserField

This search template retrieves the list of header journal user field assignments from the journal user fields page.

  • Search Result:
    • Journal user field name
    • Journal user field data type
    • Journal user field value
  • Parameters:
    • Transaction
    • Journal user field set name
  • Filters:
    • Transaction == Transactional document name that is used as input, for example, PurchaseOrder, ReceiveDelivery
    • AND Journal user field set name == Journal User Field name

getJournalLineUserField

This search template retrieves the list of journal line user field assignments from the journal user fields page.

  • Search Result:
    • Journal user field name
    • Journal user field data type
    • Journal user field value
  • Parameters:
    • Transaction
    • Journal user field set name
  • Filters:
    • Transaction == Transactional document name that is used as input, for example, PurchaseOrder, ReceiveDelivery
    • AND Journal user field set name == Journal User Field name