<?xml version="1.0" encoding="UTF-8"?>
<!--

    Copyright 2005-2014 The Kuali Foundation

    Licensed under the Educational Community License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.opensource.org/licenses/ecl2.php

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

-->
<chapter xml:id="document_type" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook"  version="5.0">
    <info>
        <title>Document Type</title>
    </info>
    <para>Administration > Workflow > Document Type</para>
    <para>The Document Type document defines basic information about the document types that exist
        in applications. It also defines document types specific to workflow and KIM. Many
        attributes of a document type not defined here are included in its workflow process
        definition and the data dictionary (a technical resource). The workflow process definition
        for a document type can be viewed using the Document Type lookup.</para>
    <para>Document Type documents can only be created by members of the KR-SYS Technical
        Administrator or suitable application roles and they do not route for approval.</para>
    <section>
        <title>Document Layout</title>
        <para><figure><title>Document Type document</title>
            <mediaobject>
                <imageobject>
                    <imagedata fileref="../images/help/document_type_document.png"/>
                </imageobject>
            </mediaobject>
        </figure></para>
        <para>The Document Type document contains the <emphasis role="bold">Edit Document
                Type</emphasis> tab and the <emphasis role="bold">Fields Available for Retroactive
                Application</emphasis> tab.</para>
        <section>
            <title>Edit Document Type Tab</title>
            <para><figure><title>Edit Document Type tab</title>
                <mediaobject>
                    <imageobject>
                        <imagedata fileref="../images/help/edit_document_tab.png"/>
                    </imageobject>
                </mediaobject>
            </figure></para>
            <para>
                <table frame="none" tabstyle="striped">
                    <title>Edit Document Type tab definition</title>
                    <tgroup cols="2">
                    <colspec colwidth="1.0*"/>
                    <colspec colwidth="1.0*"/>
                    <thead>
                        <row>
                            <entry>Title</entry>
                            <entry>Description</entry>
                        </row>
                    </thead>
                    <tbody>
                        <row>
                            <entry>Parent Name</entry>
                            <entry><para>Required. Every document type must answer to another document type in a parent/child
                                    relationship. Use the lookup to search for the document type to
                                    which this document type will answer.</para><para>Document types can inherit important attributes from their parent document types, including
                                    permissions and responsibilities.</para></entry>
                        </row>
                        <row>
                            <entry>Name</entry>
                            <entry>Required. The common name of the document type.</entry>
                        </row>
                        <row>
                            <entry>Document Handler URL</entry>
                            <entry>Optional. (Technical) Identifies the basic URL that will take a user
                                to this document type.</entry>
                        </row>
                        <row>
                            <entry>Notification From Address</entry>
                            <entry>Optional. The email address that will appear as the 'From' address
                                on any action list notifications sent by workflow for this document
                                type. This allows several applications using workflow to maintain
                                separate notification email addresses.</entry>
                        </row>
                        <row>
                            <entry>Active</entry>
                            <entry>Required. The box should be checked if the document type is active
                                and available for use. Uncheck the box to inactivate the document
                                type.</entry>
                        </row>
                    </tbody>
                    </tgroup>
                </table>
            </para>
        </section>
        <section>
            <title>Fields Available for Retroactive Application Tab</title>
            <para>These are Document Type attributes that can be edited retroactively if need be.
                This means that should you decide to change one of these values for a given document
                type it is possible to apply the change retroactively to any documents of this type
                already created. For example, if you decided to change the Label of the Budget
                Adjustment document type you could choose that have that label change apply to
                historical Budget Adjustment documents in your KFS system.</para>
            <para><figure><title>Fields Available for Retroactive Application tab</title>
                <mediaobject>
                    <imageobject>
                        <imagedata fileref="../images/help/retroactive_application_tab.png"/>
                    </imageobject>
                </mediaobject>
            </figure></para>
            <para>
                <table frame="none" tabstyle="striped">
                    <title>Fields Available for Retroactive Application tab definition</title>
                    <tgroup cols="2">
                    <colspec colwidth="1.0*"/>
                    <colspec colwidth="1.0*"/>
                    <thead>
                        <row>
                            <entry>Title</entry>
                            <entry>Description</entry>
                        </row>
                    </thead>
                    <tbody>
                        <row>
                            <entry>Label</entry>
                            <entry>Optional. The Label appears in most places where document types are
                                displayed in results (including the action list and document search
                                screens) and is commonly longer than the document Name, which is
                                often an abbreviation.</entry>
                        </row>
                        <row>
                            <entry>Description</entry>
                            <entry>Optional. A text description of this document type.</entry>
                        </row>
                        <row>
                            <entry>Help Definition URL</entry>
                            <entry>Optional. (Technical) Identifies the URL where the online help
                                content for this document type resides.</entry>
                        </row>
                        <row>
                            <entry>Document Search Help URL</entry>
                            <entry>Optional. (Technical) Identifies the URL where the online document
                                search help content for this document type resides.</entry>
                        </row>
                        <row>
                            <entry>Apply Label Change Retroactively</entry>
                            <entry>Optional. Check this box only when updating an existing document
                                type and only if you wish the fields on this tab to be updated on
                                previously created versions of documents of this type.</entry>
                        </row>
                    </tbody>
                    </tgroup>
                </table>
            </para>
        </section>
        <section>
            <title>Document Type Inquiry</title>
            <para>The Document Type Inquiry contains some additional fields that are not defined on
                this document but referenced from their source (either the corresponding workflow
                process definition or data dictionary information). These fields are defined
                below.</para>
            <para><figure><title>Document Type Inquiry</title>
                <mediaobject>
                    <imageobject>
                        <imagedata fileref="../images/help/document_type_inquiry.png"/>
                    </imageobject>
                </mediaobject>
            </figure></para>
            <para>
                <table frame="none" tabstyle="striped">
                    <title>Document Type Inquiry definition</title>
                    <tgroup cols="2">
                    <colspec colwidth="1.0*"/>
                    <colspec colwidth="1.0*"/>
                    <thead>
                        <row>
                            <entry>Title</entry>
                            <entry>Description</entry>
                        </row>
                    </thead>
                    <tbody>
                        <row>
                            <entry>Parent ID</entry>
                            <entry>Display only. The unique, system-generated ID number that identifies
                                the parent document of this Document Type.</entry>
                        </row>
                        <row>
                            <entry>ID</entry>
                            <entry>Display only. The unique, system-generated ID number that identifies
                                this document type.</entry>
                        </row>
                        <row>
                            <entry>Post Processor Class</entry>
                            <entry>Display only. (Technical.) Identifies the post processor this
                                document type calls upon reaching a completed workflow status
                                (usually 'Final' or 'Processed'). The post processor is the code
                                that tells and application what tables to update when a document is
                                approved. </entry>
                        </row>
                        <row>
                            <entry>Service Namespace</entry>
                            <entry>Display only. The namespace (large functional category) that is
                                associated with this document type.</entry>
                        </row>
                    </tbody>
                    </tgroup>
                </table>
            </para>
        </section>
    </section>
</chapter>
