Generate Document

Use this action to validate and generate a report-based document for the selected business objects. The document must be based on a report for this action to function.

Note: It is recommended that both the document type and the report should either be consolidated or neither should be consolidated for the report generation to work properly.

You can generate a single consolidated document for multiple objects using this action. For example, you can generate a single Certificate Of Origin for multiple campaign lines at the same time.

If you select multiple objects and a document type of 'consolidated', then a consolidated document and corresponding link documents are generated for the objects. Otherwise only individual documents are generated for the objects selected.

If you select multiple objects and a document type of 'standard', then standard link documents are created. Else, if the document type is 'consolidated' then ad hoc link documents are created along with the consolidated document for the selected objects.

You can also use this action to update the content of a consolidated document, which in turn will be reflected in all the documents linked to it.

For a standard document, the resulting report can replace existing content or be added as a new revision. For additional documents, you can only generate a document once. Once a standard document is finalized, any attempt to upload, generate, or remove the document will fail.

The corresponding agent action is Generate Standard Document, and appears on business objects such as buy shipments, trading partner items, trade transactions, campaigns, campaign lines, etc.

The following options are available when generating an additional document. Generating a document is similar to running a report.

Generating a Document

  1. Select the type of document you want to generate from the Document Type drop-down list. When generating a document from a business object, Oracle Transportation Management lists available document types allowed for generation. Only document types that are set up to be Owned By the business object are available for generation. For example, A Bill of Lading document that is owned by an order release cannot be generated from a claim.

Note: If you select a Document Type of 'consolidated', a Document Number field will be displayed. Enter a number in this field. This number is a document context qualifier which identifies a consolidated document. If you are generating a consolidated document with the same document number again, then the consolidated document revision is created with the incremental revision number. Document Number and Document Revision are stored as document context qualifiers with the qualifier name provided in the glog.document.properties for respective data query type.

For generating a consolidated document on multiple objects, following are the mandatory configurations:
1. While creating the data model in BIP report server for the report specified in the Document Type field, the SQL query must have "IN" instead of "=" where this parameter is being used.
2. The parameter defined in the data model in BIP report server must have the check box "Text field contains comma separated values" selected.                                                                                                      
The optional feature "DOCUMENT NUMBER OPTIONAL FOR CONSOLIDATED DOCUMENT" is used to make the document number non-mandatory while adding or generating a consolidated document. When the feature is opted in, providing a document number is optional for consolidated documents. When the feature is opted out, providing a document number is mandatory while adding or generating a consolidated document. 

  1. Enter the required dates in the Effective Date and Expiration Date fields.
  2. Select the Add New Revision check box to create a new revision of the document.
  3. Enter any additional note in the Annotation field.
  4. Select the required option from the Content Management System drop-down list. This selection determines how the generated reports are saved as document attachments to each associated business object. If you leave this field blank, each report is generated for immediate distribution, such as email or printing, and not saved. If you select "DATABASE", a persistent document is attached to the business object containing the report content.

Delivery/Format

Use this section to determine how you want the document to look, and how you want it delivered. Specify what to do with the generated content, such as create a PDF, HTML, or Excel, etc. and print it or email it. For more detail, see the Delivery/Format section of the Run Reports/Documents topic.

Click Generate to generate the document.

Parameters

If the report backing the document requires additional parameters, both the standard documents and the additional documents use of Generate Document will have this section. The parameters are the extra report parameters needed to complete the report, with the exception of the object GID.

See the Entering Parameters section of the Run Reports/Documents topic for detailed information.

Storage

If you do not want to store the content of the document, select the Preview check box.

Document

This section only appears for standard documents. For more detailed information, see the Document section of Run Reports/Documents.

Related Topics