Creating, Editing, Copying, and Deleting Extract Packages
You create an extract package from the Extract Packages tab of the application inspector.
Creating Extract Packages
You must have Owner or Metadata Manager permission on at least one dimension in an application in order to create an extract package for that application.
- Inspect the application that you want to create the extract package for. See Inspecting Applications.
- On the Extract Packages tab, click Create.
- Enter a name and optionally a description for the extract package, and then
click Create.
The extract package is displayed in the inspector.
Editing Extract Packages
You must have Owner or Metadata Manager permission on all of the dimensions in an extract package in order to edit that package.
After you create an extract package, you edit it to change the name or description and to specify extract package details, such as which extracts to include in the package, connection information, and extract combination options.
- On the General tab, click Edit and change any of these
Summary settings:
- Name or description of the extract package
- Zip File Name (must include the .ZIP file extension).
- Zip Package:
- Enabled: The extract package is always zipped, even if it is a single file.
- Disabled: The extract package is zipped as follows:
- Extract package run to a file: If the package
creates a single file, the output is not zipped.
Note:
If the package creates multiple files the output is always zipped, regardless of the Zip Package setting. - Extract package run to a connection or to the staging area: The extract package output is not zipped.
- Extract package run to a file: If the package
creates a single file, the output is not zipped.
- In Connection, specify a global connection name and any
parameters for that connection. The parameters that you specify are specific to
the connection type.
You can test the connection before saving. The Test Connection button is enabled only if you have set up a global connection and defined the required parameters. See Creating Global Connections.
Note:
The global connection must be supported by the application that you are creating the extract package for. - Select Combine Extracts if you want to have one or more
extracts in the package combined into a single output file. You select which
extracts to combine on the Extracts tab. Only extracts of the same file type
(text or Excel) can be combined into a single file, and an extract package can
only contain one combined file. The other files can still be included in the
extract package as separate files, but they cannot be combined.
Note:
Selecting this option does not automatically combine all of the extracts in the package together. Use the Combine Extract check box on the Extracts tab to specify which extracts you want to combine.After you select Combine Extracts, specify a name and, optionally, a header and footer for the combined file.
- On the Extracts tab, click Add and then select the
extracts to add to the package from the drop down menu. You can select any
public extract in any dimension in the application that you have Owner or
Metadata Manager permission on. A check mark is displayed next to
each extract that you select. Click the extract again to remove your selection,
and click outside of the menu to finalize your selections.
Note:
If the viewpoint for an extract has been archived, a warning icon is displayed. You cannot save an extract package that contains an extract that uses an archived viewpoint. - For each extract that you want to combine into a single output file, select
Combine Extract. The extracts are output in the file
in the order in which they are listed in the inspector.
Note:
This option is available only if you have selected Combine Extracts on the General tab.- To reorder the extracts in the package: Click
Actions
and use the reorder options.
- To remove an extract from the package: Click
Actions
and select Remove.
- To reorder the extracts in the package: Click
Actions
- Optional: For extracts with the Excel file type, by default the extract package uses the sheet names that are defined for the extracts. You can enter a different sheet name in Package Sheet Name.
- Optional: After you select Combine Extract, enter a Package Extract Header to be displayed before the combined file, a Package Extract Footer to be displayed after the combined file, and then optionally use the Exclude Original Extract Header and Exclude Original Extract Footer options to exclude the column or custom header and custom footer of the original extracts.
- Click Save.
Copying Extract Packages
You must have Owner or Metadata Manager permission on all of the dimensions in an extract package in order to copy that package.
To copy an extract package:
- From the Extract Packages tab of the application inspector,
click Actions
in the Action column of the extract package that you want to copy, and then select Copy.
- Enter a name for the copied extract package, and then click Copy.
- Optional: Edit the extract package to specify extract package details, such as which extracts to include in the package, connection information, and extract combination options. See Editing Extract Packages.
Deleting Extract Packages
You must have Owner or Metadata Manager permission on all of the dimensions in an extract package in order to delete that package.
Note:
Deleting an extract package does not delete the individual extracts that were in that package.
To delete an extract package, from the Extract Packages tab of
the application inspector, click Actions
in the Action column of the extract package that you want to delete, and
then select Delete.