Creating Calculated Journal Entry Events

Download Designer Guide

You can use Longview Designer to create Calculated Journal Entry events.

Specifying calculated journal entry settings

You can use Longview Designer to specify the main settings for a Calculated Journal Entry event.

Specifying the manual trigger override

Use Manual Trigger Override to specify any commands to run if the event is triggered manually.

The manual trigger override is typically used to set any E_<DIMNAME> variables where the symbol to be calculated in the event is different than the symbol set up in the manual trigger event rule.

For example, normally a manual trigger event rule is set to use CURRENCIES_Default as the currencies symbol. However, the calculation itself is normally performed on all currencies. The default code block in the manual trigger override sets the E_CURRENCIES variable to all currencies.

Specifying the main procedure

The Main Procedure is the controlling procedure that is run when the event is triggered. A standard code template is provided and can be modified. The standard code provided performs the following:

1. Creates a data area where the calculations will be performed

   Note: The template code creates the data area using Main.lvdsp. This data area spec will need to be created. See Specifying the data area definition for more information

2. Processes each time period and determines:
   • If it is the current period, the calculated journal entry type would be CURRENTPERIOD
   • If it is not the current period, the calculated journal entry type would be PPA (Prior Period Adjustment)
3. Processes each entity individually and adds the entity name to the APP ID if ‘Create a calculated JE by entity’ is selected. For more information, see Specifying Calculated Journal Entry Settings.

   Note: The application ID is the combination of the specified application ID prefix, the entity name (optional), two digits for the creation year indicator and two digits for the creation month indicator. The complete application ID name can have a maximum of 31 characters. If the entity name is too long and would cause the application ID to be over 31 characters, the entity name will be truncated in the application ID.

4. Runs the “CJE\ProcessCJE.lvpro” procedure which handles processing, creating and posting the calculated journal entry. For more information on the flow of the ProcessCJE procedure, see Calculated Journal Entry Event Template - Process Flow.

   Note: If you are creating a persistent event, you may want to make use of the LVS_EVENTINITIALIZE, LVS_EVENTSHUTDOWN and LVS_PERSISTENT system variables to improve the efficiency and speed of your events. You can use the template document “Template_Event_Persistent” to provide a framework for using these system variables in your code. For more information, see Working with system variables for persistent event rules.
   

Specifying the set values procedure

The Set Values Procedure is the procedure where the values for the calculated journal entry are determined. The values should be stored in variables which would be used in the calculated journal entry detail.

For more information, see Specifying Calculated Journal Entry Detail.

Within the Set Values procedure, variable CJE_IsPostRequired should be set to 1 when posting is required, and set to 0 when posting is not required.

If a journal entry is required to be unposted, deleted or created and posted within the Set Values procedure, the following procedures can be used:

• CJE\UnPost.lvpro
• CJE\Delete.lvpro
• CJE\CreateAndPost.lvpro

Prior to running these procedures, the variable CJE_Status should be checked to make sure the journal entry is eligible to be unposted, deleted, or created and posted. The following CJE_Status values are valid for each action:

Each procedure will reset the CJE_Status variable upon completion.

You can use the template document “Template_CJE_Process_Line” to provide a framework for your set values procedure.

For more information on Template Documents, see "Template documents".

Example:

Specifying calculated journal entry detail

Use Calculated JE Details to add detail lines that the calculated journal entry event will use to post. The header of the calculated journal entry is handled internally based on the settings set in Specifying calculated journal entry settings.

You can use the Detail template for syntax reference by typing in Template in the Calculated JE Detail.

For more information on Calculated journal entry documents, see “Creating CalculatedJESpec documents” in the Longview Developer’s Guide.

Example:

Specify the data area definition

Use Data Area Definition to specify the data area to be queried for the export. Open the data area definition to specify its properties.

Note: The name of the data area definition is Main.lvdsp and the name of the data area created using it is daMain.

1. For the Name, enter the name of your Trigger Area

   Note: The name must 29 or fewer characters and only contain alphanumeric characters and underscore “_”.

2. In the Options table, complete the following fields:

   Field	Notes
   Data type	Specify the data to be queried using one of the following options: ADJUSTED — Indicates that data queries include adjustments made via journal entries UNADJUSTED — Indicates that data queries exclude adjustments made via journal entries Default is ADJUSTED.
   Download type	Specify the type of data to be downloaded using one of the following options (download option specific in brackets): Exclude parent values — Indicates that parent data is excluded in the download (STANDARDLEAFONLY) Exclude parent and calculated values — Indicates that only leaf data that was submitted to the database via import, input or event calculation is included in the download (LEAFDATA). Default is All data.

