CasewareDocs

Standard Import Routine Extension

Use this function to create a Standard Import Routine which can be extended later on. You can create Standard Import Routines consisting of several partial Standard Import Routines. Each extension could also run as a standalone Standard Import Routine. In this case more than one Standard Import Routine could be defined which imports only the relevant data from an export which are needed for the preparation of specific parts (General Ledger, Fixed Assets).

You can also use this function for other purposes, e. g. if you want to run your own audit tests on databases imported with an Caseware Standard Import Routine.

In contrast to the Standard Import Routine Extension content item Standard Import Routines created with the content item Standard Import Routine cannot be extended.

Step-by-Step

  1. To create an extended Standard Import Routine (SIR) select New in the File tab. Alternatively, you can click the New icon in the Quick Access Toolbar.
  2. In the New SmartAnalyzer App SDK Project dialog box select Standard Import Routine Extension.
  3. Enter a name for the SmartAnalyzer App SDK Project. The name has to comply with the Windows guidelines for file and folder names.
  4. Select the location of the file to be created by clicking the Browse button.
  5. Click OK. A new dialog box is opened.
  6. In the General area the name, the author and the version number are shown. You can change them. The name is the content item name in SmartAnalyzer, the maximum length is 128 characters. You do not have to consider any Windows guidelines when entering the name, any character is allowed.
  7. Enter the minimum version of IDEA which supports the audit test in the Minimum IDEA Version field. By default, the lowest version number for which an app definition could be created is shown. If you enter a lower number, it will be changed automatically. If you have an IDEA version lower than the number shown by default, you will not be able to import the Standard Import Routine Extension into SmartAnalyzer.
  8. In the Execution Order Number field you can enter an index number between 0 and 1023. This index number controls in which order extensions will be executed. The default value is 999.
  9. Click the button in the Is Based on Import Routine field to choose the Standard Import Routine to be extended. The dialog box Available Standard Import Routines opens.

  10. In the field Belongs to Import Group(s) field you can enter one or several groups in which this Import Routine will be listed. You can do this in the Group Names dialog box. When importing data using this Import Routine the names will be displayed in the Data Source/ERP System area. Additionally, you have to specify a group name.

  11. Specify whether the Standard Import Routine shall support IDEA Server by clicking the corresponding option.

    Support of IDEA server
    Original Standard Import Routine supports server Extension supports server Extended Standard Import Routine supports server
    Yes Yes Yes
    Yes No No
    No Yes No
    No No No

  12. You can specify whether the data preparation will be run during the import. Click the arrow next to the Separate Import and Preparation field and select one of the options. If you select the Ask the user can decide if he wants to run the data preparation immediately after the import. If you select the Always option, only the import will be run and the user has to run the data preparation separately. If you select the Never option, the data preparation will always be run automatically after the import.

  13. Use the Select all Files option to specify how to proceed with additional files. Select Yes to automatically select additional files for the import, select No to let the user decide which additional file he wants to import.

  14. The selection in the Ask for Batch Import File (index.xml) field depends on whether the data to be imported is delivered with a batch import file. If this is the case, click Yes. If this option is set to No (default setting) the developer has to make sure that the user can select the data to be imported.

  15. Use the Requires Audit Period option to define whether a period will be created and set during the data preparation.
  16. Specify which files shall be imported with the Standard Import Routine extension in the Files to be Imported field. The selection is made using the Files to be Imported dialog box.
  17. In the Preliminary Routine field select a routine that will be run before the import. It can be used to e.g. analyze data before the import. Another possibility would be to ask the user which data he wants to import. This routine will be run once before the import. This routine can be an IDEAScript macro or a C# project. The routine is selected in the Select Routine dialog box. You can start a macro editor by clicking the Open editor icon. If you have not selected a macro yet, the editor which you have defined in the Options dialog box will be opened with the corresponding template chosen in the Options dialog box too. If you have already selected a macro, the code will be displayed in the editor you have defined in the Options dialog box.
  18. Click the icon next to the Special Routines field and select the dialog routines from the Manage Special Routines dialog box. For each routine you can specify if it will be run before or after the import. Only select routines here that are intended for a special purpose. You can specify the main routines for the data preparation in the Preliminary Routine and Preparation Routine fields.
  19. In the Preparation Routine field select the routine to extend the selected Standard Import Routine. You can start a macro editor by clicking the Open IDEA macro with the corresponding editor button. If you have not selected a macro yet, the editor which you have chosen in the Options dialog box will be opened. If you have already selected a macro, the editor which was used to create the macro will be opened.

  20. If one or more embedded dialog boxes are needed for the macro, you can select them by clicking the button within the Embedded Dialogs field. A dialog box is opened where you can choose one or more Visual Studio projects.

  21. In the Properties area you can set a property. This property can be used to assign the Standard Import Routine extension to a workflow. If a new value is added the current list separator selected for your computer have to be added after it.
    In the Compatibility Indicator field you can enter a group of string values used later to enable the merging of app workflows. App workflows can be merged if they have at least one compatible indicator value in common