Extraction Files
Use Datamart Extractor to create the extraction properties files. You can specify a subset of projects to extract from StarTeam Server. If extracting a single project, you can specify a subset of views to extract from the project.
Creating an Extraction File
Datamart extracts content data directly from the vault, so it is required that the Datamart process has direct access to the server's repository and vault. The server repository path needs to be provided by the user. This can be entered in the user interface or by editing the serverRepositoryPath option in the .stxtract file. Content extraction is optional and can be disabled by clearing the serverRepositoryPath value.
-
Select Start > Programs > StarTeam > Datamart > Datamart Extractor.
The Repository Extractor window is displayed.
-
Click New.
The Edit Property File dialog box is displayed.
-
Click the StarTeam tab.
- Enter a File Name for the extraction.
- Enter the IP address (or host name) of the StarTeam Server that contains the data you want to extract, and the Endpoint for that machine.
- Enter your StarTeam Server User Name and Password.
- If the server port requires connection using TLS protocol, select the “Use TLS" checkbox.
- The All Projects check box is selected by default. Click the Browse button to select a subset of projects from which to extract the data.
- If only one project is selected, the Views section of the Edit Property File dialog box will be enabled and the All Views check box selected by default. Click the Browse button to select a subset of views from which to extract the data.
-
If the option to Extract content property data is selected, a valid server repository path needs to be entered.
This option is provided to extract content data for content properties. If the option is not selected, Datamart will extract only the metadata information as it always does.
-
Select the StarTeam Database tab.
- Select the Database Type.
- Enter the Server name or IP address.
- Enter the Database name.
- Enter your User Name and Password for the database.
-
Select the Database tab.
- Select the Database Type.
- Enter the Server name or IP address.
- Enter the Database name.
- Enter your User Name and Password for the database.
- Check the Update option to set the Extractor to update mode. Update mode only updates the data for any changes since the last extract. The alternative is full extract mode, in which all tables are removed, recreated and filled. Update mode is much faster.
-
Check the Continuous option to set the default refresh interval to the default of five minutes. This value can be modified as scheduledRefreshInterval in the .stxtract file.
The continuous data extraction mode provides near real-time data reporting. This feature requires an MPX-enabled server for optimal performance. With this option, Datamart will run as a continuous process listening to events on the views/projects that have been selected for extraction and only queries the database when there is an update of interest on the server.
-
Select the Tables tab.
-
Select the tables you want to include in the extraction file. You can select them individually, use the Shift key to select a range of groups, or the Ctrl key to select additional groups. Some tables are contingent upon others.
Note: Labels and links take the most time to extract.
- Click the Add button, or click the Add All to add all of the tables.
- Click OK. The data is stored in a file at C:/Program Files/Micro Focus/Datamart (or wherever you installed Datamart) with the extension .stxtract that contains the extraction information.
-
Editing an Extraction File
To edit an extraction file, do the following:
-
In the StarTeam Repository window, select the file you want to edit and click Edit.
The Edit Property File dialog box appears.
- Make any necessary changes and click OK.
Removing an Extraction File
To remove an extraction file, do the following:
-
In the StarTeam Repository window, select the file you want to delete and click Remove.\
The Edit Property File dialog box appears, asking if you are sure you want to delete the file.
- Click
Yes to delete it, or
No to keep it.
Note: You cannot recover a deleted file.
Running an Extraction
To run an extraction, do the following:
Note: Labels and links take the most time to extract.
- Click Start > Programs > StarTeam > Datamart > Datamart Extractor. The Repository Extractor window displays.
- Select a file and click Run. A status box displays indicating when the extraction is complete.
Stopping an Extraction
To stop an extraction, do the following:
You can halt an extraction and restart it at a later time.
-
Click the Stop Extract button to stop the extraction.
The extraction is interrupted and closes the database connection, the StarTeam Server connection, and completes the log including metrics, any exceptions, and other notes. If the status box is closed, the extract stops immediately without completing the log.
If, at a later time, you select the file and click Run, the extraction resumes where it left off. If you simply close the window, it will also pick up where it left off, but the log file may not include the summary information.
-
Click Close.
An HTML log file is created at C:/Program Files/Micro Focus/Datamart (or wherever you installed Datamart) that contains the extraction details.
Purging an Extraction
Datamart Extractor enables you to purge data from the database from the tables that you specified in a properties file. If you want to only purge a subset of the data specified in the properties file, you need to create one or more additional properties files to correctly identify the subset.
To purge an extraction, do the following:
- Select the desired properties file from the list.
- Click Purge. Datamart Extractor deletes the data in the tables defined in the selected the properties file.