Table of Contents

Search

  1. Preface
  2. Starting Data Archive
  3. System Configuration
  4. Database Users and Privileges
  5. Source Connections
  6. Target Connections
  7. Archive Store Configuration
  8. Datatype Mapping
  9. Database Optimization
  10. SAP Application Retirement
  11. z/OS Source Data Retirement
  12. Seamless Data Access
  13. Data Discovery Portal
  14. Security
  15. SSL Communication with Data Vault
  16. LDAP User Authentication
  17. Auditing
  18. Running Jobs from External Applications
  19. Salesforce Archiving Administrator Tasks
  20. Upgrading Oracle History Data
  21. Upgrading PeopleSoft History Data
  22. Data Archive Maintenance
  23. Appendix A: Datetime and Numeric Formatting
  24. Appendix B: Data Archive Connectivity

Administrator Guide

Administrator Guide

General Properties

General Properties

You must configure general properties for Data Archive before you run an archive project.
The
conf.properties
file includes the following general properties:
informia.api.authentication
You can enable API authentication to check if a password given in the API URL is valid. To enable or disable API authentication, configure this property.
Valid inputs are Y and N. Default is N.
Password authentication is available only for API's built with the authentication mechanism.
informia.appendHostAndPortInLog
Displays the host and the port number on every line of the
applimation.log
file. Enable this property only at the request of Informatica Global Customer Support.
informia.applicationHostname
IP address of the ILM application server.
The embedded web server binds to one IP address. If the ILM application server needs to be accessible to multiple IP addresses, enable the
informia.bindTomcatToMultipleIPAddress
property.
informia.applicationPort
Port on which the ILM application server starts. If you change the default port, verify that the port number is not used by another application.
Default is 8080.
informia.applicationSessionTimeout
Browser session timeout period in minutes.
Default is 20. If blank, default is 10.
informia.appViewGetAllowed
Enables you to use a URL to view the Data Discovery portal application view for entities.
Default is disabled.
informia.bcp.columnSeparator
The column separator to designate distinct columns in an SQL query when you extract table data to flat files. The column separator must be unique. To use the Data Vault Service, comment out this property.
For example,
%@%
acts as a column separator.
Use
^#^
as the column separator when you extract table data for SAP application retirement.
informia.bcp.maxLOBFilesInADir
The maximum number of large files, such as BLOB or CLOB files, to store in a folder in the BCP directory. For example, if you set the value to 10,000 and you have 30,000 BLOB files, Data Archive creates three folders. Each folder will contain 10,000 files. The size of each file is determined by the
informia.LoaderDatFileMaxSizeLimit
property.
Default is 100,000.
The BCP directory path is
<bcp_location>/<job_id>/<table_id>/<column_id>/A<number>
where:
  • table_id
    is the
    meta_table_id
    in
    am_meta_tables
  • column_id
    is the
    meta_column_id
    in
    am_meta_columns
informia.bcp.rowSeparator
Uses the specified value, which must be unique, as a row separator. A row separator designates distinct rows in an SQL query when you extract table data to flat files. To archive to the Data Vault, comment out this property.
For example,
%#%
is a row separator.
Use
@#@#
as the row separator when you extract table data for SAP application retirement.
informia.bindTomcatToMultipleIPAddress
Enables the embedded web server to bind to multiple IP addresses. Enter Y if the ILM application server needs to be accessible to multiple IP addresses. Enter N if you want Data Archive to use the first IP address from the network configuration.
Default is N.
informia.bulkExtractionMode
Increases the performance of data extraction to flat files. Disable if a query contains data that cannot be extracted, such as images. Disable only at the request of Informatica Global Customer Support.
informia.dataDiscoveryAppendJobIdPredicate
Appends the job ID to Data Discovery queries, so that query results do not include a table more than once. For example, if you run a retirement cycle twice, Data Discovery displays the tables from that cycle one time.
informia.dataDiscoveryMetadataQuery
The metadata connection for the Data Discovery portal.
Default is AMHOME.
informia.defaultArchiveAreaRetention
The default retention period for an archive area within the Data Vault Service.
Use one of the following values:
  • -1. Indefinite retention.
  • 0. Immediate expiration.
Default is -1.
informia.disableAddingExtractJobIdPredicate
Determines whether job IDs are considered when creating a query to display data on the
Browse Data
page.
Use one of the following values:
  • N. Consider job IDs when creating a query to display data on the
    Browse Data
    page.
  • Y. Ignore job IDs when creating a query to display data on the
    Browse Data
    page.
