Report Objects
A report object is a type of content in a report in CDM. You can add as many report objects as necessary to a report.
As the administrator, you can add or delete report objects at any time when you are building a new report, or when you are working with an existing report. Users can edit existing report objects, but they cannot add report objects to, or delete report objects from, a report.
CDM includes these report object types:
- Excel objects
- Word objects
- PowerPoint objects
- PDF objects
- Web Page objects
Add a Report Object to a Report
You can add a report object to a report.
When a report is opened by filtering one or more custom groups, report objects that are added are automatically assigned to the custom group or groups.
To add a report object to a report:
- Open the report that you want to work with.
- In the report tree on the left, right-click the name of the report, click Add Child, and then the report object type. You can select one of the five report object types: Excel Object, Word Object, PowerPoint Object, PDF Object, and Web Object. You can also select Shared Report Object or Section.
- The report object appears in the User Object Summary tab in the work area.
Change the Order of Report Objects in a Report
You can change the order of report objects in a report. Report objects can appear in any logical order in a report.
- Open the report that you want to work with.
- The report objects display in the report tree in the order that they will appear in the report when it is generated.
- To change the order that a report object appears in the report, drag and drop it to a different location in the report tree. When you drag the report object, you can see icons that indicate locations that are, or are not, appropriate new locations. You can also see the following messages to help you place the report object where you want it: Drop Before, Drop After, and Drop In.
- Click Refresh.
Edit the Properties of a Report Object
- Open the report that you want to work with.
- In the report tree, right-click the report object and click Properties > Manage All Object Properties.
- In the Properties tab of the Properties and Comments window, edit the properties as you want. You can change any property that is not gray.
- Click OK.
You can view or edit the following information:
Property |
Report Object Type |
Description |
|---|---|---|
Name |
All |
User specified name for the report object. Each report object or section must have a unique name. |
Report Object Due Date |
All |
The due date of the report object. |
Inherit Due Date |
All |
If selected, the report object inherits the due date from its parent section due date or the report due date, depending on its position in the report hierarchy. |
Workflow Due Date |
All |
The due date of the current workflow. |
Inherit Workflow |
All |
If selected, the report object inherits the workflow due date from its parent section workflow due date or the report workflow due date, depending on its position in the report hierarchy. |
Document Type |
Word |
The document type for the current Word object.
|
Print Options |
Excel, Word, and PowerPoint |
The print options for the current report object.
|
Break Type |
Excel, Word, and PowerPoint |
When you specify a break type, you can specify the number of pages, rows, or slides to use for spacing. You cannot assign break types to Web Page and PDF objects because these report objects are not included in the generated report. |
Continue with Next |
Word |
Specifies a string of text that is displayed on the second and later pages of a report if the current report object that contains a note variable heading exceeds one page. |
ToC Variable |
Excel, Word, and PowerPoint |
Defines a table of contents variable for the report object. You cannot assign ToC variables to Web Page and PDF objects because these report objects are not included in the generated report. |
Note Type |
Excel and Word |
Specifies the note types that the report uses.
You cannot assign note variables to Web Page and PDF objects because these report objects are not included in the generated report. |
Active User |
All |
Displays the user who checked out the current report object. |
Current Workflow State |
All |
Shows the current workflow state of the report object. |
Share Report Object |
All |
Marks the current report object as shared and makes the report object visible in the window that opens when you add reference objects. When a report object is set as shared, an icon in the report tree beside the report object name indicates that the report object is a shared object. |
Include in XBRL Inline Generation |
Specifies whether to include the PDF content in XBRL inline generation. This feature is only available for ESMA jurisdiction. It allows you to add supplementary documents to an annual filing to meet a jurisdictional compliance requirement.
When multiple PDF objects are included before/after the generated document, they will be stitched at the beginning/end of the document, in the same order they are found in the report tree. The PDF content will always start on a new page. |
- You can modify properties for a report object only if you have checked it out and have permission to modify report object properties. You cannot modify report object properties if the report object is checked out by another user. Also, if a report object is checked out and the session state is invalid, for example as a result of a crash, you cannot modify report object properties, until the object is forcefully checked back in.
- If you use CDM in Arabic and you select Contextual for Digit Shaping in the Options window, some dates in report properties might appear with European number shaping. The dates that might appear with European number shaping are those that are selected through a calendar field in CDM.
Associate a Report Object with a Custom Group
You can associate a report object with a custom group. However, before doing this, you must define the custom groups that you need. For each Excel, Word, or PowerPoint object, you can select one or more groups.
When a report is generated using a custom group, CDM filters out and excludes any report objects that are not part of the selected group.
When a report is opened by filtering one or more custom groups, report objects that are added to the report are automatically assigned to the custom group or groups.
To associate a report object with custom groups:
- Open the report that you want to work with.
- In the report tree, right-click the report object that you want to associate with a custom group and select Properties > Custom Groups.
- Select the custom group that you want to associate with the report object and click the single arrow to move it to the appropriate pane. To associate all custom groups with the report object, click the double arrow to move them to the appropriate pane.
- Click OK.
Include or Exclude Report Objects in a Generated Report
Print options can be used to control print and print-type properties for report objects and sections.
Printable Property
You include or exclude report objects from a generated report by using the Printable property.
You can set the Printable property for an individual report object to include or exclude it from a generated report. You can also set the Printable property for a section to include or exclude all its report objects and subsections from the generation.
When a section is set to Not Printable, the descendant report objects and sections appear as Not Printable. The section descendants' Printable property is grayed out and you cannot change their Printable property.
The explicit Printable property of report objects and sections is maintained in CDM, therefore, you can change the Printable property of a parent section without modifying the Not Printable property of a report object that is not to be printed.
Variables defined in Microsoft Excel objects that are Not Printable are still resolved when referenced in other CDM report objects.
Print Type Property
You can use the Print Type property to determine if Microsoft Word, PowerPoint, and Excel objects or sections are to be generated in the main report, in an exhibit, or are supporting documents.
When adding or importing a child report object or section to an exhibit section, the Print Type property is automatically set to Exhibit. The report object or section is included in the generation of the exhibit section. This property can not be changed. Such report objects can be additionally marked as Exhibit Supporting Document using the report object properties.
In all other scenarios, the default Print Type for newly created or imported report objects and sections is to be included in the main report. Such report objects can be additionally marked as Supporting Document using the report object properties. You can then use the Include Supporting Documents and Include supporting documents in the main report generation options to control how supporting documents are generated and accessed.
Set the Printable Property for a Report Object or Section
- Open the report that you want to work with.
- To exclude a single report object from generation, right-click it and select Properties > Printable > Not Printable.
- To exclude all of descendant report objects in a section, right-click the section and select Properties > Printable > Not Printable.
- To make a report object or section eligible for generation again, right-click and select Properties > Printable > Printable.
Tip: When sections or report objects in a report are set as Not Printable, their names in the report tree become lighter and more transparent. You can also set a report object or section as Not Printable in their Properties and Comments window (right-click and select Properties > Manage All Object Properties and clear the Printable checkbox).
Push Report Objects Down to Cascaded Reports
You can push down one or more report objects from a master report to cascaded reports.
- In the destination report, you need permission to view the report and to add report objects.
- In the source report, you need permission to push down report object updates and to create report objects.
As you add new report objects to a master report, you can add copies of these report objects to any cascaded reports by pushing the report objects down.
In a cascaded report, pushed-down report objects appear in the report tree under the Pushed Down Objects heading. Report objects under this heading are not included when you generate the report. If you want to include any pushed-down report objects in a generated report, drag the report objects to a different part of the hierarchy.
To push report objects down to cascaded reports:
- Open the report that you want to work with.
- In the report tree, right-click the report object that you want to push down to the cascaded reports and select Pushdown.
Tip: If you want to push down more than one report object at once, press CTRL and select multiple report objects. Then right-click in the report tree and select Pushdown.
- Select the checkboxes for the cascaded reports that you want to push the report object down to, and click OK.
- A copy of the report object is pushed down to the cascaded reports. If you push down a report object that already exists in the cascaded report, a number is added to the name of the report object.
Note: By default, pushed-down report objects are not printable.
Delete a Report Object from a Report
If you no longer need a report object, you can delete it.
Important: If you delete a report object, you cannot undo your action. Proceed with caution.
To delete a report object from a report:
- Open the report that you want to work with.
- In the report tree, right-click the report object that you want to delete and select Delete.
- In the confirmation window, click Yes.