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

Sample Conf.properties File

Sample Conf.properties File

You might configure the conf.properties file similar to the sample file below.
#Use this to update the port on which application starts (if unset, default is 8080) informia.applicationPort=8080 #Use this to enable https for ILM application #informia.sslEnabled=Y #Property that specifies whether the keystore password is encrypted #informia.isKeyStorePassEncrypted=true #informia.sslKeystoreFile=path to keystore #informia.sslKeystorePass=password for keystore #informia.validateKeystore=false #Set the session timeout value (Time in mins) (if unset, default is 10)informia.applicationSessionTimeout=20 #Set the maxActive java thread to run at a time (if unset, default is 10)informia.maxActiveAMThread=10 #Set the maxActive java thread to run at a time for a smart partitioning job (if unset, default is 6)informia.maxActiveSPThread=6 #If you want the quartz log to get printed set the value to Y (if unset, default is N) #informia.showQuartzLog=Y #maximum numbers of am statements that are cached (if unset, default is 100) #informia.maxCachedStatements=100#ORACLE EXPORT IMPORT ATTRIBUTES #If you have oracle client installed on webserver, point it to the location #informia.oracleClientPath= #DB2 EXPORT IMPORT ATTRIBUTES #Uncomment this parameter to use Export/Import Utilities for DB2. The value should be pointing to the location of DB2 Connect Client, #ex: \home\user\sqllib #informia.db2ClientPath #Extra Attribute for DB2 EXPORT IMPORT ATTRIBUTES for AS400 and Mainframe only #informia.importUtilName=IMPORT #Temp folder for export/import used with above attribute #informia.TempDirectory #Temp Folder on DB2 Server to be used by Export / Import Utilities for storing LOB values #informia.exportLobLocation #DATA DISCOVERY RELATED ATTRIBUTES #if you want the xsl debugging enabled, set it to Y (if unset, default is N #informia.xslDebugMode=Y #If you want the storage lib to load (make sure the relevent storage files are in path) (if unset, default is N) #informia.loadStorageLib=Y # Set this to Y and the server will not attampt to display main Applimation web site page on the login screeninformia.intranetMode=N # Enable this and set to Y to enable row count validation before delete #informia.validateRowCountBeforeDelete=N #Archive to External Storage Email msg Attributes, default from_addr and to_addr will be picked up if no entity or pfv specific entries are available. #entity_-8_from_addr=From_Entity_-8 #entity_-8_to_addr=To_Entity_-8 #entity_-12_from_addr=From_Entity_-12 #entity_-12_to_addr=To_Entity_-12 #pfv_100_from_addr=From_Pfv_100 #pfv_100_to_addr=To_Pfv_100from_addr=ILMAdministratorto_addr=ILMAdministrator # Data Discovery attributes #Use this for delimiters in BCP files - should have different Characters #informia.bcp.columnSeparator=%@% #informia.bcp.rowSeparator=%#%# #Use this for Archive to External Storage in Serial Mode #informia.discovery.serialMode=Y #Use this for Reconciler Standalone Program #informia.discovery.issueDelete=Ninformia.dataDiscoveryMetadataQuery=AMHOME #informia.dataDiscoveryIgnoreJobIdQuery=Y #informia.maxDiscoveryRows=100 #informia.dataDiscoveryAppendJobIdPredicate=false #informia.dataDiscoverySimpleQueryConstruct=false #Data Archive Quick restore Attributes #informia.MonitorQuickTxnRestoreQueue: Used to control the behavior of the monitor thread used to Poll the Status of the Restore Jobs triggered by the external API. #Values: #Y: Monitor Process would poll the progress and the data can be accessed from jsp/TxnRestoreApiUtil.jsp #N: Monitor process would not poll the process #Blank defaults to Y #informia.MonitorQuickTxnRestoreQueue=N # IP address for tomcat binding # informia.applicationHostname=<IP address> # where <IP address> is the IP address of the ILM server. # To bind Tomcat to multiple IP Addresses of the Host #informia.bindTomcatToMultipleIPAddress=N # LDAP related properties ## Enable LDAP authentication ## authenticationMethod=LDAP ## Enable LDAP SSL authentication ## ldap.useSSL=true # Enable LDAP role synchronization # ldap.syncRoles=true # Use LDAP Role name prefix # Multiple comma separated prefixes are supported. # If set, LDAP security groups must start with this prefix to be considered an ILM role. # For example: # ldap.roleNamePrefix=ILM- # The LDAP group ILM-Legal_Hold_User would be treated as ILM's Legal_Hold_User role # # ldap.roleNamePrefix= # Only consider groups that start with the role name prefix in nested group search, enabled by default # ldap.useRoleNamePrefixForNestedGroups=true # Ignore referral errors such as: # javax.naming.PartialResultException: [LDAP: error code 10 - 0000202B: RefErr: DSID-0310063C, ... # ldap.ignoreRefErrors=true # Restrict LDAP searches of roles assigned to a user to the user's domain component (DC) # For example: The DC of CN=jdoe,OU=Resources,DC=example,DC=com # would be DC=example,DC=com and LDAP groups other than DC=example,DC=com will be skipped # ldap.skipReferrals=false# Nested role/group search, enabled by default # ldap.enableNestedRoles=true # The isMemberOf attribute of certain LDAP systems (e.g. OUD) shows both direct and indirect group memberships from nested groups. # This can lead to incorrect role assignments if role synchronization is enabled. # Set the following attribute to true to filter out indirect group memberships. # ldap.directGroupMembershipCheck=false ## LDAP attribute mapping properties ## Attribute that maps to the ILM user name (AM_USERS.USER_NAME) # ldap.attribute.userName=uid # The default is "uid" for Sun LDAP and "sAMAccountName" for Active Directory ## Attribute that maps to the ILM full user name (AM_USERS.FULL_NAME) # ldap.attribute.fullName=cn # The default is "uid" for Sun LDAP and "displayName" for Active Directory ## Attribute that maps to the email address (AM_USERS.EMAIL_ADDRESS) # ldap.attribute.email=mail # The default is "mail" for bot Sun LDAP and Active Directory ## Attribute that maps to the email address (AM_USERS.ORGANIZATION_NAME) # ldap.attribute.organizationName # No default value. If this property is not set then the user's Organization Name will be set to "LDAP User". ## Group member attribute name # ldap.attribute.member=member # The default is "uniqueMember" for Sun LDAP and "member" for Active Directory # The name of the attribute that represents the groups the user is member of. # ldap.attribute.ismemberof=isMemberOf # The default is "isMemberOf" for Sun LDAP and "memberOf" for Active Directory. # The name of object class representing a group. # ldap.attribute.groupclassname # The default is "groupOfUniqueNames" for Sun LDAP and "group" for Active Directory. # LDAP Paging support: This property controls the number of entries returned in a single page. A value of 0 disables paging. # ldap.pageSize=500 # This property controls whether to drop interim tables when terminating a job (default = false) # informia.dropInterimTablesOnTerminate=false # Data Discovery properties # Append applimation_job_id predicate to child table query where clauses # defaults to false if metadata source = AMHOME, otherwise defaults to true # informia.dataDiscoveryAppendJobIdPredicate=true # Property to use "row level" security in amhome mode (informia.dataDiscoveryMetadataQuery=AMHOME) # informia.dataDiscoverySearchUsingNPASecurity=true # The useAppendHintForRestore property controls whether restore cycles will use an APPEND hint in CTD insert as select statements. # The default setting is false and restore cycles will not use the hint. # Note that using APPEND will require an exclusive lock on the ERP table and ORA-02049: timeout: distributed transaction waiting for lock errors might occur. # informia.useAppendHintForRestore=false # Use DBA_* or ALL_* views when creating the seamless access layer (default is to use DBA_* views) # If set to true then access to the following DBA views is required: # Seamless Access User: DBA_DEPENDENCIES, DBA_SYNONYMS, DBA_OBJECTS, DBA_POLICIES # Source User: DBA_VIEWS, DBA_TAB_COLUMNS #informia.useDbaViewsInSeamlessAccess=true # Use this parameter to specify the default retention period for the archive folder. # 0 Immediate expiry allowed. # -1 Infinite retention applies. # nd|D|m|M|y|Y Positive integer with d, or m, or y suffix (case insensitive). #For example, 500d means 500 days; 24m means 24 months; and 10y means 10 years. #informia.defaultArchiveAreaRetention=-1 # Use this parameter in case of Legacy Platforms to query database catalog from Database Drivers Provider's implementation of the API# Y uses the Driver providers implementation of JDBC API to query DB object information # N uses the universal approach of querying the DB object information (default) # informia.useDriverProvidedMetadata = Y #Use this parameter to control renaming of the Staging Directory of ArchiveTarget #informia.attachmentRenameDir=Y #Use this paramater to enable Orcale Cardinality Hint. This can be useful to improve the performace. #informia.privacyEnableCardinalityHint=Y #Use this parameter to enable security in JSP based API to manage Jobs. #you can provide comma separated host entries #validHosts=host1, 192.168.168.97, dev.* #Use this parameter to print the host and port in the logs #informia.appendHostAndPortInLog=N #Use this parameter to enable retaining of trailing spaces in FAS #informia.retainTrailingSpaces=N #Uncomment this property to turn off bulk extraction select statements from the engine #informia.bulkExtractionMode=Ninformia.virtualView.colSeparatorConstant=&COL_SEPARATOR #Uncomment this property to add addtional attributes to FAS load properties #informia.fasLoadAdditionalAttributes=<entry key="maxSourceLineLength">512000000</entry> #Use this parameter to limint the concatenated Column length in Bulk Extract mode. Default is 2000 bytes #informia.bulkModeMaxConcatenatedColumnLength=2000 #Uncomment this parameter to get the App View over URL using GET method #informia.appViewGetAllowed=Y #MIS Integration Properties #DomainName=<Domain_Name> #DomainHost=<PCHostName> #DomainPort=<DISPort> #nodeName=<PCNode_Name> #UserName=<PowerCenter_User> #Password=<PowerCenter_User_Password> #version=9.1 #UserNameSpace=<PC_Authentication_Method> #mrsServiceName=<Model_Repository_Name> #DisName=<DataIntegrationServiceName> ##Set to UK if you want to use uniqueness runs and PK to do Primary Key Profiling runs instead. #informia.pkInferenceType=UK #PC Integration #PCRSName=<DataDomainServiceName> #PCISName=<Power Center Integration Service Name> #ide.thread.sleeptime=3000 #informia.pc.codepage=MS1252 #informia.pc.repdbtype=Oracle #informia.pc.foldername=ArchiveInt #informia.isPCOnWindows=Y #informia.pc.sourceDatabaseType=Oracle #informia.exposePCForExecution=N # Legal hold query options # Prevent legal hold child table queries to run in parallel (default is false) # legalhold.useWithClauseForChildTableQuery=true # Number of npa_unique_record_index values in the IN list of legal hold child table queries (default is 100) # legalhold.numUniqueIdsInWhereClause=100 # Use this parameter for meta data mining, insert commit interval # informia.miningCommitCount=10000 # DB2 HPU ExportUtil Configuration #informia.db2HPUPath=/opt/IBM/DB2TOOLS/HighPerformanceUnload42 #informia.exportUtilName=HPU #informia.db2Extension=DEL #These are added after the load file name is mentioned in import command. #informia.db2ImpStart= #These are added before the insert statement mentioned in import command. #informia.db2ImpMiddle= #These are added after the Insert statement is mentioned in import command. #informia.db2ImpLast= #These are added after the unload file name is mentioned in export command. #informia.db2ExpStart= #These are added after the select statement is mentioned in export command. #informia.db2ExpLast= #If enabled then it is used only when we use HPU. If disabled then we do not use it in any utility. Please note that HPU allows only one byte long separator. #informia.hpu.columnSeparator= #informia.hpu.rowSeparator= # Create threading tables as Index Organized Tables (defaults to true): # informia.createDFSThreadingTableAsIOT=true # Create index on APPLIMATION_ROWNUM column if tables are not created as IOTs (defaults to true): # informia.createIndexOnDFSThreadingTable=true #Use this parameter to enable DFS Pause & Resume Functionality #informia.DFS.PauseResume=Y # Set informia.dataDiscovery.deleteTransactionXML to false in order to keep the transaction xml (App View) for debugging purposes # informia.dataDiscovery.deleteTransactionXML=true # CR 277873 : Setting this property to Y, disables the trend graph calculation for large datasets in the DGA Administrator Dashboard # informia.disableTrendGraph=Y # Data Partition Column Name being added to Partitioned tablesinformia.partition.ilm.column=ILM_PART_COLUMN #if the partitionDbms is N then use native partition(no redefinition) #informia.partitionDbmsRedef=N # default value is - " -k 4 -j 1" #informia.fasLoadProcessingThreads= -a 0x00 -k 4 -j 1 -x #[in MB's] default value is 1024 #informia.maxBcpGroupSize=1024 # used in the case of mount points #informia.sctPremissionCommand=chmod 664 #property defines task timout of FAS server(if unset, default is 3000(ms)) #informia.fasServerTaskTimeout=120000 # default value for informia.isSapOnWindows is 'N'informia.isSapOnWindows=Y # defaule value for maximum number of large object files in a directory # one megalob file gets generated for per multiple rows per large object column in table, size of megalob is determined by informia.LoaderDatFileMaxSizeLimit propertyinformia.bcp.maxLOBFilesInADir = 100000 # list of special characters in table or column Nameinformia.bcp.specialChars = / \\ $ ( ) = & ^ @ # % ! * # set below property to Y to enable Role assignment to partition #informia.enableAccessLayer=N # set the below property to Y to treat varbinary with length less than 2000 in SQL server to be treated as varcharinformia.sqlServerVarBinaryAsVarchar=N # set the below property to execute run procedure in archive from histroy #informia.proceduresToExecute.inArchiveFromHistory=java://com.applimation.archive.dao.impl.MoveFileDAOImpl #property defines maximum allowed error count before aborting File Archive Loader Job. (if unset, default is 4 )#informia.fasLoaderErrorThresholdCount=4 #property defines size limit of megalob file in MB. (if unset, default is 20480 MB.) #informia.LoaderDatFileMaxSizeLimit=20480 # set the below property to N to stop using the InsertAsSelect in CTD and GC step. Default behavior is Yes. #informia.insertAsSelectFlag=Y # Run DGA Data Collection as admin user or application user (default true) # informia.dga.useAdminUser=true #property specifies encoding technique used by tomcat #informia.httpCharacterEncoding=UTF-8 #property defines NULL Representation in bcpinformia.NULLRepresentationInBcp=\u007F #Property to turn off loading visualization on server startup. Value Y is the default behaviour. #informia.loadDataVisualization=N #Property overrides the default RMI port used to connect to visualization server. the default value is 1129 #informia.visualizationPort=1129 #Property overrides the default RMI host used to connect to visualization server. the default value is localhost #informia.visualizationHost=localhost #property to enable DDM support queryinformia.enableDDMSecurity=N #Property to define the lucene index directory, this directory should be outside your tomcat install, to avoid any impacts on upgrade. #Provide the absolute path of the directory. Use double slash for Windows path, eg : C:\\ILM\\lucene #informia.keywordSearchIndexDir=/u01/611/lucene/ #property to specify number of threads used in data vault Loader job.By Default, the ILM engine calculates the value by dividing the number of CPU cores by 2 #informia.faThreadCount= #Data Archive page that appears when user logs in. enter the url of the page you want the user to first see, based on the user's system-defined role. #informia.welcomePage= #Remote storage metadata loading fails if multiple threads are used, to use single thread, enable this property by replacing 'N' with 'Y' #informia.metaDataLoaderThreadCount=N #Property to define the number of threads created by indexing job.#informia.maxActiveIndexThreads=10 # Storage option for XMLTYPE columns in Staging and History tables # If set, should be either CLOB or BINARY XML # informia.XMLTYPE_Storage_Option=CLOB #Property to define the NVARCHAR(MAX) and VARCHAR(MAX) to VARCHAR(32000)#informia.sqlServerNVarcharMaxAndVarcharMaxToVarchar=N#set the following properties to extract the data in non-ascii format #informia.extractSqlServerBinaryasHexaData=N #informia.extractSqlServerVarBinaryasHexaData=N #informia.extractSybaseVarBinaryasHexaData=N #set the following properties to extract bit as byte #informia.extractSybaseBitAsByte=N # Property to let know the start year of 5-digit julian data #informia.julianLimiterYear=1940 # For Windows network driver as staging. Wait time in milli seconds. Default value is 0 seconds. #For a value of 5000. File Archive Loader job waits for 5 seconds. #informia.regfileWaitTimeForNas=5000 #informia.loadWaitTimeForNas=5000 #Commit intervel for number of update querires when making scts online, if this propery is not enabled default values is 10000#informia.updateSCTCommitInterval=10000 #Property to be set if default encoding defined by file.encoding and operating system locale are different #if inactive the default value is taken from property file.encoding defined in startApplimation #informia.loadExternalAttachmentsFileEncoding=#Properties to be provided for enabling Single sign on. #informia.sso.enable = N #Path of meta-data file generated after configuring the application to IDP.#informia.idp.metedata.file = idp.xml#Path of the key which will be used to encrypt the authRequest send to IDP. #informia.key.path = key #Alias name used to generate the key mentioned above. #informia.key.alias.name = alias #Password used to generate the key mentioned above in encrypted format.#informia.key.password = password # Property hold Certificate file path to enabled SSL from DA side to communicate with IDV which running on SSL mode#informia.idv.ssl.certificatePath= # Property to enable the authentication for the API requests, default value is N.#informia.api.authentication=N#property defines size limit of export XML files in MB. (if unset, default is 1024 MB.) #informia.MetaDataExportXMLFileMaxSize=1024 #property to enable import metadata from database option in EDM, default value is Y. #informia.enable.mining=Y #property to enable enhanced import option in EDM, default value is Y. #informia.enable.enhanced.import=Y #Property to disabled jobids for the browse data queriesinformia.disableAddingExtractJobIdPredicate=Y #property to enable traditional import metadata option in EDM, default value is N. #informia.enable.traditional.import=N #Command to generate encryption key using third party utility #informia.encryptionkey.command=java -classpath cryptokey.jar com.crypto.GenerateKey#property defines the number of admin threads to be used in encrypting the idv data. default value is 5. #informia.encryption.RegistrationThreadCount=10 #property defines the number of worker threads to be used in encrypting the idv data. default value is 10. #informia.encryption.WorkerThreadCount=50 #property that defines SCT file regisration type in IDV. property values can be sql/admin , default is sql. #informia.encryption.SCTRegistrationType=sql #property defines the admin timeout in seconds #informia.encryption.AdminTimeout=120 #property defines delete data files or not. default values is N ( no) #informia.encryption.DeleteOldDataFiles=N #encrypt idv data job property defines if idv should execute the encrypt commnad in debug mode or not, default value is N ( no) #informia.encryption.IDVDeBugMode=N # Property to disable the signing of JAR files using timestamp server. Default value is Y. #informia.useTimestampServerForJARSigning=N #Set the following property to Y to disable the daylight saving time #informia.disableDaylightSavingTime=Y #Set this property to add wait time for the RuntimeUtil used in ssadrv. For a value 10 - we are adding wait time of 10 seconds[10 iterraions of 1 second each]. Default value is 10 seconds. #informia.waitTimeForRuntimeStreamRead=10 #Set the following property to Y to display column descriptions for the columns on Browse Data pageinformia.useColumnDescriptionOnBrowseDataPage=Y #Set the following property to Y to apply the Business Rules during the Archive from the History jobinformia.applyBusinessRulesDuringArchiveFromHistory=N #Set the following property to Y to enable the indexing of ZIP files present in AM_ATTACHMENTS table in Create Index on Data Vault job #informia.indexZIPFiles=Y #Set the following property to Y to disable CSRF check #informia.disableCSRFCheck=Y #Set wait time to open DAT after an failed attempt in milli seconds #informia.loadWaitTimeForFOS=5000 #Enter a custom file name and location for the master key file. For example: C:\\ILM\\Masterkey\\key.file. The default value is the Data Archive installation directory. #informia.encryption.masterKeyPath= #Property to enable or disable SQL Safe Validation. Default value is Y. To disable, set to N. informia.SQlSafeValidation=Y

0 COMMENTS

We’d like to hear from you!