Run the content discovery task from the command line - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The content discovery task can be started using the Windows command prompt.

The content discovery task creation executable file, SPFNCreateCDT.exe, is available on Smart Community. For more information, see Find sample data on Smart Community.

You can only create a content discovery task when you have Data Capture installed on the computer.

Command line arguments

The arguments that can be used with SPFNCreate.exe are listed below.

/U - identifies the database user name (required).

/P - identifies the database password (required).

/S - identifies the Data Capture site (required).

/H - identifies the server host computer (required).

/SECURE - indicates if the Data Capture site is secured.

/DS - identifies the document status set on the document.

The following table displays the string that corresponds to each Data Capture reader.

Character

Document status

0

DocumentLoaded

1

DocumentResolved

2

Document OutOfDate

3

DocumentContentExtractionFailed

4

DocumentDataExtractionFailed

5

DocumentRelationshipsCreationFailed

6

DocumentStatusTagDataExtractionFailed

7

DocumentStatusProcessed

/DR - identifies the file types related to the Data Capture reader.

The following table displays the string that corresponds to each Data Capture reader.

String

Data Capture reader

3DModel

3DModel Reader

Document

Document Reader

Drawing

Drawing Reader

Image

Image Reader

Text

Text Reader

Default

Base Reader

/DP - identifies the document name pattern.

This example creates a document discovery task that processes all the documents that have the Document Loaded status, are Drawing files, and have a pattern that matches *doc*.

SPFNCreateCDT.exe /U Data Captureadministrator /P /S spfnserver /H localhost /DS 0 /DR Drawing /DP *doc*.

Start a content discovery task from a command prompt

  1. Open a Command Prompt window.

  2. In the Command Prompt window, change the folder to the product folder, for example: C:\Program Files (x86)\SmartPlant\Foundation\SPFDesktopClient\CurrentVersion.

  3. Type the following command:

    "SPFNCreateCDT.exe /U Data Captureadministrator /P /S spfnserver /H localhost /DS 0 /DR Drawing /DP *doc*"

    A message appears to indicate the successful creation of content discovery task.

  • If the creation of the content discovery task fails, review the log file output.txt in the installation folder location for more information.

  • When launching the SmartPlant Foundation Desktop Client from the command line, all parameters that begin with a slash ( / ) are uppercase and require a space between the parameter and the value. If the value contains spaces, it must be enclosed inside double quotation marks (“ ”).

  • Please provide access for the user provided to the method SPFNProcessJob_Create.