Appendix - Configuration Parameters

The following tables detail the parameters that you can use to configure the ENOVIA ER connector.

This page discusses:

See Also
Connectivity Modes
Configuring the Connector in 3DSpace Mode
Configuring the Connector in HTTP REST Mode
Configuring the Connector in Local Context Mode

Connection Parameters

Parameter Description
Component class name

Select On premise.

Connectivity mode

Select the connectivity mode to connect to ENOVIA.

  • Local Context - Use this mode to connect to ENOVIA using the DMP studio agent through OCI.

    This RMI In-Process (RIP) mode uses the Live Collaboration Server implementation classes. However, instead of going through a registry and invoking a separate process, the client's address space loads the server classes directly.

    Database communication is directly between the ENOVIA client and the database. This is more efficient in situations that involve processing an extremely large number of transactions.

    This mode reduces the load on the HTTP ENOVIA server.
  • REST - In this mode, you can crawl data from the ENOVIA Tomcat server in HTTP Rest mode.

    It allows you to connect remotely on a CAS-secured instance.

  • 3DSpace - New mode to connect to ENOVIA through the 3DSpace.
  • Legacy XML Servlet - Do not use this mode.
URL

Specify the base URL of the 3DSpace, or leave empty if you use Local Context.

Login

3DSpace | XML Servlet | Local Context user login for indexing documents. Read-access required.

Password

3DSpace | XML Servlet | Local Context password for the ENOVIA user.

Role

Role that can access ENOVIA.

Vault

Optionally, you can specify the name of the ENOVIA vault you want to index. If you do not specify any vault, the connector scans all vaults.

Important: It is possible to use different connectivity modes on several vaults in parallel.
Event monitor name

Optional. Specifies the Event monitor name, if you want to create an Event monitor to manage incremental indexing. By default, the connector uses an incremental scan based on dates.

Important: Defining the Even monitor name is one of the steps in the Event monitor configuration. To get the complete procedure, see Adding an Event Monitor for Incremental Indexing.
Has write access

Allows the connector to modify the content of the database. It is typically useful for the following use cases:

  • If you use an Event Monitor, the connector can purge consumed events out of the database. If the write access is not enabled, events remain in the database and you must purge them manually.
  • If the FCS is remote, the connector needs to update file synchronization information.
Tenant

This is for Cloud deployments. For NETVIBES experts only.

Query Parameters

Parameter Description
Component class name

Configure query using:

  • UI - that is to say through the Exalead CloudView Administration Console, by listing Business objects and Relationships below this property. This configuration type applies to the 3DSpace connectivity mode only. It is based on 3DSpace NLS files.
    • Translate into: Translates workflow fields (for example, STATE).
    • Translate all selects: Translates all fields.
    • Names conform with data-model: Adapts the meta name to conform with the name rules of a data model. Names must conform with the regular expression [A-Za-z0-9_]+
  • file - through a configuration file (same configuration mode than the legacy ENOVIA SBA connector).
    • Query configuration file path: Specify the file path of the configuration file. It must be on the same server than your ENOVIA instance. The xml nodes correspond to the UI options that found in this table. See the Configuration File Example below.
Business objects
Enovia type name

Name of the Business Object type.

Make a query by subtype

Useful when data is very split. For example, when a Designer Central contains all CAD types and several subtypes, we can make a query for each subtype. This option gives you multithreading capabilities.

Important: Leave empty if you have more than one object type to index.
Where clause

Filters objects. For example, owner == <login>

Index basics

Indexes all ENOVIA basics attributes. For example, all IDs.

Recommendation: Avoid using this option as it has an impact on performance. It is better to specify Selectables in the configuration (see below).
Index all attributes

Indexes all ENOVIA attributes.

Recommendation: Avoid using this option as it has an impact on performance. It is better to specify Selectables in the configuration (see below).
Index files

Indicates whether to index files for this Business object type.
Trace tenant

If your server vault has multiple tenants, it traces the source tenant by storing this info in a specific tenant meta.

Trace history

Indicates whether to trace history events as documents linked to the Business Object.
Trace type lineage

Creates a taxonomy of Business object types. It stores the hierarchy of the object using a | (pipe) separator. For example, MCAD Model|3DPart|CATIA Part

Preserve empty values

Shows attribute names in search results, even when these attributes have null or empty values.

Without this option, when an attribute is not valuated, Exalead CloudView cannot retrieve it and cannot produce a document with a meta containing the attribute.
CV type names

The first element in this item list must be the Data Model class and the hierarchy type root node of the Consolidation Server.

Include policies

Includes the specified Business object policies only.

Exclude policies