3. In the Trigger Area table, complete the following fields for each dimension:

   Note: The Spec and Level fields are not applicable if a symbol contains a variable.

   Field	Notes
   Symbols	Type a symbol name. Alternatively, you can use the symbol selector. To add more than one symbol for a dimension, select a row containing the dimension for which you want to add another symbol and click Symbol. To move a symbol up or down within a dimension, click Move Up or Move Down. Note: To use the symbol selected by the user or defined by an attribute, enter the name of the dimension as a variable. For example, $ENTITIES$.
   Spec	Indicate the symbol specification using one of the following values: All: Includes all symbols within the selected symbol’s hierarchy. Leaf: Includes only leaf symbols within the selected symbol’s hierarchy. Parent: Includes only parent symbols within the selected symbol’s hierarchy. Root and Parent: Includes only root and parent symbols within the selected symbol’s hierarchy. Note: To use the symbol selected by the user or defined by an attribute, enter the name of the dimension as a variable. For example, $ENTITIES$.
   Level	Specify the number of levels down from the symbol to be included in the data area.

4. Use Additional Configuration to specify any other Data Area Definition features you wish to use. Additional Configuration is a code editor that allows you to enter data area definition functions to be included in the data area.

   For more information on the code editor, see Using the Code Editor.

   Typical use of Additional Configuration in a data area definition is to

   • Add an attribute filter using the AttributeFilter function
   • Add a schedule to the using the Schedule function
   • Add a temporary symbol using the TempSym function

Specifying Export Specs - Script

Use Export Specs - Script to create export specification scripts that can be executed as part of an app, event, or configuration library.

To create an Export Spec - Script:

1. Right-click Export Specs - Script and select New Document.
2. For Name, enter the name of the export specification.
3. In the code editor, enter the script required for the export specification.
4. Save the document.

Managing Export Specs - Script

After creating an Export Spec - Script, you can manage it using the available context menu options.

To Duplicate an Export Spec - Script:

Right-click the Export Spec - Script and select Duplicate. A copy of the Export Spec - Script is created with - Copy appended to the document name.

To Delete an Export Spec - Script:

Right-click the Export Specs - Script and select Delete to permanently remove it from the application.

To change the document order:

1. Right-click the Export Specs - Script folder.
2. Select Change Document Order.
3. In the Change Document Order dialog box, select the document you want to move.
4. Click Move Up or Move Down to change its position.
5. Click OK to save the new order.

The documents are displayed in the updated order within the Export Specs - Script folder.

Specifying Import Specs - Script

Use Import Specs - Script to create import specification scripts that can be executed as part of the app, event, or configuration library.

To create an Import Spec - Script:

1. Right-click Import Specs - Script and select New Document.
2. For the Name, enter the name of your import specification.
3. In the code editor, enter the script required for the import specification.
4. Save the document.

Managing Import Specs - Script

After creating an Import Spec - Script, you can manage it using the available context menu options.

To Duplicate an Import Spec - Script:

Right-click the Import Spec - Script and select Duplicate. A copy of the Import Spec - Script is created with - Copy appended to the document name.

To Delete an Import Spec - Script:

Right-click the Import Specs - Script and select Delete to permanently remove it from the application.

To change the document order:

1. Right-click the Import Specs - Script folder.
2. Select Change Document Order.
3. In the Change Document Order dialog box, select the document you want to move.
4. Click Move Up or Move Down to change its position.
5. Click OK to save the new order.

The documents are displayed in the updated order within the Import Specs - Script folder.

Specifying procedures

Use Procedures to create any additional procedures that are required as part of the app, event, or configuration library.

To create a procedure:

1. Right-click on Procedures and select New Document.
2. For the Name, enter the name of your Procedure.
3. In the code editor, enter the commands to run when the procedure is executed. For more information on procedures, see Developing Longview Procedures.

Specifying models

Use Models to create models that are executed as part of the app, event, or configuration library.

To create a model:

1. Right-click on Models and select New Document.
2. For the Name, enter the name of your Model.
3. In the code editor, enter the code required for the model calculation. For more information on models, see Developing Longview Models.

Specifying Model Subroutines

Use Model Subroutines to create reusable subroutines that can be called from Longview models as part of the app, event, or configuration library.

To create a Model Subroutine:

1. Right-click Model Subroutines and select New Document.
2. For the Name, enter the name of your model subroutine.
3. In the code editor, enter the code required for the model subroutine.
4. Save the document.

Managing Model Subroutines

After creating an Model Subroutines, you can manage it using the available context menu options.

To Duplicate an Model Subroutines:

Right-click the Model Subroutines and select Duplicate. A copy of the Model Subroutines is created with - Copy appended to the document name.

To Delete an Model Subroutines:

Right-click the Model Subroutine and select Delete to permanently remove it from the application.

To change the document order:

1. Right-click the Model Subroutines folder.
2. Select Change Document Order.
3. In the Change Document Order dialog box, select the document you want to move.
4. Click Move Up or Move Down to change its position.
5. Click OK to save the new order.

The documents are displayed in the updated order within the Model Subroutines folder.

Specifying Symbol Maps

Use Symbol Maps to create symbol mappings that can be used as part of the app, event, or configuration library.

To create a Symbol Map:

1. Right-click Symbol Maps and select New Document.
2. For the Name, enter the name of your symbol map.
3. In the editor, define the required symbol mappings.
4. Save the document.

Managing Symbol Maps

After creating an Symbol Maps, you can manage it using the available context menu options.

To Duplicate an Symbol Maps:

Right-click the Symbol Maps and select Duplicate. A copy of the Symbol Maps is created with - Copy appended to the document name.

To Delete an Symbol Maps:

Right-click the Symbol Maps and select Delete to permanently remove it from the application.

To change the document order:

1. Right-click the Symbol Maps folder.
2. Select Change Document Order.
3. In the Change Document Order dialog box, select the document you want to move.
4. Click Move Up or Move Down to change its position.
5. Click OK to save the new order.

The documents are displayed in the updated order within the Symbol Maps folder.

Specifying Data Table definitions

To create a table definition:

1. Right-click on Table Definition and select New Document.
2. For the Name, enter the name of your Table Definition.
3. In the columns section the table and columns are defined.
   • For the table name, select the table to use. The list includes all app tables defined in the system.
   • If you pick a table based on a view it will display an information icon indicating that the table will be read-only.
   • After selecting a table the columns in the table will be displayed. All columns will be selected by default. Also the columns that define the primary key will be indicated with a key icon. If some or all of the primary key columns are not included, the table will be read only.
   • You may add or remove temporary columns using the Add Column and Remove Column buttons.

     Note: Temporary columns are added to the table for use with an app, but are not submitted to the database.

   • For each column complete the following fields:

     Field	Notes
     Include	Check each column to be included in the query. Use the check box in the header to select all columns.
     Column	For persistent table columns, displays the name of the column. For temporary columns, enter the name of the column.
     Nullable	Indicates whether the column can be saved with no value specified. If any non-nullable columns are excluded the table will be read-only.
     Type	For persistent table columns, displays the data type of the column. For temporary columns, select the data type for the column. If you select Symbol[Dimension], you will be prompted to select the dimension that applies. If you select Symbol[DimensionColumnName], you will be prompted to select a column (of type Dimension).
     Values (String)	For String columns allows you to optionally define a list of values the user can select from. Enter a | delimited list of values. Optionally enter a | delimited list of display values by placing a semi-colon after the list of values. Note: You can also use variables to define the list of values and display values.
     Values (Symbol)	For Symbol columns allows you to limit the symbols available. Enter a | delimited list of symbol specifications. You can also use a form to select the symbol specifications by clicking the search icon. Note: You can also use a variable to define the list of symbol specifications.
     Values (User)	For User columns, allows you to limit the users available for selection. Enter (or select) a | delimited list of user and group names. Note: You can also use a variable to define the list of users and groups.
     Values (User List)	For UserList columns, allows you to limit the users available for selection. Enter (or select) a | delimited list of user and group names. Note: You can also use a variable to define the list of users and groups.
     Allow Override	For String columns with Values defined, indicates whether the user can enter a value that is not in the list of values.
     Min / Max (Date)	For date columns, allows you to set a valid range of selectable dates. Note: The interface only supports explicit dates. To specify the valid date range using variables use the Additional Configuration section to define the date range using the SetColumn function.
     Default (Boolean)	For Boolean columns, allows you to indicate if the default value for the column is checked.
     Default (Dimension)	For Dimension columns, allows you to set he default dimension to be selected when a new row is added. Default is no default selection.

Specifying Table Definitions - Script

Use Table Definitions - Script to create scripted table definitions that can be executed as part of the app, event, or configuration library.

To create a Table Definition - Script:

1. Right-click Table Definitions - Script and select New Document.
2. For the Name, enter the name of your table definition.
3. In the code editor, enter the script required for the table definition.
4. Save the document.

Managing Table Definitions - Script

After creating an able Definitions - Script , you can manage it using the available context menu options.

To Duplicate an Table Definitions - Script :

Right-click the Table Definitions - Script and select Duplicate. A copy of the Table Definitions - Script is created with - Copy appended to the document name.

To Delete an Symbol Maps:

Right-click the Table Definitions - Script and select Delete to permanently remove it from the application.

To change the document order:

1. Right-click the Table Definitions - Script folder.
2. Select Change Document Order.
3. In the Change Document Order dialog box, select the document you want to move.
4. Click Move Up or Move Down to change its position.
5. Click OK to save the new order.

The documents are displayed in the updated order within the Table Definitions - Script folder.

Specifying Supporting Files

Use Supporting Files to store files that are required by the app, event, or configuration library, such as configuration files, templates, or other supporting resources.

To add a Supporting File:

1. Right-click Supporting Files and select New Document.
2. For the Name, enter the name of the supporting file.
3. Add or edit the content of the supporting file as required.
4. Save the document.

Managing Supporting Files

After creating an Supporting Files , you can manage it using the available context menu options.

To Duplicate an Supporting Files :

Right-click the Supporting Files and select Duplicate. A copy of the Supporting Files is created with - Copy appended to the document name.

To Delete an Supporting Files:

Right-click the Supporting Files and select Delete to permanently remove it from the application.

To change the document order:

1. Right-click the Supporting Files folder.
2. Select Change Document Order.
3. In the Change Document Order dialog box, select the document you want to move.
4. Click Move Up or Move Down to change its position.
5. Click OK to save the new order.

The documents are displayed in the updated order within the Supporting Files folder.