Documentation Center

SES Connector - Configuration parameters

Describes all the configuration parameters you can use to initialize the Tridion Docs SES Connector

Initialization

Parameters
Parameter nameUsageRequiredDefault value
ses.api.urlMain SES web services URL locationYes
ses.api.tbdbModel to target on the SES serverYes
request.timeoutTimeSpan that indicates the timeout for a request to the SES serverNo00:00:60 (=60 seconds)
request.retriesHow many times to retry a failed requestNo5
request.retries.sleeptimebetweenretriesTimeSpan that indicates the time to wait before retrying a failed attemptNo00:00:01 (=1 second)
request.maxparallelMaximum number of http requests to the SES web services to execute in parallelNo1
request.maxurllengthMaximum amount of characters allowed in a URLNo2000
retrieve.stoplimitUsed to limit the amount of tags (and perhaps also relations) that are returned from the RetrieveTags and RetrieveTagStructure methods. Note that once this limit is reached, the connector might still return more hits than configured in order to give a consistent result of tags and relations. If the amount of hits is higher than this limit a warning message will be added to the result, even when the entire result set is returned.No10000
metadatabindingXML that contains the field information and which entry points, selection, relations, ... that need to be used to retrieve the termsYes
relationsXML that contains the information about the relationsYes
languagemappingsXML that contains a mapping to obtain the SES language for a given languageNodefault language configured in SES
Example

<infoShareExtensionConfig version="1.0">
  <metadatabindings>
    <metadatabinding ishfieldname="FLOCATION" sourceref="SmartLogicSESDataSource" />
  </metadatabindings>
  <sources>
    <source id="SmartLogicSESDataSource" handler="SmartLogicSESConnector">
      <initialize>
        <parameters>
          <parameter name="ses.api.url">http://smartlogic.example.com/ses</parameter>
          <parameter name="ses.api.tbdb">Example</parameter>
          <parameter name="request.timeout">00:03:00</parameter>
          <parameter name="request.maxurllength">2000</parameter>
          <parameter name="retrieve.stoplimit">50000</parameter>
          <parameter name="metadatabinding"></parameter>
          <parameter name="relations"></parameter>
          <parameter name="languagemappings"></parameter>
        </parameters>
      </initialize>
    </source>
  </sources>
