Skip to end of metadata
Go to start of metadata

The BiZZdesign Connect periodic import and export feature can only be used in local client installations of Enterprise Studio. You cannot use it if you are working with Enterprise Studio Online, the hosted solution. 


For scheduling periodic model data exchange with the external application without user interaction, it is possible to generate a command-line script. This script can be added when calling Enterprise Studio from the command line, or when scheduling a periodic task using the Windows Task Scheduler for example.

Configuration of periodic model data exchange for an Excel, ServiceNow, or SQL connection includes the following steps:


On this page:


Activating script generation

Activating script generation is done on model level. Once activated, scripts can be generated any time, for each connection that is present in the model.

To enable generating scripts for connections, follow these steps:

  1. In the model browser, click the Connection model.

  2. In the Connection model's properties window, on the General tab, click the red cross next to the Activate script generation option. When it turns into a check mark, it is activated.

Generating a script

  1. Open the connection view containing the connection for which you want to schedule periodic data exchange.

  2. In the connection view, select the connection, and then click . The properties pop-up window has an additional tab Script.



    Which settings are available, depends on the type of connection and whether the model package is a shared package that is stored on the Team Server.

  3. Specify the settings for the script. Options with a check mark  are activated, with a cross  they are deactivated. Click the check mark or cross to change the status.

    Script file: Define the location of the generated script. Click in the box, navigate to the desired location, and click Save. If desired you can rename it before saving.

    Script log file
    : Define the location of the log file for the command-line script. The log file contains information about the successful execution of the script, as well as error messages and warnings. Click in the box, navigate to the desired location, and click Save. If desired you can rename it before saving.

    Excel file
    (only for Excel connections): Define the location of the Excel file that is used for import or export.

    Direction
    : Select the operation that must be performed: import or export.

    Commit changes
    (only for shared model packages): If the changes made to the model by an import or export must automatically be committed, activate this option. If deactivated, changes need to be committed manually.

    If Commit changes is activated, and there are still uncommitted changes in the model at the time of a periodic import or export, they will be committed too.


    Update first (only for shared model packages): Activate this option if the model package must automatically be updated before starting an import or export. If deactivated, updates need to be performed manually if desired.

  4. When you are ready, click the Generate script control  in the properties window to generate the script. Click OK when the script is ready.

Testing the generated script

To test the generated script, follow these steps:

  1. Close Enterprise Studio.

  2. Start the Command Prompt and navigate to the folder where the Enterprise Studio executable is located (default location is C:\Program Files\BiZZdesign\Enterprise Studio version).



  3. Add the following line, and execute the command.

    EnterpriseStudio -script=script file incl path

    Example

    EnterpriseStudio -script="C:\TEMP\scripts\Script for IT.txt" 

    If there are spaces in the path and/or file name, make sure to place the location between double quotes (like in the example above), or else the script cannot be found.

The test run is started.

If the test is successful, Enterprise Studio is started and automatically closed again. If the test fails, an error message appears after Enterprise Studio has started indicating the problem. Close the message and resolve the problem.

Scheduling the data exchange

Last step is scheduling the data exchange in the Windows Task Scheduler, or a similar scheduling tool. In the scheduler, specify the following:

  • Select Start a program as the action.
  • Select EnterpriseStudio.exe as the program/script.
  • Add as an argument -script="script file incl path".

When setting the moment for the periodic import or export, make sure to pick a time when Enterprise Studio is not running, or else the periodic import or export will not work.



For more details on the use of the Windows Task Scheduler, please refer to https://technet.microsoft.com/en-us/library/cc766428(v=ws.11).aspx.