Database Batch Import
On the Database Batch Import screen, you need to set up batches of imported files, and specify import settings.
For version 16.5 Update 13 and later: Security permissions based on workgroups and user accounts can be applied to batch import settings. Use Permissions in the Batch import settings dropdown menu to access the Permissions dialog. Access to the batch management controls will depend on the permissions which have been granted to the user's account.
Set up import batches
Each tab on the Database Batch Import screen corresponds to an import batch. Batches are used to load files from several locations at once, or to load the same set of files with different settings. Each batch is processed completely before the loader moves on to the next batch. Batch management buttons are described in the table below; the same functions are available in the context menu if you right-click a batch tab.
Note: The import begins with projects at the left-most batch tab and proceeds from left to right. Each batch is processed completely before the data loader moves on to the next batch.
Button | Description |
---|---|
Creates a new batch. | |
Renames the selected batch. | |
Deletes the selected batch. | |
Moves the selected batch to the left. | |
Moves the selected batch to the right. |
Select files to import
If the selected mapping template contains a valid database connection it will be connected immediately and the field on the left will be filled with a file structure extracted from the database. If there is no connection you will need to edit the template and check the connection settings, or use a different template.
In the file structure shown, check the boxes for the items you want to import.
You can use CTRL+A to Select All files, or SHIFT+CTRL+A to Deselect All files; these are also clickable actions in the right-click context menu.
For version 16.5 Update 6 and later: You can use the check box Load All Items to automatically select all items in the file structure. When this setting is used, any manual selections will be ignored.
Specify import settings
Note: Settings in the right-hand pane apply to individual batches. Thus, you can select different import options for each set of imported files.
New Documents and Existing Documents: These settings determine how new and existing projects will be treated during import, as described in the table below.
Option | Description |
---|---|
Create document | If a document does not already exist, it will be created. |
Ignore document (do not add) | If a document does not already exist, it will not be imported. |
Apply currency settings | Check this box if you have set up currency settings (such as currency deck and inflation date) in the mapping template and want to apply them. If you do not set up currency settings or do not apply them, the document will be created without a currency deck or inflation date. For information about currencies in documents, see Assign a currency deck and Change currency. |
Update document | Existing documents will be updated with values from the imported Excel file if they exist directly under the node selected as the destination import node. |
Update document at any root |
Existing documents will be updated if they exist on any level under the node that is selected as the destination import node. Important: If you have several documents with the same name, only the first found document will be updated. |
Update document using unique identifier |
Existing documents will be updated if they contain a certain variable, specified using the Document ID and Document ID Variable drop-downs in the Template Mappings window. For version 16.5 Update 13 and later: This option is renamed Update document using identifier and the behavior is changed to load source data into multiple documents. Selecting this option will update all documents that match with the specified identifier. |
Create additional document | A copy of the existing document will be created and populated with values from the imported Excel file. |
Log and skip document | Existing documents will be not be updated, and a record will be made in the log file. |
Override currency settings | Check this box to overwrite the document's currency settings (currency deck and inflation date) with the currency settings specified in the mapping template. |
Override start date | Check this box to override the document's start date with the date specified in the mapping template. This will enable the Data Options button, which opens a window where you can select to shift or truncate your data. |
Scenario settings: These settings specify the scenarios for imported documents, as described in the table below.
Option | Description |
---|---|
Import into Tagged Scenario / Import into Named Scenario |
Either import data into a scenario with a particular tag (select a tag from the dropdown list at the right), or with a particular name (type the name in the input field at the right). The selection/input will be ignored if Use Setting from Mapping Template is checked. |
Use Setting from Mapping Template | If this is checked the scenario setting from the mapping template will be used to set the value for the 'Tagged Scenario' or 'Named Scenario'. |
Create if not found | If you are using the Import into Tagged scenario option, check this box to create a new scenario and apply the selected tag to it. If you are using the Import into Named scenario option, check this box to create a new scenario with the specified name. |
Create scenario tags from named scenarios | Added in version 16.5 Update 14 If you are using the Import into Named scenario option, check this box to create (if it does not exist) and apply a scenario tag that matches the named scenario which is being used for the import. The user executing the load must have the 'Dataflow/Tags' role in order to create a new scenario tag; full permissions on the tag will granted to that user (and to Administrators), and all users will be granted access to it. If the scenario tag already exists but the user doesn't have permission to use it, a warning will be shown in the log. |
Imported values will be saved in the destination Dataflow documents as a new revision. In the Revision Comments field, enter comments in the same way that you would provide when saving documents in Dataflow. If you are importing reserves data, check the Tag reserves data changes as box to select a reason for the change.
Batch Settings management
You can store batch import settings for reuse later. To open a stored configuration, select it from the list in the Batch import settings field at the top of the screen. Next to this field is a drop-down menu with settings management options, which are explained in the table below. You can export a stored configuration to a 'XET' file in the local file system, and import configurations from XET files (you can use this feature to move configurations between different PlanningSpace tenants, for example).
Option | Description |
---|---|
New Settings | Creates a new stored configuration. |
Save Settings | Saves the current on-screen settings into the currently-selected configuration. |
Rename Settings | Renames the selected stored configuration. |
Delete Settings | Deletes the selected stored configuration. |
Import Settings | Import a settings configuration from a local file (XET format). |
Export Settings | Export a settings configuration to a local file (XET format). |
View All Settings | (only for the Economics and Financials loaders) This contains the utilities Export to CSV to export settings into a CSV file, and Copy Settings Between Batches to optionally copy settings values between batch tabs. |
For version 16.5 Update 13 and later: Security permissions based on workgroups and user accounts can be applied to batch import settings. Use Permissions in the dropdown menu to access the Permissions dialog. Access to the batch management controls (Save, Rename, Delete, etc.) will depend on the permissions which have been granted to the user's account.