Creating reports for selected objects


In Developer Studio, you can create reports that detail the properties of the following AR System server objects:

  • Working lists
  • Applications
  • Packing lists
  • Objects in object lists
  • Objects in packing list

For more information, see To create a report about selected objects.

You can also create reports from the following tabs:

  • Analyzer Results
  • Relationships
  • Search Results

For more information, see To create a report from a tab.

Reports are available in PDF, RTF, or HTML format.

 To create a report about selected objects

  1. Select the objects for the report:
    • In the AR System Navigator, select a working list, application, or packing list.
    • In a packing list, select an object.
    • In an object list, select one or more objects.
  2. Right-click and select Document.
    The Document Objects dialog box appears, displaying the Select Objects page, as shown in the following figure.
    Document Objects dialog box
    DocObjects.gif
  3. To add more objects to include in the document:
    1. Click Add.
    2. In the Add Items dialog box, use the Filtering Options section to filter the options that are listed.
    3. From the list, select the objects you want to add. (Use the CTRL or SHIFT key to select more than one object.)
    4. From the Add Items with Related Property list, select one of the following options:
    5. Click OK.
  4. (Optional) To change which related objects appear in the document, in the Document Objects dialog box, select an object, and click the appropriate button:
    • Object Only
    • Directly Related Objects
    • All Related Objects
  5. Click Next.
    The Output Details Page appears as shown in the following figure.
    Output Details Page
    OutputDetailsPg.gif
  6. On the Output Details Page, select the options for your document.
    1. (For objects that contain forms) To create separate reports that outline information about the fields on the selected forms, select the Document Fields option, and then select one of the following options:
      • Summary—Lists a summary of details about each field. Details include field name, ID, type, length, and permissions. One summary document is created.
      • Detail—Lists details about the properties of each field on the selected forms. A separate document is created for the each form. The names for these separate documents include a prefix (if any), the form name, and a suffix called _Fields.
        For example, if you document the AlertList and Adhoc:Dialog forms (with a prefix of doc), a doc_forms document is created to describe the two forms. Additionally, the following documents are created to describe the details about the fields: doc_AlertList_Fields and doc_Adhoc_Dialog_Fields. (Special characters, such as colons [:], are replaced with a underscores [_].)
        The Document Fields option is disabled if you did not select any forms for the report.
    2. To specify what appears in the report for all objects, select one of the following options:
      • Regular—Lists all of the properties of the object
      • Help Text and Change History—Lists details about help text and change history only
    3. In the Output Details section, select one of the following options:
      • To File—If you select this option, select the file format (RTF, PDF, or HMTL). Optionally, include a prefix to add to each document's file name. Enter the path to the output folder.
        To open the folder that contains the files after you click Finish, select the Show Output Folder When Complete check box.

        The PDF option cannot generate Japanese characters. For objects in Japanese locales, select RTF or HTML.

      • To Printer—Click Print Setup to select a printer.
  7. Click Finish.
    The Progress tab displays the progress of the report creation.
    A document is created for each object type that you selected. For example, if you selected forms and their related objects, and active links were related to the forms, two documents would be created—one for the forms and one for the active links.

 To create a report from a tab

  1. In Developer Studio, place focus on the tab for which you want to document: Analyzer Results, Relationships, or Search Results.
  2. Select File > Document.
  3. Select a location for the file.
  4. In the File Name field, enter a name for the report.
  5. From the Save as Type drop-down list, select a file format:
    • PDF
    • RTF
    • HTML
  6. Click Save.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*