CasewareDocs

Standard Import Routine

Standard Import Routines are the easiest way to import data sets. The data will not only be imported but the data will also be prepared and tagged.

At this stage you can define all settings required for the data import using a Standard Import Routine. You specify the workflow for the import process, select the routines that will be run before and during the import and define the data structure.

Standard Import Routines created with this content item could not be extended. To create partial Standard Import Routines which could be extended use the content item Standard Import Routine Extension.

Follow the steps below to create a Standard Import Routine:

Step-by-Step

  1. To create a Standard Import Routine select New in the File tab. Alternatively, you can select the New icon in the Quick Access Toolbar.
  2. In the New SmartAnalyzer App SDK Project dialog box select Standard Import Routine.
  3. Enter a name for the Standard Import Routine. The name has to comply with the Windows guidelines for file and folder names.
  4. Optionally select the location of the file to be created by clicking the Browse button (not recommended).
  5. Click OK. The new dialog box is opened.
  6. In the General area the name, the author, the owner and the version number are shown. You can change these entries except for the owner. The maximum length of the name 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 IDEA and SmartAnalyzer commands used for this Standard Import Routine in the Minimum IDEA Version field.
  8. Use the Description File option to select the file containing a description of the Standard Import Routine (optional).
  9. 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.

  10. Specify whether the Standard Import Routine shall support IDEA Server by clicking the according option.
  11. Use the Requires Audit Period option to define whether a period will be created and set during the data preparation. This option is currently not supported.
  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. Supports Unicode specifies whether the Standard Import Routine is compatible with the IDEA Unicode version or not. Setting this property to Yes means that the Standard Import Routine will always be executed. Selecting No means that a Standard Import Routine will not be displayed in case an IDEA Unicode version is installed. You may choose this setting if a command was used which is not supported by IDEA Unicode (@ASCII, @CHR, @RegExpr, @Soundex and @SoundsLike).

  16. The fields in the Localization area only serve as information. They show the language settings that were made in the Options dialog box.
  17. Specify which files shall be imported with the Standard Import Routine in the Files to be Imported field. The selection is made using the Files to be Imported dialog box.
  18. 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.
  19. 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.
  20. In the Preparation Routine field select the main routine for the data preparation. 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.
  21. 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.

  22. In the Properties area you can set a property. This property can be used to assign the Standard Import Routine 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

Working with SmartAnalyzer App SDK Projects you can open a context menu by right-clicking on a card-index tab.