Default is Y.
informia.disableTrendGraph
Determines if Data Growth Analyzer calculates the trend graph. When you set to Y, the trend graph is disabled. Set to Y for extended date ranges, such as 2,000 years. If you do not set this value to Y for date ranges with lengthy time spans, then the trend graph appears as an empty image.
When you set to N, Data Growth Analyzer computes the trend graph.
Default is N.
informia.dropInterimTablesOnTerminate
Drops interim tables when you terminate an archive or retirement job. If you are in a development or debugging phase, you may want to select false to examine interim tables in the source staging schema. If you are in a production phase, you might want to select true to eliminate unnecessary tables in the source staging schema.
Default is False.
informia.enableDDMSecurity
Encrypts user information and adds the encrypted text to each Data Vault query sent to Dynamic Data Masking. If you want to mask sensitive information in Data Discovery search results or in data visualization reports, enable this property. You must have Informatica Dynamic Data Masking installed and configured to enable masking. When a user queries data in Data Vault, masking rules that you set up in Dynamic Data Masking apply based on the Data Vault access role assigned to the user. Dynamic Data Masking replaces sensitive information such as a credit card number with a randomly generated number or Xs in the query results.
Default is No.
informia.enable.enhanced.import
Enables the enhanced import option for importing metadata accelerators and entities in the Enterprise Data Manager. Valid inputs are Y and N.
Default is Y.
informia.enable.mining
Enables the "import metadata from database" option in the Enterprise Data Manager. Valid inputs are Y and N.
Default is Y.
informia.enable.traditional.import
Enables the traditional method of importing entities and custom product family versions. Valid inputs are Y and N.
Default is N.
informia.encryptionkey.command
If you use a third-party encryption key generator to encrypt Data Vault files, provide the command to run the encryption key generator. The command provided should return only the encryption key.
informia.encryption.AdminTimeout
Defines the admin timeout in seconds.
informia.encryption.DeleteOldDataFiles
Specifies whether or not to delete the original unencrypted data files during the encryption job. Valid property values are Y and N. Default value is N. For more information on this property, see the chapter "Scheduling Jobs" in the
Data Archive User Guide
.
informia.encryption.IDVDeBugMode
Specifies whether or not Data Vault runs the encryption job in debug mode. Valid property values are Y and N. Default value is N.
informia.encryption.RegistrationThreadCount
Defines the number of registration threads used to encrypt the Data Vault data. Default value is 5.
informia.encryption.SCTRegistrationType
Defines whether the SQL or admin registers the encrypted .SCT files in Data Vault. Valid property values are SQL and admin. Default is SQL.
informia.encryption.WorkerThreadCount
Defines the number of worker threads used to encrypt the Data Vault data. Default value is 10.
informia.faThreadCount
Determines the number of threads used in the Data Vault Loader job.
By default, the ILM engine calculates the value by dividing the number of CPU cores by two. For example, if the server has eight CPU cores, then the default value is 4.
informia.fasLoadAdditionalAttributes
Loads tables with row length greater than 100,000,000 bytes.
informia.fasLoadProcessingThreads
Specifies command line options for the Data Vault Loader job.
informia.fasMigrationErrorThresholdCount
Defines the maximum number of errors that the Data Vault Service migration process can generate before the migration process stops loading data into the Data Vault. Default is 4.
informia.idv.ssl.pemCertificatePath
Defines the path to the PEM certificate file that enables SSL communication with Data Vault.
informia.isKeyStorePassEncrypted
Determines if the password for the keystore file is encrypted. This property applies if you enable the ILM application server to run on HTTPS and must create a keystore file.
Default is False.
informia.isSapOnWindows
Determines if an additional row separator is required for BCP file generation when the retirement job uses an SAP function module to generate BCP files for data in transparent HR and STXL tables, ADK files, and attachments. Required only for SAP application retirement if the SAP application is hosted on Windows.
Use one of the following values:
  • Y. Operating system that hosts the SAP application is Windows. The retirement job appends
    \r
    as a suffix to the BCP file row separator that is configured in the
    informia.bcp.rowSeparator
    property. The
    \r
    is required to confirm the end of rows on Windows.
  • N. Operating system that hosts the SAP application is not Windows. The retirement job uses the value configured in the
    informia.bcp.rowSeparator
    property as the BCP file row separator.
Default is Y.
informia.julianLimiterYear
The year by which to limit Julian dates that do not include a century during Julian to Gregorian date conversion for Data Discovery Portal searches.
For example: informia.julianLimiterYear=1975
The 5-digit Julian date "15001" could be either 1915 or 2015. If you set the limiting year to 1975, then the dates "05001," "15001," and "65001" are converted as 2005, 2015, and 2065. The Julian dates "75001," "85001," and "95001" are converted as 1975, 1985, and 1995.
informia.keywordSearchIndexDir
Specifies the location of the search indexes used in Search Data Vault. You must enter the file path of the folder containing the search indexes. The folder must be in the same root directory as the Data Archive installation. The ILM Engine must have read and write privileges to the folder.
You must set this property to run the jobs that create and delete the search indexes. Both jobs use the file path entered in this property to find the search indexes.
Based on your operating system, use one of the following formats for the file path:
  • On a Windows operating system, use a double back slash between folder names. For example,
    C:\\KeywordSearchIndex
  • On all other operating systems, use a single forward slash between folder names. For example,
    /Data/KeywordSearchIndex
