Package com.orchestranetworks.addon.hmfh

Provides classes and interfaces to use {addon.label} services: export, import and compare.

See: Description

Interface Summary

Interface	Description
HmfhExport	Provides a method to execute the Hyperion export service.
HmfhImport	Provides a method to execute the Hyperion import service.
UserMessageList	Provides a list of UserMessage.

Class Summary

Class	Description
ADSSectionEnumeration	Defines sections in ADS file.
ApplicationStructure	Defines the available import and export application structures.
BehaviorOfImportEmptyValue	Defines behaviors when importing an empty value.
BooleanFormat	Deprecated use BooleanFormatEntity instead.
BooleanFormatEntity
BooleanStringValueFormat
CSVDelimiter	Defines available delimiters for CSV export.
DefaultExtensionTableTrigger	Fills extension record primary keys in the 'Extension' tab with values from the corresponding dimension record.
DimensionsComparison	Provides a method to create an instance of UIHttpManagerComponent in order to call the EBX® user interface to display the Compare service.
DimensionsComparisonSpec	Defines the features of Comparison dimension.
ExportHierarchyOrder
FileExport	Represents the exported file, with the name and absolute path of the file.
FileExtension	Defines the file extensions available for import and export.
HmfhExportFlatCSVSpec	Defines the exported CSV file.
HmfhExportResult	Defines the properties of a Hyperion export's result.
HmfhExportSpec	Defines the features of a Hyperion export.
HmfhFactory	Factory for instances of HmfhImport and HmfhExport.
HmfhHierarchyNodeBean	Defines the object used to store a node and its parent.
HmfhImportResult	Defines the properties of the result of a Hyperion import.
HmfhImportResultForTable	Defines the properties of the result of a Hyperion import into a table.
HmfhImportSpec	Defines the features of a Hyperion import.
HmfhLoggingProcedureEnumeration	Defines available the {addon.label} procedures.
HmfhLoggingSpec	Defines the features of the {addon.label} logging.
HmfhSpec	Defines the basic features of a Hyperion import or export.
ImportType	Defines the available import types.
LiteralBooleanFormat
NativeBooleanFormat
StartingNodes	Defines the object used to store the nodes to export data from for each dimension.

Enum Summary

Enum	Description
DimensionsComparisonDisplayMode	Defines the comparison display mode of the Compare service used to display the configuration screen or result page.
NumberOfComparingItemsPerPage	Defines the Comparison dimension.

Exception Summary

Exception	Description
HmfhException	Defines the exception for the {addon.label}.
HmfhOperationException	Exception thrown when an operation cannot complete normally in the {addon.label}.

Package com.orchestranetworks.addon.hmfh Description

Provides classes and interfaces to use {addon.label} services: export, import and compare.

It's possible to hide extension tab on Extra custom dimensions:
Step 1: Create your Access rule class that extends AccessRule interface (For example: HiddenExtensionAccessRule.java)

        if (adaptation.isHistory())
        {
            return AccessPermission.getHidden();
        }
        Path datasetExtensionPath = Path
            .parse("./root/Hyperion/Financial/Properties/datasetExtension");
        Adaptation dataset = adaptation.isSchemaInstance() ? adaptation
            : adaptation.getContainer();
        SchemaNode rootNote = dataset.getSchemaNode();
        if (rootNote.getNode(datasetExtensionPath) == null
            || dataset.get(datasetExtensionPath) == null)
        {
            return AccessPermission.getHidden();
        }
        return AccessPermission.getReadWrite();

Step 2: Create your Schema extension class that implements SchemaExtensionsForAdvancedIntegration (For example: CustomSchemaExtension.java)

        extensionContext.setAccessRuleOnNodeAndAllDescendants(
                Path.parse("./root/Hyperion/Financial/Custom1/extension"),
                true,
                new HiddenExtensionAccessRule());

Step 3: Attach the CustomSchemaExtension file to the Special extensions of the Custom data model.

Classes to access Compare service.

It's possible to get the UIHttpManagerComponent to display the Configuration screen of Compare service:

        DimensionsComparisonSpec compareSpec = new DimensionsComparisonSpec(
                                sourceDataset,
                                targetDataset,
                                application,
                                dimension,
                                NumberOfComparingItemsPerPage.parse(itemsPerPage));
        UIHttpManagerComponent component = DimensionsComparison.getComparisonService(
                                compareSpec,
                                DimensionsComparisonDisplayMode.NORMAL_COMPARISON_SERVICE,
                                context);

It's possible to get the UIHttpManagerComponent to display the result page of Compare service:

        DimensionsComparisonSpec compareSpec = new DimensionsComparisonSpec(
                                sourceDataset,
                                targetDataset,
                                application,
                                dimension,
                                NumberOfComparingItemsPerPage.parse(itemsPerPage));
        UIHttpManagerComponent component = DimensionsComparison.getComparisonService(
                                compareSpec,
                                DimensionsComparisonDisplayMode.COMPARISON_RESULT_ONLY,
                                context);

