Copying documents between projects

You can copy a document between projects by creating a portable document, which contains all the design of the document without the data. The lack of data allows you to copy portable documents between projects, even when those projects do not have the same metadata. When you import the document into the replacement project, you map the document to the new project (referred to as reconciling the document).

High-level steps to copy a document between projects

The following checklist describes the high-level steps to copy a document between projects.

1. In the original project, create the document to be used as a portable document.

2. Export the document from the original project. Exporting creates a package file with the extension .pkg.

3. Import the document into the replacement project.

   The document is automatically checked to see if it needs to be reconciled. If it does, you are guided through the reconciliation process.

Prerequisites

• You have created the document that will be used as the original document, following these requirements:

  • The document must be created in a project that was created with MicroStrategy version 8.0.1 or later.

  • The document cannot contain derived metrics, derived elements, or drill maps.

• To export the document, you must have browse and read access to the document.

• To import the document into the replacement project, you must have the Use Document Editor privilege, and browse and use access on all replacement objects.

To copy a document between projects

Export the portable document from the original project

1. In MicroStrategy Developer, log in to the original project (the project that contains the document to export).

2. Select the document to use as the original document.

3. From the Tools menu, select Export Document Template. The Browse for Folder dialog box opens.

4. Navigate to the folder to save the file in, name the file, and then click OK. Integrity checks are run to ensure that the document meets the prerequisite requirements.

   • If the integrity checks fail, a message appears. Click OK to return to MicroStrategy Developer. The document is not exported. Review the prerequisite requirements and edit the document so that it meets those requirements.

   • If the document passes the integrity checks, the document, named document_name.pkg, is saved in the selected folder.

5. Log out of the project.

Import the portable document into the replacement project

6. In MicroStrategy Developer, log in to the replacement project (the project that you want to import the document to).

7. From the Tools menu, select Import Document Template. The Select a Package dialog box opens.

8. Navigate to and select the portable document to import.

9. Click Open.

10. The document is automatically reviewed to see if it needs reconciliation.

    • If the document needs reconciliation, the Document Reconciliation Editor opens. A status message indicating how many replacement reports or objects need to be reconciled is displayed. Follow the Reconcile steps below.

    • If the document does not need reconciliation, the Document Reconciliation Editor opens with blank fields and a blank status message. One way that this can happen is if the document does not contain any dataset reports. Skip to the Save steps below.

Reconcile

The Document Reconciliation Editor lists:

• The dataset reports in the original document

• The dataset objects on those reports

• How many replacement reports or objects need to be reconciled (the status message)

11. Map an original dataset report to a replacement dataset report by following these steps:

    1. Click Select in the Replacement Report column of the original dataset report row. The Select a Report dialog box opens.

    2. Navigate to and select the replacement dataset report.

       If the same dataset object is included in multiple original dataset reports, the selected replacement dataset reports must contain a corresponding common dataset object. For example, if Original Dataset 1 and Original Dataset 2 both contain Original Attribute 1, then Replacement Dataset 1 and Replacement Dataset 2 must both contain Replacement Attribute 1.

    3. Click Open. If the replacement dataset report does not match the original dataset report (for example, the original report contains two attributes but the replacement report has only one), a message is displayed. Click OK, and select a different report.

    4. The Replacement Report column now displays the name of the replacement dataset report to map to, and the Replacement Objects column displays the objects on the replacement dataset report.

       If a suitable replacement report does not exist, you can create a new report to use, without closing the Document Reconciliation Editor. If the Select a Report dialog box is open, click Cancel to close it. Return to MicroStrategy Developer without closing the editor (for example, you can use ALT+TAB to select MicroStrategy Developer), and then create the report and save the report. Return to the Document Reconciliation Editor (for example, using ALT+TAB), and then begin mapping the replacement report again.

12. If an original dataset object exists in the replacement report, it is automatically mapped to that object. Objects are matched by GUID, then by name. If you want to change an automatic mapping or an object is not mapped, follow the steps below:

    1. Select the replacement dataset object in the Replacement Objects column. Cells in the Replace With column that can be mapped to the replacement object are highlighted. (For example, if you select an attribute, all attribute cells are highlighted.)

    2. Drag the replacement dataset object to the matching Replace With cell. For example, if Employee in the original and EE in the replacement are equivalent, drag Employee to EE. The selected replacement dataset object must contain at least the same number of attribute forms as the original dataset object.

    3. Repeat these steps for each dataset object on the original dataset report.

13. ID and DESC attribute forms in the original are automatically mapped to ID or DESC forms in the replacement, but you can select another replacement attribute form, as long as it is an ID or DESC form. You can map a custom attribute form in the original to any custom attribute form in the replacement. If you want to change an automatic mapping or an attribute form is not mapped, follow the steps below:

    1. Select the replacement attribute form in the Replacement Objects column.

    2. Drag the replacement attribute to the matching Replace With cell. For example, if Employee Number in the original and EE# in the replacement are equivalent, drag Employee Number to EE#.

    3. Repeat these steps for each attribute form on the original dataset report.

       Attribute form reconciliation occurs only in certain cases, depending on the document's design, so this step may not be required.

14. Repeat the Reconcile steps above until all original dataset reports, original dataset objects, and original attribute forms are mapped to the replacement. Once this is complete, the status message, which displays the number of reports or objects to be reconciled, disappears.

Save

11. Select Save from the File menu.

12. Navigate to the folder to save the document in, and then click OK. A message appears indicating the document was saved.

13. Click OK. The Document Reconciliation Editor closes, and you are returned to MicroStrategy Developer.

Review

14. After importing the document, review the resulting document to ensure that it works correctly. Follow the suggestions in Reviewing after reconciliation.

15. Save any changes to the document.