# Close IdML Function Component

The Close IdML Function Component is used to explicitly close an IdML book.

## Configuration

Book Name
  Name of the book within the scope of the AssemblyLine.
Detailed Log
  Enabling this will generate debug log messages.

## Function Component Input

Some of the parameters configured in the Configuration screen of the Close IdML FC can be provided as Attributes mapped from the work Entry in the Output 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 Assembly Line data flow and overrides the 'bookName' configuration parameter.

## Function Component Output

Once the Close IdML FC has executed, the FC makes the following attributes available for attribute mapping (read through the Input Map tab):

idml.bookName (String)
  The file name of the book, generated from the associated Open IdML FC configuration parameters. The file name does not include the absolute path, only the name of the generated file.

## Using the FC

The Close IdML FC may be used within an AssemblyLine containing other TDI components such as Connectors and other Function Components. An Open IdML FC with the same 'bookName' is required to be used before using the Close IdML FC.

The Close IdML FC is optional because the Open IdML FC will close the book and validate it when the AssemblyLine terminates. The Close IdML FC should be used when there is a need to explicitly close the book so that other actions can be taken with the book. Such actions might include transfer of the book to a discovery library file store.

The Close IdML FC will also validate the book if the validation parameter was selected on the Open IdML FC. If this is the case, the Open IdML FC will detect that the book has been validated and will not validate the book twice.