Excludes the specified Business object policies only.

Selectables

Use selectables to use basic or other ENOVIA attributes without attribute [<ATTRIBUTE_NAME>] curly braces inclusion. You can use the target meta name to copy basics or attributes into one or several metas.

Programs

For legacy mode we need to support JPO, TCL or MQL. The connector sends the code to the ENOVIA kernel directly. From V6R2017x, it also supports JPO servers.
File filter

This node allows you to specify formats, extensions, etc. to accept or exclude during indexing. For example, you may want to index PDF and exclude XML files when indexing the content of a repository.

The Trace reason option allows you to log why Exalead CloudView did not index files (for debug purpose).

Relationships

The properties and options are the same that the Business Object ones.

Processing Parameters

Parameter Description
Component class name

Select processing policy. This is typically useful to get rid of items you do not want to index. Using a processor allows you to go further than using Include/Exclude policies as you can customize it to your own needs.

Advanced Parameters

Parameter Description
Pushed documents before checkpoint

Minimum number of documents pushed between 2 consecutive checkpoints. It is better to specify a low value when Exalead CloudView documents are sorted (default behavior), and take time to be processed (for example, documents in OnePart).
Connect to ENOVIA on apply configuration

The connector connects to ENOVIA automatically when you click Apply, to verify that the configuration is correct. For example, to verify that you there are no references to types that do not exist.

Push API thread count

Number of threads used to push data into the Exalead CloudView Push API Server. It is useful when converting documents using PushAPI filters.
Push API queue size

Maximum number of intermediary documents stored between the ENOVIA database and the Exalead CloudView Push API Server. When the number of documents reaches this limit, the connector stops reading the ENOVIA database, to stop receiving more documents.

Verbose

Useful to debug the connector configuration. Logs each event sent to the Exalead CloudView Push API. For internal use by Support teams only.

Multithreading strategy

Choose how to organize your thread pool.

  • Query: for on-premises deployment, Business Object and Relationship queries are executed in parallel on a single ENOVIA source.
  • Tenant: for cloud deployment, it allows you to index multiple ENOVIA sources at the same time.
Enovia indexing thread count

Number of threads used by Query or Vault Tenant Producers.

Refresh the data model at each scan

Each time a scan starts, it looks for changes in the data model. This is a costly operation. Use it only when your data model changes regularly. Do not use it if the data model never changes, or very rarely.

Graph management mode
  • Default E/R graph manager - This is the most simple mode as it allows you to simplify the naming of URIs. You can use the Trace tenant option for cloud deployments, to trace the ENOVIA vault and tenant.
  • ENOVIA SBA graph manager - The connector manages graphs like the legacy SBA connector (Exalead CloudView processes URIs and Consolidation Server object graph the same way).
File container handler

Specifies how to attach ENOVIA files as binary parts to Exalead CloudView documents.
Incremental scan options
  • Incremental timestamp offset: Specify the number of minutes to add to the last modified date checkpoint.
  • Force strict ordering: Specify the number of seconds between 2 consecutive scans. If the previous scan happened before this duration, then the connectors make a partial ordering over the modified date, else this is a strict ordering.
    • Negative value disables the partial ordering
    • 0 forces the partial ordering
    • Positive value gives the duration in seconds such as:

      Tn - Tn-1 this value, the where clause for query indexing is: modified previous checkpoint.

      Tn - Tn-1 > this value, the where clause for query indexation is: modified > previous checkpoint.
Delete options
  • Delete timestamp offset: Specify the number of minutes to add to the last delete date checkpoint.
  • Disable Where clause: If you do not select this option, the connector deletes all the documents corresponding to the reverse of the where clause, for each query made to the ENOVIA database. This can be costly.
    Recommendation: For better performance, select this option to avoid querying the ENOVIA database.
Send data model in consobox
  • Send the data model to consobox: Shows options to send documents describing the ENOVIA data model in the Exalead CloudView Consolidation Server.
  • Send dimension: Use it to see the dimensions referenced by the pushed attributes.
  • Arcs to interfaces: Draw arcs between the business objects or connections, and the interface types they reference. The connector requires this configuration to send interfaces to the Consolidation Server.
  • Arcs to relationships: Draw arcs between the connections and the relationship types they reference. The connector requires this configuration to send relationships to the Consolidation Server.
  • Arcs to types: Draw arcs between business objects and the types they reference. The connector requires this configuration to send types to the Consolidation Server.
  • Metadata type to send to the consobox can be of 3 types: Type, Relationship, or Interface. The Send attribute option sends the attributes attached to the Type. Select the User name for URI option to use the type name instead of the type id, to identify the documents stored in Exalead CloudView.
