Maintaining document details

Unified Glossary

Basics of using a Ramco iEnterprise Series 4.0  Web Page

Using Online Help

This page allows you to maintain the document details such as document title, document subject, document type, document status, library number, document purpose, document category, number of copies of the document and applicability level. Tell me more.

The “Maintain Document Information” page appears.

Date & Time Format

The format in which the date and time fields are displayed in this page. This format is displayed from the "User Preferences" business component based on the login user ID. In case the format is not defined, the system displays the date and time format from the “Enterprise Modeling” business component by default.

The system displays the following in the “Document Details” group box:

Document #

The number identifying the document whose details are to be maintained.

Revision #

The revision number of the document.

Document Title

The name of the document (Alphanumeric, 150). Mandatory.

Zoom facility available.

Document Subject

A brief description about the document (Alphanumeric, 150).

Zoom facility available.

Document Type

Use the drop-down list box to specify the type of the document that is to be registered. The system lists all the active document types with “Maintained In Library?” field set as “Yes”, as defined in the “Create Reference Document Type” activity of the “Common Masters” business component.

The system also lists the inactive document type existing for the selected document and revision number combination.

Document Status

Use the drop-down list box to specify the document status. The system lists the following options:

  •  “Fresh” – Select this option if the document is yet to be approved for distribution.

  • “Active” – Select this option if the document is approved and operational, for distribution.

  • “Inactive” – Select this option if the document is temporarily withdrawn from distribution.

  •  “Revised” – Select this option if the new version of the document is approved.

  •  “Obsolete” – Select this option if the document  is no longer relevant for use and distribution.

Ref. Doc Type

Use the drop-down list box to specify the reference document type. The system lists the following options:

  • “Customer Order #” – Select this option if the reference document is a customer order.

  •  “Visit Package #” – Select this option if the reference document is a visit package.

  •  “Hangar Work Order” – Select this option if the reference document is a hangar work order.

  • “Work Scope #” – Select this option if the reference document is a work scope.

  • “Technical Log #” – Select this option if the reference document is a technical log.

  • “Engineering Order #” – Select this option if the reference document is an engineering order.

  • “Repair Order #” – Select this option if the reference document is a repair order.

  • “Other #” – Select this option if the reference document is any other document other than the options mentioned above.

Data selection in this field is mandatory, if “Ref. Doc Details” is specified.

The system leaves this field blank by default.

Ref. Doc Details

Any details pertaining to the reference document (Alphanumeric, 40).

Library #

Use the drop-down list box to specify the library where the document is to be maintained. The system lists all the active library codes as defined in the “Maintain Library Information” activity of the “Library” business component. Mandatory

Note: You can modify the library only if none of the copies of the document-revision number combination has distribution type as “Returnable”.

The system displays the following field in the “Library Details” group box:

Library Name

The name of the library.

Document Purpose

Use the drop-down list box to specify the purpose of the document. The system lists all the active quick codes of type “Document Purpose”, as defined in the “Maintain Quick Codes” activity of the “Library” business component.

The system also lists the inactive quick code of type “Document Purpose” existing for selected document and revision number combination.

By default, the system displays the default value set for the “Document Purpose” quick code type in the “Maintain Quick Codes” activity of the “Library” business component.

Data selection in this field is mandatory, if the “Mandatory ?” field is set as “Yes” for the “Document Purpose” quick code type in the “Maintain Quick Codes” page of the “Library” business component.

Document Class

Use the drop-down list box to specify the document class. The system lists all the active quick codes of type “Document Class”, as defined in the “Maintain Quick Codes” activity of the “Library” business component.

The system also lists the inactive quick code of type “Document Class” existing for the selected document and revision number combination.

By default, the system displays the default value set for the “Document Class” quick code type in the “Maintain Quick Codes” activity of the “Library” business component.

Data selection in this field is mandatory, if the “Mandatory ?” field is set as “Yes” for the “Document Class” quick code type in the “Maintain Quick Codes” page of the “Library” business component.

Document Nature

Use the drop-down list box to specify the nature of the document. The system lists all the active quick codes of type “Document Nature”, as defined in the “Maintain Quick Codes” activity of the “Library” business component.

The system also lists the inactive quick code type “Document Nature” existing for the selected document and revision number.

By default, the system displays the default value set for the “Document Nature” quick code type in the “Maintain Quick Codes” activity of the “Library” business component.

Data selection in this field is mandatory, if the “Mandatory ?” field is set as “Yes” for the “Document Nature” quick code type in the “Maintain Quick Codes” page of the “Library” business component.

Document Category

Use the drop-down list box to specify the category to which the document belongs. The system lists all the active quick codes of type “Document Category”, as defined in the “Maintain Quick Codes” activity of the “Library” business component.

The system also lists the inactive quick code of type “Document Category” existing for the selected document and revision number combination.

By default, the system displays the default value set for the “Document Category” quick code type in the “Maintain Quick Codes” activity of the “Library” business component.

Data selection in this field is mandatory, if the “Mandatory ?” field is set as “Yes” for the “Document Category” quick code type in the “Maintain Quick Codes” page of the “Library” business component.

Std. Distribution #

Use the drop-down list box to specify the standard distribution list to whom the document must be distributed. The system lists all the active standard distribution numbers, as defined in the “Maintain Library Information” activity of the “Library” business component.

The system leaves this field blank by default.

The system displays the following field in the “Additional Details” group box:

Dist. Name

The name of the standard distribution list.

Zoom facility available.

No. of Copies

The total number of copies of the document that are to be maintained in the library (Integer). Mandatory. Ensure that you enter a positive value.

The system displays the following fields:

Usable Copies

The total number of copies of the document that are in usable condition. The system displays the difference between the total number of copies and the total number of discarded copies.  The value is computed, based on the ‘Condition’ attribute saved in the ‘Record Document Distribution’ activity.

Discarded Copies

The total number of copies of the document that are discarded. For a new record, the system displays “0” on launch of the page.

Applicability Level

Use the drop-down list box to specify the applicability level of the document. The system lists the following options:

  • “Model” – Select this option if the document is applicable for an aircraft model.

  • ”Aircraft” – Select this option if the document is applicable for an aircraft.

  • “Parts” – Select this option if the document is applicable for a part.

  • “Others” – Select this option if the document is applicable to options other than those mentioned above.

Do not leave this field blank.

File Name

The name of the file attached to the document.

Help facility available.

Note: The system displays an error message, if any other concurrent user attempts to simultaneously modify the document details.

Note: You cannot update the document details for those documents that are in “Inactive” and “Obsolete” status.

You cannot modify the status of those documents that are in “Revised” status.

The system perfoms the following:

The system performs the following, if the library to which the document-revision number combination belongs, is changed:

To proceed, carry out the following:

The system displays the following fields in the “Record Statistics” group box:

Registered by

The name of the login user who registered the document.

Registered Date

The date on which the document was registered.

Registered at

The location at which the document is registered.

Last Modified by

The name of the login user who last modified the document.

Last Modified Date

The date on which the document was last modified.

Last Revised by

The name of the login user who last revised the document.

Last Revised Date

The date on which the document was lastly revised.

#Top

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Maintaining document details – An overview

This page allows you to maintain the document details. The document details such as document title, document subject, document type, document status, library number, document purpose, document category, number of copies of the document and applicability level are recorded in the page. This page also allows you to record the following:

Note: You cannot update the document details for those documents that are in “Inactive” and “Obsolete” status.

#Top