# IdML Relationship Connector

When an IdML book is authored, there are two main types of elements to add; configuration items (CI) and relationships. The IdML Relationship Connector writes relationship elements to open IdML books.

The IdML Relationship Connector supports AddOnly mode only.

## Configuration

The Connector needs the following parameters:

Class Type
  The name of the Common Data Model class for the relationship element (e.g. runsOn). This string should contain the prefix 'cdm:' (e.g. cdm:runsOn).
Book Name
  Name of an IdML book within the scope of the AssemblyLine. An Open IdML FC should already have opened this book before attempting to use this connector to write to it.
Detailed Log
  Enabling this will generate debug log messages.

## Connector Input

Some of the parameters configured in the Configuration screen of the IdML Relationship Connector can be provided as Attributes mapped from the work Entry in the Input Map. When present and non-empty, they take precedence over the parameters in the Configuration screen:

book.name
  This attribute, of type java.io.String, represents the name of the book in the context of the AssemblyLine data flow and overrides the 'bookName' configuration parameter.

## Adding 'source' and 'target' Attributes

There are two attributes that required to add an IdML relationship; source and target. The source and target attributes refer to the 'id' attribute of IdML elements. The source and target elements must be present in the book prior to the relationship being added. To specify the source and target attributes, add connector attributes called 'source' and 'target' respectively.