Error management

Specifies how to handle retry on errors for Business Objects retrieved from the ENOVIA database. It does not handle errors that may occur to the document afterward, for example, a faulty Push API filter or a Consolidation Server error.

  • Enable error management: Enables retry on error. If disabled:
    • The connector fails at the first error when retrieving data.
    • It does launch a retry, even if there is a major error requiring one.
  • Maximum number of retries: Specifies the maximum number of consecutive fetch retrieval errors a single object can trigger before being ignored. The connector launches each retry only once per scan, provided the query that fetched the object is still present. Possible values:
    • A negative value means that there is no upper limit.
    • 0 means that no retry is launched. The connector discards and logs every error.
    • A positive value (above 0) specifies the number of retries.
    Note: If the scan of a Business Object fails as many times as the maximum number of retries, but matches the WHERE clause in the following scan, the cycle starts once again.
  • Maximum number of errors: Specifies the maximum number of errors tolerated for a single scan. Once this number is reached, the connector generates an error. Possible values:
    • A negative value means that there is no limit in the number of errors.
    • 0 means that the first error stops the entire scan.
    • A positive value (above 0) specifies the number of tolerated errors for a given scan. This value may sometimes be crossed as the query can be executed in parallel.

Configuration File Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<query-config>

  <businessobject-meta-groups>
    <metas>
      <name>attributes</name>
      <selects>
        <select translated="false" select="Title">
          <target-metas>
            <meta-name>name</meta-name>
          </target-metas>
          <data-type>STRING</data-type>
        </select>
        <select translated="false" select="Originator">
          <target-metas>
            <meta-name>description</meta-name>
          </target-metas>
          <data-type>STRING</data-type>
        </select>
      </selects>
      <programs/> 
    </metas>
  </businessobject-meta-groups>

  <businessobject-queries>
    <query>
      <name>MCAD Model</name>
      <cloudview-types>
        <name>mcad_model</name>
        <name>model</name>
      </cloudview-types>
        <index-all-basics>true</index-all-basics>
        <index-all-attributes>false</index-all-attributes>
        <sorted>true</sorted>
        <index-files>true</index-files>
        <make-a-query-by-subtype>false</make-a-query-by-subtype>
      <includes>
        <name>attributes</name>
      </includes>
      <metas/>
      <file-filter>
        <max-file-size>-1</max-file-size>
        <trace-reason>false</trace-reason>
      </file-filter>
    </query>
  </businessobject-queries>

  <relationship-meta-groups>
    <metas> 
      <name>attributes</name>
      <selects>
        <select translated="false" select="IsFinalized">
          <target-metas>
            <meta-name>name</meta-name>
          </target-metas>
          <data-type>STRING</data-type>
        </select>
      </selects>
      <programs/>
    </metas>
  </relationship-meta-groups>

  <relationship-queries>
    <query>
      <name>VersionOf</name>
      <cloudview-types>
        <name>instance</name>
      </cloudview-types>
      <index-all-basics>false</index-all-basics>
      <sorted>false</sorted>
      <index-all-attributes>false</index-all-attributes>
      <make-a-query-by-subtype>false</make-a-query-by-subtype>
      <includes>
        <name>attributes</name>
      </includes>
      <metas/>
    </query>
  </relationship-queries>

  <translation-locale>en</translation-locale>
  <translate-all-selects>false</translate-all-selects>
  <datamodel-metaname-conformant>false</datamodel-metaname-conformant>

</query-config>

Advanced Parameters Not in the UI

For specific use cases, you can also edit other advanced parameters manually in the connector.properties file.

This file is present in:

  • The Exalead CloudView <DATADIR/connector-java0/config directory.
  • The ER Agent, either in the /config directory or in the Tomcat /config/bin directory if you have a 3DSpace configuration mode.
Note: This section does not give an exhaustive list of the connector.properties file parameters.

Parameter Description
relationship.invalid.basic.ignore

Use this Boolean parameter if the query sent to the ENOVIA database returns an object for which either the id or the PhysicalId attribute is empty:

  • If false (default value), the connector generates an exception and stops the indexing of the relationship.
  • If true, the connector generates an error message in the ER Agent (or in the connector logs if you use the Local Context mode), and continue its indexing job.
businessobject.invalid.basic.ignore

Use this Boolean parameter if the query sent to the ENOVIA database returns an object for which either the id or the PhysicalId attribute is empty:

  • If false (default value), the connector generates an exception and stops the indexing of the business objects.
  • If true, the connector generates an error message in the ER Agent (or in the connector logs if you use the Local Context mode), and continue its indexing job.