Common

Parameters – Collect

Use this page to Configure Collect Parameters.

To access this page, select Common > Configuration > Modules > Parameters-Collect in the Navigation pane.

This page contains the following tabs:

General tab

Field

Description

Application Information

Version

Displays current release version of the component, Collect.

Release Date

Displays date when the component version was released.

Filters

Action Filter

Displays prefix used for action stored procedures. Default value is asp%.

Rule Filter

Displays prefix used for rule stored procedures. Default value is ir%.

Connection Info

Server Name

Displays name of server where application resides

DB2Time Out

Displays time, in milliseconds, for an idle transaction in DB2. Default value is 180.

Oracle Time Out

Displays time, in milliseconds, for an idle transaction in Oracle. Default value is 180.

SQLSERVER Time Out

Displays time, in milliseconds, for an idle transaction in SQL Server. Default value is 180.

General Settings tab

Field

Description

Job Settings

Queue ID

Displays queue used for table downloads when a table is refreshed in Collect. The default value, General, is used by all Collect table refreshes.

To prevent processing backlogs and inefficient Stewardship Tier usage during the execution of large Collect refreshes, the queue ID can also be set in Collect at the target, target source or table level. Refer to Assign a Queue to a Refresh for more information.

Recycle Job Max

Displays number of times the download process is recycled. If the job fails, the table is recycled into the job queue at the end of the current cycle. This feature is designed to monitor network problems. If set to 0, the job isn’t recycled. Default value is 3.

Duration Warning Limit

Displays limit (in seconds) for long-running tables. These tables display in the Duration Warning List report, which is available in Collect under Reports > Duration Warning List.

Run Jobs Metrics

Displays a value that captures run and duration times for data downloads and conversions.

Values are:

  • No Metrics – Disables metric process
  • Build Job Metrics – Stores duration for the job to complete all events
  • Build Event and Job Metrics – Stores duration of each event and total for the job

Default value is Build Job Metrics.

Job Metrics Retention

Displays number of days to store Table Download Runtime processing data. Default value is 1 day.

Misc. Settings

Scheduled Downloads

If checked, Collect service jobs run in the background. Default is Enabled.

Test Source Before Delete

If checked, the ability to log in to the source system is tested before the current data is deleted and before the creation of the download. Default value is Enabled.

Max Tracing Count

Displays maximum value of how large the DebugLog table can get before logging for Collect turns off.

Default Collation Type

Displays the language option for text data in the database.

Values are: General Latin Case-insensitive, General Latin Case-sensitive

Default value is General Latin Case-insensitive, which means the collation uses Latin characters and is case-insensitive.

Max Record Sources For Union View

Display the threshold for the number of sources that can be registered for the Record Count on the Tables page’s Vertical View to be calculated.

If the number of sources registered exceeds the threshold set by this parameter, no Record Count is calculated and the Record Count field on the Tables page’s Vertical View is 0.

Package Info tab

Field

Description

General Package Settings

Build Package Default

Displays default setting for building tables. Default value is CranPort.

Package Extension

Displays characters appended to the package name. Default value is imp.

SSIS Settings

SSIS File Path

Displays folder on the component server that stores SSIS packages.

RFC Settings

Rfc Name Space Option

Displays option for RFC name.

Values are:

  • NAMESPACE — uses the namespace version of the BOA Function Module
  • NONNAMESPACE — uses non-namespace version of the BOA Function Module.

NOTE: The namespace concept describes how customers and partners name their development objects to avoid overlapping when SAP software is upgraded. BDC Function Modules and BAPI Function Modules can be namespace or non-namespace objects.

NOTE: If this field is not populated and if the Use SAP Namespace check box on the Data Source Registry page is unchecked, the Stewardship Tier overrides the logging configuration settings with “namespace.”

Default value is NONNAMESPACE.

Rfc Type

Displays type of RFC used.

Values are:

  • SAP RFC – Uses SAP’s Remote Function Call
  • BOA RFC – Uses custom Remote Function Call developed by Syniti

Default value is BOA RFC.

Rfc Records Per Call

Enter number of records to pull per block from SAP. Default value is 5000.

Data Services Settings tab

Field

Description

Datastore Settings

Source Datastore Name Format

Displays the format for a Datastore object created for a source connection when building a SAP Data Services package. Default value is #SOURCE#.

Target Datastore Name Format

Displays the format for a Datastore object created for a target connection when building an SAP Data Services package. Default value is #TARGET#.

Collect Datastore Name Format

Displays the format for a Datastore object created for a collect connection when building a SAP Data Services package. Default value is dgDataGarage.

Download Job Settings

Download Job Name Format

Displays name format for the job that executed a download of source table to a target table. Default value is #SOURCE#_#TARGET#_#SOURCETABLE#_imp.

Download Job Data Flow Name Format

Displays the format for the Data Flow object in a Download job. Default value is DF_#SOURCE#_#TARGET#_#SOURCETABLE#.

Download Job Source Table Data Flow Display Name Format

Displays the format for the source table display name in a Data Flow object of a Download job. Default value is #SOURCETABLE#_#SOURCE#.

Download Job Target Table Data Flow Display Name Format

Displays the format for the target table display name in a Data Flow object of a Download job. Default value is #TARGETTABLE#_#TARGET#.

Download Job Source Table Description Format

Displays the format of the source table description in a Download job. Default value is #SOURCETABLE# table from #SOURCE#.

Download Job Target Table Description Format

Displays the format of the target table description in a Download job. Default value is #TARGETTABLE# table from #TARGET#.

Download Job Schema Name Format

Displays the format of the Schema Name object in a Download job. Default value is TFM_#TARGETTABLE#.

Query Job Settings

Query Job Name Format

Displays name format for the job that executes a schema query on a Datastore. Default value is Collect staging table dg#JOBTYPE#Query_#SOURCE#.

Query Job Data Flow Name Format

Displays name format for a DataFlow object in a Query job. Default value is DF_dg#JOBTYPE#Query_#SOURCE#.

Query Job SQL Query Name Format

Displays name format for a SQLQuery object in a Query job. Default value is SQL_dg#JOBTYPE#Query_#SOURCE#.

Query Job Target Table Data Flow Display Name Format

Displays format for the target table display name in a Data Flow of a Query job. Default value is #QUERYJOBTARGETTABLE#(Collect).

Query Job Target Table Description Format

Displays format of the target table description in a Query job. Default value is Collect staging table #QUERYJOBTARGETTABLE#.

Workflow Settings tab

Use this tab to Update the Retention Expiration Warning Period.

Field

Description

Retention Date Notification

Retention Expiration Date Notification

Displays the number of days before data is purged (the retention expiration date) that a warning workflow email is sent to the Data Controller.

The email contains a list of objects whose data will be purged and a link to access the objects in the Stewardship Tier.

The Stewardship Tier sends this email daily when an object is scheduled to be purged during this time.

Retention Warning Email

Click to open the Collect Retention Expiration Email page to configure the subject line and body of the workflow email sent when an object’s retention date is within the number of days set in the Retention Expiration Date Notification field.

Email Contents

Collect Work Flow From Email

Displays email address of account that sends workflow emails.

Collect Work Flow Failure Body

Displays text for body of failed table workflow emails.

Collect Work Flow Failure Table Vertical

Displays the header definition for failed table workflow emails.

Collect Work Flow Summary Body

Displays text for body of summary workflow emails.

Collect Work Flow Summary Table Header

Displays table header row in summary workflow emails.

Collect Work Flow Summary Table Line

Displays the row definition for summary workflow emails.