Methods: Journal
The following methods are available for the Journal component:
Import
Driver Type: DJI
This is the main component method, and executes all the stages of Ledger Import:
- Loads all the lines into the posting tables.
- Validates all lines.
- If correct, posts into the actual ledger tables.
Successful posting to the ledger table is reliant on the MethodContext section in the Input Payload. For example, the PostingType must be specified, and LoadOnly must not be set as Yes. If PostingType is not specified, or LoadOnly is Yes, the lines are loaded into the posting tables, but not actually posted in the ledger table. Therefore, the lines are assigned a PostingHeaderId, but not a journal number. In this case, you must use Ledger Import (LIM) to locate the lines and post them.
This method is available from the SunSystems web page. Select the Journal component from the list of registered components.
This method is also available from within Transfer Desk (specified in Transfer Desk Profile Designer by setting the Source and Target Datatype to Ledger with the Target Method to CreateOrAmend). The Transfer Results dialog displays the number of records transferred, with the count of successful and unsuccessful records. In this dialog, the Posting Information node shows the specific posting results from the ZZZ_PSTG_HDR table. The information is displayed in the format: Posting Header Id: nnnn; Line Count: n1; Lines Posted: n2; Lines Rejected: n3.
The sum of Lines Posted + Lines Rejected may be less than the Line Count. This can occur when using Post If No Errors, if only a few lines are rejected due to errors, preventing any of the lines from being posted. In such cases, where a few erroneous lines prevent any line from being posted, the default rejection error message (This line has been rejected due to errors in other lines or posting options) is displayed for all lines where no validation errors occurred. This can make it difficult to identify the lines containing invalid data. To suppress the default rejection message, select and set «Suppress Default Message for Errors» true. This results in a non-standard error output, where only lines with validation errors are displayed.
To create a ledger note, at minimum you must supply values for Line.LedgerNote.NoteDetail.NoteDetailSequenceNumber and Line.LedgerNote.NoteDetail.Text. When creating multiple notes for a single journal line, you must set a different sequence number for NoteDetailSequenceNumber. The following example shows a simple version of the nodes required when creating ledger notes:
<Line>
...
<LedgerNote>
<JournalLineNumber>2</JournalLineNumber>
<NoteDetail>
<NoteClassCode>A</NoteClassCode>
<NoteDetailSequenceNumber>1</NoteDetailSequenceNumber>
<Text>test text 1</Text>
</NoteDetail>
<NoteDetail>
<NoteDetailSequenceNumber>2</NoteDetailSequenceNumber>
<Text>test text 2</Text>
</NoteDetail>
</LedgerNote>
...
</Line>
Unlike the other nodes which ultimately will be imported into the ledger table as attributes of the ledger notes, NoteClassCode will not be populated due to the limitation set by the respective COBOL function.
Load
Driver Type: DJI
This method simply loads all the lines into the posting tables. Load only does not carry out any validation of the data. For example, you may successfully load a payload that contains a budget code of H, even though H does not exist in the business unit. It is not to be rejected until it is actually passed to Ledger Import.
This method does not require completion of the MethodContext section of the input payload, since those values are provided by running Ledger Import from within SunSystems.
This method is not available from within Transfer Desk; only from the SunSystems web page by selecting the Journal component from the list of registered components.
LoadAndPost
Driver Type: DJI
We recommended you do not use this method is not used, unless you know the results can be predicted in advance. This method posts to the actual ledger even if the validation fails. If you are in doubt, the import method should be used instead.
This method is not available from within Transfer Desk; only from the SunSystems web page by selecting the Journal component from the list of registered components.
ProcessPostingDetails
Driver Type: SASI
Use this method to validate lines within the posting tables and then post them into the actual ledger.
This method is not available from within Transfer Desk; only from the SunSystems web page by selecting the Journal component from the list of registered components.
Query
Driver Type: Export
Use this method to obtain details of ledger transactions and extract ledger transaction details from the actual ledger tables.
This method is available from within Transfer Desk, specified in Transfer Desk Profile Designer by setting the profile type to Export and setting the source datatype to Ledger.
This method is available from the SunSystems web page. Select the Journal component from the list of registered components.
There are ten additional nodes in the payload definition to allow queries to retrieve the details for each analysis code, for example, Description, Lookup code, etc. However, these elements are disabled by default, because the time taken to process a query with these elements enabled may increase by up to three times, depending on the number of analysis dimensions present on the ledger lines.
You can enable the appropriate elements in the ledger payload using Component Manager, by selecting each analysis node and clicking Mark As Used.
If you are not intending to use this feature, we recommend that you leave these ten additional elements disabled.
You can disable or re-enable them at any time.
ValidateOnly
Driver Type: DJI
Use this method to validate your journal lines before posting them.
This method is not available from within Transfer Desk; only from the SunSystems web page by selecting the Journal component from the list of registered components.