Get started with Datastore

The following procedures illustrate an end-to-end scenario that uses the Datastore samples provided with the product.

Sample configuration in design environment:

Sample usage in runtime environment:


If during the installation PassPort has been set up to be used as authentication method, assign the:

  • Datastore_Administrator predefined role to the user who will log in to the Datastore Client application.
  • IPDesigner_Administrator predefined role to the user that will log in to the Designer application.

Related topics

For more information, refer to Use the predefined roles.

Samples description

The data model of the Loan release management process contains the following:

  • The Collection type is called Loan.
  • The object type named RELEASE contains the amount to be released and the customer data
  • The Element of object type RELEASE named FEES contains the information related to the fees the customer must pay. It includes one segment per fees type.
  • The object type named FULLREPAY contains the entire amount remaining to be paid and the customer data
  • The object type named PARTIALREPAY contains the partial amount to be paid and the customer data

Create the configuration in Designer

Load the configuration into Designer

Connect to the Designer, choose Load configuration, and select Get Started with Datastore.

Deploy the configuration

  • Select the configuration to deploy
  • Click Deploy configuration
  • Choose Repository and Datastore
  • Launch the deployment.

Create queries

You can import predefined queries or create your own queries based on sample queries.

Import the sample queries

In Datastore Client:

  1. If PassPort is installed, log in using the user setup with the proper privileges.
  2. Start the Configuration Repository Console in: [Install_path]/AIS/Repository/startConsole.
  3. Launch the following command:
    importQueries -f [Install_path]/Datastore/getStarted/withDatastore/queries/queries.xml -c DatastoreClient
  4. where DatastoreClient indicates the name you gave to the Datastore Client component when you installed it.

Expected results

The following queries are imported:

  • ./Loans/2_Granted release_Information
  • ./Loans/6_Total prepayment
  • ./Loans/1_Granted release_Total number
  • ./Loans/4_Granted release_Bank fees
  • ./Loans/5_Partial prepayment
  • ./Loans/3_Granted release_Amount greater than xxxxxx

Inject the data files

On the Datastore Runtime console:

  1. Open a DOS session and navigate to the Install_path]/Datastore/DatastoreRuntime directory.
  2. Inject the data of the reference period table:dstools inject --collection LOAN ../getStarted/withDatastore/data/IEvent.seq

Expected results

44 records IEvent are injected, including 24 RELEASE, 10 FULLREPAY and 10 PARTIAL REPAY.

Execute queries on test data

  1. Connect to Datastore Client.
  2. Execute the imported predefined queries.
    Results are displayed in the P1 panel.
  3. Query name Number of lines
    1_Granted release_Total number 10
    2_Granted release_Information 10
    3_ Granted release_Amount greater than xxxxxx = 300000 6
    3_ Granted release_Amount greater than xxxxxx = 500000 1
    4_ Granted release_Bank fees 14
    5_Partial prepayment 10
    6_Total prepayment 10

You can also check in the History panel the queries that you have executed during your tests.

Export a query result to an Excel file

In Datastore Client, when viewing a query result, you can export it to an Excel file:

  1. From the main toolbar, select MoreExport into Excel.
  2. Select the path and name of the file that will contain the result of the export and click Save.

Related Links