IHsvAdminICM Interface Overview

The IHsvAdminICM interface enables you to programmatically administer intercompany transactions. For example, you can use this interface to open and close periods, lock and unlock entities, and set and get period settings. For information on setting IHsvAdminICM object references and details on the interface’s methods, see IHsvAdminICM Interface Methods.

The following table summarizes the IHsvAdminICM interface’s methods.

Table 41. IHsvAdminICM Interface Methods

Method

Description

CheckSecurityForICExtract

Indicates whether the connected user has security rights for extracting intercompany transactions.

CloseICPeriod

Closes a given period for intercompany transactions.

GetICEntitiesLockStatus

Indicates whether any entities are locked for a given scenario, year, and period.

GetLockStatusICEntities

Deprecated - use GetICEntitiesLockStatus.

GetLockStatusICEntity

Indicates whether an entity is locked or unlocked for a given scenario, period, and year.

GetSettingsICPeriod

Returns the period status, matching tolerance, and Match/Validate Before Post settings for a scenario, year, and period.

GetSettingsICPeriods

Returns the period status, matching tolerance, and Match/Validate Before Post settings of multiple periods for a scenario and year.

LoadICTransactions

Loads or scans intercompany transactions from arrays that specify the transactions’ dimension members and data.

LockICEntity

Locks an entity for a given scenario, year, and period.

OpenICPeriod

Opens a period for a given scenario and year, and specifies the period’s matching tolerance and Match/Validate Before Post settings.

OpenICPeriod2

Opens a period for a given scenario and year, and specifies the period’s Match/Validate Before Post settings and absolute or percentage matching tolerance.

SavePeriodsSettings

For internal use.

UnlockICEntity

Unlocks an entity for a given scenario, year, and period.

UpdatePeriodSettings

Updates an open period’s matching tolerance and Match/Validate Before Post settings for a given scenario and year.

UpdatePeriodSettings2

Updates an open period’s Match/Validate Before Post settings and absolute or percentage matching tolerance for a given scenario and year.