Data Sync Advanced Configurations

Transcription

1 Data Sync Advanced Configurations There are some settings that can be used to configure DataSync in advanced scenarios that are not available through any user interface. EnvironmentParameters table settings. Open Sql Mgmt Studio and open the EnvironmentParameters table. Settings are in the form name : value. The name goes in the name column and the value goes in the value column. After making any changes in this table, you will need to restart the services and applications for it to take affect. o BadgePass.SqlCommandTimeout : value in seconds - the default for this is 30 seconds. This value is used for the amount of time before a sql command times out when loading the BadgePass or Source Data ( when using Sql source ). This is used when querying for the column names or table names or view names. This same setting is also used by BadgePass Server, so it will determine the sql timeout values for the entire BadgePass system, so be aware. o DataSync.ThreadLimit : integer value is number of concurrent threads - the default value is 5. This indicates that up to 5 threads will be running concurrently processing rows of the source data. If you are getting deadlock errors, you may need to change this value to 1 thus getting rid of concurrent processing. If you are having the profile run too slowly and not using too much resources, you could increase this number to increase throughput. BadgePassEnvironmentParameter file ( EnvironmentParameters.xml in ProgramData/BadgePass ) on the computer where DataSync is installed: o DataSync.DataSetSize : integer representing number of rows default is This is the chunk of the source data that is loaded into memory for processing. DataSync will load the number specified here, then start processing the rows. Then when like 90% of them are done, it will start loading the next datasetsize number of rows from the source. Logging. The logging can be changed on the fly without restarting any services or applications. To make these changes, modify this file: C:\Program Files (x86)\badgepass DataSync Server\Logger\SemanticLogging-svc.xml. By default there are 3 places that logs go listed below. There are different levels that can be set for logging: Summary: No level filtering is done on the event. LogAlways = 0, This will give you almost too much logs

2 Summary: This level corresponds to a critical error, which is a serious error that has caused a major failure. Critical = 1, Summary: This level adds standard errors that signify a problem. Error = 2, Summary: This level adds warning events (for example, events that are published because a disk is nearing full capacity). Warning = 3, default value for DataSync Summary: This level adds informational events or messages that are not errors. These events can help trace the progress or state of an application. Informational = 4, best to start with this when you need more troubleshooting logs Summary: This level adds lengthy events or messages. It causes all events to be logged. Verbose = 5 move here after informational if you need more info Three default places for logging: o BPDataSync event log. This is what is output to the windows event viewer under the BPDataSync log. This corresponds to this entry in the file: <customsink name="eventviewerlistenerdatasync" type="testeventlogsink.eventviewerlistener, TestEventLogSink" > <eventsource name="bp Data Sync" level="warning"/> <parameters> <parameter name="eventlogname" value="bpdatasync" type="system.string" /> <parameter name="source" value="bpdatasync" type="system.string"/> </parameters> </customsink> To adjust the level for this log, changed the hightlighted text above to a different log level. o ProgramData/BadgePass/BadgePass Data Sync/DataSyncErrors.timestamp.log. These logs are written to the file system so you don t have to worry about the windows event log filling up and overwriting the logs.

3 <rollingflatfilesink name="svcruntime" filename="c:\programdata\badgepass\badgepass Data Sync\DataSyncErrors.log" rollsizekb="20000" maxarchivedfiles="5" rollfileexistsbehavior="overwrite" rollinterval="midnight" timestamppattern="yyyymmdd"> <!-- The below settings shows a simple configuration sample for the buit-in non-transient fault tracing --> <!-- Remove this eventsource if you'd like, and add your own configuration according to the documentation --> <!-- The name attribute is from the EventSource.Name Property --> <eventsource name="bp Data Sync" level="warning"/> <!--[Add any built-in or custom formatter here if the sink supports text formatters]--> <eventtextformatter header=" "/> </rollingflatfilesink> The hightlighted sections are sections you may want to change, the max # of archived files, the total size of each file, and the level of this log. o ProgramData/BadgePass/BadgePass Data Sync/FailedRecords.timestamp.log <rollingflatfilesink name="summaryfilelog" filename="c:\programdata\badgepass\badgepass Data Sync\FailedRecords.log" rollsizekb="20000" maxarchivedfiles="5" rollfileexistsbehavior="overwrite" rollinterval="midnight" timestamppattern="yyyymmdd"> <!-- The below settings shows a simple configuration sample for the buit-in non-transient fault tracing --> <!-- Remove this eventsource if you'd like, and add your own configuration according to the documentation --> <!-- The name attribute is from the EventSource.Name Property --> <eventsource name="bp Data Sync" level="logalways" matchanykeyword="16"/> <!--[Add any built-in or custom formatter here if the sink supports text formatters]--> <eventtextformatter header=" "/> </rollingflatfilesink> This log will most likely not need to be modified. It is set to only log failed records, and modifying the level will not add more verbose logging. If you want the debug logs, set the level to LogAlways, and set matchanykeyword to 64.

4 Once you save the file, the new settings should take affect. If they do not, then you can restart the BadgePass Enterprise Logging Service. I have had to do that on some occasions. Interpretting Logs: Example Log: This log happens after a row of the source is processed and returned: The stored procedure ( [DataSync-Visitor Import] ) returned - [880FF895-D25D- E711-B D7B8A0482][ 1][Photo 1 B07F322D-DB5D-E711-B D7B8A0482 C:\Users\shuds\Desktop\New folder (2)\1W7A1001.jpg?][]. [entity s uid that was added or updated, ie employeeuid, visitoruid][events that will fire, ie employeeadded, employeecardenabled ][list of images that were added separated by? ][log of any sql errors] The list of images will have 4 parts separated by 1. Image type 2. Image Type ID 3. the entityimageuid that was added/updated 4. The path that was added to the database for this image. This will be where BadgePass looks for that image when pulling up in IM etc. So the above example shows That entity with UID (880FF895-D25D-E711-B D7B8A0482) was edited ( 1 ) and that the visitoredited event will fire. Also that an image was added/updated. Events will be listed in the Stored Procedure Returned event separated by a pipe for example 9 means that the GroupMembershipChanged event will fire. public enum EventType { / <summary> An enum constant representing the added option. </summary> Added = 0, / <summary> An enum constant representing the edited option. </summary> Edited = 1, / <summary> An enum constant representing the deleted option. </summary> Deleted = 2, / <summary> An enum constant representing the disabled option. </summary> Disabled = 3, / <summary> An enum constant representing the card disabled option. </summary> CardDisabled = 4, / <summary> An enum constant representing the card printed option. </summary> CardPrinted = 5,

5 / <summary> An enum constant representing the banned option. </summary> Banned = 6, / <summary> An enum constant representing the enabled option. </summary> Enabled = 7, / <summary> An enum constant representing the card enabled option. </summary> CardEnabled = 8, / <summary> An enum constant representing the group membership changed option. </summary> GroupMembershipChanged = 9 } Keywords that can be used to filter on in the logs: public class Keywords { public const EventKeywords SummaryFile = (EventKeywords)16; public const EventKeywords ReadRow = (EventKeywords)32; public const EventKeywords Debug = (EventKeywords)64; public const EventKeywords Formats = (EventKeywords)128; public const EventKeywords ScheduleRun = (EventKeywords)256; public const EventKeywords ItemSaved = (EventKeywords)512; }