</infoShareExtensionConfig>
(http://smartlogic.example.com/ses, where smartlogic refers to an example server dedicated to logic.)

Metadatabinding parameter

XML elements
NameDescription
fieldsConfiguration of fields
fieldConfiguration for the field
field @nameThe name of the field
field @levelThe level of the field
readContainer element of the configuration settings for retrieving and validating values
entrynodesCan be used to specify which terms to see as root elements. If no entry points are present, all root terms of the tree structure in SES are shown
staticCan be used to configure some fixed term ids (static entry points), so that the tree structure will only show these terms as root terms, so it limits the tree structure to the subtrees of those terms
idTerm id to use as root term. Multiple are allowed to specify multiple root terms.
dynamicCan be used to configure that you want to use the values (terms) the user selected for another field as root terms for this fields tree structure (dynamic entry points), so it limits the tree structure to the subtrees of the terms of that field.
dynamic field @name @levelField name and level to use as dynamic entry point field, so the field were the user selected the values (terms) to use as root terms
dynamic field conversionOptionally a conversion relation can be added to use the terms related to the values the user gave in, instead of the selected user values themselves
dynamic field conversion relationConversion relation. Only one is allowed and is only followed once (so non-recursively)
dynamic field conversion relation @refReferences an id of a relation defined in the relation parameter
fieldfiltersField to use as filtering field, so the field were the user selected the values (terms) to use as filter terms. Only the tree structure that were these terms appear are shown.
fieldsfilter field @name @levelField name and level to use as filter field
fieldsfilter field conversionOptionally a conversion relation can be added to use the terms related to the values the user gave in as filter terms, instead of the selected user values themselves
fieldsfilter field conversion relationConversion relation. Only one is allowed and is only followed once (so non-recursively)
fieldsfilter field conversion relation @refReferences an id of a relation defined in the relation parameter
selectableDefines whether the term is selectable. Normally all terms will be selectable unless you use conditions.
conditionCondition that specifies which term is selectable. Multiple are allowed and or'ed.
condition @nameName of the condition to use. Only CLASS is supported at this moment. The value of the class is put as text inside the condition element.
relationsDefines the relations to follow to build up the tree structure. All relations referenced here are followed multiple times (recursively).
Example
  
<parameter name="metadatabinding">
  <fields>
    <field name="FRMEQUIPMENTPERROOMDR" level="version">
      <read>
        <entrynodes>
          <dynamic>
            <field name="FRMLIVING" level="version">
              <conversion>
                <relation ref="space2equipment" />
              </conversion>
            </field>
          </dynamic>
        </entrynodes>
        <selectable>
          <condition name="CLASS">equipment</condition>
        </selectable>
        <relations>
          <relation ref="equipment" />
        </relations>
      </read>
    </field>
    <field name='FPRODUCTTYPE' level='logical'> 
      <read>
        <selectable>
          <condition name='CLASS'>screwdriver</condition>
        </selectable>
        <relations>
          <relation ref='nt'/>
        </relations>
      </read>
   </field>
    <field name='FPRODUCT' level='logical'>
      <read>
        <entrynodes>
          <static>
            <id>389098690543540949278263164977385</id>
          </static>
        </entrynodes>
        <fieldfilters>
          <field name='FPRODUCTTYPE' level='logical'/>
        </fieldfilters>
        <selectable>
          <condition name='CLASS'>screwdriver</condition>
        </selectable>
        <relations>
          <relation ref='nt'/>
        </relations>
      </read>
    </field>
    ...
  </fields>
</parameter>

Relations parameter

XML elements
NameDescription
relationsContains all the relation definitions
relationUsed to define the relation
relation @typeType of the relation, either "associative" or "hierarchical".
relation @idId of the relation. You can choose your own id, but it should be unique.
relation @abbreviationAbbreviation which must match a relation abbreviation defined in SES
relation @directionDirection on how to follow the relation. At the moment only "Forward" is supported.
fromDefines whether the relation is appropriate to follow from the start term of the relation.
toDefines whether the relation is appropriate to follow from the end term of the relation.
conditionCondition that specifies whether to follow the relation for the term. Multiple are allowed and or'ed.
condition @nameName of the condition to use. Only "CLASS" is supported at this moment. The value of the class is put as text inside the condition element.
Example
 
<parameter name="relations">
  <relations>
    <relation type='associative' id='country2language' abbreviation='CC-LC' direction='Forward'>
      <from>
        <condition name='CLASS'>country_value</condition>
      </from>
      <to>
        <filter name='CLASS'>language_value</filter>
      </to>
    </relation>
    <relation type='hierarchical' id='ntrecursive' abbreviation='NT' direction='Forward'/>             
    <relation type='hierarchical' id='nttocity' abbreviation='NT' direction='Forward'>
      <from>
        <condition name='CLASS'>continent</condition>
        <condition name='CLASS'>country</condition>
      </from>
      <to>
        <condition name='CLASS'>city</condition>
      </to>
    </relation>
  </relations>
</parameter>

Language Mappings parameter

XML elements
NameDescription
mappingsContainer element for language conversions. If no match is found the default language defined in SES is used.
addAdds a possible mapping between a language coming from Content Manager and a SES language
add @inputContent Manager language
add @seslanguageMatching SES language
Example

 <parameter name="languagemappings">
   <mappings>
      <!--Trisoft Language-->
      <add input='en' seslanguage='English'/>
      <!--Windows System Language-->
      <add input='en-US' seslanguage='English'/>
    </mappings>
  </parameter>