General Settings

General settings allow you to define the project name, description, log file path and configurations of project files. The General settings tab contains the following areas:

• General: Defines all the project related information and processing timeout details.

• Logging: Defines the log file path and log file name with log level information.

• Configurations: Defines configuration details relating to extract, transform and load.

  

  Note: The triangle symbol near the General tab indicates that some fields have unsaved changes or have invalid data.

General Area

You can use the fields in the General area to add project-related information, such as the project name, project description and processing timeout details.

To complete the project related information:

1. Type the Project Name and Project Description in the respective fields.

   Note: The Project Name is a required field and cannot be empty.

2. Type the time in the Timeout (in minutes) box to define the maximum execution time of the project.

   Note: The Timeout value must be a non-negative integer.

3. Click Save Settings to save the general settings options.

Logging Area

You can use the fields in the Logging area to specify different logging information, such as warning and error messages. The Gateway produces a log file in the location defined by Log Path. Its default value is a Logs subfolder under the project file location.

To specify the Logging information:

4. Type the log file path in Log Path box or click the Browse Path icon to specify the log file path.

   If the log folder path exists, it will create the logs in the specified log path. If the log folder path does not exist, it creates the folder automatically. The default name of the log file name is the name of the input data. The log files will be named as <input filename>.log.

5. Specify a Log Level to log all events greater than and equal to the specified severity level. For example, if you set the Log Level to Verbose, all errors, warnings and informational messages are logged.

   Note: The Log Level value is case-sensitive and must be one of the following: Error, Warning, Information and Verbose. The following table shows the severity standard for different Log Levels.

   Log Level	Severity
   Error	Indicates logs for an error message. An Error is an unexpected condition that is likely to result in erroneous information in the output.
   Warning	Indicates logs for an error and warning message. A Warning is a message or a notification that alerts you of a condition that may cause a problem in the future.
   Information	Indicates logs for an error, warning and other informational message. An Information is a message with a concise report of a object processing, timestamp, problem trigger, processing details and working of software modules
   Verbose	Indicates logs at all levels, that is, error, warning and informational messages. A verbose is a message that provides additional details about the activity start and end, dump data and the values of the variables and arguments that are used. This extra information can be helpful during troubleshooting, but as it creates large log files this option should be avoided in normal runs.

6. Select the Append Logs box in the General settings Page to control the value of appendToLog in the configuration file. By default, the appendToLog value is deselected and false.

   The following two scenarios exist under Append Logs section:

   • If you select Append Logs box, then the first run of the Gateway project will create the log file and add messages to it. The value of appendToLog (in the project's Configuration file) is updated to true. On subsequent runs, that processes the same input source, the messages are appended to this existing log file.

   • If you deselect the Append Logs box, then each run of the Gateway project will delete the old log file if it exists and create a new log file and add messages to it.

   <log level="Warning" folderPath="C:\Users\<user_name>\Test\Logs_Appended" appendToLog="false" />

7. Click Save Settings to save the Logging area settings.

After processing, the Gateway produces a Summary.txt file in the Project Logs folder, which contains statistics about the amount of extracted and loaded objects, project path, file processing information, number of errors and warnings and processing time.

Example:

Configuration Area

You can use the fields in the Configurations area to define the project configuration details.

To define the configuration settings:

1. Type the configuration details in the Extract, Transform, Load fields, respectively:

• Extract: Provide the configuration file details to extract the engineering and graphics data from the Smart 3D model. For new projects, a default configuration file for Extract is created, named as ExtractorConfiguration.xml.

  Note: The Extract path value must point to a valid extractor configuration file.

• Transform: Provide the configuration file details to transform the extracted data. The configuration file for Transform is named as TransformConfiguration.xml.

  Note: The Transform path value must point to a valid transformer configuration file.

• Load: Provide the configuration file details to load the extracted and transformed engineering data. The configuration file for Load is named as LoadConfiguration.xml.

  Note: The Load path value must point to a valid loader configuration file.

  For each specific setting, you can type the path of the configuration file (.xml file) or click File Selector at the end of the box. To modify the respective configuration files, click .

1. Click the icon to browse to the path of configuration settings.

2. Click Save Settings to save the Configuration field settings.

Note: Save Settings is applicable to all settings of the page. You can save the settings after filling the required information in General settings.