<?xml version="1.0" encoding="utf-8"?>
<Session ID="/baanerp/tt/stp/ttstplocklog" xml:lang="en">
	<Header>
		<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Generate lock graph html output (ttstplocklog)</Title>
	</Header>
	<HelpTopic xml:lang="en"><AimSection><Paragraph class="Default">
                                 Use this session to generate an html report that shows the database lock history. You can use this report to identify, for example, long waiting times, long locks and retries, which cause performance problems.</Paragraph>
			<Paragraph class="Default">The session first generates a snapshot file, based on the locking log file(s). This file contains all, or a subset of, the log records. Then, the session generates an html report that displays the contents of this snapshot file.</Paragraph>
			<Paragraph class="Default">The report consists of the following sections:</Paragraph>
			<TABLE border="1" borderstyle="default" space-and-orientation="indented-estimated"><THEAD><TR><TD rowspan="1" colspan="1">Section</TD>
						<TD rowspan="1" colspan="1">Description</TD>
					</TR>
				</THEAD>
				<TBODY><TR><TD rowspan="1" colspan="1">legend</TD>
						<TD rowspan="1" colspan="1">Explains the terms used in the report.</TD>
					</TR>
					<TR><TD rowspan="1" colspan="1">
							<Paragraph class="Default">Total wait time per table</Paragraph> <Paragraph class="Default">Wait time summary</Paragraph> <Paragraph class="Default">Wait time details</Paragraph>
						</TD>
						<TD rowspan="1" colspan="1">
							<Paragraph class="Default">These sections show wait time statistics.</Paragraph> <Paragraph class="Default">The wait time is the time between the moment a physical lock is requested and the moment the physical lock is successfully set.</Paragraph>
						</TD>
					</TR>
					<TR><TD rowspan="1" colspan="1">
							<Paragraph class="Default">Total lock time per table</Paragraph> <Paragraph class="Default">Lock time summary</Paragraph> <Paragraph class="Default">Lock time details</Paragraph>
						</TD>
						<TD rowspan="1" colspan="1">
							<Paragraph class="Default">These sections show lock time statistics.</Paragraph> <Paragraph class="Default">The lock time is the time between the moment the physical lock is successfully set and the end of the transaction (commit/abort).</Paragraph>
						</TD>
					</TR>
					<TR><TD rowspan="1" colspan="1">
							<Paragraph class="Default">Long running transactions summary</Paragraph> <Paragraph class="Default">Long running transactions details</Paragraph>
						</TD>
						<TD rowspan="1" colspan="1">
							<Paragraph class="Default">These sections show statistics on the duration of long running transactions.</Paragraph> <Paragraph class="Default">The transaction duration is the time from the first logical lock until the end of the transaction (commit/abort).</Paragraph> <Paragraph class="Default">These sections are only displayed if the <GUIRef href="/baanerp/tt/stp/ttstplocklog#transaction.info" role="field">Transaction Details</GUIRef> check box is selected.</Paragraph>
						</TD>
					</TR>
				</TBODY>
			</TABLE>
		</AimSection>
		<GeneralSection><ProcedureList><ListIntro>To generate and view the html report, complete the following steps:</ListIntro>
				<ListItem>In the <GUIRef href="" role="manual">Generate Snapshot</GUIRef> tab, specify the information required to generate the snapshot file. For details, refer to the field help.</ListItem>
				<ListItem>In the <GUIRef href="" role="manual">Generate Snapshot</GUIRef> tab, click <GUIRef href="/baanerp/tt/stp/ttstplocklog#generate.snapshot" role="command">Generate</GUIRef>. The session generates the snapshot file.</ListItem>
				<ListItem>In the <GUIRef href="" role="manual">Generate HTML</GUIRef> tab, specify the information required to generate the html report. For details, refer to the field help.</ListItem>
				<ListItem>In the <GUIRef href="" role="manual">Generate HTML</GUIRef> tab, click <GUIRef href="/baanerp/tt/stp/ttstplocklog#generate.snapshot" role="command">Generate</GUIRef>. The session generates the html report.</ListItem>
				<ListItem>In the <GUIRef href="" role="manual">Generate HTML</GUIRef> tab, click <GUIRef href="/baanerp/tt/stp/ttstplocklog#viewhtml" role="command">View</GUIRef>. The generated report is displayed in your default html browser.</ListItem>
			</ProcedureList>
		</GeneralSection>
		<Note><SectionTitle>
                                 Note
                              </SectionTitle>
			<Paragraph class="Default">You can only use this session if the logging of database locks is enabled. To enable this logging, use the <Link href="/baanerp/tt/aad/ttaad4153m000" role="session">Logging Parameters (ttaad4153m000)</Link> session.</Paragraph>
		</Note>
	</HelpTopic>
	<Forms><Form><Header>
				<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Generate Snapshot</Title>
			</Header>
			<Fields><FieldHelp ID="source"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Log File / Dir</Title>
					</Header>
					<FuncDesc>The location of the log file(s) where the database locking information is logged.</FuncDesc>
					<SimpleSection><Paragraph class="Default">The session reads log information, for a specified time frame, from the specified log files and stores this information in a snapshot file. Then, the session generates an html report based on the snapshot file.</Paragraph>
						<List><ListTitle>
                                             Note
                                          </ListTitle>
							<ListItem>If there is one log file, specify the path and name of the file. For example: <Code>/usr/bse/tmp/log_locking.1048612</Code>.</ListItem>
							<ListItem>If there are multiple log files, specify the directory where the files reside. For example: <Code>/usr/bse/tmp</Code>.</ListItem>
						</List>
					</SimpleSection>
				</FieldHelp>
				<FieldHelp ID="snapshot"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Snapshot file</Title>
					</Header>
					<FuncDesc>The path and name of the snapshot file to be generated. This file contains the log information for the selected date and time range.</FuncDesc>
					<Important><SectionTitle>
                                          Important!
                                       </SectionTitle>
						<Paragraph class="Default">The snapshot file must be stored in a folder different from the folder that contains the log files.</Paragraph>
					</Important>
				</FieldHelp>
				<FieldHelp ID="utcsnap.f" OtherIDs="utcsnap.t"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Date/Time</Title>
					</Header>
					<FuncDesc>Use this field to specify the time frame for the log information that will be stored in the snapshot file.</FuncDesc>
				</FieldHelp>
			</Fields>
		</Form>
		<Form><Header>
				<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Generate HTML</Title>
			</Header>
			<Fields><FieldHelp ID="target"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Target</Title>
					</Header>
					<FuncDesc>The path and name of the html report file to be generated. For example: <Code>/home/jsmith/db_lock_report.html</Code>.</FuncDesc>
				</FieldHelp>
				<FieldHelp ID="utc.f" OtherIDs="utc.t"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Date/Time</Title>
					</Header>
					<FuncDesc>Use this field to specify the time frame for the log information that will be displayed in the html report.</FuncDesc>
				</FieldHelp>
				<FieldHelp ID="all.tables"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">All Tables</Title>
					</Header>
					<FuncDesc>
                                       If this check box is selected, the report displays log information for all tables, for which log information is present in the snapshot file.</FuncDesc>
					<SimpleSection><Paragraph class="Default">
                                          If this check box is cleared, you must select a table for which the report will display log information.</Paragraph>
					</SimpleSection>
				</FieldHelp>
				<FieldHelp ID="stbl"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Table</Title>
					</Header>
					<FuncDesc>The package code of the table for which the report will display log information.</FuncDesc>
				</FieldHelp>
				<FieldHelp ID="smod"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Table</Title>
					</Header>
					<FuncDesc>The module code of the table for which the report will display log information.</FuncDesc>
				</FieldHelp>
				<FieldHelp ID="sfln"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Table</Title>
					</Header>
					<FuncDesc>The table number of the table for which the report will display log information.</FuncDesc>
				</FieldHelp>
				<FieldHelp ID="all.comp"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">All Companies</Title>
					</Header>
					<FuncDesc>
                                       If this check box is selected, the report displays log information for all companies, for which log information is present in the snapshot file.</FuncDesc>
					<SimpleSection><Paragraph class="Default">
                                          If this check box is cleared, you must select a company for which the report will display log information.</Paragraph>
					</SimpleSection>
				</FieldHelp>
				<FieldHelp ID="comp"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Company</Title>
					</Header>
					<FuncDesc>The company for which the report will display log information.</FuncDesc>
				</FieldHelp>
				<FieldHelp ID="topn"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Top</Title>
					</Header>
					<FuncDesc>Use this field to display the <Emphasis>top n</Emphasis> problems in the report.</FuncDesc>
					<Important><SectionTitle>
                                          Important!
                                       </SectionTitle>
						<Paragraph class="Default">You must enter a value greater than zero.</Paragraph>
					</Important>
					<SimpleSection><SectionTitle>Example</SectionTitle>
						<Paragraph class="Default">Enter 15. The report shows the following:</Paragraph>
						<TABLE border="1" borderstyle="default" space-and-orientation="indented-estimated"><THEAD><TR><TD rowspan="1" colspan="1">Report section</TD>
									<TD rowspan="1" colspan="1">Displayed content</TD>
								</TR>
							</THEAD>
							<TBODY><TR><TD rowspan="1" colspan="1">Wait time summary</TD>
									<TD rowspan="1" colspan="1">The 15 transactions with the longest wait times. The corresponding details are displayed in the Wait time details section.</TD>
								</TR>
								<TR><TD rowspan="1" colspan="1">Lock time summary.</TD>
									<TD rowspan="1" colspan="1">The 15 transactions with the longest lock times. The corresponding details are displayed in the Lock time details section.</TD>
								</TR>
								<TR><TD rowspan="1" colspan="1">Long running transactions summary</TD>
									<TD rowspan="1" colspan="1">The 15 transactions with the longest transaction durations. The corresponding details are displayed in the Long running transactions details section. <Paragraph class="Default">The Long running transactions summary section and the Long running transactions details section are only displayed if the <GUIRef href="/baanerp/tt/stp/ttstplocklog#transaction.info" role="field">Transaction Details</GUIRef> check box is selected.</Paragraph>
									</TD>
								</TR>
							</TBODY>
						</TABLE>
					</SimpleSection>
				</FieldHelp>
				<FieldHelp ID="transaction.info"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Transaction Details</Title>
					</Header>
					<FuncDesc>
                                       If this check box is selected, the report contains the following extra sections, which display statistics on the duration of long running transactions:</FuncDesc>
					<SimpleSection><List><ListItem>Long running transactions summary</ListItem>
							<ListItem>Long running transactions details</ListItem>
						</List>
					</SimpleSection>
				</FieldHelp>
			</Fields>
			<FormCommands><CommandHelp ID="generate.snapshot"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">Generate</Title>
					</Header>
					<FuncDesc>Generates the snapshot file and the html report file.</FuncDesc>
					<SimpleSection><Paragraph class="Default">To view the generated report in your default html browser, click <GUIRef href="/baanerp/tt/stp/ttstplocklog#viewhtml" role="command">View</GUIRef>.</Paragraph>
					</SimpleSection>
				</CommandHelp>
				<CommandHelp ID="viewhtml"><Header>
						<Title xmlns:HTML="http://www.w3.org/TR/REC-html40">View</Title>
					</Header>
					<FuncDesc>Displays the html report file, specified in the <GUIRef href="/baanerp/tt/stp/ttstplocklog#target" role="field">Target</GUIRef> field, in your default html browser.</FuncDesc>
				</CommandHelp>
			</FormCommands>
		</Form>
	</Forms>
</Session>