There is no default value.
informia.loadDataVisualization
Loads the Data Visualization option so that users can create reports and dashboards. Set this property to Y or N.
If you install Data Archive on multiple machines, you must set this property to Y on at least one machine to handle Data Visualization requests. Set this property to N on any machine that you do not want to handle the Data Visualization process.
Default is Y.
informia.LoaderDatFileMaxSizeLimit
Maximum size of each large object file such as BLOB or CLOB, created and stored in the BCP directory by the
informia.bcp.maxLOBFilesInADir
property.
Default is 1024 MB.
informia.maxActiveAMThread
Maximum active Java threads to run at one time. A common configuration is two times the number of cores available on the ILM application server. Increase the number of threads dependent on machine capability and the number of tables you want to extract data from. The more active threads you can run at once, the faster the archive process will complete.
Default is 10.
informia.maxActiveIndexThreads
Maximum number of Java threads to run at one time. Each thread creates a search index. You create search indexes to be able to search for records across applications in Data Vault.
Optional. Minimum is 1.
Default is one less than the number of cores on the machine hosting the ILM Engine.
informia.maxCachedStatements
Maximum number of cached statements stored in the ILM repository. When the Data Archive web application accesses the ILM repository, it caches the SQL statements to improve future query performance.
Default is 100.
informia.maxNoResultsIteration
Maximum number of milliseconds that the retirement job waits for a response from the SAP system. For every package of rows that the job processes, the job waits for a response from the SAP system.
If the SAP system does not provide a response within this time, the job fails.
SAP application retirement only.
Default is 5,000,000.
informia.miningCommitCount
Number of tables that the Import Metadata from Database job commits to the database at each commit interval. If the Enterprise Data Manager returns a memory error, reduce the property value.
Default is 10,000.
informia.MonitorQuickTxnRestoreQueue
Enables or disables monitoring requests submitted through the quick transaction restore API. Controls the behavior of the monitor thread used to poll the status of the restore jobs triggered by the external API.
Set to Y to enable monitoring requests. Set to N to disable monitoring requests.
Default is Y.
informia.NULLRepresentationInBcp
Stores the NULL character used by the Data Vault Service to load null data into table columns in the Data Vault. This property contains the value
\u007F
, which represents the null character in the Data Vault Service. If this property is not enabled and the source column contains null data, the Data Vault Service sets the column in the Data Vault to an empty string. To disable the property, use the pound character (#) character to comment out the property. Default is enabled.
informia.oracleClientPath
Web server location for the Oracle client.
informia.privacyEnableCardinalityHint
Enables or disables Oracle Cardinality Hint. Oracle Cardinality Hints can improve query performance.
informia.retainTrailingSpaces
For Data Vault Service installations on AIX, determines if you want to retain trailing spaces in archived data for VARCHAR fields when you query data from the Data Vault. This property applies only to archive areas that you create after you configure this property. This property does not apply to existing archive areas or archived data. If you do not retain trailing spaces, the Data Vault Service might return validation errors.
Use one of the following values:
  • N. Data Vault Service drivers truncate the trailing spaces.
  • Y. Data Vault Service drivers retain the trailing spaces.
Default is N.
informia.showQuartzLog
Displays quartz log messages inside the quartz log. The quartz log is a log of all the jobs you schedule in Data Archive. If set to Y, the log might be very large. Enable only at the request of Informatica Global Customer Support.
Use one of the following values:
  • N. Log messages do not appear.
  • Y. Log messages appear.
Default is N.
informia.sqlServerNVarcharMaxAndVarcharMaxToVarchar
Determines whether you want to convert the Microsoft SQL Server data types
NVARCHAR(MAX)
and
VARCHAR(MAX)
to the
VARCHAR(32000)
data type in the Data Vault. The default value N, converts these source data types to the
CLOB
data type.
Use one of the following values:
  • N. Converts the Microsoft SQL Server data types
    NVARCHAR(MAX)
    and
    VARCHAR(MAX)
    to the
    CLOB
    data type.
  • Y. Converts the Microsoft SQL Server data types
    NVARCHAR(MAX)
    and
    VARCHAR(MAX)
    to the
    VARCHAR(32000)
    data type.
If you plan to use the Application Retirement for Healthcare accelerator reports and your source database is Microsoft SQL Server, set this property to Y before you retire the healthcare data to the Data Vault.
Default is N.
informia.sqlServerVarBinaryAsVarchar
Converts the Microsoft SQL Server data type
VARBINARY
to the
VARCHAR
or
CLOB
data type in Data Vault.
In some SAP tables, the column with data type
VARBINARY
is a primary key. In this case, set this property to Y before running the archive job.
Default is N.
informia.sslEnabled
Enables the HTTP application connection to use SSL authentication.
Use one of the following values:
  • N. Disables SSL authentication.
  • Y. Enables SSL authentication.
Default is N.
informia.sslKeystoreFile
Location of the keystore file that is used to configure HTTPS. Required if you enable HTTPS support.
informia.sslKeystorePass
Plain text password for the keystore file. Required if you enable HTTPS support.
informia.techViewMaxDisplayRowCount
Maximum number of rows displayed for each child table in the Search Data Vault technical view. Each row in the child table is a record that references the record in the parent table. To view all the records in the child table, use a value of -1.
Default is 100.
If you enter -1 or a high value and the child table has a large number of records, the technical view page might take a long time to display.
informia.TempDirectory
Temporary folder for export and import used with the above attribute.
informia.updateSCTCommitInterval
For the online mode of SCT file registration in Data Vault, this property defines the number of queries that are run before the File Archive Loader job commits the queries to bring the SCT files online. The job executes one query for every 999 SCT files.
If a table has less than 999 SCT files, the File Archive Loader job commits once for all of the files in the table.
Default is 10,000.
informia.useAppendHintForRestore
Determines whether restore cycles use an APPEND hint in the copy to destination insert as select statements. Setting it to true requires an exclusive lock on the ERP table. The true value might also cause an Oracle timeout error to occur.
Default is False.
informia.useColumnDescriptionOnBrowseDataPage
Determines whether to display the following column descriptions on the
Browse Data
page:
  • Column descriptions for special and transparent tables.
  • Column descriptions for an alias name in a materialized view query.
Use one of the following values:
  • N. Do not display column descriptions for special and transparent tables. Do not display column descriptions for an alias name in a materialized view query.
  • Y. Display column descriptions for special and transparent tables. Display column descriptions for an alias name in a materialized view query.
Default is N.
informia.useDbaViewsInSeamlessAccess
Enables you to use DBA_* or ALL_* views when you create the seamless access layer. Enter ALL_* if the source administrator user does not have DBA_* views access.
Default uses DBA_* views.
informia.useTimestampServerForJARSigning
Specifies whether or not to sign JAR files that use the time stamp server. Use one of the following values:
  • N. Enter N if you do not want to sign JAR files that use the time stamp server.
  • Y. Enter Y if you want to sign JAR files that use the time stamp server.
Default value is Y.
informia.validateKeystore
Validates if the keystore has a certificate issued to the host before starting the ILM application server.
Default is false.
informia.validateRowCountBeforeDelete
Determines if archive and restore jobs validate the row count before the job deletes data from the source. You can validate row count for archive jobs with the archive and purge cycle and for restore jobs with the database archive restore cycle.
Use one of the following values:
  • N. Disables row count validation. The job deletes from the source without row count validation.
  • Y. Enables row count validation. Before the job deletes data from the source, the job compares the delete count with the insert count of the copy to destination step. If the row count is different, the job errors out.
Default is N.
informia.welcomePage
Determines the Data Archive page that appears when the user logs in. To set the welcome page, enter the page-specific portion of the URL. The following list provides page-specific URLs to Data Archive pages:
  • For the
    Keyword Search
    page, enter:
    /quickSearch.htm?action=getQuickSearchHome
  • For the
    Search Data Vault
    page, enter:
    /fileArchiveSearch.htm?action=displayFileArchiveAreas
  • For the
    Data Visualization Reports and Dashboards
    page, enter:
    /dataVisualization.htm?action=getReportsandDashboards
By default, the
Monitor Jobs
page is the welcome page.
validHosts
Determines the machines that have access to run JavaServer Page-based APIs for standalone jobs that you can run through external APIs. Enter the IP address or the host name of the machines that can access the JavaServer Pages from the external application. Use a comma to separate multiple values.
The following text is an example of the property:
validHosts=host1, 10.11.22.33, hyw172967.abc.com, dev.*
By default, no machines have access.
informia.XMLTYPE_Storage_Option
Specifies the storage type of the XMLTYPE columns that the ILM Engine creates in staging tables during the archive process.
For Oracle versions 11.2.0.3 and later, enter the value "CLOB."

0 COMMENTS

We’d like to hear from you!