Classes and interfaces to execute export and import services.

It's possible to defines the display format of the boolean values as True/False or Yes/No on exports:

        HmfhExportSpec exportSpec = new HmfhExportSpec();
        exportSpec.setBooleanFormat(new NativeBooleanFormat());
        exportSpec.setApplication("HFM");
        exportSpec.setExportType("export");
        exportSpec.setVersion("9.50");
        exportSpec.setCurrentDataset(dataset);
        exportSpec.setCurrentLocale(Locale.US);
        exportSpec.setDatasetMapping(datasetMapping);
        
        ArrayList<String> dimensions = new ArrayList<String>();
        dimensions.add("Account");      
        exportSpec.setDimensions(dimensions);
        

        List<FileExtension> fileExtensions = new ArrayList<FileExtension>();
        fileExtensions.add(FileExtension.XML);
        exportSpec.setFileExtensions(fileExtensions);
        
        Procedure proc = new Procedure()
        {
                public void execute(ProcedureContext pContext) throws Exception
                {
                        HmfhExportResult exportResult = HmfhFactory.getHmfhExport().execute(
                                exportSpec,
                                pContext);
                }
        }

The {addon.label} import service:

        HmfhImportSpec importSpec = new HmfhImportSpec();
        File resource = new File(directory);
        importSpec.setApplication("HFM");
        importSpec.setFilePath(resource.getAbsolutePath());
        importSpec.setFileName(resource.getName());
        importSpec.setImportType(ImportType.DELETE_BEFORE_IMPORT);
        importSpec.setCurrentDataset(dataset);
        importSpec.setDatasetMapping(datasetMapping);
        
        ArrayList<String> dimensions = new ArrayList<String>();
        dimensions.add("Account");
        importSpec.setDimensions(dimensions);
        
        Procedure proc = new Procedure()
        {
                public void execute(ProcedureContext pContext) throws Exception
                {
                        HmfhImportResult importResult = HmfhFactory.getHmfhImport().execute(
                                importSpec,
                                pContext);
                }
        }

The {addon.label} export service:

        HmfhExportSpec exportSpec = new HmfhExportSpec();
        exportSpec.setApplication("HFM");
        exportSpec.setExportType("export");
        exportSpec.setVersion("9.50");
        exportSpec.setCurrentDataset(dataset);
        exportSpec.setCurrentLocale(Locale.US);
        exportSpec.setDatasetMapping(datasetMapping);
        
        ArrayList<String> dimensions = new ArrayList<String>();
        dimensions.add("Account");      
        exportSpec.setDimensions(dimensions);
        

        List<FileExtension> fileExtensions = new ArrayList<FileExtension>();
        fileExtensions.add(FileExtension.XML);
        exportSpec.setFileExtensions(fileExtensions);
        
        Procedure proc = new Procedure()
        {
                public void execute(ProcedureContext pContext) throws Exception
                {
                        HmfhExportResult exportResult = HmfhFactory.getHmfhExport().execute(
                                exportSpec,
                                pContext);
                }
        }

It's also possible to declare in exportSpec some starting nodes to export:

                exportSpec.setExportFromStartingNodes();
                
                List<String> dimensions = new ArrayList<String>();
                dimensions.add("Account");
                dimensions.add("Custom1");
                dimensions.add("Version");
                dimensions.add("Entity");
                dimensions.add("Period");
                exportSpec.setDimensions(dimensions);
                exportSpec.setVersion("9.50");
                exportSpec.setCurrentDataset(dataset);
                exportSpec.setCurrentLocale(Locale.US);
                exportSpec.setDatasetMapping(datasetMapping);

                exportSpec.getStartingNodes().addStartingNode(
                        "Account",
                        new HmfhHierarchyNodeBean(
                                PrimaryKey.parseString("#root"),
                                PrimaryKey.parseString("Account0")));
                exportSpec.getStartingNodes()
                        .addStartingNode(
                                "Account",
                                new HmfhHierarchyNodeBean(
                                        PrimaryKey.parseString("#root"),
                                        PrimaryKey.parseString("Account1")));
                exportSpec.getStartingNodes()
                        .addStartingNode(
                                "Account",
                                new HmfhHierarchyNodeBean(
                                        PrimaryKey.parseString("AnotherRoot"),
                                        PrimaryKey.parseString("AnotherAccount")));
                exportSpec.getStartingNodes().addStartingNode(
                        "Custom1",
                        new HmfhHierarchyNodeBean(null, PrimaryKey.parseString("Custom1_top1")));
                exportSpec.getStartingNodes().addStartingNode(
                        "Custom1",
                        new HmfhHierarchyNodeBean(null, PrimaryKey.parseString("Custom1_top2")));

On the Extension data model: Uses or extends the DefaultExtensionTableTrigger class as a trigger for each table to automatically fill the primary key for new extension records using values from the corresponding dimension record.