Calidus HUB - User contributions [en-gb]

Template:EstimateNew

2026-02-27T14:20:44Z

Anw: Added TemplateData

{{Estimate_Head
|Client={{{Supimix_Client_Code}}}
|Project={{{Supimix_Project_Code}}}
|Site={{{Supimix_Site_Code}}}
|ClientRef={{{Supimix_Client_Reference}}}
|OBSRef={{{Supimix_Number}}}
|Version={{{The_version_of_the_document}}}
|Author={{{Your_Name}}}
|PONum={{{Supimix_PO_Reference}}}
|Priority={{{Supimix_Priority}}}
|Date={{{Date_(DD/MM/YY)}}}
|Customer={{{Clients_Customer}}}
|SysVer={{{System_Version_being_changed}}}
|ClientRequest={{{Client_Request}}}
|Solution={{{OBS_Solution}}}
}}
{{EstimateCostDetails{{{Year}}}
|REQ={{{Requirements_Days}}}
|EST={{{Estimation_Days}}}
|FS={{{Functional_Specification_Days}}}
|TS={{{Technical_Specification_Days}}}
|DEV={{{Development_Days}}}
|ST={{{Testing_and_Release_Days}}}
|IMP={{{Implementation_Days}}}
|PM={{{Project_Management_Days|X}}}
|Client={{{Supimix_Client_Code}}}
|Year={{{Year}}}
|FOC={{{Free_Of_Charge|N}}}
|FIXEDCOST={{{FIXEDCOST}}}
|NOFOOTER={{{NOFOOTER}}}
|DiscountPerc={{{DiscountPerc|0}}}
|DiscountText={{{DiscountText|Discount}}}
|System={{{System}}}
}}

<table width="100%">
<tr><td align="center"><font size="1">
Copyright © Aptean {{{Year}}}.<br />
This estimate has an expiry date of {{{ExpiryDays|30}}} days from the specified Estimate Date.<br />
The information contained herein is supplied without liability for errors or omissions.
</font></td></tr></table>
[[Category:{{{Supimix_Client_Code|TEMPLATE}}} EST]]
{{#ifeq:{{{System|}}}|||
[[Category:{{{System}}}]]
}}
<noinclude>
<templatedata>
{
"params": {
"Client": {
"label": "Client Code",
"aliases": [
"1"
],
"description": "The specific internal code identifying the client.",
"type": "string",
"required": true
},
"Project": {
"label": "Project Code",
"aliases": [
"2"
],
"description": "Internal project code identifier.",
"type": "string"
},
"Site": {
"label": "Site Code",
"aliases": [
"3"
],
"description": "Identifier for the specific client site.",
"type": "string"
},
"ClientRef": {
"label": "Client Reference",
"aliases": [
"4"
],
"description": "The client's own reference string or ID.",
"type": "string"
},
"OBSRef": {
"label": "Salesforce Reference",
"aliases": [
"5"
],
"description": "The Salesforce or internal reference number.",
"type": "string"
},
"Version": {
"label": "Document Version",
"aliases": [
"6"
],
"description": "The current version of this estimate document.",
"example": "0.01",
"type": "string"
},
"Author": {
"label": "Author Name",
"aliases": [
"7"
],
"description": "Name of the person creating the estimate.",
"type": "string",
"suggested": true
},
"PONum": {
"label": "PO Reference",
"aliases": [
"8"
],
"description": "Purchase Order reference, if available.",
"type": "string"
},
"Priority": {
"label": "Priority",
"aliases": [
"9"
],
"description": "Priority level of the estimate/project.",
"type": "string"
},
"Date": {
"label": "Date",
"aliases": [
"10"
],
"description": "Date in DD/MM/YY format.",
"type": "string"
},
"Customer": {
"label": "Client's Customer",
"aliases": [
"11"
],
"description": "The end customer of the client, if applicable.",
"type": "string"
},
"SysVer": {
"label": "System Version",
"aliases": [
"12"
],
"description": "The software version currently being modified.",
"type": "string"
},
"ClientRequest": {
"label": "Request Summary",
"aliases": [
"13"
],
"description": "Brief summary of the initial client request.",
"type": "content"
},
"Solution": {
"label": "Solution Description",
"aliases": [
"14"
],
"description": "The proposed technical solution.",
"type": "content"
},
"REQ": {
"label": "Requirements Effort (Days)",
"aliases": [
"15"
],
"description": "Days allocated for gathering requirements.",
"type": "number",
"default": "0"
},
"EST": {
"label": "Estimation Effort (Days)",
"aliases": [
"16"
],
"description": "Days allocated for the estimation process.",
"type": "number",
"default": "0"
},
"FS": {
"label": "Functional Spec Effort (Days)",
"aliases": [
"17"
],
"description": "Days allocated for creating functional specifications.",
"type": "number",
"default": "0"
},
"TS": {
"label": "Technical Spec Effort (Days)",
"aliases": [
"18"
],
"description": "Days allocated for creating technical specifications.",
"type": "number",
"default": "0"
},
"DEV": {
"label": "Development Effort (Days)",
"aliases": [
"19"
],
"description": "Days allocated for software development.",
"type": "number",
"default": "0"
},
"ST": {
"label": "Testing/Release Effort (Days)",
"aliases": [
"20"
],
"description": "Days allocated for testing and release management.",
"type": "number",
"default": "0"
},
"IMP": {
"label": "Implementation Effort (Days)",
"aliases": [
"21"
],
"description": "Days allocated for site implementation.",
"type": "number",
"default": "0"
},
"PM": {
"label": "Project Management Effort (Days)",
"aliases": [
"22"
],
"description": "Days allocated for project management.",
"type": "number",
"default": "0"
},
"Year": {
"label": "Fiscal Year",
"aliases": [
"23"
],
"description": "The year for financial tracking.",
"example": "2025",
"type": "number"
},
"FOC": {
"label": "FOC Flag",
"aliases": [
"24"
],
"description": "Is this work free of charge? (Y/N)",
"type": "string",
"default": "N"
},
"FIXEDCOST": {
"label": "Fixed Cost Flag",
"aliases": [
"25"
],
"description": "Is this a fixed cost project? (Y/N)",
"type": "string",
"default": "N"
},
"NOFOOTER": {
"label": "Hide Footer",
"aliases": [
"26"
],
"description": "Suppress the document footer? (Y/N)",
"type": "string",
"default": "N"
},
"DiscountPerc": {
"label": "Discount Percentage",
"aliases": [
"27"
],
"description": "Numerical discount percentage to apply.",
"type": "number",
"default": "0"
},
"DiscountText": {
"label": "Discount Reason",
"aliases": [
"28"
],
"description": "Description or reason for the applied discount.",
"type": "string"
},
"System": {
"label": "System/Category",
"aliases": [
"29"
],
"description": "Select the system category for this estimate.",
"type": "string",
"suggestedvalues": [
"CTMS",
"EPOD",
"MCS",
"ASSIST",
"TCM",
"VEhub",
"Vision",
"WCS",
"PORTAL",
"WMS",
"Bay Diary",
"TOC"
],
"required": true
}
},
"description": "Standardized template for generating project estimates, including effort breakdowns, financial flags, and system categories.",
"format": "block"
}
</templatedata>
</noinclude>
<noinclude>
[[Category:Templates]]
</noinclude>

Template:Estimate Template

2026-02-27T14:10:55Z

Anw: Added TemplateData

{{Template:EstimateNew
|Supimix_Client_Code=
|Supimix_Project_Code=
|Supimix_Site_Code=
|Supimix_Client_Reference=
|Supimix_Number=
|The_version_of_the_document=0.01
|Your_Name=Your_Name
|Supimix_PO_Reference=-
|Supimix_Priority=-
|Date_(DD/MM/YY)=
|Clients_Customer=
|System_Version_being_changed=
|Client_Request=
|OBS_Solution=
|Requirements_Days=0
|Estimation_Days=0
|Functional_Specification_Days=0
|Technical_Specification_Days=0
|Development_Days=0
|Testing_and_Release_Days=0
|Implementation_Days=0
|Project_Management_Days=0
|Year=
|Free_Of_Charge=N
|FIXEDCOST=N
|NOFOOTER=N
|DiscountPerc=0
|DiscountText=
|System=
}}
<noinclude>
<templatedata>
{
"params": {
"Supimix_Client_Code": {
"label": "Client Code",
"aliases": [
"1"
],
"description": "The specific internal code identifying the client.",
"type": "string",
"required": true
},
"Supimix_Project_Code": {
"label": "Project Code",
"aliases": [
"2"
],
"description": "Internal project code identifier.",
"type": "string"
},
"Supimix_Site_Code": {
"label": "Site Code",
"aliases": [
"3"
],
"description": "Identifier for the specific client site.",
"type": "string"
},
"Supimix_Client_Reference": {
"label": "Client Reference",
"aliases": [
"4"
],
"description": "The client's own reference string or ID.",
"type": "string"
},
"Supimix_Number": {
"label": "Salesforce Reference",
"aliases": [
"5"
],
"description": "The Salesforce or internal reference number.",
"type": "string"
},
"The_version_of_the_document": {
"label": "Document Version",
"aliases": [
"6"
],
"description": "The current version of this estimate document.",
"example": "0.01",
"type": "string"
},
"Your_Name": {
"label": "Author Name",
"aliases": [
"7"
],
"description": "Name of the person creating the estimate.",
"type": "string",
"suggested": true
},
"Supimix_PO_Reference": {
"label": "PO Reference",
"aliases": [
"8"
],
"description": "Purchase Order reference, if available.",
"type": "string"
},
"Supimix_Priority": {
"label": "Priority",
"aliases": [
"9"
],
"description": "Priority level of the estimate/project.",
"type": "string"
},
"Date_(DD/MM/YY)": {
"label": "Date",
"aliases": [
"10"
],
"description": "Date in DD/MM/YY format.",
"type": "string"
},
"Clients_Customer": {
"label": "Client's Customer",
"aliases": [
"11"
],
"description": "The end customer of the client, if applicable.",
"type": "string"
},
"System_Version_being_changed": {
"label": "System Version",
"aliases": [
"12"
],
"description": "The software version currently being modified.",
"type": "string"
},
"Client_Request": {
"label": "Request Summary",
"aliases": [
"13"
],
"description": "Brief summary of the initial client request.",
"type": "content"
},
"OBS_Solution": {
"label": "Solution Description",
"aliases": [
"14"
],
"description": "The proposed technical solution.",
"type": "content"
},
"Requirements_Days": {
"label": "Requirements Effort (Days)",
"aliases": [
"15"
],
"description": "Days allocated for gathering requirements.",
"type": "number",
"default": "0"
},
"Estimation_Days": {
"label": "Estimation Effort (Days)",
"aliases": [
"16"
],
"description": "Days allocated for the estimation process.",
"type": "number",
"default": "0"
},
"Functional_Specification_Days": {
"label": "Functional Spec Effort (Days)",
"aliases": [
"17"
],
"description": "Days allocated for creating functional specifications.",
"type": "number",
"default": "0"
},
"Technical_Specification_Days": {
"label": "Technical Spec Effort (Days)",
"aliases": [
"18"
],
"description": "Days allocated for creating technical specifications.",
"type": "number",
"default": "0"
},
"Development_Days": {
"label": "Development Effort (Days)",
"aliases": [
"19"
],
"description": "Days allocated for software development.",
"type": "number",
"default": "0"
},
"Testing_and_Release_Days": {
"label": "Testing/Release Effort (Days)",
"aliases": [
"20"
],
"description": "Days allocated for testing and release management.",
"type": "number",
"default": "0"
},
"Implementation_Days": {
"label": "Implementation Effort (Days)",
"aliases": [
"21"
],
"description": "Days allocated for site implementation.",
"type": "number",
"default": "0"
},
"Project_Management_Days": {
"label": "Project Management Effort (Days)",
"aliases": [
"22"
],
"description": "Days allocated for project management.",
"type": "number",
"default": "0"
},
"Year": {
"label": "Fiscal Year",
"aliases": [
"23"
],
"description": "The year for financial tracking.",
"example": "2025",
"type": "number"
},
"Free_Of_Charge": {
"label": "FOC Flag",
"aliases": [
"24"
],
"description": "Is this work free of charge? (Y/N)",
"type": "string",
"default": "N"
},
"FIXEDCOST": {
"label": "Fixed Cost Flag",
"aliases": [
"25"
],
"description": "Is this a fixed cost project? (Y/N)",
"type": "string",
"default": "N"
},
"NOFOOTER": {
"label": "Hide Footer",
"aliases": [
"26"
],
"description": "Suppress the document footer? (Y/N)",
"type": "string",
"default": "N"
},
"DiscountPerc": {
"label": "Discount Percentage",
"aliases": [
"27"
],
"description": "Numerical discount percentage to apply.",
"type": "number",
"default": "0"
},
"DiscountText": {
"label": "Discount Reason",
"aliases": [
"28"
],
"description": "Description or reason for the applied discount.",
"type": "string"
},
"System": {
"label": "System/Category",
"aliases": [
"29"
],
"description": "Select the system category for this estimate.",
"type": "string",
"suggestedvalues": [
"CTMS",
"EPOD",
"MCS",
"ASSIST",
"TCM",
"VEhub",
"Vision",
"WCS",
"PORTAL",
"WMS",
"Bay Diary",
"TOC"
],
"required": true
}
},
"description": "Standardized template for generating project estimates, including effort breakdowns, financial flags, and system categories.",
"format": "block"
}
</templatedata>
</noinclude>

Help:CreateNewPage

2026-02-27T14:00:41Z

Anw: Minor correction

{{Note}} You must be logged in to be able to create new pages in Assist.

When you are, shortcuts to create new pages will appear below here.

<div style="display:none;" class="apt-user-show">

{{Note}} Choose your document titles well - these will be included in the printed/output PDF documents on the top of every page, and therefore should be very descriptive - examples are provided of the standards being followed.

Similarly, the Products chosen when creating the new page should be used from the list below. This is because the Assist system automatically categorises all pages into sub-categories by Product based on your entry. Choosing the right one means that this is automatic and will be most useful to those using the system.
* CTMS
* EPOD
* MCS
* ASSIST
* TCM
* VEhub
* Vision
* WCS
* PORTAL
* WMS
* Bay Diary
* TOC

== New Pages ==
=== Document ===
* UG DevOps System Description Guide e.g. UG 106181 WCS Maintenance Guide
* Area - Description Guide e.g. Orders - Order Guide

<inputbox>
type=create
buttonlabel=Create New Document
preload=DocTemplate
break=yes
placeholder=Enter Document Name e.g.
</inputbox>

=== Page ===
* Name e.g. Planning
* ProgNum e.g. SOS1000, PTV_CONFIG
* Something Guide e.g. Orders Guide
* Screen - Something Tab e.g. Goods Receipt - Details Tab

<inputbox>
type=create
buttonlabel=Create New Page
preload=PageTemplate
break=yes
placeholder=Enter Page Name
</inputbox>
</div>

== Patches/Release Notes ==
Release notes are broadly in different formats, but all release notes will be categorised automatically for you.

A guide to creating ERs is available here: [[Creating an ER]]. Although this is specific to the ER process, the guide is mostly applicable to all other release documents as well.

=== WMS or TMS Patch ===
* CTMS e.g. PATCH C-TMS P091
* WMS e.g. PATCH WMS P091

<inputbox>
type=create
buttonlabel=Create New Patch
preload=Template:TMS_PATCH
break=yes
placeholder=Enter Patch Name
</inputbox>

=== WMS or CTMS Emergency Release ===
* CTMS e.g. ER C-TMS 047-001
* WMS e.g. ER WMS 046-001

<inputbox>
type=create
buttonlabel=Create New ER
preload=Template:ER
break=yes
placeholder=Enter Emergency Release Name
</inputbox>

=== WCS Patch ===
* Generic - UP{DateYYMMDD}_{Client} e.g. UP250709
* Client Specific - UP{DateYYMMDD}_{Client} e.g. UP250709_CER

<inputbox>
type=create
buttonlabel=Create New WCS Patch
preload=Template:WCS_PATCH
break=yes
placeholder=Enter WCS Build Number
</inputbox>

=== EPOD Device/APK Release Note ===
* e.g. Calidus ePOD Android v4.5 APK 4.05.01.20

<inputbox>
type=create
buttonlabel=Create New EPOD APK Release Note
preload=Template:EPOD_RelNote
break=yes
placeholder=Enter EPOD APK Relnote
</inputbox>

=== EPOD Admin/Server Release Note ===
* e.g. Calidus ePOD Server 4.5.1.12

<inputbox>
type=create
buttonlabel=Create New EPOD Admin/Server Release Note
preload=Template:EPOD_Admin_RelNote
break=yes
placeholder=Enter EPOD Admin/Server Relnote
</inputbox>

=== Portal Release Note ===
* REL Sys Version Client-Optional
* e.g. REL Portal 2.03.01
* e.g. REL Portal 11.03.01 CTY

<inputbox>
type=create
buttonlabel=Create New Portal Release Note
preload=Template:Portal_RelNote
break=yes
placeholder=Enter Relnote
</inputbox>

=== General Release Note ===
* REL Sys Version Client-Optional
* e.g. REL MCS 2.03.01
* e.g. REL Portal 11.03.01 CTY

<inputbox>
type=create
buttonlabel=Create New General Release Note
preload=Template:General_RelNote
break=yes
placeholder=Enter Relnote
</inputbox>

== Specific Document Types ==
=== Functional Specification ===
* FS 123456 Client - DocName

<inputbox>
type=create
buttonlabel=Create New FS
preload=Template:FS
break=yes
placeholder=Enter FS title
</inputbox>

=== Estimate ===
* EST 123456 (ClientRef) Client - DocName

<inputbox>
type=create
buttonlabel=Create New EST
preload=Template:Estimate_Template
break=yes
placeholder=Enter EST title
</inputbox>

=== Solution Design ===
* SDD 123456 Client Solution Design

<inputbox>
type=create
buttonlabel=Create New SDD
preload=Template:REQ
break=yes
placeholder=Enter SDD name
</inputbox>

=== Small Change Request ===
* SCR 123456 - DocName

<inputbox>
type=create
buttonlabel=Create New SCR
preload=SmallCRTemplate
break=yes
placeholder=Enter Small CR name
</inputbox>

== Category Utility Pages==
These are used when creating a title page and appendix page to group loads of categorised pages into a single combined book.

=== Document Title Page ===
* {DocName} Title e.g. similar to the Document titles above
** UG DevOps System Description Guide e.g. UG 106181 WCS Maintenance Guide Title
** Area - Description Guide e.g. Orders - Order Guide Title

<inputbox>
type=create
buttonlabel=Create New Doc Title
preload=Template:Doc_Title
break=yes
placeholder=Enter Doc Title Page Name
</inputbox>

=== Document Appendix Page ===
* {DocName} Appendix e.g. similar to the Document titles above
** UG DevOps System Description Guide e.g. UG 106181 WCS Maintenance Guide Appendix
** Area - Description Guide e.g. Orders - Order Guide Appendix

<inputbox>
type=create
buttonlabel=Create New Doc Appendix
preload=Template:Doc_Appendix
break=yes
placeholder=Enter Doc Appendix Page Name
</inputbox>

</div>
[[Category:ASSIST]]

SmallCRTemplate

2026-02-27T13:58:35Z

Anw: Minor correction

{{SmallCR
|Client=
|LogNumber=
|Date=
|Requester=
|YourName=
|System=
|Request=
|Reason=
|Alternatives=
|Changes=
|Risks=
|NO_COST=N
|EST=
|DEV=
|TEST=
|Implications=
|Status=
|Justification=
}}

SmallCRTemplate

2026-02-27T13:55:38Z

Anw: Minor formatting change

{{SmallCR
|Client=
|LogNumber=
|Date=
|Requester=
|YourName=
|System=
|Request=
|Reason=
|Alternatives=
|Changes=
|Risks=
|NO_COST=
|EST=
|DEV=
|TEST=
|Implications=
|Status=
|Justification=
}}

Template:SmallCR

2026-02-27T13:54:37Z

Anw: Added TemplateData

<table border="1" width="100%" cellspacing="0">
<tr>
<td colspan="2">
'''Small Change Request (Analysis)'''
</td>
</tr>
<tr>
<td width="63%">
Project/Log Number: {{{Client}}} / {{{LogNumber}}}
</td>
<td width="37%">
Date: {{{Date}}}
</td>
</tr>
<tr>
<td width="63%">
Requested By: {{{Requester}}}
</td>
<td width="37%">
Prepared By: {{{YourName}}}
</td>
</tr>
</table>
<br />
<table border="1" width="100%" cellspacing="0">
<tr>
<td>
'''Change Category (SCE_WMS, CTMS, EPOD, PORTAL, etc):'''<br />{{{System}}}<br /> 
</td>
</tr>
<tr>
<td>
'''Describe the Change Being Requested:'''<br />{{{Request}}}<br /> 
</td>
</tr>
<tr>
<td>
'''Describe the Reason for the Change (new requirement, s/w fix, problem management etc):'''<br />{{{Reason}}}<br /> 
</td>
</tr>
<tr>
<td>
'''Describe all Alternatives Considered:'''<br />{{{Alternatives}}}<br /> 
</td>
</tr>
<tr>
<td>
'''List Program and Change Summary Required to Implement this Change:'''<br />{{{Changes}}}<br /> 
</td>
</tr>
<tr>
<td>
'''Describe Risks to be Considered for this Change:'''<br />{{{Risks}}}<br /> 
</td>
</tr>
{{#ifeq:{{{NO_COST|N}}}|N|<tr>
<td>
'''Estimate Dev/Test Effort (in days) Needed to Implement this Change:'''
<table><tr>
<td>SCR Analysis: </td><td>{{{EST}}}</td>
</tr><tr>
<td>DEV: </td><td>{{{DEV}}}</td>
</tr><tr>
<td>TEST: </td><td>{{{TEST}}}</td>
</tr></table><br />
</td>
</tr>|}}
<tr>
<td>
'''Describe the Implications to other Customers:'''<br />{{{Implications}}}<br /> 
</td>
</tr>
<tr>
<td>
'''Requestor Sign off:'''<br />
<table><tr>
<td><table border="1" cellpadding="0" cellspacing="0"><td>  {{#ifeq:{{{Status|}}}|A|X| }}  </td></table></td><td>Approve</td>
<td><table border="1" cellpadding="0" cellspacing="0"><td>  {{#ifeq:{{{Status|}}}|R|X| }}  </td></table></td><td>Reject</td>
<td><table border="1" cellpadding="0" cellspacing="0"><td>  {{#ifeq:{{{Status|}}}|D|X| }}  </td></table></td><td>Defer</td>
</tr></table><br />
</td>
</tr>
<tr>
<td>
'''Justification of Approval, Rejection, or Deferral:'''<br />{{{Justification}}}<br /> 
</td>
</tr>
</table>
<includeonly>
[[Category:{{{Client|TEMPLATE}}} SCR]]
[[Category:{{{System}}}]]
</includeonly>
<noinclude>
== Usage ==
=== Method 1 ===
* Use the following page/section. [[Help:CreateNewPage#Create_Small_Change_Request]]
* Click '''Create''' - you will be taken to your new page.
* Enter the fields
** ''Title'' should follow the conventions "SCR {Log} {Description}"
** Always enter the client code and system.

=== Method 2 ===
Create a new page and use the template as below.

<nowiki>{{</nowiki>SmallCR

|Client=The Supimix client code.

|LogNumber=The Supimix log number

|Date=The current date, in DD/MM/YYYY format

|Requester=The requester's name

|YourName=Your Name

|System=Change Category (SCE_WMS, CTMS, EPOD, Portal, etc)

|Request=Describe the Change Being Requested

|Reason=Describe the Reason for the Change (new requirement, s/w fix, problem management etc)

|Alternatives=Describe all Alternatives Considered

|Changes=List Program and Change Summary Required to Implement this Change

|Risks=Describe Risks to be Considered for this Change

|NO_COST=Include the cost section below (Y/N)

|EST=Estimate effort (in days) needed to implement this change

|DEV=Development effort (in days) needed to implement this change

|TEST=Testing effort (in days) needed to implement this change

|Implications=Describe the Implications to other Customers

|Status=The status, one of A (Approve), R (Reject) or D (Defer). Initially leave blank.

|Justification=Justification of Approval, Rejection, or Deferral

<nowiki>}}</nowiki>

[[Category:Templates|{{PAGENAME}}]]
<templatedata>
{
"params": {
"Client": {
"label": "Client Code",
"aliases": [
"1"
],
"description": "The specific code identifying the client.",
"type": "string",
"required": true
},
"LogNumber": {
"label": "Log/Call Number",
"aliases": [
"2"
],
"description": "The log, call, or DevOps reference number.",
"type": "string",
"required": true
},
"Date": {
"label": "Date",
"aliases": [
"3"
],
"description": "The current date in DD/MM/YYYY format.",
"type": "date",
"suggested": true
},
"Requester": {
"label": "Requester Name",
"aliases": [
"4"
],
"description": "The name of the person requesting the change.",
"type": "string",
"required": true
},
"YourName": {
"label": "Your Name",
"aliases": [
"5"
],
"description": "The name of the person completing this form.",
"type": "string",
"required": true
},
"System": {
"label": "System/Category",
"aliases": [
"6"
],
"description": "Change Category (e.g., SCE_WMS, CTMS, EPOD, Portal).",
"type": "string",
"required": true,
"suggestedvalues": [
"CTMS",
"EPOD",
"MCS",
"ASSIST",
"TCM",
"VEhub",
"Vision",
"WCS",
"PORTAL",
"WMS",
"Bay Diary",
"TOC"
]
},
"Request": {
"label": "Request Description",
"aliases": [
"7"
],
"description": "A description of the change being requested.",
"type": "content",
"required": true
},
"Reason": {
"label": "Reason for Change",
"aliases": [
"8"
],
"description": "The business or technical reason for the change.",
"type": "content",
"required": true
},
"Alternatives": {
"label": "Alternatives Considered",
"aliases": [
"9"
],
"description": "Description of all alternatives considered.",
"type": "content"
},
"Changes": {
"label": "Change Summary",
"aliases": [
"10"
],
"description": "List Program and Change Summary Required.",
"type": "content",
"required": true
},
"Risks": {
"label": "Risks",
"aliases": [
"11"
],
"description": "Describe Risks to be Considered for this Change.",
"type": "content",
"required": true
},
"NO_COST": {
"label": "Exclude Cost Section",
"aliases": [
"12"
],
"description": "Include the cost section below (Y/N).",
"type": "string",
"suggestedvalues": [
"Y",
"N"
],
"default": "N",
"required": true
},
"EST": {
"label": "Estimate Effort",
"aliases": [
"13"
],
"description": "Estimate effort (in days) needed.",
"type": "number"
},
"DEV": {
"label": "Development Effort",
"aliases": [
"14"
],
"description": "Development effort (in days) needed.",
"type": "number"
},
"TEST": {
"label": "Testing Effort",
"aliases": [
"15"
],
"description": "Testing effort (in days) needed.",
"type": "number"
},
"Implications": {
"label": "Implications",
"aliases": [
"16"
],
"description": "Describe the Implications to other Customers.",
"type": "content",
"required": true
},
"Status": {
"label": "Status",
"aliases": [
"17"
],
"description": "A (Approve), R (Reject) or D (Defer).",
"type": "string",
"suggestedvalues": [
" ",
"A",
"R",
"D"
]
},
"Justification": {
"label": "Justification",
"aliases": [
"18"
],
"description": "Justification of Approval, Rejection, or Deferral.",
"type": "content"
}
},
"description": "Small Change Request (CR) template with support for both named and numbered parameters.",
"format": "block"
}</templatedata></noinclude>

Template:SmallCR

2026-02-27T13:52:53Z

Anw: Added TemplateData

<table border="1" width="100%" cellspacing="0">
<tr>
<td colspan="2">
'''Small Change Request (Analysis)'''
</td>
</tr>
<tr>
<td width="63%">
Project/Log Number: {{{Client}}} / {{{LogNumber}}}
</td>
<td width="37%">
Date: {{{Date}}}
</td>
</tr>
<tr>
<td width="63%">
Requested By: {{{Requester}}}
</td>
<td width="37%">
Prepared By: {{{YourName}}}
</td>
</tr>
</table>
<br />
<table border="1" width="100%" cellspacing="0">
<tr>
<td>
'''Change Category (SCE_WMS, CTMS, EPOD, PORTAL, etc):'''<br />{{{System}}}<br /> 
</td>
</tr>
<tr>
<td>
'''Describe the Change Being Requested:'''<br />{{{Request}}}<br /> 
</td>
</tr>
<tr>
<td>
'''Describe the Reason for the Change (new requirement, s/w fix, problem management etc):'''<br />{{{Reason}}}<br /> 
</td>
</tr>
<tr>
<td>
'''Describe all Alternatives Considered:'''<br />{{{Alternatives}}}<br /> 
</td>
</tr>
<tr>
<td>
'''List Program and Change Summary Required to Implement this Change:'''<br />{{{Changes}}}<br /> 
</td>
</tr>
<tr>
<td>
'''Describe Risks to be Considered for this Change:'''<br />{{{Risks}}}<br /> 
</td>
</tr>
{{#ifeq:{{{NO_COST|N}}}|N|<tr>
<td>
'''Estimate Dev/Test Effort (in days) Needed to Implement this Change:'''
<table><tr>
<td>SCR Analysis: </td><td>{{{EST}}}</td>
</tr><tr>
<td>DEV: </td><td>{{{DEV}}}</td>
</tr><tr>
<td>TEST: </td><td>{{{TEST}}}</td>
</tr></table><br />
</td>
</tr>|}}
<tr>
<td>
'''Describe the Implications to other Customers:'''<br />{{{Implications}}}<br /> 
</td>
</tr>
<tr>
<td>
'''Requestor Sign off:'''<br />
<table><tr>
<td><table border="1" cellpadding="0" cellspacing="0"><td>  {{#ifeq:{{{Status|}}}|A|X| }}  </td></table></td><td>Approve</td>
<td><table border="1" cellpadding="0" cellspacing="0"><td>  {{#ifeq:{{{Status|}}}|R|X| }}  </td></table></td><td>Reject</td>
<td><table border="1" cellpadding="0" cellspacing="0"><td>  {{#ifeq:{{{Status|}}}|D|X| }}  </td></table></td><td>Defer</td>
</tr></table><br />
</td>
</tr>
<tr>
<td>
'''Justification of Approval, Rejection, or Deferral:'''<br />{{{Justification}}}<br /> 
</td>
</tr>
</table>
<includeonly>
[[Category:{{{Client|TEMPLATE}}} SCR]]
[[Category:{{{System}}}]]
</includeonly>
<noinclude>
== Usage ==
=== Method 1 ===
* Use the following page/section. [[Help:CreateNewPage#Create_Small_Change_Request]]
* Click '''Create''' - you will be taken to your new page.
* Enter the fields
** ''Title'' should follow the conventions "SCR {Log} {Description}"
** Always enter the client code and system.

=== Method 2 ===
Create a new page and use the template as below.

<nowiki>{{</nowiki>SmallCR

|Client=The Supimix client code.

|LogNumber=The Supimix log number

|Date=The current date, in DD/MM/YYYY format

|Requester=The requester's name

|YourName=Your Name

|System=Change Category (SCE_WMS, CTMS, EPOD, Portal, etc)

|Request=Describe the Change Being Requested

|Reason=Describe the Reason for the Change (new requirement, s/w fix, problem management etc)

|Alternatives=Describe all Alternatives Considered

|Changes=List Program and Change Summary Required to Implement this Change

|Risks=Describe Risks to be Considered for this Change

|NO_COST=Include the cost section below (Y/N)

|EST=Estimate effort (in days) needed to implement this change

|DEV=Development effort (in days) needed to implement this change

|TEST=Testing effort (in days) needed to implement this change

|Implications=Describe the Implications to other Customers

|Status=The status, one of A (Approve), R (Reject) or D (Defer). Initially leave blank.

|Justification=Justification of Approval, Rejection, or Deferral

<nowiki>}}</nowiki>

[[Category:Templates|{{PAGENAME}}]]
<templatedata>
{
"params": {
"Client": {
"label": "Client Code",
"aliases": [
"1"
],
"description": "The specific code identifying the client.",
"type": "string",
"required": true
},
"LogNumber": {
"label": "Log/Call Number",
"aliases": [
"2"
],
"description": "The log, call, or DevOps reference number.",
"type": "string",
"required": true
},
"Date": {
"label": "Date",
"aliases": [
"3"
],
"description": "The current date in DD/MM/YYYY format.",
"type": "date",
"suggested": true
},
"Requester": {
"label": "Requester Name",
"aliases": [
"4"
],
"description": "The name of the person requesting the change.",
"type": "string",
"required": true
},
"YourName": {
"label": "Your Name",
"aliases": [
"5"
],
"description": "The name of the person completing this form.",
"type": "string",
"required": true
},
"System": {
"label": "System/Category",
"aliases": [
"6"
],
"description": "Change Category (e.g., SCE_WMS, CTMS, EPOD, Portal).",
"type": "string",
"required": true,
"suggestedvalues": [
"CTMS",
"EPOD",
"MCS",
"ASSIST",
"TCM",
"VEhub",
"Vision",
"WCS",
"PORTAL",
"WMS",
"Bay Diary",
"TOC"
]
},
"Request": {
"label": "Request Description",
"aliases": [
"7"
],
"description": "A description of the change being requested.",
"type": "content",
"required": true
},
"Reason": {
"label": "Reason for Change",
"aliases": [
"8"
],
"description": "The business or technical reason for the change.",
"type": "content",
"required": true
},
"Alternatives": {
"label": "Alternatives Considered",
"aliases": [
"9"
],
"description": "Description of all alternatives considered.",
"type": "content"
},
"Changes": {
"label": "Change Summary",
"aliases": [
"10"
],
"description": "List Program and Change Summary Required.",
"type": "content",
"required": true
},
"Risks": {
"label": "Risks",
"aliases": [
"11"
],
"description": "Describe Risks to be Considered for this Change.",
"type": "content",
"required": true
},
"NO_COST": {
"label": "Exclude Cost Section",
"aliases": [
"12"
],
"description": "Include the cost section below (Y/N).",
"type": "string",
"suggestedvalues": [
"Y",
"N"
],
"default": "N",
"required": true
},
"EST": {
"label": "Estimate Effort",
"aliases": [
"13"
],
"description": "Estimate effort (in days) needed.",
"type": "number"
},
"DEV": {
"label": "Development Effort",
"aliases": [
"14"
],
"description": "Development effort (in days) needed.",
"type": "number"
},
"TEST": {
"label": "Testing Effort",
"aliases": [
"15"
],
"description": "Testing effort (in days) needed.",
"type": "number"
},
"Implications": {
"label": "Implications",
"aliases": [
"16"
],
"description": "Describe the Implications to other Customers.",
"type": "content",
"required": true
},
"Status": {
"label": "Status",
"aliases": [
"17"
],
"description": "A (Approve), R (Reject) or D (Defer).",
"type": "string"
},
"Justification": {
"label": "Justification",
"aliases": [
"18"
],
"description": "Justification of Approval, Rejection, or Deferral.",
"type": "content"
}
},
"description": "Small Change Request (CR) template with support for both named and numbered parameters.",
"format": "block"
}</templatedata></noinclude>

SmallCRTemplate

2026-02-27T13:36:22Z

Anw: Initial Creation

{{SmallCR
|Client=The client code.
|LogNumber=The log/call/DevOps number
|Date=The current date, in DD/MM/YYYY format
|Requester=The requester's name
|YourName=Your Name
|System=Change Category (SCE_WMS, CTMS, EPOD, Portal, etc)
|Request=Describe the Change Being Requested
|Reason=Describe the Reason for the Change (new requirement, s/w fix, problem management etc)
|Alternatives=Describe all Alternatives Considered
|Changes=List Program and Change Summary Required to Implement this Change
|Risks=Describe Risks to be Considered for this Change
|NO_COST=Include the cost section below (Y/N)
|EST=Estimate effort (in days) needed to implement this change
|DEV=Development effort (in days) needed to implement this change
|TEST=Testing effort (in days) needed to implement this change
|Implications=Describe the Implications to other Customers
|Status=The status, one of A (Approve), R (Reject) or D (Defer). Initially leave blank.
|Justification=Justification of Approval, Rejection, or Deferral
}}

Template:REQ

2026-02-27T13:27:34Z

Anw: Minor formatting change

<div class="noprint">
{{#vardefine:Client|The Supimix Client Code}}
{{#vardefine:ClientName|The Client Name}}
{{#vardefine:System|''CALIDUS'' Mobile/WMS/TMS/ePOD}}
{{#vardefine:SystemCode|WCS/WMS/TMS/EPOD/MCS/Portal}}
{{#vardefine:Doc_Title|Description}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|16th June 2011}}
{{#vardefine:Reference|Supimix References}}
{{#vardefine:Year|Year}}
</div>
{{Doc_Title
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=REQ {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
}}


= Introduction =

This document is the {{#var:Doc_Title}}.

== Objective ==
The primary purpose of this document is to document the requirements gathered from {{#var:ClientName}}, at X, Y, Z



This document has been written in a manner such that it can be approved by non-technical representatives of {{#var:ClientName}} whilst also being of sufficient detail to allow the Functional or Technical Specification phase for this area to begin.

== Scope and Limitations ==
This document is based on the documentation provided by {{#var:ClientName}}, as referred to in the appendices, as well as information gleaned from site visits and workshops with {{#var:ClientName}}.


*The changes will be made in the latest version of the {{#var:System}} system.

{{ #vardefine: SCR | 0 }}


= Client Requirements =
Listed below are the proposed processes that will be followed by the operatives using {{#var:System}}. Also shown are the SCRs required for this to be achieved.

<The current operational process flow has been described in documents produced by X of Y.>



== Operational Information ==


== Standard Processing ==
=== Process 1 ===


== Functional Area 1 ==


== Functional Area 2 ==



= Appendix A: Table of SCRs and Ballpark Estimates =


{{ #vardefine: SCR | 0 }}
{{REQ_SCR_Header}}
{{REQ_SCR_Line
|SCR={{ #vardefineecho: SCR | {{ #expr: {{ #var: SCR }} + 1 }} }}
|System=System Affected
|Area=Area Affected
|Description=Description of change
|Estimate=Cost
|Notes=Any notes, numerically listed
}}
{{REQ_SCR_Footer}}

Notes:
#Any high level ballpark estimates for development are based on the basic information provided and are subject to detailed design and creation of an SCR.
#<Further notes, referenced in the notes column of the grid above>


{{Doc_Appendix
|Appendix=B
|Estimate=N
|Glossary=WCS
|Ref1=Reference1
|RefV1=0.1
|RefDate1=01/01/2011
|REQ=0
|EST=0
|FS=0
|TS=0
|DEV=0
|ST=0
|IMP=0
|Client=
|Year=
|FSEST=Y
|Rev1=Rev1
|Rev1Title=Rev1 Title
}}
[[Category:{{#var:Client}} REQ]]
[[Category:{{#var:SystemCode}}]]

Template:FS

2026-02-27T13:26:40Z

Anw: Minor formatting change

<div class="noprint">
{{#vardefine:Client|The Supimix Client Code}}
{{#vardefine:ClientName|The Client Name}}
{{#vardefine:System|''CALIDUS'' Mobile/TTM/Vision/ePOD, etc}}
{{#vardefine:SystemCode|WCS/Portal/TTM/Vision/EPOD/MCS}}
{{#vardefine:Doc_Title|Document Title}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|14th May 2020}}
{{#vardefine:Reference|Supimix Ref and Client Ref}}
{{#vardefine:Year|2019}}
{{#vardefine:Type|FS}}
{{ #vardefine: Figure | 0 }}{{ #vardefine: Example | 0 }}

</div>
{{Doc_TitleNew
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference={{#var:Type|FS}} {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
|Type={{#var:Type}}
}}


= FUNCTIONAL OVERVIEW =
== Client Requirement ==


== Solution Overview ==


== Scope ==


== Impact ==



= CONFIGURATION SET-UP =
== Pre-requisites ==


== Menu Structure ==


== Data ==


== Implementation Advice ==



= FUNCTIONAL DESCRIPTION =
== Heading ==
=== Sub Heading ===



= TECHNICAL NOTES =
== Modules Changed ==

{| class="wikitable" border="1" width="100%"
|-bgcolor="#FFFF99"
! width="20%" | Module Name || width="40%" | Module Type || width="40%" | Notes
|-
| 1 || 2 || 3
|}

== Table Updates ==

{| class="wikitable" border="1" width="100%"
|-bgcolor="#FFFF99"
! width="20%" | Name || width="10%" | Type || width="10%" | Nullable || width="10%" | Default || width="10%" | Storage || width="40%" | Comments
|-
| 1 || 2 || 3 || 4 || 5 || 6
|}

== Developer Notes ==



= TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=description of what is to be achieved
|MenuAccess=Where on the menus the item can be found
|Prerequisites=The prerequisites of the test
|Objective=The details of what each group of tests is to achieve
}}
{{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Area being tested in this cycle
|Notes=Any notes or prerequisites for the tests following.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=The actions to follow
|Result=The expected result
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=The actions to follow
|Result=The expected result
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=The actions to follow
|Result=The expected result
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_AppendixNew
|Appendix=A
|Estimate=Y
|Glossary=EPOD2
|Ref1=Reference1
|RefV1=0.1
|RefDate1=26/02/2019
|REQ=0
|EST=0
|FS=0
|TS=0
|DEV=0
|ST=0
|IMP=0
|PM=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Rev1
|Rev1Title=OBS Project Manager
|Rev2=Rev2
|Rev2Title=Customer Representative
}}
[[Category:{{#var:Client}} {{#var:Type|FS}}]]
[[Category:{{#var:SystemCode}}]]

Template:TMS PATCH

2026-02-27T13:25:52Z

Anw: Minor formatting change

<div class="noprint">
{{#vardefine:Client|Aptean}}
{{#vardefine:System|''CALIDUS'' WMS}}
{{#vardefine:Doc_Title|Release Notes}}
{{#vardefine:Version|1.0}}
{{#vardefine:Date|8th May 2021}}
{{#vardefine:Reference|Patch without the P e.g. 091}}
{{#vardefine:Year|2021}}
</div>
{{Doc_Title
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=P{{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
}}


= SUMMARY INTRODUCTION =
== INTRODUCTION ==
The main aim of this document is to provide {{#var:System}} users with the level of detail required to accurately test all software included in the patch. The document also contains set-up and configuration details to enable the user to configure the system correctly for the new functionality to work.

=== GLOSSARY OF TERMS ===

{| border="1"
|- bgcolor="silver"
!Term !! Meaning
|-
|C-TMS || Transport Management System
|-
|C-WMS || Warehouse Management System
|-
|CR || Change Request
|-
|C-WCS || Warehouse Control System
|-
|C-ePOD || Electronic Proof of Delivery
|-
|C-MCS || Mobile Control System
|-
|C-TTM || Track and Trace Management
|-
|EDI || Electronic Data Interchange
|-
|TID || Testing Issue Development, or Log
|}


== TESTING PROCESS ==

===TIDs AND RESOLUTION===
If there are any areas of the functionality that are not acceptable or do not meet the requirement specified in the Change Request then these should be expressed by raising a TID.

=== FINAL 'END TO END' TESTING ===
Prior to release to a production database, a full 'End to End' test is required on the test system by all sites using the database. Once this is signed off, a release date can be arranged.

=== AUTHORISATION ===
Authorisation from nominated release personnel only will be required when requesting a release to a production environment

= CHANGE REQUESTS =

== Customer Ref: ==
{| width="100%"
|-
|width="30%"|'''OBS Log Number:''' || '''Reporter:'''
|-
|'''Summary of Call'''||
|-
|'''Detail of Fix''' ||
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Customer Ref: ==
{| width="100%"
|-
|width="30%"|'''OBS Log Number:''' || '''Reporter:'''
|-
|'''Summary of Call'''||
|-
|'''Detail of Fix''' ||
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

= SUPPORT INCIDENTS =

== Customer Ref: ==
{| width="100%"
|-
|width="30%"|'''OBS Log Number:''' || '''Reporter:'''
|-
|'''Summary of Call'''||
|-
|'''Detail of Fix''' ||
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

= TID CHANGES =

== OBS Log Number: ==
{| width="100%"
|-
|width="30%"|'''Cust Ref:''' || '''Reporter:'''
|-
|'''Summary of Call'''||
|-
|'''Detail of Fix''' ||
|-
|'''Set-up and Configuration''' ||
|}

= PRODUCT DEVELOPMENT =

== OBS Log Number: ==
{| width="100%"
|-
|width="30%"| '''Reporter:''' ||
|-
|'''Summary of Call'''||
|-
|'''Detail of Fix''' ||
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

= MODULES DELIVERED =

{| border="1" width="100%"
|- bgcolor="silver"
!Module Name !! Version No !! Description !! Log Number
|-
| || || ||
|}

= ADDITIONAL CHANGES =
== WCS ==

A WCS change is required for the following logs:
* Log
OR

There are no WCS changes required.

== EPOD/T2A ==

An ePOD/T2A change is required for the following logs:
* Log
OR

There are no ePOD/T2A changes required.

== MCS ==

An MCS change is required for the following logs:
* Log
OR

There are no MCS changes required.

== PORTAL/TTM ==

A Portal change is required for the following logs:
* Log
OR

There are no Portal changes required.

== EDI ==

An EDI change is required for the following logs:
* Log
OR

There are no EDI changes required.

[[Category:{{#var:Client}} PATCH]]

UG 352360 CALIDUS Assist User Guide

2026-02-27T13:22:01Z

Anw: Minor formatting change

<div class="noprint">
{{#vardefine:Client|PROD}}
{{#vardefine:ClientName|Aptean}}
{{#vardefine:System|''CALIDUS'' Assist}}
{{#vardefine:SystemCode|ASSIST}}
{{#vardefine:Doc_Title|C-Assist User Guide}}
{{#vardefine:Version|1.01}}
{{#vardefine:Date|20th February 2026}}
{{#vardefine:Reference|352360}}
{{#vardefine:Year|2026}}
</div>
{{Doc_Title
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=UG {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
}}

{{NewPage}}
= Creating articles for inclusion in a PDF Book =
{{Help:PDF_Book}}

{{NewPage}}
= Creating new documents from templates =
You can create new documents using the links on the following page:
* [[Help:CreateNewPage|Create New Page]]

{{NewPage}}
= Creating a new Wiki installation =
{{Help:CreateNewWiki}}

{{NewPage}}
= Upgrading the version of an existing Wiki installation =
{{Help:UpgradeWiki}}

{{NewPage}}
= Editing a document =
{{Help:EditOBS}}

{{NewPage}}
= Support Tools =
{{:Assist Support Guide}}

=Appendix A: Document History=
<p><font size="4">'''A.1 References'''</font></p>

{| class="wikitable" border="1" width="100%"
|-
! Ref No !!Document Title & ID !! Version !! Date
|-
| 1 ||   ||   ||  
|-
| 2 ||   ||   ||  
|-
| 3 ||   ||   ||  
|}

<p><font size="4">'''A.2 Document History'''</font></p>
{| class="wikitable" border="1" width="100%"
|-
! Version !! Date !! Status !! Reason !! By
|-
| 0.1 || 25/02/2020 || Issue || Initial Version || ANW
|-
| 1.0 || 13/03/2020 || Issue || Issue || ANW
|-
| 1.01 || 20/02/2026 || Issue || Re-issue with updated support guide || ANW
|}

<p><font size="4">'''A.3 Authorised By'''</font></p>
<table width="100%" border="0">
<tr><td><br />Matt Tipping</td><td><br />Aptean Manager</td><td>_____________________________</td></tr>
<tr><td><br />Tony Walker</td><td><br />Aptean Principal Consultant</td><td>_____________________________</td></tr>
</table>
[[Category:{{#var:Client}} UG]]
[[Category:{{#var:SystemCode}}]]

Assist Support Guide

2026-02-27T12:17:07Z

Anw: /* Common Maintenance Actions */ Added patrolling edits

The intention of this guide is to provide support information, and a general knowledge base and tips for the ongoing maintenance of Assist implementations.

== Requirements ==
MySQL WorkBench

Access to the Assist server.

== Hosted Systems ==
All hosted systems are documented in SharePoint, along with users and passwords.

You must have access to the SharePoint to read this document.

https://apteanonline.sharepoint.com/teams/CALIDUS-CONNECTIONS/Shared%20Documents/Forms/AllItems.aspx?id=%2Fteams%2FCALIDUS%2DCONNECTIONS%2FShared%20Documents%2FCalidus%20Assist&viewid=fffc6c78%2D04de%2D4e7d%2Db3ec%2D62168ff125fb

== Updating Data En Mass==
By default, MySQL will not allow updating of data without explicit WHERE or LIMIT clauses. To enable this:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Safe Updates"
* Restart MySQL WorkBench.
{{Warning}} You will then be able to (for example) delete all data inadvertently, so enable this option with care.

== Viewing BLOB fields ==
By default, MySQL WorkBench displays all text fields as "BLOB", which you must then right-click and choose "Open Value in Editor". To enable viewing the text directly in the results, do the following:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Treat BINARY/VARBINARY as nonbinary character string"
* Restart MySQL WorkBench.
{{Note}} Enabling this option comes with a performance hit - some text fields contain the entire page data, so enable this with care.

== Recovering passwords from MYSQL Workbench ==
First go check where your encrypted file is. Usually it is stored at %AppData%\MySQL\Workbench\workbench_user_data.dat

If different, amend the commands below.

Use Powershell

<pre>
Add-Type -AssemblyName System.Security
$cipher = Get-Content $env:APPDATA\MySQL\Workbench\workbench_user_data.dat -Encoding Byte -Raw
$scope = [System.Security.Cryptography.DataProtectionScope]::CurrentUser
$mysqlpwd = [System.Security.Cryptography.ProtectedData]::Unprotect( $cipher, $null, $scope )
[System.Text.UTF8Encoding]::UTF8.GetString($mysqlpwd)
</pre>

== Common Queries ==
<pre>
-- Assist SQL aimed at helping with queries

-- Find the page ID
SELECT * FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%';

-- Find all revisions (to change comments)
SELECT * FROM obs_assist.obs_revision
where rev_page IN
(SELECT page_id FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%'
);

-- Find unpatrolled pages to set them patrolled
SELECT *
FROM obs_assist.obs_recentchanges
where rc_patrolled = 0;

UPDATE obs_assist.obs_recentchanges
SET rc_patrolled = 1
where rc_user_text = 'StylesC'

-- Check the logs for details of PDF production
SELECT * FROM mts_assist.oh_logging
where log_action ='PdfBook'
-- order by log_id desc

-- For v1.34 and later, comments have changed:
SELECT log.*, CONVERT(comment.comment_text USING utf8) comment
FROM epod_assist.epodlogging log
left join epod_assist.epodcomment comment
on comment.comment_id = log.log_comment_id
where log_action ='PdfBook'
--ORDER BY log_id DESC
--LIMIT 20
</pre>

== Assist Database Backup ==
Backup each database separately.

Use MySQL Administrator Data Export option.

Always check boxes as follows:
* Dump Stored Procedures and Functions
* Dump Events
* Dump Triggers
* Export to Self-contained File
** Name with the name of the Assist on the start of the dump.
* Include Create Schema

Advanced Options button
* Comments
* Create-options
* quote-names
* lock-tables
* dump-date
* disable-keys
* tz-utc
* add-locks
* extended-insert

Start Export

== Assist Database Restore ==
If required, drop the database from MySQL Administrator:
* On Schema explorer, right click on schema and select Drop Schema.

Use MySQL Administrator Data Import/Restore option.
* Import from self-contained file
* Select the database backup dump
* Click Start Import
* Refresh the schema explorer when done - the database should be present.

Restore database users, passwords and permissions when complete.

Will need to create the assist owner with username and password from LocalSettings.php
* From MySQL Admin Management Explorer
* Users and Privileges
* Add Account
** Login Name and Password - as per LocalSettings.php
* Administrative Roles tab - check DBA, which checks everything
* Schema Privileges - add entry
** Selected Schema
** Check everything (click Select 'ALL' button)
* Click Apply

Normal Assist users will need to be reset either by the users through 2FA, or through [[#Resetting User Passwords]].

== Upgrading a Wiki from 1.16 Upwards ==
The following is a checklist of actions.

{SYSTEM}
* Extracted - INCOMPLETE
* DB Import - INCOMPLETE
* DB User - INCOMPLETE
** {SYSTEM}_owner/{PASSWORD}
* Version 1.31.6 - INCOMPLETE
** Move old extensions to old folder - INCOMPLETE
** Recreate LocalSettings.php
** Update password sender and emergency contact
* Version 1.34.4 - INCOMPLETE
** Leave LocalSettings.php
** May need to remove some extensions like numberformat and variables
* Version 1.39.8 - INCOMPLETE
** Leave LocalSettings.php
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - INCOMPLETE
** admin/Liverpool123
** anw/Liverpool123
* Problems
** NONE

== Creating a Brand New Wiki ==
The following is a checklist of actions.
* Copy version 1.39.8 to a WIKI name - INCOMPLETE
** Create LocalSettings.php
** xxx_owner with appropriate password
** Note the password!
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - ensure that there is at least an Admin user with full user rights. Note the password:
** Log in as administrative user
** Special:Create Account
** Create admin account - note the password.
** Special:User Rights
** Check Administrator, Interface Administrator, Bureaucrat and Suppressor
** Save user groups

== Extracting Hacks ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
MediaWiki:Common.js
MediaWiki:Group-user.css
MediaWiki:Common.css
MediaWiki:Vector.css
MediaWiki:Timeless.css
MediaWiki:Gadget-veCenterLoader.js
MediaWiki:Gadget-autonum
MediaWiki:Gadget-autonum.js
MediaWiki:Gadget-autonum.css
MediaWiki:Gadget-veCenterLoader
MediaWiki:Gadget-veCenter.js
MediaWiki:Gadgets-definition
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-hacks.xml

== Extracting Templates ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
Template:DocLink
Template:Doc_Title
Template:Comment
Template:Incomplete
Template:Note
Template:Hint
Template:Warning
Template:Xref
PageTemplate
DocTemplate
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Templates.xml

== Extracting Common Additional Files ==
Take the following from an Assist implementation that has them:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* Special:All Pages
* Enter start of file name in "Display pages starting at:"
* Select File Namespace from drop-down list and then click Go.
* Click on the file until a full-screen version appears.
* Right-click, Save Image As
* Save to your chosen directory.

== Extracting Namespace Files ==
* Extract from an existing Assist
* Special Pages
* Export Pages
* Add the pages specifically below, replacing the namespace with the namespace of the Assist system - in this case this is from CTMS Assist:
CTMS:Privacy_policy
CTMS:General_disclaimer
CTMS:Copyrights
CTMS:About
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Namespace.xml

{{Note}} You will then need to amend the About page to change the product name and copyright dates.

== Importing Additional Files, Templates and Hacks into a Wiki ==
* Ensure that all additional files from MW-add-files have been added.
* Upload additional files:
** Special:Upload Multiple Files
** Add a description if you want
** Select the following files:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* As soon as you select the files, the files will be uploaded. The page will indicate if there is any error uploading the files (for example if they already exist)
* Upload hacks and templates:
** Special Pages
** Import Pages
** Browse for the file to import, one of (do both)
*** MW-hacks.xml
*** MW-Templates.xml
** Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
** Add a comment if you want.
** Ensure option "Import to original namespace" is selected
** Upload File.

== Importing Namespace Files ==
* Special Pages
* Import Pages
* Browse for the file to import
** MW-Namespace.xml
* Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
* Add a comment if you want.
* Ensure option "Import to a namespace" is selected
* Select the namespace from the drop-down list that matches the Assist being imported into, for example, MTS for CTMS, EPOD for C-ePOD, etc
* Upload File.

== Additional Actions ==
The following are additional actions that are required on installing a new Assist, with some sample pages.

* MediaWiki:Pagetitle-view-mainpage - change this text to define the title of the wiki e.g. Assist - OBS Hub
* Update the main page - the MTS one is the one with all the best notes in.
* Update the Did You Know page with the common Assist-based help topics - there is an example in this Assist of a Did You Know page which can be copied or exported, imported and then edited.
* "Download as PDF" to "Print as PDF" - e.g. "Print as PDF tab in the tab bar, typically on the top of the screen".

You can use the files on this Assist as templates:
* [[OBS:About]]
* [[OBS:General_disclaimer]]
* [[OBS:Privacy_policy]]
* [[OBS:Copyrights]]

== MediaWiki ==
You can find the MediaWiki license, contributors, FOSS attributions and components here:
* [[Special:Version]].

== Common Maintenance Actions ==

=== Creating Users/Resetting User Passwords ===
It is ALWAYS better to create a new user on the Wiki from the Special page "Create Account". In here, you should create the user and enter the email. This will send an email to the user to reset their own password. Details:

* Go to [[Special:CreateAccount]].
* Enter the username
* Click the box to create a temporary password, or enter a password here.
* '''Enter the email address.'''
* Click '''Create Account'''.

However, in the event of correcting a problem, this can be done from the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\createAndPromote.php {uname} {pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

You can also add some parameters to promote the user with group rights, as follows:
--bureaucrat Add the account to the bureaucrat group
--sysop Add the account to the sysop group
--interface-admin Add the account to the interface-admin group
--custom-groups Comma-separated list of groups to add the user to. This allows adding the user to any custom group.
Since MW 1.27, a user is only added to a custom group, if this group actually exists according to $wgGroupPermissions and $wgRevokePermissions. Non-existing groups are ignored.
--force If account already exists, just grant it rights or change password. Do not create a new account in this case.

In the event of needing to change a password, it is ALWAYS better to get the user to do it themselves - if the email has been set up, they can access the reset from there.

System admins can also force the sending of the reset password link from Special:ResetPassword.

In the event that this is simply correcting a previously set password, you can use the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\changePassword.php --user={uname} --password={pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.
=== Managing Revisions ===
Sometimes, you may want to roll-back edits, or delete or hide revisions to a page, perhaps to remove dangerous content.

This is controlled through user rights and groups - see below for more information on that.

Using the rollback feature (for administrators and users with the "rollback" right)

* Go to the page history, the user contributions page, or a diff page.
* Find the "rollback" link next to the consecutive edits you want to revert. It appears before the "undo" link.
* Click the "rollback" link. The page will automatically revert to the previous version by another user, and a pre-filled edit summary will appear.
* Save the edit. The change is marked as a "minor" edit in the history.
* Important: After using rollback, it's recommended to check the recent revisions to ensure all disruptive edits were reverted and no constructive edits were accidentally removed.

Using the undo feature (for any user)

* Navigate to the page history.
* Find the specific edit you want to undo in the list.
* Click the "undo" link at the end of that edit's line.
* An edit page will load with the changes from that edit removed. Later edits are retained by default.
* You can modify the default edit summary if needed.
* Click "Save page" to revert the single edit.

When to use which method

* Use rollback for reverting a large number of consecutive bad edits, such as vandalism, by the most recent user. It's a one-click process for authorized users.
* Use undo to revert a single edit or to manually edit the page to combine or resolve conflicts with later edits. The undo feature is available to all users.

You can permanently flatter all history in a page using the command line.

* For page histories: Run the script from your MediaWiki installation's directory. You can delete all old revisions by using the flag or by specifying the page ID.
* Example command (once in your wiki's maintenance directory):
** <code>{InstallDrive}:\xampp\php\php.exe deleteOldRevisions.php --delete 123</code>
* (Replace 123 with the page ID gathered from the page information).
* Note that running this script without <code>--delete</code> will just list the count of revisions that will be removed.

To delete a specific revision in MediaWiki, use the RevisionDelete feature, which administrators can enable to hide revisions from public view. This feature allows you to hide the content, username, or edit summary of one or more revisions without permanently removing them. First, enable the permission, then go to the page history, select the revisions using the checkboxes, and click "Change visibility of selected revisions" to hide them.

For administrators using RevisionDelete

# Enable the permission: Ensure your user account has the permission. This may require editing LocalSettings.php.
# Go to the page history: Navigate to the page and click the "View history" tab.
# Select revisions: Check the boxes next to the revisions you want to hide.
# Change visibility: Click the "Change visibility of selected revisions" button.
# Choose what to hide: Select the options to hide the content, usernames, or summaries.
# Apply changes: Add a log comment and click the "Apply to selected revisions" button.

=== Managing Interwikis ===
See here for an explanation of what we use this for: [[Assist Editing Guide#Interwiki|Interwiki]].

Each product wiki SHOULD be set up so that interwiki links are configured within the CALIDUS HUB only, and then disseminated to the individual Assists.

This is done in the following way:

in LocalSettingsAdditional.php:
$wgSharedDB = 'obs_assist'; # The $wgDBname for the wiki database holding the main interwiki table
$wgSharedPrefix = 'obs_'; # The $wgDBprefix for the database. Defaults to the prefix of the current wiki if not specified
$wgSharedTables = ['interwiki'];
If they are not, fix the Assist file above.

Current interwikis:

* epod
* cmcs
* ctms
* obs
* cportal
* cvision
* cwcs
* cwms

To add a new/edit an existing interwiki:

* ''Wiki Tools/Special pages''
* ''View and Edit InterWiki data''
* New
** Click ''Add an interwiki or language prefix''
** Prefix: new unique prefix
** Forward - ticked
** Transclude - ticked
** URL: the assist URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/Index.php?title=$1</nowiki>
** API: the API URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/api.php</nowiki>
** Click '''Add'''. (You may have to enter a reason).
* Edit
** Click the Edit link against the interwiki and make the changes you need, then click '''Edit'''. (You may have to enter a reason).

{{Note}}You need to be a sysop (a member of the Administrators group) to edit interwiki links. Currently that is the Admin user. See following section.

=== Maintaining User Rights ===
You must be an Administrator to do this. Currently that is the Admin user.

Use the ''Wiki Tools/Special pages'' link.

* User group rights - the rights associated to each group - this is maintained in the LocalSettings*.php files and will likely not change. Check this for a list of the rights that you want to assign. For example, if
* User list - a list of the users
* User rights - allows you to change the groups associated to each user, and therefore the rights allowed.
** Find the user ID and click '''Load User Rights'''
** Tick the boxes that you want them to have the rights to under Groups you can change
*** autoconfirmed user - has confirmed login through email address.
*** bot - leave unchecked/unassigned - no bots in this system.
*** administrator - admin/sysop (superuser) rights, patrol other users' unpatrolled edits. Basically everything
*** interface administrator - amend site CSS and Javascript i.e. a system maintainer.
*** bureaucrat - auto-patrolled edits
*** suppressor - revision maintainer
** You can also set the following against certain groups:
*** Expires: - the expiration date - use below instead if required.
*** Does not expire - check this instead.

=== Blocking Users ===
When users leave the organisation, we should block their access for the Assist user. You use Special pages to do this:

* [[Special:ListUsers]] - a list of all users, where you can block a specific user using the link provided. You will be taken to the next page.
* [[Special:Block]] - the mechanism of blocking users. You can get to it from Special pages or from the users list above.

To block users, either:

* Select the Block option against the user in the users list, or go to the block special page directly and enter their username.
* From here, block sitewide, and in block details check all boxes. Then change the expiry to Infinite, and click the button to block the user.

=== Patrolling Edits ===
Please see separate guide [[Assist - Patrolling edits]] for more details on this.

== Support Issues ==

=== Seeing a Cat in the Background ===
There is a cat.svg linked from Timeless skin. (/calidus-assist/OBS/skins/Timeless/resources/images/cat.svg). This is the default.

This is configurable in skin.json in the Timeless directory for your Wiki. i.e. D:\xampp\htdocs\calidus-assist\OBS\skins\Timeless\skin.json

Solution: Set this to user-grey.svg instead.<pre>
"config": {
"TimelessBackdropImage": {
"value": "user-grey.svg",
"description": "Set it as you would $wgLogo to an appropriate background image. Recommendation is an svg set to 500-750px wide"
},
</pre>With multiple wiki installs, this is onerous. To facilitate changing multiple wiki installs, there is a directory in D:\Assist Install Files\MW-add-files called skins.

To apply:

* Copy the directory skins.
* Navigate to your Assist main folder e.g. D:\xampp\htdocs\calidus-assist\WMS
* Paste - this will overwrite the config file with the corrected one.

{{Warning}}This file is delivered with MediaWiki. A new install will overwrite this file. If you have updated MediaWiki or installed a new version of the Timeless skin, then compare the saved skin.json file with the new one and update with any new/changed attributes.

=== Zero Bytes PDF ===
Problems typically display as the PDF being downloaded is zero bytes or cannot be opened.

The most common issues are with single page PDFs. The normal solutions are:

* For full documents, ensure that there is a heading 1 element in the file being downloaded.
* If you are transcluding pages into a document, there is typically a limit of around 15 transcluded pages before the document will not produce. Instead, consider grouping the pages into a category and extracting that instead of creating a single document.

Some documents will include a <nowiki><div class="noprint"> after the title page and a closing div at the end. This used to be require din older versions of the code, but now causes issues. To fix, remove the div and closing div tags (not the top ones around the vardefines, just the ones after that and at the very end).</nowiki>

=== '?' characters ===
Occasionally, PDFs will be produced with '?' characters in unusual places. This represents and unprintable character in the PDF. Typically, this is because of smart quotes or hyphen characters, usually because text has been pasted in from a Word document that has "helpfully" automatically changes all hyphens, quotes and single quotes into extended characters. The PDF conversion routine does not support these characters at this time. To solve this, edit the page in question and replace the quotes and hyphens with plain equivalents.

=== Unexpected Pages in PDF Books ===
When PDF books are created from Categories, sometimes there are pages included that are not expected.

Most of the time this is caused by inheritance of categories. If a page has a category and this is transcluded into another page, the default is that the page transcluding will inherit the categories listed in the transcluded page.

Check the category list of pages in Assist - usually you will see the offending page, and then the categories can be amended to resolve the issue.

Either remove the categories of the page if it is in the wrong category, or ensure that the categories are surrounded by NOINCLUDE tags. You should use the source editor to do this, as the Visual Editor does not handle this kind of meta data very well.

[[Category:Assist Guides]]
[[Category:ASSIST]]

Assist - Patrolling edits

2026-02-27T12:14:56Z

Anw: Added RSS Feed details

It's important that the quality of pages in Assist is high, and we reuse where possible.

Therefore, every edit made by users who are not system administrators are logged and marked as unpatrolled edits.

That allows administrators of Assist to patrol edits to ensure quality and prevent spamming.

Currently this is a manual process, but may elements will be automated with time.

== Reference ==
https://www.mediawiki.org/wiki/Help:Patrolled_edits

== Configuration ==
All administrators are naturally granted the autopatrol right (none of their edits require patrolling) and the patrol right (the ability to patrol unpatrolled edits).

Administrators can assign other users to the administrator group, to increase the number of users patrolling changes.

Administrators can add the patrol right to individual users.

The system has been configured to email selected administrators with details of all changes, so that they can be patrolled. To change or remove this:

* Edit /path/to/Assist/LocalSettingsAdditional.php
* Change $wgUsersNotifiedOnAllChanges with the users to be notified, as an array e.g. ['uid1', 'uid2'].

As a (better) alternative to this email notification, consider the use of https://feeder.co/reader instead. You can set up a basic free account (or use without an account.

* Go to your Assist of choice.
* Click Recent Changes
* Make sure settings are low, say 300 changes in recent day or hours.
* Click "Atom" in the Wiki Tools toolbar
* Chrome should open a page allowing you to follow the feed. Choose ''Feeder'' and click '''Follow'''.
* This should then be added to your Feeder list.

You will then receive a Chrome notification whenever a page is updated (usually within 10 minutes).

You can click on the link to be shown the page directly in Feeder, where you can see the changes made.

Consider also adding this as an extension to Chrome - the extension is called "RSS Feed Reader", search for this or "Feeder" in the [https://chromewebstore.google.com/category/extensions Chrome Web Store]

== Patrolling ==
To mark an edit as patrolled

* Access Special:RecentChanges
* Changes which are not patrolled display with a red exclamation mark (!).
* Click the (diff) link next to an edit.
* To mark the edit as patrolled, click the Mark as patrolled link.

To mark a new page as patrolled

* Access Special:NewPages
* New pages which are not patrolled display with a yellow background.
* To mark a new page as patrolled, visit it and click the ⧼markaspatrolledlink⧽ link near the bottom of the page.

To mark a new file as patrolled

* Access Special:NewFiles
* If you want to see only unpatrolled files, check "Hide patrolled uploads"
* To mark a new file or new file version as patrolled, visit it and click the ⧼markaspatrolledlink⧽ link near the bottom of the file description.

{{Note}}You can't mark a deleted file or page as patrolled.
[[Category:ASSIST]]
[[Category:Assist Guides]]

Assist Support Guide

2026-02-26T15:39:19Z

Anw: Updated creating a new user account

The intention of this guide is to provide support information, and a general knowledge base and tips for the ongoing maintenance of Assist implementations.

== Requirements ==
MySQL WorkBench

Access to the Assist server.

== Hosted Systems ==
All hosted systems are documented in SharePoint, along with users and passwords.

You must have access to the SharePoint to read this document.

https://apteanonline.sharepoint.com/teams/CALIDUS-CONNECTIONS/Shared%20Documents/Forms/AllItems.aspx?id=%2Fteams%2FCALIDUS%2DCONNECTIONS%2FShared%20Documents%2FCalidus%20Assist&viewid=fffc6c78%2D04de%2D4e7d%2Db3ec%2D62168ff125fb

== Updating Data En Mass==
By default, MySQL will not allow updating of data without explicit WHERE or LIMIT clauses. To enable this:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Safe Updates"
* Restart MySQL WorkBench.
{{Warning}} You will then be able to (for example) delete all data inadvertently, so enable this option with care.

== Viewing BLOB fields ==
By default, MySQL WorkBench displays all text fields as "BLOB", which you must then right-click and choose "Open Value in Editor". To enable viewing the text directly in the results, do the following:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Treat BINARY/VARBINARY as nonbinary character string"
* Restart MySQL WorkBench.
{{Note}} Enabling this option comes with a performance hit - some text fields contain the entire page data, so enable this with care.

== Recovering passwords from MYSQL Workbench ==
First go check where your encrypted file is. Usually it is stored at %AppData%\MySQL\Workbench\workbench_user_data.dat

If different, amend the commands below.

Use Powershell

<pre>
Add-Type -AssemblyName System.Security
$cipher = Get-Content $env:APPDATA\MySQL\Workbench\workbench_user_data.dat -Encoding Byte -Raw
$scope = [System.Security.Cryptography.DataProtectionScope]::CurrentUser
$mysqlpwd = [System.Security.Cryptography.ProtectedData]::Unprotect( $cipher, $null, $scope )
[System.Text.UTF8Encoding]::UTF8.GetString($mysqlpwd)
</pre>

== Common Queries ==
<pre>
-- Assist SQL

-- Find the page ID
SELECT * FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%';

-- Find all revisions (to change comments)
SELECT * FROM obs_assist.obs_revision
where rev_page IN
(SELECT page_id FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%'
);

-- Find unpatrolled pages to set them patrolled
SELECT *
FROM obs_assist.obs_recentchanges
where rc_patrolled = 0;

UPDATE obs_assist.obs_recentchanges
SET rc_patrolled = 1
where rc_user_text = 'StylesC'

-- Check the logs for details of PDF production
SELECT * FROM mts_assist.oh_logging
where log_action ='PdfBook'
-- order by log_id desc

-- For v1.34 and later, comments have changed:
SELECT log.*, CONVERT(comment.comment_text USING utf8) comment
FROM epod_assist.epodlogging log
left join epod_assist.epodcomment comment
on comment.comment_id = log.log_comment_id
where log_action ='PdfBook'
--ORDER BY log_id DESC
--LIMIT 20
</pre>

== Assist Database Backup ==
Backup each database separately.

Use MySQL Administrator Data Export option.

Always check boxes as follows:
* Dump Stored Procedures and Functions
* Dump Events
* Dump Triggers
* Export to Self-contained File
** Name with the name of the Assist on the start of the dump.
* Include Create Schema

Advanced Options button
* Comments
* Create-options
* quote-names
* lock-tables
* dump-date
* disable-keys
* tz-utc
* add-locks
* extended-insert

Start Export

== Assist Database Restore ==
If required, drop the database from MySQL Administrator:
* On Schema explorer, right click on schema and select Drop Schema.

Use MySQL Administrator Data Import/Restore option.
* Import from self-contained file
* Select the database backup dump
* Click Start Import
* Refresh the schema explorer when done - the database should be present.

Restore database users, passwords and permissions when complete.

Will need to create the assist owner with username and password from LocalSettings.php
* From MySQL Admin Management Explorer
* Users and Privileges
* Add Account
** Login Name and Password - as per LocalSettings.php
* Administrative Roles tab - check DBA, which checks everything
* Schema Privileges - add entry
** Selected Schema
** Check everything (click Select 'ALL' button)
* Click Apply

Normal Assist users will need to be reset either by the users through 2FA, or through [[#Resetting User Passwords]].

== Upgrading a Wiki from 1.16 Upwards ==
The following is a checklist of actions.

{SYSTEM}
* Extracted - INCOMPLETE
* DB Import - INCOMPLETE
* DB User - INCOMPLETE
** {SYSTEM}_owner/{PASSWORD}
* Version 1.31.6 - INCOMPLETE
** Move old extensions to old folder - INCOMPLETE
** Recreate LocalSettings.php
** Update password sender and emergency contact
* Version 1.34.4 - INCOMPLETE
** Leave LocalSettings.php
** May need to remove some extensions like numberformat and variables
* Version 1.39.8 - INCOMPLETE
** Leave LocalSettings.php
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - INCOMPLETE
** admin/Liverpool123
** anw/Liverpool123
* Problems
** NONE

== Creating a Brand New Wiki ==
The following is a checklist of actions.
* Copy version 1.39.8 to a WIKI name - INCOMPLETE
** Create LocalSettings.php
** xxx_owner with appropriate password
** Note the password!
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - ensure that there is at least an Admin user with full user rights. Note the password:
** Log in as administrative user
** Special:Create Account
** Create admin account - note the password.
** Special:User Rights
** Check Administrator, Interface Administrator, Bureaucrat and Suppressor
** Save user groups

== Extracting Hacks ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
MediaWiki:Common.js
MediaWiki:Group-user.css
MediaWiki:Common.css
MediaWiki:Vector.css
MediaWiki:Timeless.css
MediaWiki:Gadget-veCenterLoader.js
MediaWiki:Gadget-autonum
MediaWiki:Gadget-autonum.js
MediaWiki:Gadget-autonum.css
MediaWiki:Gadget-veCenterLoader
MediaWiki:Gadget-veCenter.js
MediaWiki:Gadgets-definition
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-hacks.xml

== Extracting Templates ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
Template:DocLink
Template:Doc_Title
Template:Comment
Template:Incomplete
Template:Note
Template:Hint
Template:Warning
Template:Xref
PageTemplate
DocTemplate
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Templates.xml

== Extracting Common Additional Files ==
Take the following from an Assist implementation that has them:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* Special:All Pages
* Enter start of file name in "Display pages starting at:"
* Select File Namespace from drop-down list and then click Go.
* Click on the file until a full-screen version appears.
* Right-click, Save Image As
* Save to your chosen directory.

== Extracting Namespace Files ==
* Extract from an existing Assist
* Special Pages
* Export Pages
* Add the pages specifically below, replacing the namespace with the namespace of the Assist system - in this case this is from CTMS Assist:
CTMS:Privacy_policy
CTMS:General_disclaimer
CTMS:Copyrights
CTMS:About
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Namespace.xml

{{Note}} You will then need to amend the About page to change the product name and copyright dates.

== Importing Additional Files, Templates and Hacks into a Wiki ==
* Ensure that all additional files from MW-add-files have been added.
* Upload additional files:
** Special:Upload Multiple Files
** Add a description if you want
** Select the following files:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* As soon as you select the files, the files will be uploaded. The page will indicate if there is any error uploading the files (for example if they already exist)
* Upload hacks and templates:
** Special Pages
** Import Pages
** Browse for the file to import, one of (do both)
*** MW-hacks.xml
*** MW-Templates.xml
** Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
** Add a comment if you want.
** Ensure option "Import to original namespace" is selected
** Upload File.

== Importing Namespace Files ==
* Special Pages
* Import Pages
* Browse for the file to import
** MW-Namespace.xml
* Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
* Add a comment if you want.
* Ensure option "Import to a namespace" is selected
* Select the namespace from the drop-down list that matches the Assist being imported into, for example, MTS for CTMS, EPOD for C-ePOD, etc
* Upload File.

== Additional Actions ==
The following are additional actions that are required on installing a new Assist, with some sample pages.

* MediaWiki:Pagetitle-view-mainpage - change this text to define the title of the wiki e.g. Assist - OBS Hub
* Update the main page - the MTS one is the one with all the best notes in.
* Update the Did You Know page with the common Assist-based help topics - there is an example in this Assist of a Did You Know page which can be copied or exported, imported and then edited.
* "Download as PDF" to "Print as PDF" - e.g. "Print as PDF tab in the tab bar, typically on the top of the screen".

You can use the files on this Assist as templates:
* [[OBS:About]]
* [[OBS:General_disclaimer]]
* [[OBS:Privacy_policy]]
* [[OBS:Copyrights]]

== MediaWiki ==
You can find the MediaWiki license, contributors, FOSS attributions and components here:
* [[Special:Version]].

== Common Maintenance Actions ==

=== Creating Users/Resetting User Passwords ===
It is ALWAYS better to create a new user on the Wiki from the Special page "Create Account". In here, you should create the user and enter the email. This will send an email to the user to reset their own password. Details:

* Go to [[Special:CreateAccount]].
* Enter the username
* Click the box to create a temporary password, or enter a password here.
* '''Enter the email address.'''
* Click '''Create Account'''.

However, in the event of correcting a problem, this can be done from the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\createAndPromote.php {uname} {pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

You can also add some parameters to promote the user with group rights, as follows:
--bureaucrat Add the account to the bureaucrat group
--sysop Add the account to the sysop group
--interface-admin Add the account to the interface-admin group
--custom-groups Comma-separated list of groups to add the user to. This allows adding the user to any custom group.
Since MW 1.27, a user is only added to a custom group, if this group actually exists according to $wgGroupPermissions and $wgRevokePermissions. Non-existing groups are ignored.
--force If account already exists, just grant it rights or change password. Do not create a new account in this case.

In the event of needing to change a password, it is ALWAYS better to get the user to do it themselves - if the email has been set up, they can access the reset from there.

System admins can also force the sending of the reset password link from Special:ResetPassword.

In the event that this is simply correcting a previously set password, you can use the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\changePassword.php --user={uname} --password={pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.
=== Managing Revisions ===
Sometimes, you may want to roll-back edits, or delete or hide revisions to a page, perhaps to remove dangerous content.

This is controlled through user rights and groups - see below for more information on that.

Using the rollback feature (for administrators and users with the "rollback" right)

* Go to the page history, the user contributions page, or a diff page.
* Find the "rollback" link next to the consecutive edits you want to revert. It appears before the "undo" link.
* Click the "rollback" link. The page will automatically revert to the previous version by another user, and a pre-filled edit summary will appear.
* Save the edit. The change is marked as a "minor" edit in the history.
* Important: After using rollback, it's recommended to check the recent revisions to ensure all disruptive edits were reverted and no constructive edits were accidentally removed.

Using the undo feature (for any user)

* Navigate to the page history.
* Find the specific edit you want to undo in the list.
* Click the "undo" link at the end of that edit's line.
* An edit page will load with the changes from that edit removed. Later edits are retained by default.
* You can modify the default edit summary if needed.
* Click "Save page" to revert the single edit.

When to use which method

* Use rollback for reverting a large number of consecutive bad edits, such as vandalism, by the most recent user. It's a one-click process for authorized users.
* Use undo to revert a single edit or to manually edit the page to combine or resolve conflicts with later edits. The undo feature is available to all users.

You can permanently flatter all history in a page using the command line.

* For page histories: Run the script from your MediaWiki installation's directory. You can delete all old revisions by using the flag or by specifying the page ID.
* Example command (once in your wiki's maintenance directory):
** <code>{InstallDrive}:\xampp\php\php.exe deleteOldRevisions.php --delete 123</code>
* (Replace 123 with the page ID gathered from the page information).
* Note that running this script without <code>--delete</code> will just list the count of revisions that will be removed.

To delete a specific revision in MediaWiki, use the RevisionDelete feature, which administrators can enable to hide revisions from public view. This feature allows you to hide the content, username, or edit summary of one or more revisions without permanently removing them. First, enable the permission, then go to the page history, select the revisions using the checkboxes, and click "Change visibility of selected revisions" to hide them.

For administrators using RevisionDelete

# Enable the permission: Ensure your user account has the permission. This may require editing LocalSettings.php.
# Go to the page history: Navigate to the page and click the "View history" tab.
# Select revisions: Check the boxes next to the revisions you want to hide.
# Change visibility: Click the "Change visibility of selected revisions" button.
# Choose what to hide: Select the options to hide the content, usernames, or summaries.
# Apply changes: Add a log comment and click the "Apply to selected revisions" button.

=== Managing Interwikis ===
See here for an explanation of what we use this for: [[Assist Editing Guide#Interwiki|Interwiki]].

Each product wiki SHOULD be set up so that interwiki links are configured within the CALIDUS HUB only, and then disseminated to the individual Assists.

This is done in the following way:

in LocalSettingsAdditional.php:
$wgSharedDB = 'obs_assist'; # The $wgDBname for the wiki database holding the main interwiki table
$wgSharedPrefix = 'obs_'; # The $wgDBprefix for the database. Defaults to the prefix of the current wiki if not specified
$wgSharedTables = ['interwiki'];
If they are not, fix the Assist file above.

Current interwikis:

* epod
* cmcs
* ctms
* obs
* cportal
* cvision
* cwcs
* cwms

To add a new/edit an existing interwiki:

* ''Wiki Tools/Special pages''
* ''View and Edit InterWiki data''
* New
** Click ''Add an interwiki or language prefix''
** Prefix: new unique prefix
** Forward - ticked
** Transclude - ticked
** URL: the assist URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/Index.php?title=$1</nowiki>
** API: the API URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/api.php</nowiki>
** Click '''Add'''. (You may have to enter a reason).
* Edit
** Click the Edit link against the interwiki and make the changes you need, then click '''Edit'''. (You may have to enter a reason).

{{Note}}You need to be a sysop (a member of the Administrators group) to edit interwiki links. Currently that is the Admin user. See following section.

=== Maintaining User Rights ===
You must be an Administrator to do this. Currently that is the Admin user.

Use the ''Wiki Tools/Special pages'' link.

* User group rights - the rights associated to each group - this is maintained in the LocalSettings*.php files and will likely not change. Check this for a list of the rights that you want to assign. For example, if
* User list - a list of the users
* User rights - allows you to change the groups associated to each user, and therefore the rights allowed.
** Find the user ID and click '''Load User Rights'''
** Tick the boxes that you want them to have the rights to under Groups you can change
*** autoconfirmed user - has confirmed login through email address.
*** bot - leave unchecked/unassigned - no bots in this system.
*** administrator - admin/sysop (superuser) rights, patrol other users' unpatrolled edits. Basically everything
*** interface administrator - amend site CSS and Javascript i.e. a system maintainer.
*** bureaucrat - auto-patrolled edits
*** suppressor - revision maintainer
** You can also set the following against certain groups:
*** Expires: - the expiration date - use below instead if required.
*** Does not expire - check this instead.

=== Blocking Users ===
When users leave the organisation, we should block their access for the Assist user. You use Special pages to do this:

* [[Special:ListUsers]] - a list of all users, where you can block a specific user using the link provided. You will be taken to the next page.
* [[Special:Block]] - the mechanism of blocking users. You can get to it from Special pages or from the users list above.

To block users, either:

* Select the Block option against the user in the users list, or go to the block special page directly and enter their username.
* From here, block sitewide, and in block details check all boxes. Then change the expiry to Infinite, and click the button to block the user.

== Support Issues ==

=== Seeing a Cat in the Background ===
There is a cat.svg linked from Timeless skin. (/calidus-assist/OBS/skins/Timeless/resources/images/cat.svg). This is the default.

This is configurable in skin.json in the Timeless directory for your Wiki. i.e. D:\xampp\htdocs\calidus-assist\OBS\skins\Timeless\skin.json

Solution: Set this to user-grey.svg instead.<pre>
"config": {
"TimelessBackdropImage": {
"value": "user-grey.svg",
"description": "Set it as you would $wgLogo to an appropriate background image. Recommendation is an svg set to 500-750px wide"
},
</pre>With multiple wiki installs, this is onerous. To facilitate changing multiple wiki installs, there is a directory in D:\Assist Install Files\MW-add-files called skins.

To apply:

* Copy the directory skins.
* Navigate to your Assist main folder e.g. D:\xampp\htdocs\calidus-assist\WMS
* Paste - this will overwrite the config file with the corrected one.

{{Warning}}This file is delivered with MediaWiki. A new install will overwrite this file. If you have updated MediaWiki or installed a new version of the Timeless skin, then compare the saved skin.json file with the new one and update with any new/changed attributes.

=== Zero Bytes PDF ===
Problems typically display as the PDF being downloaded is zero bytes or cannot be opened.

The most common issues are with single page PDFs. The normal solutions are:

* For full documents, ensure that there is a heading 1 element in the file being downloaded.
* If you are transcluding pages into a document, there is typically a limit of around 15 transcluded pages before the document will not produce. Instead, consider grouping the pages into a category and extracting that instead of creating a single document.

Some documents will include a <nowiki><div class="noprint"> after the title page and a closing div at the end. This used to be require din older versions of the code, but now causes issues. To fix, remove the div and closing div tags (not the top ones around the vardefines, just the ones after that and at the very end).</nowiki>

=== '?' characters ===
Occasionally, PDFs will be produced with '?' characters in unusual places. This represents and unprintable character in the PDF. Typically, this is because of smart quotes or hyphen characters, usually because text has been pasted in from a Word document that has "helpfully" automatically changes all hyphens, quotes and single quotes into extended characters. The PDF conversion routine does not support these characters at this time. To solve this, edit the page in question and replace the quotes and hyphens with plain equivalents.

=== Unexpected Pages in PDF Books ===
When PDF books are created from Categories, sometimes there are pages included that are not expected.

Most of the time this is caused by inheritance of categories. If a page has a category and this is transcluded into another page, the default is that the page transcluding will inherit the categories listed in the transcluded page.

Check the category list of pages in Assist - usually you will see the offending page, and then the categories can be amended to resolve the issue.

Either remove the categories of the page if it is in the wrong category, or ensure that the categories are surrounded by NOINCLUDE tags. You should use the source editor to do this, as the Visual Editor does not handle this kind of meta data very well.

[[Category:Assist Guides]]
[[Category:ASSIST]]

Assist Support Guide

2026-02-26T15:14:02Z

Anw: Added details of blocking users

The intention of this guide is to provide support information, and a general knowledge base and tips for the ongoing maintenance of Assist implementations.

== Requirements ==
MySQL WorkBench

Access to the Assist server.

== Hosted Systems ==
All hosted systems are documented in SharePoint, along with users and passwords.

You must have access to the SharePoint to read this document.

https://apteanonline.sharepoint.com/teams/CALIDUS-CONNECTIONS/Shared%20Documents/Forms/AllItems.aspx?id=%2Fteams%2FCALIDUS%2DCONNECTIONS%2FShared%20Documents%2FCalidus%20Assist&viewid=fffc6c78%2D04de%2D4e7d%2Db3ec%2D62168ff125fb

== Updating Data En Mass==
By default, MySQL will not allow updating of data without explicit WHERE or LIMIT clauses. To enable this:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Safe Updates"
* Restart MySQL WorkBench.
{{Warning}} You will then be able to (for example) delete all data inadvertently, so enable this option with care.

== Viewing BLOB fields ==
By default, MySQL WorkBench displays all text fields as "BLOB", which you must then right-click and choose "Open Value in Editor". To enable viewing the text directly in the results, do the following:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Treat BINARY/VARBINARY as nonbinary character string"
* Restart MySQL WorkBench.
{{Note}} Enabling this option comes with a performance hit - some text fields contain the entire page data, so enable this with care.

== Recovering passwords from MYSQL Workbench ==
First go check where your encrypted file is. Usually it is stored at %AppData%\MySQL\Workbench\workbench_user_data.dat

If different, amend the commands below.

Use Powershell

<pre>
Add-Type -AssemblyName System.Security
$cipher = Get-Content $env:APPDATA\MySQL\Workbench\workbench_user_data.dat -Encoding Byte -Raw
$scope = [System.Security.Cryptography.DataProtectionScope]::CurrentUser
$mysqlpwd = [System.Security.Cryptography.ProtectedData]::Unprotect( $cipher, $null, $scope )
[System.Text.UTF8Encoding]::UTF8.GetString($mysqlpwd)
</pre>

== Common Queries ==
<pre>
-- Assist SQL

-- Find the page ID
SELECT * FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%';

-- Find all revisions (to change comments)
SELECT * FROM obs_assist.obs_revision
where rev_page IN
(SELECT page_id FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%'
);

-- Find unpatrolled pages to set them patrolled
SELECT *
FROM obs_assist.obs_recentchanges
where rc_patrolled = 0;

UPDATE obs_assist.obs_recentchanges
SET rc_patrolled = 1
where rc_user_text = 'StylesC'

-- Check the logs for details of PDF production
SELECT * FROM mts_assist.oh_logging
where log_action ='PdfBook'
-- order by log_id desc

-- For v1.34 and later, comments have changed:
SELECT log.*, CONVERT(comment.comment_text USING utf8) comment
FROM epod_assist.epodlogging log
left join epod_assist.epodcomment comment
on comment.comment_id = log.log_comment_id
where log_action ='PdfBook'
--ORDER BY log_id DESC
--LIMIT 20
</pre>

== Assist Database Backup ==
Backup each database separately.

Use MySQL Administrator Data Export option.

Always check boxes as follows:
* Dump Stored Procedures and Functions
* Dump Events
* Dump Triggers
* Export to Self-contained File
** Name with the name of the Assist on the start of the dump.
* Include Create Schema

Advanced Options button
* Comments
* Create-options
* quote-names
* lock-tables
* dump-date
* disable-keys
* tz-utc
* add-locks
* extended-insert

Start Export

== Assist Database Restore ==
If required, drop the database from MySQL Administrator:
* On Schema explorer, right click on schema and select Drop Schema.

Use MySQL Administrator Data Import/Restore option.
* Import from self-contained file
* Select the database backup dump
* Click Start Import
* Refresh the schema explorer when done - the database should be present.

Restore database users, passwords and permissions when complete.

Will need to create the assist owner with username and password from LocalSettings.php
* From MySQL Admin Management Explorer
* Users and Privileges
* Add Account
** Login Name and Password - as per LocalSettings.php
* Administrative Roles tab - check DBA, which checks everything
* Schema Privileges - add entry
** Selected Schema
** Check everything (click Select 'ALL' button)
* Click Apply

Normal Assist users will need to be reset either by the users through 2FA, or through [[#Resetting User Passwords]].

== Upgrading a Wiki from 1.16 Upwards ==
The following is a checklist of actions.

{SYSTEM}
* Extracted - INCOMPLETE
* DB Import - INCOMPLETE
* DB User - INCOMPLETE
** {SYSTEM}_owner/{PASSWORD}
* Version 1.31.6 - INCOMPLETE
** Move old extensions to old folder - INCOMPLETE
** Recreate LocalSettings.php
** Update password sender and emergency contact
* Version 1.34.4 - INCOMPLETE
** Leave LocalSettings.php
** May need to remove some extensions like numberformat and variables
* Version 1.39.8 - INCOMPLETE
** Leave LocalSettings.php
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - INCOMPLETE
** admin/Liverpool123
** anw/Liverpool123
* Problems
** NONE

== Creating a Brand New Wiki ==
The following is a checklist of actions.
* Copy version 1.39.8 to a WIKI name - INCOMPLETE
** Create LocalSettings.php
** xxx_owner with appropriate password
** Note the password!
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - ensure that there is at least an Admin user with full user rights. Note the password:
** Log in as administrative user
** Special:Create Account
** Create admin account - note the password.
** Special:User Rights
** Check Administrator, Interface Administrator, Bureaucrat and Suppressor
** Save user groups

== Extracting Hacks ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
MediaWiki:Common.js
MediaWiki:Group-user.css
MediaWiki:Common.css
MediaWiki:Vector.css
MediaWiki:Timeless.css
MediaWiki:Gadget-veCenterLoader.js
MediaWiki:Gadget-autonum
MediaWiki:Gadget-autonum.js
MediaWiki:Gadget-autonum.css
MediaWiki:Gadget-veCenterLoader
MediaWiki:Gadget-veCenter.js
MediaWiki:Gadgets-definition
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-hacks.xml

== Extracting Templates ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
Template:DocLink
Template:Doc_Title
Template:Comment
Template:Incomplete
Template:Note
Template:Hint
Template:Warning
Template:Xref
PageTemplate
DocTemplate
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Templates.xml

== Extracting Common Additional Files ==
Take the following from an Assist implementation that has them:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* Special:All Pages
* Enter start of file name in "Display pages starting at:"
* Select File Namespace from drop-down list and then click Go.
* Click on the file until a full-screen version appears.
* Right-click, Save Image As
* Save to your chosen directory.

== Extracting Namespace Files ==
* Extract from an existing Assist
* Special Pages
* Export Pages
* Add the pages specifically below, replacing the namespace with the namespace of the Assist system - in this case this is from CTMS Assist:
CTMS:Privacy_policy
CTMS:General_disclaimer
CTMS:Copyrights
CTMS:About
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Namespace.xml

{{Note}} You will then need to amend the About page to change the product name and copyright dates.

== Importing Additional Files, Templates and Hacks into a Wiki ==
* Ensure that all additional files from MW-add-files have been added.
* Upload additional files:
** Special:Upload Multiple Files
** Add a description if you want
** Select the following files:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* As soon as you select the files, the files will be uploaded. The page will indicate if there is any error uploading the files (for example if they already exist)
* Upload hacks and templates:
** Special Pages
** Import Pages
** Browse for the file to import, one of (do both)
*** MW-hacks.xml
*** MW-Templates.xml
** Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
** Add a comment if you want.
** Ensure option "Import to original namespace" is selected
** Upload File.

== Importing Namespace Files ==
* Special Pages
* Import Pages
* Browse for the file to import
** MW-Namespace.xml
* Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
* Add a comment if you want.
* Ensure option "Import to a namespace" is selected
* Select the namespace from the drop-down list that matches the Assist being imported into, for example, MTS for CTMS, EPOD for C-ePOD, etc
* Upload File.

== Additional Actions ==
The following are additional actions that are required on installing a new Assist, with some sample pages.

* MediaWiki:Pagetitle-view-mainpage - change this text to define the title of the wiki e.g. Assist - OBS Hub
* Update the main page - the MTS one is the one with all the best notes in.
* Update the Did You Know page with the common Assist-based help topics - there is an example in this Assist of a Did You Know page which can be copied or exported, imported and then edited.
* "Download as PDF" to "Print as PDF" - e.g. "Print as PDF tab in the tab bar, typically on the top of the screen".

You can use the files on this Assist as templates:
* [[OBS:About]]
* [[OBS:General_disclaimer]]
* [[OBS:Privacy_policy]]
* [[OBS:Copyrights]]

== MediaWiki ==
You can find the MediaWiki license, contributors, FOSS attributions and components here:
* [[Special:Version]].

== Common Maintenance Actions ==

=== Creating Users/Resetting User Passwords ===
It is ALWAYS better to create a new user on the Wiki from the Special page "Create Account". In here, you should create the user and enter the email. This will send an email to the user to reset their own password.

However, in the event of coreecting a problem, this can be done from the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\createAndPromote.php {uname} {pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

You can also add some parameters to promote the user with group rights, as follows:
--bureaucrat Add the account to the bureaucrat group
--sysop Add the account to the sysop group
--interface-admin Add the account to the interface-admin group
--custom-groups Comma-separated list of groups to add the user to. This allows adding the user to any custom group.
Since MW 1.27, a user is only added to a custom group, if this group actually exists according to $wgGroupPermissions and $wgRevokePermissions. Non-existing groups are ignored.
--force If account already exists, just grant it rights or change password. Do not create a new account in this case.

In the event of needing to change a password, it is ALWAYS better to get the user to do it themselves - if the email has been set up, they can access the reset from there.

System admins can also force the sending of the reset password link from Special:ResetPassword.

In the event that this is simply correcting a previously set password, you can use the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\changePassword.php --user={uname} --password={pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.
=== Managing Revisions ===
Sometimes, you may want to roll-back edits, or delete or hide revisions to a page, perhaps to remove dangerous content.

This is controlled through user rights and groups - see below for more information on that.

Using the rollback feature (for administrators and users with the "rollback" right)

* Go to the page history, the user contributions page, or a diff page.
* Find the "rollback" link next to the consecutive edits you want to revert. It appears before the "undo" link.
* Click the "rollback" link. The page will automatically revert to the previous version by another user, and a pre-filled edit summary will appear.
* Save the edit. The change is marked as a "minor" edit in the history.
* Important: After using rollback, it's recommended to check the recent revisions to ensure all disruptive edits were reverted and no constructive edits were accidentally removed.

Using the undo feature (for any user)

* Navigate to the page history.
* Find the specific edit you want to undo in the list.
* Click the "undo" link at the end of that edit's line.
* An edit page will load with the changes from that edit removed. Later edits are retained by default.
* You can modify the default edit summary if needed.
* Click "Save page" to revert the single edit.

When to use which method

* Use rollback for reverting a large number of consecutive bad edits, such as vandalism, by the most recent user. It's a one-click process for authorized users.
* Use undo to revert a single edit or to manually edit the page to combine or resolve conflicts with later edits. The undo feature is available to all users.

You can permanently flatter all history in a page using the command line.

* For page histories: Run the script from your MediaWiki installation's directory. You can delete all old revisions by using the flag or by specifying the page ID.
* Example command (once in your wiki's maintenance directory):
** <code>{InstallDrive}:\xampp\php\php.exe deleteOldRevisions.php --delete 123</code>
* (Replace 123 with the page ID gathered from the page information).
* Note that running this script without <code>--delete</code> will just list the count of revisions that will be removed.

To delete a specific revision in MediaWiki, use the RevisionDelete feature, which administrators can enable to hide revisions from public view. This feature allows you to hide the content, username, or edit summary of one or more revisions without permanently removing them. First, enable the permission, then go to the page history, select the revisions using the checkboxes, and click "Change visibility of selected revisions" to hide them.

For administrators using RevisionDelete

# Enable the permission: Ensure your user account has the permission. This may require editing LocalSettings.php.
# Go to the page history: Navigate to the page and click the "View history" tab.
# Select revisions: Check the boxes next to the revisions you want to hide.
# Change visibility: Click the "Change visibility of selected revisions" button.
# Choose what to hide: Select the options to hide the content, usernames, or summaries.
# Apply changes: Add a log comment and click the "Apply to selected revisions" button.

=== Managing Interwikis ===
See here for an explanation of what we use this for: [[Assist Editing Guide#Interwiki|Interwiki]].

Each product wiki SHOULD be set up so that interwiki links are configured within the CALIDUS HUB only, and then disseminated to the individual Assists.

This is done in the following way:

in LocalSettingsAdditional.php:
$wgSharedDB = 'obs_assist'; # The $wgDBname for the wiki database holding the main interwiki table
$wgSharedPrefix = 'obs_'; # The $wgDBprefix for the database. Defaults to the prefix of the current wiki if not specified
$wgSharedTables = ['interwiki'];
If they are not, fix the Assist file above.

Current interwikis:

* epod
* cmcs
* ctms
* obs
* cportal
* cvision
* cwcs
* cwms

To add a new/edit an existing interwiki:

* ''Wiki Tools/Special pages''
* ''View and Edit InterWiki data''
* New
** Click ''Add an interwiki or language prefix''
** Prefix: new unique prefix
** Forward - ticked
** Transclude - ticked
** URL: the assist URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/Index.php?title=$1</nowiki>
** API: the API URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/api.php</nowiki>
** Click '''Add'''. (You may have to enter a reason).
* Edit
** Click the Edit link against the interwiki and make the changes you need, then click '''Edit'''. (You may have to enter a reason).

{{Note}}You need to be a sysop (a member of the Administrators group) to edit interwiki links. Currently that is the Admin user. See following section.

=== Maintaining User Rights ===
You must be an Administrator to do this. Currently that is the Admin user.

Use the ''Wiki Tools/Special pages'' link.

* User group rights - the rights associated to each group - this is maintained in the LocalSettings*.php files and will likely not change. Check this for a list of the rights that you want to assign. For example, if
* User list - a list of the users
* User rights - allows you to change the groups associated to each user, and therefore the rights allowed.
** Find the user ID and click '''Load User Rights'''
** Tick the boxes that you want them to have the rights to under Groups you can change
*** autoconfirmed user - has confirmed login through email address.
*** bot - leave unchecked/unassigned - no bots in this system.
*** administrator - admin/sysop (superuser) rights, patrol other users' unpatrolled edits. Basically everything
*** interface administrator - amend site CSS and Javascript i.e. a system maintainer.
*** bureaucrat - auto-patrolled edits
*** suppressor - revision maintainer
** You can also set the following against certain groups:
*** Expires: - the expiration date - use below instead if required.
*** Does not expire - check this instead.

=== Blocking Users ===
When users leave the organisation, we should block their access for the Assist user. You use Special pages to do this:

* [[Special:ListUsers]] - a list of all users, where you can block a specific user using the link provided. You will be taken to the next page.
* [[Special:Block]] - the mechanism of blocking users. You can get to it from Special pages or from the users list above.

To block users, either:

* Select the Block option against the user in the users list, or go to the block special page directly and enter their username.
* From here, block sitewide, and in block details check all boxes. Then change the expiry to Infinite, and click the button to block the user.

== Support Issues ==

=== Seeing a Cat in the Background ===
There is a cat.svg linked from Timeless skin. (/calidus-assist/OBS/skins/Timeless/resources/images/cat.svg). This is the default.

This is configurable in skin.json in the Timeless directory for your Wiki. i.e. D:\xampp\htdocs\calidus-assist\OBS\skins\Timeless\skin.json

Solution: Set this to user-grey.svg instead.<pre>
"config": {
"TimelessBackdropImage": {
"value": "user-grey.svg",
"description": "Set it as you would $wgLogo to an appropriate background image. Recommendation is an svg set to 500-750px wide"
},
</pre>With multiple wiki installs, this is onerous. To facilitate changing multiple wiki installs, there is a directory in D:\Assist Install Files\MW-add-files called skins.

To apply:

* Copy the directory skins.
* Navigate to your Assist main folder e.g. D:\xampp\htdocs\calidus-assist\WMS
* Paste - this will overwrite the config file with the corrected one.

{{Warning}}This file is delivered with MediaWiki. A new install will overwrite this file. If you have updated MediaWiki or installed a new version of the Timeless skin, then compare the saved skin.json file with the new one and update with any new/changed attributes.

=== Zero Bytes PDF ===
Problems typically display as the PDF being downloaded is zero bytes or cannot be opened.

The most common issues are with single page PDFs. The normal solutions are:

* For full documents, ensure that there is a heading 1 element in the file being downloaded.
* If you are transcluding pages into a document, there is typically a limit of around 15 transcluded pages before the document will not produce. Instead, consider grouping the pages into a category and extracting that instead of creating a single document.

Some documents will include a <nowiki><div class="noprint"> after the title page and a closing div at the end. This used to be require din older versions of the code, but now causes issues. To fix, remove the div and closing div tags (not the top ones around the vardefines, just the ones after that and at the very end).</nowiki>

=== '?' characters ===
Occasionally, PDFs will be produced with '?' characters in unusual places. This represents and unprintable character in the PDF. Typically, this is because of smart quotes or hyphen characters, usually because text has been pasted in from a Word document that has "helpfully" automatically changes all hyphens, quotes and single quotes into extended characters. The PDF conversion routine does not support these characters at this time. To solve this, edit the page in question and replace the quotes and hyphens with plain equivalents.

=== Unexpected Pages in PDF Books ===
When PDF books are created from Categories, sometimes there are pages included that are not expected.

Most of the time this is caused by inheritance of categories. If a page has a category and this is transcluded into another page, the default is that the page transcluding will inherit the categories listed in the transcluded page.

Check the category list of pages in Assist - usually you will see the offending page, and then the categories can be amended to resolve the issue.

Either remove the categories of the page if it is in the wrong category, or ensure that the categories are surrounded by NOINCLUDE tags. You should use the source editor to do this, as the Visual Editor does not handle this kind of meta data very well.

[[Category:Assist Guides]]
[[Category:ASSIST]]

Category:TEST

2026-02-25T10:35:30Z

Anw: TEST

TEST PAGES

TEST

2026-02-25T10:35:10Z

Anw: TEST

= 325145 Device Audit Log Improvements =

== Requirements ==
* Send the device audit log through a new web service method, rather than through email.
* Request that the device send through the audit log by making a setting on the server.
* Allow configuration of the audit log:
** Per device and default for the system.
** What is to be audited (types of audit log messages).
** Number of records to store on the audit log.
* Admin screen available to OBSL users only, to configure audit logs and request them to be sent (Devices screen).

== Overview of Solution ==
=== Device Audit Log Web Service Method ===
The PDA Audit Log screen will be modified to build a message onto the pending queue, containing all the logged data.

A new message request will be created for this (AUDIT_LOG).

Structure to be defined, but it is assumed this will follow the structure of the existing XF_AUDIT device table.

The server PDA web service will be modified to receive this message and save this to a file in a server-side folder. The folder will be defined as a system web configuration parameter. The name to be confirmed, but will likely comprise:
* "AUDIT_LOG_"
* device_id
* date
* time
* ".XML"

=== Request Device Audit Log ===
The EPOD_DEVICE table will be modified to add the following fields:
* EPD_AUDIT_LOG_REQUESTED_IND - int default 0
* EPD_LAST_AUDIT_LOG_REQUESTED_DATE - int default 0
* EPD_LAST_AUDIT_LOG_REQUESTED_TIME - int default 0
* EPD_LAST_AUDIT_LOG_RECEIVED_DATE - int default 0
* EPD_LAST_AUDIT_LOG_RECEIVED_TIME - int default 0
* EPD_LAST_AUDIT_LOG_RECEIVED - nvarchar(100) NULL

The server PDA web service will be modified to recognise this flag on the following existing web service methods:
* LOGON_REQUEST
* AUTO_UPDATE_REQUEST

The device will be extracted and, if EPD_AUDIT_LOG_REQUESTED_IND is set to 1, the following additional information will be returned on the message:
* EPD_AUDIT_LOG_REQUESTED_IND - int default 0
* EPD_LAST_AUDIT_LOG_REQUESTED_DATE - int default 0
* EPD_LAST_AUDIT_LOG_REQUESTED_TIME - int default 0

Structure to be defined, but it is assumed this will follow the structure of the existing EPOD_DEVICE table.

The device will be modified to check the responses to these messages (including a grace logon) and check the value of the indicator. If the flag is set to 1, the process will check the last requested date and time is different to the last request received. If so, the device will call the same code as the Audit screen i.e. generate a new AUDIT_LOG web service call.

The server PDA web service AUDIT_LOG method will be modified to extract the device from the message and update the following fields:
* EPD_AUDIT_LOG_REQUESTED_IND - set to 0
* EPD_LAST_AUDIT_LOG_RECEIVED_DATE - set to sysdate
* EPD_LAST_AUDIT_LOG_RECEIVED_TIME - set to systime
* EPD_LAST_AUDIT_LOG_RECEIVED - set to the name of the audit log file created.

=== Device Audit Log Configuration ===
{{Note}} This supersedes the Audit Logging configuration on the device.

The EPOD_DEVICE table will be modified to add the following fields:
* EPD_AUDIT_LOGGING_IND - int, default 0
* EPD_AUDIT_LOG_TYPES - nvarchar(MAX) -
* EPD_AUDIT_LOG_LIMIT - int, default 2000

Defaults for the system will be set to be:
* EPD_AUDIT_LOGGING_IND - 0
* EPD_AUDIT_LOG_TYPES - "{}"
* EPD_AUDIT_LOG_LIMIT - 2000

The server PDA web service will be modified for the LOGON_REQUEST method to return the content of the EPD_DEVICE table for the device.

The device will be modified to check the LOGON_RESPONSE message and store the devices flags. The value of EPD_AUDIT_LOG_TYPES will be stored as a JSON object or as a delimited list of areas.

{{Note}} This list of all areas is defined as a list of all calls to logAudit or funLogMessage in the mobile device application.

The device will store the log indicator and limit (EPD_AUDIT_LOGGING_IND and EPD_AUDIT_LOG_LIMIT) as new global variables or system properties.

The device audit logging process (XF_AUDIT) will be modified to use the limit (EPD_AUDIT_LOG_LIMIT) instead of the fixed limit (2000). If the limit has changed, all messages will be removed from the table.

The device logging process will be modified to check whether the area exists in EPD_AUDIT_LOG_TYPES. If so, and audit logging is enabled (EPD_AUDIT_LOGGING_IND = 1), the device will write the debug message to the audit log.

=== Devices Maintenance Screen ===
The EPOD_DEVICE table will be modified to add the following fields:
* EPD_NAME - nvarchar(50)

EPOD_LISTS and EPOD_LIST_ITEMS records will be created with all logging areas.

{{Note}} This list of all areas is defined as a list of all calls to logAudit or funLogMessage in the mobile device application.

A new Devices screen will be created to maintain the device table, including the new logging functionality.

This screen is available to OBSL users only, to configure audit logs and request them to be sent. This screen will not be added to any menus.

This will be created as a new MVC screen. This requires the existing EPOD_DEVICE and EPOD_DEVICE_TYPE DAL classes to be converted to the new models.

The screen will allow work similarly to existing screens, for finding and editing data.

New devices cannot be created from this screen.

The screen will allow searching for devices using the following criteria:
* ''Device ID'' - text box with fuzzy match.
* ''Device Name'' - text box with fuzzy match.
* ''Date Type'' selector, one of:
** ''Last Used''.
** ''Audit Requested''.
** ''Audit Received''.
* ''Date Range'' - a date range from/to, defaulting to the last week.
* ''User'' - textbox.
* ''Site'' - textbox, defaulting to the logged-on site.
* ''Audit Logging'' - a checkbox, defaulting to unchecked.

The results will be displayed in a jQuery datatable-enabled gridview.

The columns will be:
* ''Device ID''.
* ''Device Name''.
* ''Last Used'' (Date/Time).
* ''User''.
* ''Site''.

Clicking on a row will display the actions:
* '''Show Audit Logs''' - optional, allowing showing all logs associated to that device ID. This requires opening a folder on the IIS web server for browsing, like the PDAUpdates folder on the server.
* '''Select'''.

Pressing '''Select''' shows the details of the device:
* ''Device ID'' - read only
* ''Device Name'' - textbox.
* ''Last Used Date/Time'' - read only
* ''User'' - read only
* ''Site'' - read only
* ''Audit Logging'' section:
** ''Last Requested Date/Time'' - read only
** ''Last Received Date/Time'' - read only
** ''Last Audit Log'' - read only
** ''Enable Audit Logging'' - checkbox.
** ''Audit Log Types'' - a multi-select list. This is disabled if audit logging is disabled. This list will be populated from EPOD_LIST_ITEMS for the requisite list.
** '''Request Audit Log''' button - clicking this button enables the EPD_AUDIT_LOG_REQUESTED_IND field. This button is disabled if the indicator is already 1. This button is disabled if audit logging is disabled on the device.

A '''Save''' and '''Cancel''' button will also be provided.
[[Category:TEST]]

Assist - General Usage

2026-02-25T10:07:47Z

Anw: Added preferences

This page is intended to show the available functions and benefits of using an Assist system for documentation.

== What is Assist? ==
Assist is a Wiki, first and foremost.

Each Assist instance contains information, guides, documents and FAQs on the product for which it is intended, plus links to any other product Assist instances that may be relevant.

Assist is '''product''' documentation and guides, as opposed to specific customer usage guides. All customer-specific functionality has been referenced and documented as part of the product. Customer-specific Usage guides are generally the responsibility of the customer to produce, based on the provided product documentation and the solution design document and Statement of Work.

Should any customer wish for their specific documentation to be hosted within Assist, Aptean will review on a case-by-case basis and add as appropriate, so long as specific permission is given for this documentation to be available for all customers.

At this moment, no customer-specific instances of Calidus Assist exist.

== What does Assist Provide? ==
Internally and externally, Assist provides:
* Web-accessible help direct to customers.
* Web-accessible help per page, which can be linked to from our applications.
** [[Assist Help Config in Other Systems]]
* Ability to download any guide in Aptean formatted PDF document.
* Faster, more accurate and appropriate searching of functionality (compared to hosted documents).
* Historical access to previous versions of pages and images.
* Image repository - View and download any file.

Internally, Assist also provides:
* A central hub of ideas, technical assistance guides, release notes and other internal documentation, to aid in sharing.
* Reusable screen shots and screen descriptions.
* Categorization of pages together, both for navigation purposes and producing documents from the categories.
* Transclusion - the text from any page can be pulled directly into any other page through transclusion. This promotes "write once, write everywhere" sensibilities and reduces duplication of effort and increases the likelihood that all pages are up to date with the latest functionality.
* Templates - promoting a similar look and feel to all documents, templates can be used to ensure that documents look like Aptean documents, that warnings and informational noted look the same, etc. This improves readability for the end users.
* Assistance creating new pages using templates
** [[Help:CreateNewPage]]
** [[Creating an ER]]

== Features ==
* Technical
** Latest security patched Apache, MariaDB and PHP installations.
** Latest security patched MediaWiki installations.
** Enhanced security of edits through CAPTCHA.
* Maintenance
** Easy upgrade path in the future to maintained LTS MediaWiki releases.
** Batch Editing/Replacement - through Extension:Nuke/Extension:ReplaceText
*** [[Assist Global Replace]]
** Code syntax and error highlighting - through Extension:CodeEditor/Extension:SyntaxHighlight
** Email/2FA account registration
** Easier page/document creation - through Extension:InputBox
** Batch upload of images, easing creation of new pages - through Extension:SimpleBatchUpload.
*** [[Assist Editing Guide]]
* QoL
** Improved editor
*** [[Assist Editing Guide]]
*** On-line preview - through Extension:WikiEditor
*** Template inserting - through Extension:TemplateWizard and Extension:TemplateData
*** Visual Editor - through Extension:VisualEditor and Extension:Gadgets
*** Visual Differences in edits and history - through Extension:VisualEditor
** Easier category navigation - through Extension:CategoryTree
** Clean, modern layout, compatible with Mobile - through Timeless/Vector skin
** Searching of tables - through bespoke code
*** [[#Searching]]
** Exporting to PDF in Aptean format- through Extension:PdfBook
*** [[#Printing and Exporting]]
** Online translation of pages to multiple languages - through Extension:GoogleTranslator
*** [[#Translation]]
** "Peek" at linked pages by hovering over the link. Incudes an appropriate thumbnail picture if there is one - through Extension:Popups

Note thar all extensions mentioned above are properly attributed to their authors, visible through the Assist's special page "Special:Version". See section [[Assist - General Usage#Special Pages|Special Pages]] below.

== Accessing the Systems ==
Assists are accessed through a globally-available link <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/{system}</nowiki>, such as:

https://calidusassist.adcservices.apteancloud.com/calidus-assist/OBS - this Calidus HUB.

There is a landing page available with links to each Assist here:

https://calidusassist.adcservices.apteancloud.com/calidus-assist/

The available systems are:

* ''CALIDUS'' TMS
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS
* ''CALIDUS'' Total Logistics TMS
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/CTL-TMS
* ''CALIDUS'' ePOD
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/EPOD
* ''CALIDUS'' Portal
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/Portal
* ''CALIDUS'' Vision (V1)
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/Vision
* ''CALIDUS'' WCS
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/WCS
* ''CALIDUS'' WMS,
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/WMS
* ''CALIDUS'' MCS
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/MCS

You can access the systems through any internet connected device - the layout by default conforms to the best use of your screen size, for example:<center>[[File:ASSIST-UI-PC.png|none|thumb|800x800px|Browser UI]]</center>

<center>[[File:ASSIST-UI-Tab-Landscape.png|none|thumb|800x800px|Assist UI Tablet Landscape]]</center>

<center><gallery widths="260" heights="600" perrow="3">
File:ASSIST-UI-Tab-Portrait.png|Assist UI Tablet Portrait
File:ASSIST-UI-iPhone.png|Assist UI iPhone
File:ASSIST-UI-Android-Long.png|Assist UI Android (Long)
</gallery></center>

== Logging In ==
You don't need to log in to view pages on Assist, only if you want to edit them.

If you do, click the ''Anonymous'' drop-down on the title, where you have the option to log in.

If you've forgotten your password, you can reset it here using your username or your email - this will only work if your email is associated to your user.

You should change your user page within Assist to list your contact details (email and phone number) so that other users can easily contact you.

If this is your first time logging on, your preferences should be set up automatically and should not need changing.

However, the following is a brief guide to what should be set and how to get to them:

Click your user name in the header

Select ''Preferences'' - you will be taken to the main preferences page.

* ''User Profile'' tab:
** ''Email options'':
*** Email should be set to your Aptean email - if not, contact the maintainers.
*** Checked - Allow other users to email me.
*** Checked - Allow emails from brand-new users.
*** Unchecked - Send me copies of emails I send to other users.
*** Checked - Email me when a page or a file on my watchlist has changed.
*** Checked - Email me when my user talk page has changed.
*** Unchecked - Email me also for minor edits of pages and files.
* ''Appearance'' tab:
** Skin - set to Timeless.
** Skin preferences - all ticked.
** Reading preferences - all ticked.
* ''Editing'' tab:
** Unchecked - Mark all edits as minor by default.
** Checked - Prompt me when entering a blank edit summary (or the default undo summary).
** Checked - Warn me when I leave an edit page with unsaved changes.
** Unchecked - Temporarily disable the visual editor while it is in beta.
** Checked - Enable the editing toolbar.
* ''Watchlist'' tab:
** Everything unchecked except Expand Watchlist.
* ''Gadgets'' tab:
** Everything checked.

== Reading ==
Each page is typically linked to from lots of different areas:

* From the main page you will generally find links to everything in the system.
* You can search for pages using the search bar - see [[Assist - General Usage#Searching|Searching]] below.
* You can browse pages through categories - see [[Assist - General Usage#Categories|Categories]] below.
* Through lists of pages on categories - see [[Assist - General Usage#Special Pages|Special Pages]] below.
* You can move to other pages through embedded links on a page.

When there is a link to another page, you can hover your mouse over it and the system will display a quick summary and an image to give you a flavour of the content before you click it. Not all links can display like this, but most do, and it's useful to get a preview of the contents of a link before you click into it.

== Contacting other users ==
You can contact other users, including the admin of the system, using the user's talk pages.

You might find a user through page change history or through the users list. Once you click on the user, you will be taken to their personal page.

You can add to a user's talk page by clicking on their name and clicking the Discussion tab. They will be notified through email that their page has been edited.

You can email a user directly from user's page, using the ''Page Tools'' section, ''Email this user''.

{{Note}}You can only do this when you are logged in!

== Searching ==
Although all pages from your ''CALIDUS'' system link directly to the appropriate page in this ''CALIDUS'' Assist guide, you can search for help on anything in the system using the search bar. It depends on how you have ''CALIDUS'' Assist configured, but this search bar is normally either in the title at the top of the screen or in the toolbar on the left.

Did you know that you can activate this search at any time using a shortcut key combination? Hover over the Search bar now and you will see it tells you the hot-key combination, typically ALT-F or ALT-SHIFT-F. Hitting those keys together will activate the search box and you can type in what you're looking for. Be aware that these shortcuts are dependent on the browser that you are using, so check for compatibility first.

If you know the name of the page, just type it there and click the '''Go''' button. If you want to search for any text in the page, click the '''Search''' button instead, or just hit enter for ''CALIDUS'' Assist to do it for you. Typically, as you type, the search bar will quickly offer you some matches that might be what you're looking for - if it is, just click the suggestion and Assist will take you there.

Some tips on searching:

* If you enter multiple words (like "fixed drop scheduling") without quotes, the search routine will find you pages that match any of the words, but ordered in the most likely order (i.e. with most matches of most words)
* If there is a page called "fixed drop scheduling", you will be taken straight to it.
* If you enter your search with quotes i.e. "fixed drop scheduling", it will find that specific phrase in the pages, rather than any of the words.
* If you enter plus instead of space i.e. fixed+drop+scheduling, you will only get pages in the results that have all 3 words in them, anywhere in the page, in any order.
* You can also control partial word matching with as asterisk. So let's say you are searching for a parameter called AUTO_SCHED something-or-other. Searching for AUTO_SCHED will not bring back any results, as there are no full words or phrases like that. But if you enter AUTO_SCHED_* instead, it will search for words ''starting with'' "AUTO_SCHED" and bring you back some matches.

== Searching Tables ==
A lot of the pages have tables of data on them - this can be a bit difficult to see what you're after. So, in the cases where there is a large amount of data in tables, we have made the tables searchable.

On top of the table will be a ''Search'' entry box. Type in what you're looking for and the table will be filtered to show all of the matching rows - that is, rows where any column contains that text at all, anywhere. This filters as you type.

Note that some data will be always be shown, like headers, or rows that the writers of the page have decided must always be shown.

You can clear the text out of the ''Search'' box and this will display everything again - do this by either deleting it or use the provided clear ('''X''') button to the right of the ''Search'' box.

Have a go below - maybe try entering "ap", then "app", or enter "fruit" and see the way it works.

{| class="wikitable apt-searchable" id="dyk-search-table"
|-
! Fruit !! Some Text - this header row is always shown
|-
| Apple || Green apples
|-
| Orange || Not an apple
|-
| Pineapple || Also not
|-
| Grapefruit || Very big!
|- class="non-searchable"
| Banana || I like bananas, so I'm always going to show them
|-
| Kumquat || Interesting fruit
|-
| Grape || Small fruit
|-
| Tomato || Is this a fruit or a vegetable?
|}

== Categories ==
Pages are typically categorised into groups, either for commonality or in a lot of cases so you can print all of the pages as a PDF book.

From a page, you can see categories in the Categories list and click on them to see all pages in that category.

You can also see all categories from the Categories or Category Tree [[Assist - General Usage#Special Pages|special pages]].

{{Note}} Category editing is a <span style="color: black; text-shadow: 0 0 2px red, 0 0 10px #600; font: 900 2rem serif; ">DARK ART</span> but necessary - see the [[Assist Editing Guide]] for more details.

== Image Repository ==
The Wiki acts as an image repository for all. This is especially useful to sales teams both internal and external, as images can be clicked, zoomed in and downloaded for your own use.

== Historical Version Access ==
Wikis always keep a history of all changes made to a page, along with a commentary as to why this change was made. You can access this with the History tool. This allows you to see previous versions, check the authors, query with the correct people, etc, which ensures much more accurate documentation.

Note that you can also access historical versions of images when clicking the image. You can view and download these historical versions.

== Seeing Links ==
Beyond just categories that have been set by the authors, you can also see what links to a particular page (and therefore more related information about that page) by clicking the ''What Links Here'' page tool.

This will show you all the times the page is used and what a page uses. Some definitions:
* ''Links'' - the listed page has a link that you can follow to this page.
* ''Redirect'' - a page with a different name forwards directly to this page. This could be another title to the page, or a screen ID.
* ''Transclusion'' - the page in question includes all of the text on this directly in itself. Any change to this transcluded page will reflect in the other page.

You can also click the ''Page Information'' tool to see what this page uses itself (i.e. pages that this page transcludes).

You can see both what links from and to, in transcluded by and transcludes this page and the history of changes to each of the related pages by using the ''Related Changes'' tool.

== Special Pages ==
You can access a lot of special pages from the ''Wiki Tools/Special Pages'' menu. Of interest are:

* Lists of pages
** All pages - see and search the titles of all pages.
** Categories - see and search the titles of all categories.
** Category tree - see and browse through a tree of all categories.
** Search - search for pages or content, with many more advanced features than the simple search bar at the top of the page.
* Users and rights
** Active users list - any active users.
** Change or remove email address
** Preferences
** Reset password
** User contributions - showing edits by specified users.
** User list - a list of all users on the system.
* Recent changes and logs
** Gallery of new files
** New pages
** Recent changes
** Watchlist - your watchlist of pages.
* Media reports and uploads
** File list - a searchable list of all media (images etc)
* Data and tools
** Version - system component versions and software attributions

== Translation ==
Aptean do not maintain translated Assist help pages. However, the toolbox contains a link to Google Translate to translate the page into a language of your choice. Select the language from the drop-down list, and Google will translate the whole page for you.

You can remove the translation by closing the Translate toolbar at the top of the screen.

== Printing and Exporting ==
You can export pages from ''CALIDUS'' Assist using the ''Print as PDF'' or ''Download as PDF'' link. Where this appears depends on the style the Assist is configured with, but by default this link will be in the ''Toolbox'' menu on the left of the screen, or on the tabs at the top right of the screen.

You can export categories as a full document in the same way - all pages in that category will be included in the PDF in the order in which they are listed in the category.

We've typically also included a link in the description of categories where this will export as a document, and we also add the {{DocLink|Did You Know}}button next to documents that you can download from the first page of Assist.

<noinclude>
[[Category:Assist Guides]]
[[Category:ASSIST]]
</noinclude>

Assist - General Usage

2026-02-25T09:14:08Z

Anw: Minor formatting change

This page is intended to show the available functions and benefits of using an Assist system for documentation.

== What is Assist? ==
Assist is a Wiki, first and foremost.

Each Assist instance contains information, guides, documents and FAQs on the product for which it is intended, plus links to any other product Assist instances that may be relevant.

Assist is '''product''' documentation and guides, as opposed to specific customer usage guides. All customer-specific functionality has been referenced and documented as part of the product. Customer-specific Usage guides are generally the responsibility of the customer to produce, based on the provided product documentation and the solution design document and Statement of Work.

Should any customer wish for their specific documentation to be hosted within Assist, Aptean will review on a case-by-case basis and add as appropriate, so long as specific permission is given for this documentation to be available for all customers.

At this moment, no customer-specific instances of Calidus Assist exist.

== What does Assist Provide? ==
Internally and externally, Assist provides:
* Web-accessible help direct to customers.
* Web-accessible help per page, which can be linked to from our applications.
** [[Assist Help Config in Other Systems]]
* Ability to download any guide in Aptean formatted PDF document.
* Faster, more accurate and appropriate searching of functionality (compared to hosted documents).
* Historical access to previous versions of pages and images.
* Image repository - View and download any file.

Internally, Assist also provides:
* A central hub of ideas, technical assistance guides, release notes and other internal documentation, to aid in sharing.
* Reusable screen shots and screen descriptions.
* Categorization of pages together, both for navigation purposes and producing documents from the categories.
* Transclusion - the text from any page can be pulled directly into any other page through transclusion. This promotes "write once, write everywhere" sensibilities and reduces duplication of effort and increases the likelihood that all pages are up to date with the latest functionality.
* Templates - promoting a similar look and feel to all documents, templates can be used to ensure that documents look like Aptean documents, that warnings and informational noted look the same, etc. This improves readability for the end users.
* Assistance creating new pages using templates
** [[Help:CreateNewPage]]
** [[Creating an ER]]

== Features ==
* Technical
** Latest security patched Apache, MariaDB and PHP installations.
** Latest security patched MediaWiki installations.
** Enhanced security of edits through CAPTCHA.
* Maintenance
** Easy upgrade path in the future to maintained LTS MediaWiki releases.
** Batch Editing/Replacement - through Extension:Nuke/Extension:ReplaceText
*** [[Assist Global Replace]]
** Code syntax and error highlighting - through Extension:CodeEditor/Extension:SyntaxHighlight
** Email/2FA account registration
** Easier page/document creation - through Extension:InputBox
** Batch upload of images, easing creation of new pages - through Extension:SimpleBatchUpload.
*** [[Assist Editing Guide]]
* QoL
** Improved editor
*** [[Assist Editing Guide]]
*** On-line preview - through Extension:WikiEditor
*** Template inserting - through Extension:TemplateWizard and Extension:TemplateData
*** Visual Editor - through Extension:VisualEditor and Extension:Gadgets
*** Visual Differences in edits and history - through Extension:VisualEditor
** Easier category navigation - through Extension:CategoryTree
** Clean, modern layout, compatible with Mobile - through Timeless/Vector skin
** Searching of tables - through bespoke code
*** [[#Searching]]
** Exporting to PDF in Aptean format- through Extension:PdfBook
*** [[#Printing and Exporting]]
** Online translation of pages to multiple languages - through Extension:GoogleTranslator
*** [[#Translation]]
** "Peek" at linked pages by hovering over the link. Incudes an appropriate thumbnail picture if there is one - through Extension:Popups

Note thar all extensions mentioned above are properly attributed to their authors, visible through the Assist's special page "Special:Version". See section [[Assist - General Usage#Special Pages|Special Pages]] below.

== Accessing the Systems ==
Assists are accessed through a globally-available link <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/{system}</nowiki>, such as:

https://calidusassist.adcservices.apteancloud.com/calidus-assist/OBS - this Calidus HUB.

There is a landing page available with links to each Assist here:

https://calidusassist.adcservices.apteancloud.com/calidus-assist/

The available systems are:

* ''CALIDUS'' TMS
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS
* ''CALIDUS'' Total Logistics TMS
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/CTL-TMS
* ''CALIDUS'' ePOD
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/EPOD
* ''CALIDUS'' Portal
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/Portal
* ''CALIDUS'' Vision (V1)
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/Vision
* ''CALIDUS'' WCS
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/WCS
* ''CALIDUS'' WMS,
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/WMS
* ''CALIDUS'' MCS
** https://calidusassist.adcservices.apteancloud.com/calidus-assist/MCS

You can access the systems through any internet connected device - the layout by default conforms to the best use of your screen size, for example:<center>[[File:ASSIST-UI-PC.png|none|thumb|800x800px|Browser UI]]</center>

<center>[[File:ASSIST-UI-Tab-Landscape.png|none|thumb|800x800px|Assist UI Tablet Landscape]]</center>

<center><gallery widths="260" heights="600" perrow="3">
File:ASSIST-UI-Tab-Portrait.png|Assist UI Tablet Portrait
File:ASSIST-UI-iPhone.png|Assist UI iPhone
File:ASSIST-UI-Android-Long.png|Assist UI Android (Long)
</gallery></center>

== Logging In ==
You don't need to log in to view pages on Assist, only if you want to edit them.

If you do, click the ''Anonymous'' drop-down on the title, where you have the option to log in.

If you've forgotten your password, you can reset it here using your username or your email - this will only work if your email is associated to your user.

You should change your user page within Assist to list your contact details (email and phone number) so that other users can easily contact you.

== Reading ==
Each page is typically linked to from lots of different areas:

* From the main page you will generally find links to everything in the system.
* You can search for pages using the search bar - see [[Assist - General Usage#Searching|Searching]] below.
* You can browse pages through categories - see [[Assist - General Usage#Categories|Categories]] below.
* Through lists of pages on categories - see [[Assist - General Usage#Special Pages|Special Pages]] below.
* You can move to other pages through embedded links on a page.

When there is a link to another page, you can hover your mouse over it and the system will display a quick summary and an image to give you a flavour of the content before you click it. Not all links can display like this, but most do, and it's useful to get a preview of the contents of a link before you click into it.

== Contacting other users ==
You can contact other users, including the admin of the system, using the user's talk pages.

You might find a user through page change history or through the users list. Once you click on the user, you will be taken to their personal page.

You can add to a user's talk page by clicking on their name and clicking the Discussion tab. They will be notified through email that their page has been edited.

You can email a user directly from user's page, using the ''Page Tools'' section, ''Email this user''.

{{Note}}You can only do this when you are logged in!

== Searching ==
Although all pages from your ''CALIDUS'' system link directly to the appropriate page in this ''CALIDUS'' Assist guide, you can search for help on anything in the system using the search bar. It depends on how you have ''CALIDUS'' Assist configured, but this search bar is normally either in the title at the top of the screen or in the toolbar on the left.

Did you know that you can activate this search at any time using a shortcut key combination? Hover over the Search bar now and you will see it tells you the hot-key combination, typically ALT-F or ALT-SHIFT-F. Hitting those keys together will activate the search box and you can type in what you're looking for. Be aware that these shortcuts are dependent on the browser that you are using, so check for compatibility first.

If you know the name of the page, just type it there and click the '''Go''' button. If you want to search for any text in the page, click the '''Search''' button instead, or just hit enter for ''CALIDUS'' Assist to do it for you. Typically, as you type, the search bar will quickly offer you some matches that might be what you're looking for - if it is, just click the suggestion and Assist will take you there.

Some tips on searching:

* If you enter multiple words (like "fixed drop scheduling") without quotes, the search routine will find you pages that match any of the words, but ordered in the most likely order (i.e. with most matches of most words)
* If there is a page called "fixed drop scheduling", you will be taken straight to it.
* If you enter your search with quotes i.e. "fixed drop scheduling", it will find that specific phrase in the pages, rather than any of the words.
* If you enter plus instead of space i.e. fixed+drop+scheduling, you will only get pages in the results that have all 3 words in them, anywhere in the page, in any order.
* You can also control partial word matching with as asterisk. So let's say you are searching for a parameter called AUTO_SCHED something-or-other. Searching for AUTO_SCHED will not bring back any results, as there are no full words or phrases like that. But if you enter AUTO_SCHED_* instead, it will search for words ''starting with'' "AUTO_SCHED" and bring you back some matches.

== Searching Tables ==
A lot of the pages have tables of data on them - this can be a bit difficult to see what you're after. So, in the cases where there is a large amount of data in tables, we have made the tables searchable.

On top of the table will be a ''Search'' entry box. Type in what you're looking for and the table will be filtered to show all of the matching rows - that is, rows where any column contains that text at all, anywhere. This filters as you type.

Note that some data will be always be shown, like headers, or rows that the writers of the page have decided must always be shown.

You can clear the text out of the ''Search'' box and this will display everything again - do this by either deleting it or use the provided clear ('''X''') button to the right of the ''Search'' box.

Have a go below - maybe try entering "ap", then "app", or enter "fruit" and see the way it works.

{| class="wikitable apt-searchable" id="dyk-search-table"
|-
! Fruit !! Some Text - this header row is always shown
|-
| Apple || Green apples
|-
| Orange || Not an apple
|-
| Pineapple || Also not
|-
| Grapefruit || Very big!
|- class="non-searchable"
| Banana || I like bananas, so I'm always going to show them
|-
| Kumquat || Interesting fruit
|-
| Grape || Small fruit
|-
| Tomato || Is this a fruit or a vegetable?
|}

== Categories ==
Pages are typically categorised into groups, either for commonality or in a lot of cases so you can print all of the pages as a PDF book.

From a page, you can see categories in the Categories list and click on them to see all pages in that category.

You can also see all categories from the Categories or Category Tree [[Assist - General Usage#Special Pages|special pages]].

{{Note}} Category editing is a
<span style="color: black; text-shadow: 0 0 2px red, 0 0 10px #600; font: 900 2rem serif; ">DARK ART</span> but necessary.

== Image Repository ==
The Wiki acts as an image repository for all. This is especially useful to sales teams both internal and external, as images can be clicked, zoomed in and downloaded for your own use.

== Historical Version Access ==
Wikis always keep a history of all changes made to a page, along with a commentary as to why this change was made. You can access this with the History tool. This allows you to see previous versions, check the authors, query with the correct people, etc, which ensures much more accurate documentation.

Note that you can also access historical versions of images when clicking the image. You can view and download these historical versions.

== Seeing Links ==
Beyond just categories that have been set by the authors, you can also see what links to a particular page (and therefore more related information about that page) by clicking the ''What Links Here'' page tool.

This will show you all the times the page is used and what a page uses. Some definitions:
* ''Links'' - the listed page has a link that you can follow to this page.
* ''Redirect'' - a page with a different name forwards directly to this page. This could be another title to the page, or a screen ID.
* ''Transclusion'' - the page in question includes all of the text on this directly in itself. Any change to this transcluded page will reflect in the other page.

You can also click the ''Page Information'' tool to see what this page uses itself (i.e. pages that this page transcludes).

You can see both what links from and to, in transcluded by and transcludes this page and the history of changes to each of the related pages by using the ''Related Changes'' tool.

== Special Pages ==
You can access a lot of special pages from the ''Wiki Tools/Special Pages'' menu. Of interest are:

* Lists of pages
** All pages - see and search the titles of all pages.
** Categories - see and search the titles of all categories.
** Category tree - see and browse through a tree of all categories.
** Search - search for pages or content, with many more advanced features than the simple search bar at the top of the page.
* Users and rights
** Active users list - any active users.
** Change or remove email address
** Preferences
** Reset password
** User contributions - showing edits by specified users.
** User list - a list of all users on the system.
* Recent changes and logs
** Gallery of new files
** New pages
** Recent changes
** Watchlist - your watchlist of pages.
* Media reports and uploads
** File list - a searchable list of all media (images etc)
* Data and tools
** Version - system component versions and software attributions

== Translation ==
Aptean do not maintain translated Assist help pages. However, the toolbox contains a link to Google Translate to translate the page into a language of your choice. Select the language from the drop-down list, and Google will translate the whole page for you.

You can remove the translation by closing the Translate toolbar at the top of the screen.

== Printing and Exporting ==
You can export pages from ''CALIDUS'' Assist using the ''Print as PDF'' or ''Download as PDF'' link. Where this appears depends on the style the Assist is configured with, but by default this link will be in the ''Toolbox'' menu on the left of the screen, or on the tabs at the top right of the screen.

You can export categories as a full document in the same way - all pages in that category will be included in the PDF in the order in which they are listed in the category.

We've typically also included a link in the description of categories where this will export as a document, and we also add the {{DocLink|Did You Know}}button next to documents that you can download from the first page of Assist.

<noinclude>
[[Category:Assist Guides]]
[[Category:ASSIST]]
</noinclude>

Process - Using Office Templates

2026-02-25T09:01:06Z

Anw: Minor correction

This page ins intended to help with the process of using Office Document Templates, with specific instructions on BRD, EST and COST sheet templates.

== Files ==

* Templates - document templates
** Standard Aptean Templates - you should check for updates on Sharepoint - these may be old. Check
*** https://apteanonline.sharepoint.com/teams/ProfessionalServices/Shared%20Documents/Forms/AllItems.aspx?id=%2Fteams%2FProfessionalServices%2FShared%20Documents%2FPS%20Toolkits%20and%20Templates&viewid=16bf487a%2Db518%2D4d9b%2D9e56%2Dec08d613223e&csf=1&web=1&e=VsnbKf&CID=e87578dc%2D9fcb%2D43b5%2D9d17%2D37f54e85a09b&FolderCTID=0x012000A28CE6AA0953C14D8AF48281AB3DDE58
*** Aptean PS General Schedule to SOW Template 2023.dotx
*** Aptean Workshop Session Agendas TEMPLATE.docx
*** Aptean Engagement Report TEMPLATE.docx
** BRD SFNumber Client v0.02.xltx - capturing business requirements from notes fragments, cross-referencing to create SCRs for a full project,
** Calidus Network Diagram Template.vstx - Technical Architecture Diagram Visio Template
** Client_BugList Analysis.xltx - referenced in "Process - Reporting Rework Faults" - paste in DevOps extracted bugs here, get reported stats.
** COST-SFNumber Client Cost Sheet v1.07.xltx - cost sheet for full system implementations/new projects.
** DEVLOG-SFNumber-ClientCode-Development & Implementation Issues List.xltx - a template for a spreadsheet to capture UAT issues and feed back from DevOps.
** EST-CaseNo-Desc v0.01.dotx - estimate document template
** EST-SFNumber Client Description v1.02.xltx - estimate spreadsheet in hours and days, calculating based on parameters.
** FS-CaseNo-Desc v0.01.dotx - FS template. Also in Assist
** POT-SFNumber Description v1.1.dotx - Proof of Testing Template
** Release Note Template Aptean POD - Calidus Edition v4.x.xx.xx.dotx - Release Notes - use Assist template instead.
** SCR-CaseNo-Desc v0.1.dotx - Small Change Request template - also in Assist.
** Screen Templates.xls - a spreadsheet to help design oracle forms/new .NET screens
** SDD-CaseNo-Desc v0.01.dotx - Solution Design/Requirements template. Also in Assist.
** SOW-SFOppNo-Desc v0.02.dotx - Statement of Work - see notes above for validity.
** SUP-Cust-Desc v0.01.dotx - handover to support document template.
** TP-CaseNo-Desc v0.01.dotx - Test Plan template
** Unlikely to ever be of use to anyone:
*** BPA-CaseNo-Desc Agenda v0.01.dotx - Elucid agenda template.

== Notes on Templates ==

=== Using Office Templates ===

Note that templates do not open natively in Teams - you have to download them to use them.

They are double-clicked on, then the appropriate office app will create a copy and open up that copy.

You can then save that as the new document you want to create WITHOUT affecting the template on which it is based.

In summary:

* Download the template.
* Double-click on it.

If you want to edit the template, first open your office app (e.g. Word or Excel), then open the template. Any change you make and save will be saved to the template, and then any NEW documents created from that template will have your changes. This will not affect any documents already created.

{{Note}}Be kind - upload your modification back to Teams as a new version - maintain the templates for everyone.

=== Using the EST template Spreadsheet ===

For a one-off estimate and SOW. See later for how to use to hold technical notes for many related estimates in a BRD or Cost Sheet.

* ''Calc'' tab
** Enter the Customer and Rates year e.g. NHSBT, 2025. The rates for the sheet will populate below, if they have been set up - see Rates tab.
** Fill in the yellow fields. Everything else will calculate based on settings. See Rates tab..
** Fields in yellow highlight are designed for you to enter data.
*** REQ is time you have taken so far on the scoping.
*** EST is the time taken estimating, talking to R&D, etc.
*** REL costs should be 0.5d or 4 hours per system affected.
*** IMP costs should be the amount of time to run additional scripts, set up the data for the customer, any agreed post-implementation consultancy time required.
** You can then copy the Cost Detail section for pasting into an Estimate, or the lower table for pasting into an SOW.
* ''Notes'' tab
** Keep a note of all your discussions, and also your prosed technical solution notes here.
** Ensure that System, Lang and Est columns are populated where required. Area is for your own notes.
** The table will total your estimates at the bottom.
** The sheet will calculate percentages by language and system - you may need to refresh the data source or tables to make this happed. Easiest is to select the Data tab menu at the top, and click Refresh All.
* ''Rates'' tab
** You should enter the customer, year, activity, day rate and currency here if not present. Contact your manager/PM for the relevant rates. You should amend the template with the new rates, so you don't have to do this every time. Remember rates change every year. Hourly rates will automatically calculate.
** Settings show how the Calc tab calculates the rest of the settings.
*** FS/ST/CON/PM - percentage of DEV to apply to calculate these figures in the sheet.
*** Rounding - how closely to round. - 0.25 or 0.1 Leave as s.
*** Hours per day - uses this to calculate the dev activity costs, but also the rates. Leave as is.
*** Contingency - be led by your PM. Assume 10 or 20% uplift as required.

Notes:

* If a change is complicated, I always include a contingency line in the notes, adding a little more to the estimate on top of any global contingency added to the estimate by the calculations. This is to account for something difficult taking longer than expected. Be led by R&D advice for this.

=== Using the BRD template ===

The purpose is to help the process of taking notes and translating them to changes when doing a larger analysis.

It's also a working document to refine and capture multiple meetings and notes, all the way through to fully-qualified and quantified SCRs.

* ''Notes'' tab.
** You will have taken notes - give them a reference (e.g. TW/20251211-1) and enter this and a brief description in the Refs tab. Refer to any supporting docs in this note like the ER(s) you gene rated the notes from.
** Enter your notes here in the Description column. Break them down to small pieces/statements, in general the smaller the better.
** Then for each note, categorise by Area. Note if more complicated than this, add a column for sub-area.
** Add a section title - Number those sections by logical area.
*** Use two decimal places for IDs. For WMS that might be
*** 1.00 - General Information
*** 2.00 - Config
*** 3.00 - Receipt
*** 4.00 - Putaway
*** 5.00 - Movements
*** 6.00 - Stock Take
*** 7.00 - Orders
*** 8.00 - Picking
*** etc.
** Make sure every note is then ID'd under the section e.g. 1.01, 1.02, etc. This will be useful later.
** Mark every note you have entered has Source column marked with the Ref for that meeting note. Maintain the refs on the ''Refs'' tab with a code, document name and description.
** Mark every note as to which System this applies to (WMS, PORTAL, WCS, etc) in the System column.
** If a note refers to or expands on a previous note line, use XREF to show the note to which this cross-references. Don't just type in the ID, type in "=" then select the ID field of the note you are cross-referencing.
** Do this for all your meetings and notes, from as many people who provide them to you.
** Now use SCR column to decide whether you think this may be a change. Y, N, ? (unsure). The column will colour code, so anything red/yellow is something you have to deal with.
** Enter any clarifications you want with the customer in the Notes column.
** Run through and MoSCoW each change. By convention:
*** M(ust) - critical to do, phase 1.
*** S(hould) - will be included in the estimates phase 1
*** C(ould) - will not be included phase 1, could do it later. Will highlight yellow
*** W(ould) - will not be done. Will highlight yellow
*** ? - Unsure. Will highlight yellow
* ''SCRs'' tab.
** Now go through each note you have marked as SCR = "Y" or "?". Basically, if you need an SCR, add it to the list in this SCRs tab.
** Enter the SCR number.
*** By convention, anything chargeable to the customer starts at 01, anything that might be implementation or product dev starts at 99 and counts down.
*** By convention, if you want to split an SCR into smaller components (perhaps for multiple systems development, add an A, B, C etc to the end).
** Cross-ref the IDs in the BR (optional)
** Enter System, Area, Sub-area and a short description.
** Categorise however you like, but expect that PROD would be product development, you might use this for phases, or leave blank and work with it later. Basically it's usually a good column to sort and format stuff later. Consider adding conditional formatting on NA to make it red and strikethrough, adding why this change is no longer applicable in the Notes column.
** Enter a basic Hours or Days (whatever your favoured convention is here). Don't get too bogged down in details just yet - this is t-shirt sizing at this time (2/5/10/25, etc). The total column will calculate for you based on some basic uplift settings in the Summary sheet.
** Hide the following columns initially - they are only used when we start to make further refinements later with the customer
*** Initially provisioned
*** Expected
*** Delta
*** Delta Notes
** Use the cross-referenced BR ID to get more information.
** Paste any tech or clarification notes into the Notes column.
** When the SCR is created, enter that in the SCR column in the ''Notes'' sheet. Again, use "=" and then select the ID column on the SCR tab to get it as an updating cross-reference - if you change SCR numbers later, the references will update on the prior sheet and vice versa. Enter that ID against every BR note that the SCR could reference. Extremely useful for discussions later.
* ''Summary'' sheet
** Maintain the uplifts here, similar to the EST sheet.
** You also have summary stats of changes/days per category, very useful for phasing, e.g.

Now you have a list of SCRs and t-shirt sizes, ballpark costings and criticality to start discussing with the customer.

As discussions go on, more notes can be generated - follow the same process to put them in the BR sheet. Amend any SCRs.

When SCRs have been initially discussed and categorised, the customer will likely want you to firm up the estimates.

Use the SCR numbers and fully cross referenced notes you have to put together discussion notes for use with R&D.

The best way to go about this is to use a variant of the EST sheet above.

You may also move forward from this point by creating a change document, SOW or SDD. In any case, you can use this sheet to keep track of where you are up to in documenting and ensuring all requirements are met.

* ''Notes'' tab:
** Resolved % - has this been resolved 100% by the SCRs?
** Section - what section is this populating the final doc (number, text or just a Y to say you've included it/copied the descriptive text into the final doc.)
* ''SCRs'' tab:
** Doc - have you added this into the final doc or created a doc for it - y.

=== Using the EST template for multiple SCRs. ===

We will use the sheet as before, but now we will make a copy of Cost tab and call it SCR-01.

We will then use this to collate discussion notes from the BRD into this tab.

We will do this for each SCR.

We will either estimate ourselves and make technical notes, or we will discuss with R&D and make technical notes in here, deciding on the cost for each line, if any.

Then we can use the total to revise/refine the days back in the BRD.

We should also fill in the EST sheet in exactly the same way as before, including release and imp totals - although these are not used right now, these may be useful later if the customer chooses to break these SCRs down into other phases, or do SCRs singly.

=== Using the Cost Sheet Template. ===

This can be used right from the start as a full project cost sheet, or can be used after the stages above to start to pull together full project costs.

note that, due to rounding, a fully qualified BRD list of SCRs will probably not exactly match the costs in a cost sheet - agree with the PM which is the cost mechanism and use accordingly. It's up the PM to manage this with the customer.

Note also that this template includes some of the tabs from the BRD template (Notes, References) - if not going from BRD initially, you can use the same process here on these tabs to do a similar process of creating notes and cross-referencing SCRs, but this time the cross-referenced SCRs go in the Configuration and Development Tab.

* ''Profile'' tab
** Enter the olive columns. Specifically:
** Enter your rates.
** "Fixed Cost" will apply an uplift like the Estimate sheet.
** "Inc Optional" will include phase 1 and optional (phase X) changes in the total costs produced. Typically "No".
** "Full Project" - applies system testing rates, typically the same as unit testing for all the changes, in the C&D tab. Typically "Yes".
** "Hourly" - hourly rather than daily estimates - typically "Yes"
** Enter the total sites and users for each Calidus product - this is typically used by the team producing SOWs to determine licence costs.
** The rest of the sections should be populated if we don't have format RFQ information (which we should reference in the RFQ tab) or SDD/BRD notes (which should be referenced here or in other documents.)
* ''Assumptions & Comments'' tab - typically this is a restatement of general SOW comments. But you can add specifics here that the SOW team will use to help qualify the SOW.
* ''Configuration and Development'' tab
** You will determine before or during this process a list of SCRs that you want to develop as part of this project, either now, pre-known requests from the customer, or from a BRD or BRD-style process. Enter them in the Configuration and Developments tab in a similar way to the BRD process above.
*** Phases can be shown in the Phase 1 and Optional changes sections. Split them accordingly.
*** Req column references the Notes, as in BRD.
*** Enter the System, Area, Sub-area and Description as before.
*** Enter the olive columns - specifically:
**** Dev - the days/hours you estimate (either t-shirt or from an estimate or combined estimate sheet, as before.)
**** Config/Spec - any CON, REQ, Pre or Post imp cost SPECIFICALLY FOR THIS SCR - we will count some global values for these later, so just specific to this change.
*** Enter solution notes and comments as per the BRD process.
* ''Cost Details'' tab
** You can enter the Olive columns. Some calculate already, but over-type if you're confident.
** Use the notes column to qualify and quantify the value here. For example, you may add 30 hours for Release under the implementations section. You may then want to quantify and qualify that e.g. "Assuming 2 major releases over 2 systems"
** Technical assistance (Other Sites) - If you're trying to cost a major implementation project across multiple sites, you may want to enter a value here. Simply enter the number of hours or days you want in the Notes column - the sheet will then calculate the total amount for other sites (total sites from the Profile sheet, minus 1)
* ''Calculations'' tab
** Some cross-references and settings, much like EST and BRD. Importantly, also:
*** Rounding - use 0.1 for daily and 0.25 for hourly.
*** Imp Hours per SCR - this is a number of hours to globally add for implementation per SCR, for the project costs. This covers standard consultancy and implementation changes, not SCR specific ones. Also used to calculate Super User Training costs, testing assistance, go live assistance.
*** Support Transition Hours per SCR - handover to support, plus 7.5 hours.

The result of this is the Summary of Costs tab, which is essentially a copy/paste into an SOW.

Note that the year 1 and 2+ costs are included here. This can be modified to include the WCS/EPOD year 1/2 costs, or can be left blank/deleted - typically the Sales team will do this licensing and additional costs separately, and may need to include SaaS costs as well.

<noinclude>
[[Category:Processes]]
</noinclude>

Process - Updating Documentation

2026-02-25T08:52:30Z

Anw: Added customer support agents

The intention of this process is to confirm the process that all should follow for documentation of new changes to software.

These are guidelines.

The goal is the important thing - everyone updates documentation.

Some products, or some smaller changes, may not require the full process being followed, but the principles are the same - ensure that documentation for changes to our systems is completed in a timely fashion, in a quality form.

== When should documentation be updated? ==
For customer-facing documentation, whenever a release is made to the software to a customer system. So, whenever this get's a release note, ER or otherwise. There are exceptions, which should be managed by the development manager and project managers together, such as:

* Long-running project changes.
* Internal development.

For internal documentation, on processes being changed, new changes upcoming that require testing, etc, as and when this is passed to others. Also, this is a continuous process - if others are expected to use software to test or discuss with customers, then technical guides should exist for these functions.

== Who should update documentation? ==
'''Everyone.'''

It is everyone's responsibility to update documentation.

* The developer completes a new development and creates a technical guide.
* The tester updates the technical guide.
* The release administrator updates release documentation.
* When released, the implementer uses the technical guide, the release notes and the specification to update the customer-facing documentation. They also correct any errors in the release documentation.
* The implementer may refine this through testing with the customer (s). This customer-facing and internal documentation is used as the basis of support handover.
* The support team update the documentation and FAQ guides to reflect real-world usage.

== What should be documented or updated? ==
'''Everything'''.

In summary that is:
* Technical guides.
* Screen help.
* Processes.
* Release notes.

All of these combine together to provide us with quality documentation - for our customers and for ourselves.

=== Technical Guides ===
Technical guides should exist within CALIDUS Hub (this wiki).

They should be categorised for the product that they are relevant to, and classified as a technical guide.

This is not the same as the technical areas of a functional specification - things can change and adapt as development continues. Therefore this should contain enough pertinent information for the users (i.e. other Aptean staff, departments, etc) to be able to get this process running, for testing and release purposes.

This is the place for fields, tables, SQL if this helps,.

Cross reference any customer-facing documentation in other Assists, so that you do not have to re-type everything.

A good example is in this wiki: [[CTMS Paragon Interface]].

=== Customer-facing Documentation ===
This exists with the appropriate product Assist implementation.

Any change, no matter how small, should be reflected in the appropriate pages within the Assist.

If a new page is created, it is important that that page is included in categories for the documents that are being produced for that particular area. This changes per Assist. As for information.

Change details should be provided with each change to each page made.

This should be consistent, but should reflect the patch, ER or release number.

See [[Assist Editing Guide#Saving your Changes|Saving your changes]] in the [[Assist Editing Guide]] for more details.

Change or reflect EVERY page that is required. For example:

* If this change affects maintenance screens, add the new field to the screen documentation
* If this change adds system parameters or settings, update those as well.
* If this change affects EDI processes, update those EDI processes as well.
* If this change requires implementation from Aptean staff in order to be enabled, reflect that in the documentation.
* If this change affects a general process, update that process documentation as well.

In general:

* If the screen documentation doesn't come up to the standards required, fix it as you edit.
* Change screenshots where required.

For example:

* The change adds a flag to Carriers on the screen, plus a new system parameter.
* The new flag can be imported.
* The result of these changes is to affect the scheduling engine.
* The change is release in ER47-189.

Your actions:

* Each change is added noting the release number in the change documentation.
* You update the carriers screen with the new field. You update the screenshot. You notice that some other areas are missing and update those.
** Change comment "ER47-189 - Added X field and updated in general."
* You update the list of system parameters with your new parameter and description.
** Change comment "ER47-189 - Added new system parameters for X"
* You update the import affected with the new field.
** Change comment "ER47-189 - Updated Y import with new field X."
* You update the scheduling engine process documentation to show the affects of this change. You ensure that the system parameter that controls this is reflected in both the documentation and in any list of applicable system parameters within the guide. If one does not exist, you create it.
** Change comment "ER47-189 - Added details of X functionality."

For example:

* You create a new Quarantine screen for CTMS, and this affects and is affected by changes in other systems (e.g. MCS).
* It is affected by various existing and new system parameters.

Your actions:

* Create a new page for the Quarantine screen.
* Create a redirect for the form name in CTMS.
* You add this Quarantine page to the appropriate overview guide (through categorisation).
** You should look for examples of other pages and ensure that the appropriate categories are added.
** In this case, as this is part of the Maintenance menu, you would add this to the Maintenance guide, the User Guide and to the Modules guide. That will ensure that the page is added to the guides when exported to PDF. Example:
<pre>
<noinclude>
[[Category:Maintenance|150]]
[[Category:C-TMS Modules|D-150]]
[[Category:C-TMS User Guide|BD-150]]
</noinclude>
</pre>
* You ensure that documentation for MCS is released and updated as well (it may not be you doing it, but it's your responsibility to make sure it's all done).
* As this is a brand new process, you create a new user guide for this as well, describing how this affected across all systems.
** For example: "CALIDUS Quarantine User Guide".
** If there are pages you want to pull in across systems, you can do this through interwiki links - see here: [[Assist Editing Guide#Interwiki|Interwiki]].
** This would be formatted as a formal Aptean document. Example: [[ctms:UG_CTMS_LogiNext_Interface_Guide]]
** You may decide not to use the existing full page but just the screenshot. You do not need to create the screenshot again, just link to the existing screenshot.
** You may decide that the MCS changes do not need to be documented here, but just referenced. You can do that using interwiki links to the documentation within the other Assists.

=== Customer-Specific Documentation ===
In general, our product documentation is exactly that - PRODUCT documentation, not customer-specific.

Any change that we undertake, whether product or customer change, is considered product, and should be documented as such.

This is accessible and visible to all of our customers, so we should steer clear of documents that mention specific customers.
{| class="wikitable"
|+Examples of good generic documentation
!Bad
!Good
|-
|Stapletons
|Tyre transport operation
|-
|Stapletons Scheduling Engine
|Fixed Drop Scheduling Engine
|}
From time to time, a customer may ask us to create specific documentation for them. This is a chargeable task.

We should ONLY host that customer-specific documentation within the product Assist instance if

* the customer is aware that this will be visible to ALL Aptean Calidus customers.
* the customer agrees to this.

Regardless, customer-specific documentation does have a place in Assist. For example, these process-style documents are incredibly useful for project handover to support. So in that instance, they should exist within the (Aptean internal only) Calidus HUB Assist instead.

There is no issue with FAQs being put up within Product Assist instances, as long as they are removed of any customer names or true specificity, or the customer has agreed that this will be visible to other customers.

=== Customer Support Agents ===
Customer support agents are updated based on the PDFs extracted from the product Assists.

When product documentation is updated (i.e. on release of software to a customer), standard guides for that product should be updated and produced.

These guides should be stored in the SharePoint folders for the products in R&D CALIDUS Documents:

* CTMS/MCS/T2A - https://apteanonline.sharepoint.com/:f:/r/teams/RDCALIDUS/Shared%20Documents/CALIDUS%20TMS/Training%20Guides?csf=1&web=1&e=QGsFpZ
* PORTAL - https://apteanonline.sharepoint.com/:f:/r/teams/RDCALIDUS/Shared%20Documents/CALIDUS%20Portal/Development/Training%20Guides?csf=1&web=1&e=OkEPj8
* VEhub - https://apteanonline.sharepoint.com/:f:/r/teams/RDCALIDUS/Shared%20Documents/CALIDUS%20VEHUB/Documentation/User?csf=1&web=1&e=2I5Tc8
* EPOD - https://apteanonline.sharepoint.com/:f:/r/teams/RDCALIDUS/Shared%20Documents/CALIDUS%20ePOD/Training%20Guides?csf=1&web=1&e=N5f1Kt
* WMS/Bay Diary/TCM/ToC - https://apteanonline.sharepoint.com/:f:/r/teams/RDCALIDUS/Shared%20Documents/CALIDUS%20WMS/Training%20Guides?csf=1&web=1&e=xoS5Sw
* CAL-E - https://apteanonline.sharepoint.com/:f:/r/teams/RDCALIDUS/Shared%20Documents/CALIDUS%20WMS%20(London)/User%20Guides%20(v4)/User%20Guides%20PDF?csf=1&web=1&e=KGp8zq
* WCS - https://apteanonline.sharepoint.com/:f:/r/teams/RDCALIDUS/Shared%20Documents/CALIDUS%20WCS/Training/Training%20Guides%20from%20Assist?csf=1&web=1&e=V9Ajv6

When this is done, the support agents will be updated with the new knowledge within a day.

== How much is this going to help? ==
By following this process, you have updated the affected pages (screens, processes, etc) only once.

These pages and screenshots are re-used and applied into ALL documentation.

This reduces fragmentation and increases reusability, and therefore reduces the time taken to produce all documentation across all systems for everyone.

The systems can directly link to the Assist pages you created and updated directly from the UI, meaning that the user has direct access to the latest documentation, not waiting for a published PDF to be provided to them or custom documentation being written with single-use scenarios. This reduces support calls and implementation time.

The old system of documents piling up for each customer isn't relevant any more - they can download the equivalent documents direct from the Assist. So no updating many documents because of a single change or hunting for the "latest document that was created when we last did this, but not that one because it's too specific".

As you are creating technical documentation as well, but also linking to customer facing documentation, you are providing an easier understanding path for other Aptean resources and departments to be able to understand, test and implement your change, not just one person who wrote a requirements document.

You are reducing inter-department calls and handover times - because quality technical and user documentation exists, you will not be pestered multiple times by testers, implementers and customers. We can all use the documentation to answer our own questions.

As everyone is responsible for updating and checking documentation, there is less chance that undocumented features are present, and any poorly-described functionality is refined by multiple hands, improving the quality of the documentation for the systems.

[[Category:Processes]]
[[Category:ASSIST]]

UG 352360 CALIDUS Assist User Guide

2026-02-20T12:35:46Z

Anw: Version update

<div class="noprint">
{{#vardefine:Client|PROD}}
{{#vardefine:ClientName|Aptean}}
{{#vardefine:System|''CALIDUS'' Assist}}
{{#vardefine:SystemCode|ASSIST}}
{{#vardefine:Doc_Title|C-Assist User Guide}}
{{#vardefine:Version|1.01}}
{{#vardefine:Date|20th February 2026}}
{{#vardefine:Reference|352360}}
{{#vardefine:Year|2026}}
</div>
{{Doc_Title
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=UG {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
}}

<div class="noprint">
{{NewPage}}
= Creating articles for inclusion in a PDF Book =
{{Help:PDF_Book}}

{{NewPage}}
= Creating new documents from templates =
You can create new documents using the links on the following page:
* [[Help:CreateNewPage|Create New Page]]

{{NewPage}}
= Creating a new Wiki installation =
{{Help:CreateNewWiki}}

{{NewPage}}
= Upgrading the version of an existing Wiki installation =
{{Help:UpgradeWiki}}

{{NewPage}}
= Editing a document =
{{Help:EditOBS}}

{{NewPage}}
= Support Tools =
{{:Assist Support Guide}}

=Appendix A: Document History=
<p><font size="4">'''A.1 References'''</font></p>

{| class="wikitable" border="1" width="100%"
|-
! Ref No !!Document Title & ID !! Version !! Date
|-
| 1 ||   ||   ||  
|-
| 2 ||   ||   ||  
|-
| 3 ||   ||   ||  
|}

<p><font size="4">'''A.2 Document History'''</font></p>
{| class="wikitable" border="1" width="100%"
|-
! Version !! Date !! Status !! Reason !! By
|-
| 0.1 || 25/02/2020 || Issue || Initial Version || ANW
|-
| 1.0 || 13/03/2020 || Issue || Issue || ANW
|-
| 1.01 || 20/02/2026 || Issue || Re-issue with updated support guide || ANW
|}

<p><font size="4">'''A.3 Authorised By'''</font></p>
<table width="100%" border="0">
<tr><td><br />Matt Tipping</td><td><br />Aptean Manager</td><td>_____________________________</td></tr>
<tr><td><br />Tony Walker</td><td><br />Aptean Principal Consultant</td><td>_____________________________</td></tr>
</table>
</div>
[[Category:{{#var:Client}} UG]]
[[Category:{{#var:SystemCode}}]]

Assist Support Guide

2026-02-20T12:32:14Z

Anw: Added PDT Production Support Issues

The intention of this guide is to provide support information, and a general knowledge base and tips for the ongoing maintenance of Assist implementations.

== Requirements ==
MySQL WorkBench

Access to the Assist server.

== Hosted Systems ==
All hosted systems are documented in SharePoint, along with users and passwords.

You must have access to the SharePoint to read this document.

https://apteanonline.sharepoint.com/teams/CALIDUS-CONNECTIONS/Shared%20Documents/Forms/AllItems.aspx?id=%2Fteams%2FCALIDUS%2DCONNECTIONS%2FShared%20Documents%2FCalidus%20Assist&viewid=fffc6c78%2D04de%2D4e7d%2Db3ec%2D62168ff125fb

== Updating Data En Mass==
By default, MySQL will not allow updating of data without explicit WHERE or LIMIT clauses. To enable this:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Safe Updates"
* Restart MySQL WorkBench.
{{Warning}} You will then be able to (for example) delete all data inadvertently, so enable this option with care.

== Viewing BLOB fields ==
By default, MySQL WorkBench displays all text fields as "BLOB", which you must then right-click and choose "Open Value in Editor". To enable viewing the text directly in the results, do the following:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Treat BINARY/VARBINARY as nonbinary character string"
* Restart MySQL WorkBench.
{{Note}} Enabling this option comes with a performance hit - some text fields contain the entire page data, so enable this with care.

== Recovering passwords from MYSQL Workbench ==
First go check where your encrypted file is. Usually it is stored at %AppData%\MySQL\Workbench\workbench_user_data.dat

If different, amend the commands below.

Use Powershell

<pre>
Add-Type -AssemblyName System.Security
$cipher = Get-Content $env:APPDATA\MySQL\Workbench\workbench_user_data.dat -Encoding Byte -Raw
$scope = [System.Security.Cryptography.DataProtectionScope]::CurrentUser
$mysqlpwd = [System.Security.Cryptography.ProtectedData]::Unprotect( $cipher, $null, $scope )
[System.Text.UTF8Encoding]::UTF8.GetString($mysqlpwd)
</pre>

== Common Queries ==
<pre>
-- Assist SQL

-- Find the page ID
SELECT * FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%';

-- Find all revisions (to change comments)
SELECT * FROM obs_assist.obs_revision
where rev_page IN
(SELECT page_id FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%'
);

-- Find unpatrolled pages to set them patrolled
SELECT *
FROM obs_assist.obs_recentchanges
where rc_patrolled = 0;

UPDATE obs_assist.obs_recentchanges
SET rc_patrolled = 1
where rc_user_text = 'StylesC'

-- Check the logs for details of PDF production
SELECT * FROM mts_assist.oh_logging
where log_action ='PdfBook'
-- order by log_id desc

-- For v1.34 and later, comments have changed:
SELECT log.*, CONVERT(comment.comment_text USING utf8) comment
FROM epod_assist.epodlogging log
left join epod_assist.epodcomment comment
on comment.comment_id = log.log_comment_id
where log_action ='PdfBook'
--ORDER BY log_id DESC
--LIMIT 20
</pre>

== Assist Database Backup ==
Backup each database separately.

Use MySQL Administrator Data Export option.

Always check boxes as follows:
* Dump Stored Procedures and Functions
* Dump Events
* Dump Triggers
* Export to Self-contained File
** Name with the name of the Assist on the start of the dump.
* Include Create Schema

Advanced Options button
* Comments
* Create-options
* quote-names
* lock-tables
* dump-date
* disable-keys
* tz-utc
* add-locks
* extended-insert

Start Export

== Assist Database Restore ==
If required, drop the database from MySQL Administrator:
* On Schema explorer, right click on schema and select Drop Schema.

Use MySQL Administrator Data Import/Restore option.
* Import from self-contained file
* Select the database backup dump
* Click Start Import
* Refresh the schema explorer when done - the database should be present.

Restore database users, passwords and permissions when complete.

Will need to create the assist owner with username and password from LocalSettings.php
* From MySQL Admin Management Explorer
* Users and Privileges
* Add Account
** Login Name and Password - as per LocalSettings.php
* Administrative Roles tab - check DBA, which checks everything
* Schema Privileges - add entry
** Selected Schema
** Check everything (click Select 'ALL' button)
* Click Apply

Normal Assist users will need to be reset either by the users through 2FA, or through [[#Resetting User Passwords]].

== Upgrading a Wiki from 1.16 Upwards ==
The following is a checklist of actions.

{SYSTEM}
* Extracted - INCOMPLETE
* DB Import - INCOMPLETE
* DB User - INCOMPLETE
** {SYSTEM}_owner/{PASSWORD}
* Version 1.31.6 - INCOMPLETE
** Move old extensions to old folder - INCOMPLETE
** Recreate LocalSettings.php
** Update password sender and emergency contact
* Version 1.34.4 - INCOMPLETE
** Leave LocalSettings.php
** May need to remove some extensions like numberformat and variables
* Version 1.39.8 - INCOMPLETE
** Leave LocalSettings.php
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - INCOMPLETE
** admin/Liverpool123
** anw/Liverpool123
* Problems
** NONE

== Creating a Brand New Wiki ==
The following is a checklist of actions.
* Copy version 1.39.8 to a WIKI name - INCOMPLETE
** Create LocalSettings.php
** xxx_owner with appropriate password
** Note the password!
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - ensure that there is at least an Admin user with full user rights. Note the password:
** Log in as administrative user
** Special:Create Account
** Create admin account - note the password.
** Special:User Rights
** Check Administrator, Interface Administrator, Bureaucrat and Suppressor
** Save user groups

== Extracting Hacks ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
MediaWiki:Common.js
MediaWiki:Group-user.css
MediaWiki:Common.css
MediaWiki:Vector.css
MediaWiki:Timeless.css
MediaWiki:Gadget-veCenterLoader.js
MediaWiki:Gadget-autonum
MediaWiki:Gadget-autonum.js
MediaWiki:Gadget-autonum.css
MediaWiki:Gadget-veCenterLoader
MediaWiki:Gadget-veCenter.js
MediaWiki:Gadgets-definition
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-hacks.xml

== Extracting Templates ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
Template:DocLink
Template:Doc_Title
Template:Comment
Template:Incomplete
Template:Note
Template:Hint
Template:Warning
Template:Xref
PageTemplate
DocTemplate
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Templates.xml

== Extracting Common Additional Files ==
Take the following from an Assist implementation that has them:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* Special:All Pages
* Enter start of file name in "Display pages starting at:"
* Select File Namespace from drop-down list and then click Go.
* Click on the file until a full-screen version appears.
* Right-click, Save Image As
* Save to your chosen directory.

== Extracting Namespace Files ==
* Extract from an existing Assist
* Special Pages
* Export Pages
* Add the pages specifically below, replacing the namespace with the namespace of the Assist system - in this case this is from CTMS Assist:
CTMS:Privacy_policy
CTMS:General_disclaimer
CTMS:Copyrights
CTMS:About
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Namespace.xml

{{Note}} You will then need to amend the About page to change the product name and copyright dates.

== Importing Additional Files, Templates and Hacks into a Wiki ==
* Ensure that all additional files from MW-add-files have been added.
* Upload additional files:
** Special:Upload Multiple Files
** Add a description if you want
** Select the following files:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* As soon as you select the files, the files will be uploaded. The page will indicate if there is any error uploading the files (for example if they already exist)
* Upload hacks and templates:
** Special Pages
** Import Pages
** Browse for the file to import, one of (do both)
*** MW-hacks.xml
*** MW-Templates.xml
** Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
** Add a comment if you want.
** Ensure option "Import to original namespace" is selected
** Upload File.

== Importing Namespace Files ==
* Special Pages
* Import Pages
* Browse for the file to import
** MW-Namespace.xml
* Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
* Add a comment if you want.
* Ensure option "Import to a namespace" is selected
* Select the namespace from the drop-down list that matches the Assist being imported into, for example, MTS for CTMS, EPOD for C-ePOD, etc
* Upload File.

== Additional Actions ==
The following are additional actions that are required on installing a new Assist, with some sample pages.

* MediaWiki:Pagetitle-view-mainpage - change this text to define the title of the wiki e.g. Assist - OBS Hub
* Update the main page - the MTS one is the one with all the best notes in.
* Update the Did You Know page with the common Assist-based help topics - there is an example in this Assist of a Did You Know page which can be copied or exported, imported and then edited.
* "Download as PDF" to "Print as PDF" - e.g. "Print as PDF tab in the tab bar, typically on the top of the screen".

You can use the files on this Assist as templates:
* [[OBS:About]]
* [[OBS:General_disclaimer]]
* [[OBS:Privacy_policy]]
* [[OBS:Copyrights]]

== MediaWiki ==
You can find the MediaWiki license, contributors, FOSS attributions and components here:
* [[Special:Version]].

== Common Maintenance Actions ==

=== Creating Users/Resetting User Passwords ===
It is ALWAYS better to create a new user on the Wiki from the Special page "Create Account". In here, you should create the user and enter the email. This will send an email to the user to reset their own password.

However, in the event of coreecting a problem, this can be done from the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\createAndPromote.php {uname} {pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

You can also add some parameters to promote the user with group rights, as follows:
--bureaucrat Add the account to the bureaucrat group
--sysop Add the account to the sysop group
--interface-admin Add the account to the interface-admin group
--custom-groups Comma-separated list of groups to add the user to. This allows adding the user to any custom group.
Since MW 1.27, a user is only added to a custom group, if this group actually exists according to $wgGroupPermissions and $wgRevokePermissions. Non-existing groups are ignored.
--force If account already exists, just grant it rights or change password. Do not create a new account in this case.

In the event of needing to change a password, it is ALWAYS better to get the user to do it themselves - if the email has been set up, they can access the reset from there.

System admins can also force the sending of the reset password link from Special:ResetPassword.

In the event that this is simply correcting a previously set password, you can use the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\changePassword.php --user={uname} --password={pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.
=== Managing Revisions ===
Sometimes, you may want to roll-back edits, or delete or hide revisions to a page, perhaps to remove dangerous content.

This is controlled through user rights and groups - see below for more information on that.

Using the rollback feature (for administrators and users with the "rollback" right)

* Go to the page history, the user contributions page, or a diff page.
* Find the "rollback" link next to the consecutive edits you want to revert. It appears before the "undo" link.
* Click the "rollback" link. The page will automatically revert to the previous version by another user, and a pre-filled edit summary will appear.
* Save the edit. The change is marked as a "minor" edit in the history.
* Important: After using rollback, it's recommended to check the recent revisions to ensure all disruptive edits were reverted and no constructive edits were accidentally removed.

Using the undo feature (for any user)

* Navigate to the page history.
* Find the specific edit you want to undo in the list.
* Click the "undo" link at the end of that edit's line.
* An edit page will load with the changes from that edit removed. Later edits are retained by default.
* You can modify the default edit summary if needed.
* Click "Save page" to revert the single edit.

When to use which method

* Use rollback for reverting a large number of consecutive bad edits, such as vandalism, by the most recent user. It's a one-click process for authorized users.
* Use undo to revert a single edit or to manually edit the page to combine or resolve conflicts with later edits. The undo feature is available to all users.

You can permanently flatter all history in a page using the command line.

* For page histories: Run the script from your MediaWiki installation's directory. You can delete all old revisions by using the flag or by specifying the page ID.
* Example command (once in your wiki's maintenance directory):
** <code>{InstallDrive}:\xampp\php\php.exe deleteOldRevisions.php --delete 123</code>
* (Replace 123 with the page ID gathered from the page information).
* Note that running this script without <code>--delete</code> will just list the count of revisions that will be removed.

To delete a specific revision in MediaWiki, use the RevisionDelete feature, which administrators can enable to hide revisions from public view. This feature allows you to hide the content, username, or edit summary of one or more revisions without permanently removing them. First, enable the permission, then go to the page history, select the revisions using the checkboxes, and click "Change visibility of selected revisions" to hide them.

For administrators using RevisionDelete

# Enable the permission: Ensure your user account has the permission. This may require editing LocalSettings.php.
# Go to the page history: Navigate to the page and click the "View history" tab.
# Select revisions: Check the boxes next to the revisions you want to hide.
# Change visibility: Click the "Change visibility of selected revisions" button.
# Choose what to hide: Select the options to hide the content, usernames, or summaries.
# Apply changes: Add a log comment and click the "Apply to selected revisions" button.

=== Managing Interwikis ===
See here for an explanation of what we use this for: [[Assist Editing Guide#Interwiki|Interwiki]].

Each product wiki SHOULD be set up so that interwiki links are configured within the CALIDUS HUB only, and then disseminated to the individual Assists.

This is done in the following way:

in LocalSettingsAdditional.php:
$wgSharedDB = 'obs_assist'; # The $wgDBname for the wiki database holding the main interwiki table
$wgSharedPrefix = 'obs_'; # The $wgDBprefix for the database. Defaults to the prefix of the current wiki if not specified
$wgSharedTables = ['interwiki'];
If they are not, fix the Assist file above.

Current interwikis:

* epod
* cmcs
* ctms
* obs
* cportal
* cvision
* cwcs
* cwms

To add a new/edit an existing interwiki:

* ''Wiki Tools/Special pages''
* ''View and Edit InterWiki data''
* New
** Click ''Add an interwiki or language prefix''
** Prefix: new unique prefix
** Forward - ticked
** Transclude - ticked
** URL: the assist URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/Index.php?title=$1</nowiki>
** API: the API URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/api.php</nowiki>
** Click '''Add'''. (You may have to enter a reason).
* Edit
** Click the Edit link against the interwiki and make the changes you need, then click '''Edit'''. (You may have to enter a reason).

{{Note}}You need to be a sysop (a member of the Administrators group) to edit interwiki links. Currently that is the Admin user. See following section.

=== Maintaining User Rights ===
You must be an Administrator to do this. Currently that is the Admin user.

Use the ''Wiki Tools/Special pages'' link.

* User group rights - the rights associated to each group - this is maintained in the LocalSettings*.php files and will likely not change. Check this for a list of the rights that you want to assign. For example, if
* User list - a list of the users
* User rights - allows you to change the groups associated to each user, and therefore the rights allowed.
** Find the user ID and click '''Load User Rights'''
** Tick the boxes that you want them to have the rights to under Groups you can change
*** autoconfirmed user - has confirmed login through email address.
*** bot - leave unchecked/unassigned - no bots in this system.
*** administrator - admin/sysop (superuser) rights, patrol other users' unpatrolled edits. Basically everything
*** interface administrator - amend site CSS and Javascript i.e. a system maintainer.
*** bureaucrat - auto-patrolled edits
*** suppressor - revision maintainer
** You can also set the following against certain groups:
*** Expires: - the expiration date - use below instead if required.
*** Does not expire - check this instead.

== Support Issues ==

=== Seeing a Cat in the Background ===
There is a cat.svg linked from Timeless skin. (/calidus-assist/OBS/skins/Timeless/resources/images/cat.svg). This is the default.

This is configurable in skin.json in the Timeless directory for your Wiki. i.e. D:\xampp\htdocs\calidus-assist\OBS\skins\Timeless\skin.json

Solution: Set this to user-grey.svg instead.<pre>
"config": {
"TimelessBackdropImage": {
"value": "user-grey.svg",
"description": "Set it as you would $wgLogo to an appropriate background image. Recommendation is an svg set to 500-750px wide"
},
</pre>With multiple wiki installs, this is onerous. To facilitate changing multiple wiki installs, there is a directory in D:\Assist Install Files\MW-add-files called skins.

To apply:

* Copy the directory skins.
* Navigate to your Assist main folder e.g. D:\xampp\htdocs\calidus-assist\WMS
* Paste - this will overwrite the config file with the corrected one.

{{Warning}}This file is delivered with MediaWiki. A new install will overwrite this file. If you have updated MediaWiki or installed a new version of the Timeless skin, then compare the saved skin.json file with the new one and update with any new/changed attributes.

=== Zero Bytes PDF ===
Problems typically display as the PDF being downloaded is zero bytes or cannot be opened.

The most common issues are with single page PDFs. The normal solutions are:

* For full documents, ensure that there is a heading 1 element in the file being downloaded.
* If you are transcluding pages into a document, there is typically a limit of around 15 transcluded pages before the document will not produce. Instead, consider grouping the pages into a category and extracting that instead of creating a single document.

Some documents will include a <nowiki><div class="noprint"> after the title page and a closing div at the end. This used to be require din older versions of the code, but now causes issues. To fix, remove the div and closing div tags (not the top ones around the vardefines, just the ones after that and at the very end).</nowiki>

=== '?' characters ===
Occasionally, PDFs will be produced with '?' characters in unusual places. This represents and unprintable character in the PDF. Typically, this is because of smart quotes or hyphen characters, usually because text has been pasted in from a Word document that has "helpfully" automatically changes all hyphens, quotes and single quotes into extended characters. The PDF conversion routine does not support these characters at this time. To solve this, edit the page in question and replace the quotes and hyphens with plain equivalents.

=== Unexpected Pages in PDF Books ===
When PDF books are created from Categories, sometimes there are pages included that are not expected.

Most of the time this is caused by inheritance of categories. If a page has a category and this is transcluded into another page, the default is that the page transcluding will inherit the categories listed in the transcluded page.

Check the category list of pages in Assist - usually you will see the offending page, and then the categories can be amended to resolve the issue.

Either remove the categories of the page if it is in the wrong category, or ensure that the categories are surrounded by NOINCLUDE tags. You should use the source editor to do this, as the Visual Editor does not handle this kind of meta data very well.

[[Category:Assist Guides]]
[[Category:ASSIST]]

Assist Support Guide

2026-02-20T12:22:09Z

Anw: Minor update

The intention of this guide is to provide support information, and a general knowledge base and tips for the ongoing maintenance of Assist implementations.

== Requirements ==
MySQL WorkBench

Access to the Assist server.

== Hosted Systems ==
All hosted systems are documented in SharePoint, along with users and passwords.

You must have access to the SharePoint to read this document.

https://apteanonline.sharepoint.com/teams/CALIDUS-CONNECTIONS/Shared%20Documents/Forms/AllItems.aspx?id=%2Fteams%2FCALIDUS%2DCONNECTIONS%2FShared%20Documents%2FCalidus%20Assist&viewid=fffc6c78%2D04de%2D4e7d%2Db3ec%2D62168ff125fb

== Updating Data En Mass==
By default, MySQL will not allow updating of data without explicit WHERE or LIMIT clauses. To enable this:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Safe Updates"
* Restart MySQL WorkBench.
{{Warning}} You will then be able to (for example) delete all data inadvertently, so enable this option with care.

== Viewing BLOB fields ==
By default, MySQL WorkBench displays all text fields as "BLOB", which you must then right-click and choose "Open Value in Editor". To enable viewing the text directly in the results, do the following:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Treat BINARY/VARBINARY as nonbinary character string"
* Restart MySQL WorkBench.
{{Note}} Enabling this option comes with a performance hit - some text fields contain the entire page data, so enable this with care.

== Recovering passwords from MYSQL Workbench ==
First go check where your encrypted file is. Usually it is stored at %AppData%\MySQL\Workbench\workbench_user_data.dat

If different, amend the commands below.

Use Powershell

<pre>
Add-Type -AssemblyName System.Security
$cipher = Get-Content $env:APPDATA\MySQL\Workbench\workbench_user_data.dat -Encoding Byte -Raw
$scope = [System.Security.Cryptography.DataProtectionScope]::CurrentUser
$mysqlpwd = [System.Security.Cryptography.ProtectedData]::Unprotect( $cipher, $null, $scope )
[System.Text.UTF8Encoding]::UTF8.GetString($mysqlpwd)
</pre>

== Common Queries ==
<pre>
-- Assist SQL

-- Find the page ID
SELECT * FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%';

-- Find all revisions (to change comments)
SELECT * FROM obs_assist.obs_revision
where rev_page IN
(SELECT page_id FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%'
);

-- Find unpatrolled pages to set them patrolled
SELECT *
FROM obs_assist.obs_recentchanges
where rc_patrolled = 0;

UPDATE obs_assist.obs_recentchanges
SET rc_patrolled = 1
where rc_user_text = 'StylesC'

-- Check the logs for details of PDF production
SELECT * FROM mts_assist.oh_logging
where log_action ='PdfBook'
-- order by log_id desc

-- For v1.34 and later, comments have changed:
SELECT log.*, CONVERT(comment.comment_text USING utf8) comment
FROM epod_assist.epodlogging log
left join epod_assist.epodcomment comment
on comment.comment_id = log.log_comment_id
where log_action ='PdfBook'
--ORDER BY log_id DESC
--LIMIT 20
</pre>

== Assist Database Backup ==
Backup each database separately.

Use MySQL Administrator Data Export option.

Always check boxes as follows:
* Dump Stored Procedures and Functions
* Dump Events
* Dump Triggers
* Export to Self-contained File
** Name with the name of the Assist on the start of the dump.
* Include Create Schema

Advanced Options button
* Comments
* Create-options
* quote-names
* lock-tables
* dump-date
* disable-keys
* tz-utc
* add-locks
* extended-insert

Start Export

== Assist Database Restore ==
If required, drop the database from MySQL Administrator:
* On Schema explorer, right click on schema and select Drop Schema.

Use MySQL Administrator Data Import/Restore option.
* Import from self-contained file
* Select the database backup dump
* Click Start Import
* Refresh the schema explorer when done - the database should be present.

Restore database users, passwords and permissions when complete.

Will need to create the assist owner with username and password from LocalSettings.php
* From MySQL Admin Management Explorer
* Users and Privileges
* Add Account
** Login Name and Password - as per LocalSettings.php
* Administrative Roles tab - check DBA, which checks everything
* Schema Privileges - add entry
** Selected Schema
** Check everything (click Select 'ALL' button)
* Click Apply

Normal Assist users will need to be reset either by the users through 2FA, or through [[#Resetting User Passwords]].

== Upgrading a Wiki from 1.16 Upwards ==
The following is a checklist of actions.

{SYSTEM}
* Extracted - INCOMPLETE
* DB Import - INCOMPLETE
* DB User - INCOMPLETE
** {SYSTEM}_owner/{PASSWORD}
* Version 1.31.6 - INCOMPLETE
** Move old extensions to old folder - INCOMPLETE
** Recreate LocalSettings.php
** Update password sender and emergency contact
* Version 1.34.4 - INCOMPLETE
** Leave LocalSettings.php
** May need to remove some extensions like numberformat and variables
* Version 1.39.8 - INCOMPLETE
** Leave LocalSettings.php
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - INCOMPLETE
** admin/Liverpool123
** anw/Liverpool123
* Problems
** NONE

== Creating a Brand New Wiki ==
The following is a checklist of actions.
* Copy version 1.39.8 to a WIKI name - INCOMPLETE
** Create LocalSettings.php
** xxx_owner with appropriate password
** Note the password!
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - ensure that there is at least an Admin user with full user rights. Note the password:
** Log in as administrative user
** Special:Create Account
** Create admin account - note the password.
** Special:User Rights
** Check Administrator, Interface Administrator, Bureaucrat and Suppressor
** Save user groups

== Extracting Hacks ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
MediaWiki:Common.js
MediaWiki:Group-user.css
MediaWiki:Common.css
MediaWiki:Vector.css
MediaWiki:Timeless.css
MediaWiki:Gadget-veCenterLoader.js
MediaWiki:Gadget-autonum
MediaWiki:Gadget-autonum.js
MediaWiki:Gadget-autonum.css
MediaWiki:Gadget-veCenterLoader
MediaWiki:Gadget-veCenter.js
MediaWiki:Gadgets-definition
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-hacks.xml

== Extracting Templates ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
Template:DocLink
Template:Doc_Title
Template:Comment
Template:Incomplete
Template:Note
Template:Hint
Template:Warning
Template:Xref
PageTemplate
DocTemplate
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Templates.xml

== Extracting Common Additional Files ==
Take the following from an Assist implementation that has them:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* Special:All Pages
* Enter start of file name in "Display pages starting at:"
* Select File Namespace from drop-down list and then click Go.
* Click on the file until a full-screen version appears.
* Right-click, Save Image As
* Save to your chosen directory.

== Extracting Namespace Files ==
* Extract from an existing Assist
* Special Pages
* Export Pages
* Add the pages specifically below, replacing the namespace with the namespace of the Assist system - in this case this is from CTMS Assist:
CTMS:Privacy_policy
CTMS:General_disclaimer
CTMS:Copyrights
CTMS:About
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Namespace.xml

{{Note}} You will then need to amend the About page to change the product name and copyright dates.

== Importing Additional Files, Templates and Hacks into a Wiki ==
* Ensure that all additional files from MW-add-files have been added.
* Upload additional files:
** Special:Upload Multiple Files
** Add a description if you want
** Select the following files:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* As soon as you select the files, the files will be uploaded. The page will indicate if there is any error uploading the files (for example if they already exist)
* Upload hacks and templates:
** Special Pages
** Import Pages
** Browse for the file to import, one of (do both)
*** MW-hacks.xml
*** MW-Templates.xml
** Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
** Add a comment if you want.
** Ensure option "Import to original namespace" is selected
** Upload File.

== Importing Namespace Files ==
* Special Pages
* Import Pages
* Browse for the file to import
** MW-Namespace.xml
* Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
* Add a comment if you want.
* Ensure option "Import to a namespace" is selected
* Select the namespace from the drop-down list that matches the Assist being imported into, for example, MTS for CTMS, EPOD for C-ePOD, etc
* Upload File.

== Additional Actions ==
The following are additional actions that are required on installing a new Assist, with some sample pages.

* MediaWiki:Pagetitle-view-mainpage - change this text to define the title of the wiki e.g. Assist - OBS Hub
* Update the main page - the MTS one is the one with all the best notes in.
* Update the Did You Know page with the common Assist-based help topics - there is an example in this Assist of a Did You Know page which can be copied or exported, imported and then edited.
* "Download as PDF" to "Print as PDF" - e.g. "Print as PDF tab in the tab bar, typically on the top of the screen".

You can use the files on this Assist as templates:
* [[OBS:About]]
* [[OBS:General_disclaimer]]
* [[OBS:Privacy_policy]]
* [[OBS:Copyrights]]

== MediaWiki ==
You can find the MediaWiki license, contributors, FOSS attributions and components here:
* [[Special:Version]].

== Common Maintenance Actions ==

=== Creating Users/Resetting User Passwords ===
It is ALWAYS better to create a new user on the Wiki from the Special page "Create Account". In here, you should create the user and enter the email. This will send an email to the user to reset their own password.

However, in the event of coreecting a problem, this can be done from the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\createAndPromote.php {uname} {pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

You can also add some parameters to promote the user with group rights, as follows:
--bureaucrat Add the account to the bureaucrat group
--sysop Add the account to the sysop group
--interface-admin Add the account to the interface-admin group
--custom-groups Comma-separated list of groups to add the user to. This allows adding the user to any custom group.
Since MW 1.27, a user is only added to a custom group, if this group actually exists according to $wgGroupPermissions and $wgRevokePermissions. Non-existing groups are ignored.
--force If account already exists, just grant it rights or change password. Do not create a new account in this case.

In the event of needing to change a password, it is ALWAYS better to get the user to do it themselves - if the email has been set up, they can access the reset from there.

System admins can also force the sending of the reset password link from Special:ResetPassword.

In the event that this is simply correcting a previously set password, you can use the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\changePassword.php --user={uname} --password={pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.
=== Managing Revisions ===
Sometimes, you may want to roll-back edits, or delete or hide revisions to a page, perhaps to remove dangerous content.

This is controlled through user rights and groups - see below for more information on that.

Using the rollback feature (for administrators and users with the "rollback" right)

* Go to the page history, the user contributions page, or a diff page.
* Find the "rollback" link next to the consecutive edits you want to revert. It appears before the "undo" link.
* Click the "rollback" link. The page will automatically revert to the previous version by another user, and a pre-filled edit summary will appear.
* Save the edit. The change is marked as a "minor" edit in the history.
* Important: After using rollback, it's recommended to check the recent revisions to ensure all disruptive edits were reverted and no constructive edits were accidentally removed.

Using the undo feature (for any user)

* Navigate to the page history.
* Find the specific edit you want to undo in the list.
* Click the "undo" link at the end of that edit's line.
* An edit page will load with the changes from that edit removed. Later edits are retained by default.
* You can modify the default edit summary if needed.
* Click "Save page" to revert the single edit.

When to use which method

* Use rollback for reverting a large number of consecutive bad edits, such as vandalism, by the most recent user. It's a one-click process for authorized users.
* Use undo to revert a single edit or to manually edit the page to combine or resolve conflicts with later edits. The undo feature is available to all users.

You can permanently flatter all history in a page using the command line.

* For page histories: Run the script from your MediaWiki installation's directory. You can delete all old revisions by using the flag or by specifying the page ID.
* Example command (once in your wiki's maintenance directory):
** <code>{InstallDrive}:\xampp\php\php.exe deleteOldRevisions.php --delete 123</code>
* (Replace 123 with the page ID gathered from the page information).
* Note that running this script without <code>--delete</code> will just list the count of revisions that will be removed.

To delete a specific revision in MediaWiki, use the RevisionDelete feature, which administrators can enable to hide revisions from public view. This feature allows you to hide the content, username, or edit summary of one or more revisions without permanently removing them. First, enable the permission, then go to the page history, select the revisions using the checkboxes, and click "Change visibility of selected revisions" to hide them.

For administrators using RevisionDelete

# Enable the permission: Ensure your user account has the permission. This may require editing LocalSettings.php.
# Go to the page history: Navigate to the page and click the "View history" tab.
# Select revisions: Check the boxes next to the revisions you want to hide.
# Change visibility: Click the "Change visibility of selected revisions" button.
# Choose what to hide: Select the options to hide the content, usernames, or summaries.
# Apply changes: Add a log comment and click the "Apply to selected revisions" button.

=== Managing Interwikis ===
See here for an explanation of what we use this for: [[Assist Editing Guide#Interwiki|Interwiki]].

Each product wiki SHOULD be set up so that interwiki links are configured within the CALIDUS HUB only, and then disseminated to the individual Assists.

This is done in the following way:

in LocalSettingsAdditional.php:
$wgSharedDB = 'obs_assist'; # The $wgDBname for the wiki database holding the main interwiki table
$wgSharedPrefix = 'obs_'; # The $wgDBprefix for the database. Defaults to the prefix of the current wiki if not specified
$wgSharedTables = ['interwiki'];
If they are not, fix the Assist file above.

Current interwikis:

* epod
* cmcs
* ctms
* obs
* cportal
* cvision
* cwcs
* cwms

To add a new/edit an existing interwiki:

* ''Wiki Tools/Special pages''
* ''View and Edit InterWiki data''
* New
** Click ''Add an interwiki or language prefix''
** Prefix: new unique prefix
** Forward - ticked
** Transclude - ticked
** URL: the assist URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/Index.php?title=$1</nowiki>
** API: the API URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/api.php</nowiki>
** Click '''Add'''. (You may have to enter a reason).
* Edit
** Click the Edit link against the interwiki and make the changes you need, then click '''Edit'''. (You may have to enter a reason).

{{Note}}You need to be a sysop (a member of the Administrators group) to edit interwiki links. Currently that is the Admin user. See following section.

=== Maintaining User Rights ===
You must be an Administrator to do this. Currently that is the Admin user.

Use the ''Wiki Tools/Special pages'' link.

* User group rights - the rights associated to each group - this is maintained in the LocalSettings*.php files and will likely not change. Check this for a list of the rights that you want to assign. For example, if
* User list - a list of the users
* User rights - allows you to change the groups associated to each user, and therefore the rights allowed.
** Find the user ID and click '''Load User Rights'''
** Tick the boxes that you want them to have the rights to under Groups you can change
*** autoconfirmed user - has confirmed login through email address.
*** bot - leave unchecked/unassigned - no bots in this system.
*** administrator - admin/sysop (superuser) rights, patrol other users' unpatrolled edits. Basically everything
*** interface administrator - amend site CSS and Javascript i.e. a system maintainer.
*** bureaucrat - auto-patrolled edits
*** suppressor - revision maintainer
** You can also set the following against certain groups:
*** Expires: - the expiration date - use below instead if required.
*** Does not expire - check this instead.

== Support Issues ==

=== Seeing a Cat in the Background ===
There is a cat.svg linked from Timeless skin. (/calidus-assist/OBS/skins/Timeless/resources/images/cat.svg). This is the default.

This is configurable in skin.json in the Timeless directory for your Wiki. i.e. D:\xampp\htdocs\calidus-assist\OBS\skins\Timeless\skin.json

Solution: Set this to user-grey.svg instead.<pre>
"config": {
"TimelessBackdropImage": {
"value": "user-grey.svg",
"description": "Set it as you would $wgLogo to an appropriate background image. Recommendation is an svg set to 500-750px wide"
},
</pre>With multiple wiki installs, this is onerous. To facilitate changing multiple wiki installs, there is a directory in D:\Assist Install Files\MW-add-files called skins.

To apply:

* Copy the directory skins.
* Navigate to your Assist main folder e.g. D:\xampp\htdocs\calidus-assist\WMS
* Paste - this will overwrite the config file with the corrected one.

{{Warning}}This file is delivered with MediaWiki. A new install will overwrite this file. If you have updated MediaWiki or installed a new version of the Timeless skin, then compare the saved skin.json file with the new one and update with any new/changed attributes.
[[Category:Assist Guides]]
[[Category:ASSIST]]

Assist Support Guide

2026-02-20T12:16:11Z

Anw: Minor formatting change

The intention of this guide is to provide support information, and a general knowledge base and tips for the ongoing maintenance of Assist implementations.

== Requirements ==
MySQL WorkBench

Access to the Assist server.

== Hosted Systems ==
All hosted systems are documented in SharePoint, along with users and passwords.

You must have access to the SharePoint to read this document.

https://apteanonline.sharepoint.com/teams/CALIDUS-CONNECTIONS/Shared%20Documents/Forms/AllItems.aspx?id=%2Fteams%2FCALIDUS%2DCONNECTIONS%2FShared%20Documents%2FCalidus%20Assist&viewid=fffc6c78%2D04de%2D4e7d%2Db3ec%2D62168ff125fb

== Updating Data En Mass==
By default, MySQL will not allow updating of data without explicit WHERE or LIMIT clauses. To enable this:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Safe Updates"
* Restart MySQL WorkBench.
{{Warning}} You will then be able to (for example) delete all data inadvertently, so enable this option with care.

== Viewing BLOB fields ==
By default, MySQL WorkBench displays all text fields as "BLOB", which you must then right-click and choose "Open Value in Editor". To enable viewing the text directly in the results, do the following:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Treat BINARY/VARBINARY as nonbinary character string"
* Restart MySQL WorkBench.
{{Note}} Enabling this option comes with a performance hit - some text fields contain the entire page data, so enable this with care.

== Recovering passwords from MYSQL Workbench ==
First go check where your encrypted file is. Usually it is stored at %AppData%\MySQL\Workbench\workbench_user_data.dat

If different, amend the commands below.

Use Powershell

<pre>
Add-Type -AssemblyName System.Security
$cipher = Get-Content $env:APPDATA\MySQL\Workbench\workbench_user_data.dat -Encoding Byte -Raw
$scope = [System.Security.Cryptography.DataProtectionScope]::CurrentUser
$mysqlpwd = [System.Security.Cryptography.ProtectedData]::Unprotect( $cipher, $null, $scope )
[System.Text.UTF8Encoding]::UTF8.GetString($mysqlpwd)
</pre>

== Common Queries ==
<pre>
-- Assist SQL

-- Find the page ID
SELECT * FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%';

-- Find all revisions (to change comments)
SELECT * FROM obs_assist.obs_revision
where rev_page IN
(SELECT page_id FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%'
);

-- Find unpatrolled pages to set them patrolled
SELECT *
FROM obs_assist.obs_recentchanges
where rc_patrolled = 0;

UPDATE obs_assist.obs_recentchanges
SET rc_patrolled = 1
where rc_user_text = 'StylesC'

-- Check the logs for details of PDF production
SELECT * FROM mts_assist.oh_logging
where log_action ='PdfBook'
-- order by log_id desc

-- For v1.34 and later, comments have changed:
SELECT log.*, CONVERT(comment.comment_text USING utf8) comment
FROM epod_assist.epodlogging log
left join epod_assist.epodcomment comment
on comment.comment_id = log.log_comment_id
where log_action ='PdfBook'
--ORDER BY log_id DESC
--LIMIT 20
</pre>

== Assist Database Backup ==
Backup each database separately.

Use MySQL Administrator Data Export option.

Always check boxes as follows:
* Dump Stored Procedures and Functions
* Dump Events
* Dump Triggers
* Export to Self-contained File
** Name with the name of the Assist on the start of the dump.
* Include Create Schema

Advanced Options button
* Comments
* Create-options
* quote-names
* lock-tables
* dump-date
* disable-keys
* tz-utc
* add-locks
* extended-insert

Start Export

== Assist Database Restore ==
If required, drop the database from MySQL Administrator:
* On Schema explorer, right click on schema and select Drop Schema.

Use MySQL Administrator Data Import/Restore option.
* Import from self-contained file
* Select the database backup dump
* Click Start Import
* Refresh the schema explorer when done - the database should be present.

Restore database users, passwords and permissions when complete.

Will need to create the assist owner with username and password from LocalSettings.php
* From MySQL Admin Management Explorer
* Users and Privileges
* Add Account
** Login Name and Password - as per LocalSettings.php
* Administrative Roles tab - check DBA, which checks everything
* Schema Privileges - add entry
** Selected Schema
** Check everything (click Select 'ALL' button)
* Click Apply

Normal Assist users will need to be reset either by the users through 2FA, or through [[#Resetting User Passwords]].

== Creating Users/Resetting User Passwords ==
It is ALWAYS better to create a new user on the Wiki from the Special page "Create Account". In here, you should create the user and enter the email. This will send an email to the user to reset their own password.

However, in the event of coreecting a problem, this can be done from the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\createAndPromote.php {uname} {pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

You can also add some parameters to promote the user with group rights, as follows:
--bureaucrat Add the account to the bureaucrat group
--sysop Add the account to the sysop group
--interface-admin Add the account to the interface-admin group
--custom-groups Comma-separated list of groups to add the user to. This allows adding the user to any custom group.
Since MW 1.27, a user is only added to a custom group, if this group actually exists according to $wgGroupPermissions and $wgRevokePermissions. Non-existing groups are ignored.
--force If account already exists, just grant it rights or change password. Do not create a new account in this case.

In the event of needing to change a password, it is ALWAYS better to get the user to do it themselves - if the email has been set up, they can access the reset from there.

System admins can also force the sending of the reset password link from Special:ResetPassword.

In the event that this is simply correcting a previously set password, you can use the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\changePassword.php --user={uname} --password={pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

== Upgrading a Wiki from 1.16 Upwards ==
The following is a checklist of actions.

{SYSTEM}
* Extracted - INCOMPLETE
* DB Import - INCOMPLETE
* DB User - INCOMPLETE
** {SYSTEM}_owner/{PASSWORD}
* Version 1.31.6 - INCOMPLETE
** Move old extensions to old folder - INCOMPLETE
** Recreate LocalSettings.php
** Update password sender and emergency contact
* Version 1.34.4 - INCOMPLETE
** Leave LocalSettings.php
** May need to remove some extensions like numberformat and variables
* Version 1.39.8 - INCOMPLETE
** Leave LocalSettings.php
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - INCOMPLETE
** admin/Liverpool123
** anw/Liverpool123
* Problems
** NONE

== Creating a Brand New Wiki ==
The following is a checklist of actions.
* Copy version 1.39.8 to a WIKI name - INCOMPLETE
** Create LocalSettings.php
** xxx_owner with appropriate password
** Note the password!
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - ensure that there is at least an Admin user with full user rights. Note the password:
** Log in as administrative user
** Special:Create Account
** Create admin account - note the password.
** Special:User Rights
** Check Administrator, Interface Administrator, Bureaucrat and Suppressor
** Save user groups

== Extracting Hacks ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
MediaWiki:Common.js
MediaWiki:Group-user.css
MediaWiki:Common.css
MediaWiki:Vector.css
MediaWiki:Timeless.css
MediaWiki:Gadget-veCenterLoader.js
MediaWiki:Gadget-autonum
MediaWiki:Gadget-autonum.js
MediaWiki:Gadget-autonum.css
MediaWiki:Gadget-veCenterLoader
MediaWiki:Gadget-veCenter.js
MediaWiki:Gadgets-definition
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-hacks.xml

== Extracting Templates ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
Template:DocLink
Template:Doc_Title
Template:Comment
Template:Incomplete
Template:Note
Template:Hint
Template:Warning
Template:Xref
PageTemplate
DocTemplate
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Templates.xml

== Extracting Common Additional Files ==
Take the following from an Assist implementation that has them:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* Special:All Pages
* Enter start of file name in "Display pages starting at:"
* Select File Namespace from drop-down list and then click Go.
* Click on the file until a full-screen version appears.
* Right-click, Save Image As
* Save to your chosen directory.

== Extracting Namespace Files ==
* Extract from an existing Assist
* Special Pages
* Export Pages
* Add the pages specifically below, replacing the namespace with the namespace of the Assist system - in this case this is from CTMS Assist:
CTMS:Privacy_policy
CTMS:General_disclaimer
CTMS:Copyrights
CTMS:About
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Namespace.xml

{{Note}} You will then need to amend the About page to change the product name and copyright dates.

== Importing Additional Files, Templates and Hacks into a Wiki ==
* Ensure that all additional files from MW-add-files have been added.
* Upload additional files:
** Special:Upload Multiple Files
** Add a description if you want
** Select the following files:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* As soon as you select the files, the files will be uploaded. The page will indicate if there is any error uploading the files (for example if they already exist)
* Upload hacks and templates:
** Special Pages
** Import Pages
** Browse for the file to import, one of (do both)
*** MW-hacks.xml
*** MW-Templates.xml
** Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
** Add a comment if you want.
** Ensure option "Import to original namespace" is selected
** Upload File.

== Importing Namespace Files ==
* Special Pages
* Import Pages
* Browse for the file to import
** MW-Namespace.xml
* Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
* Add a comment if you want.
* Ensure option "Import to a namespace" is selected
* Select the namespace from the drop-down list that matches the Assist being imported into, for example, MTS for CTMS, EPOD for C-ePOD, etc
* Upload File.

== Additional Actions ==
The following are additional actions that are required, with some sample pages.

* MediaWiki:Pagetitle-view-mainpage - change this text to define the title of the wiki e.g. Assist - OBS Hub
* Update the main page - the MTS one is the one with all the best notes in.
* Update the Did You Know page with the common Assist-based help topics - there is an example in this Assist of a Did You Know page which can be copied or exported, imported and then edited.
* "Download as PDF" to "Print as PDF" - e.g. "Print as PDF tab in the tab bar, typically on the top of the screen".

You can use the files on this Assist as templates:
* [[OBS:About]]
* [[OBS:General_disclaimer]]
* [[OBS:Privacy_policy]]
* [[OBS:Copyrights]]

== MediaWiki ==
You can find the MediaWiki license, contributors, FOSS attributions and components here:
* [[Special:Version]].

== Other Actions ==

=== Managing Revisions ===
Sometimes, you may want to roll-back edits, or delete or hide revisions to a page, perhaps to remove dangerous content.

This is controlled through user rights and groups - see below for more information on that.

Using the rollback feature (for administrators and users with the "rollback" right)

* Go to the page history, the user contributions page, or a diff page.
* Find the "rollback" link next to the consecutive edits you want to revert. It appears before the "undo" link.
* Click the "rollback" link. The page will automatically revert to the previous version by another user, and a pre-filled edit summary will appear.
* Save the edit. The change is marked as a "minor" edit in the history.
* Important: After using rollback, it's recommended to check the recent revisions to ensure all disruptive edits were reverted and no constructive edits were accidentally removed.

Using the undo feature (for any user)

* Navigate to the page history.
* Find the specific edit you want to undo in the list.
* Click the "undo" link at the end of that edit's line.
* An edit page will load with the changes from that edit removed. Later edits are retained by default.
* You can modify the default edit summary if needed.
* Click "Save page" to revert the single edit.

When to use which method

* Use rollback for reverting a large number of consecutive bad edits, such as vandalism, by the most recent user. It's a one-click process for authorized users.
* Use undo to revert a single edit or to manually edit the page to combine or resolve conflicts with later edits. The undo feature is available to all users.

You can permanently flatter all history in a page using the command line.

* For page histories: Run the script from your MediaWiki installation's directory. You can delete all old revisions by using the flag or by specifying the page ID.
* Example command (once in your wiki's maintenance directory):
** <code>{InstallDrive}:\xampp\php\php.exe deleteOldRevisions.php --delete 123</code>
* (Replace 123 with the page ID gathered from the page information).
* Note that running this script without <code>--delete</code> will just list the count of revisions that will be removed.

To delete a specific revision in MediaWiki, use the RevisionDelete feature, which administrators can enable to hide revisions from public view. This feature allows you to hide the content, username, or edit summary of one or more revisions without permanently removing them. First, enable the permission, then go to the page history, select the revisions using the checkboxes, and click "Change visibility of selected revisions" to hide them.

For administrators using RevisionDelete

# Enable the permission: Ensure your user account has the permission. This may require editing LocalSettings.php.
# Go to the page history: Navigate to the page and click the "View history" tab.
# Select revisions: Check the boxes next to the revisions you want to hide.
# Change visibility: Click the "Change visibility of selected revisions" button.
# Choose what to hide: Select the options to hide the content, usernames, or summaries.
# Apply changes: Add a log comment and click the "Apply to selected revisions" button.

=== Managing Interwikis ===
See here for an explanation of what we use this for: [[Assist Editing Guide#Interwiki|Interwiki]].

Each product wiki SHOULD be set up so that interwiki links are configured within the CALIDUS HUB only, and then disseminated to the individual Assists.

This is done in the following way:

in LocalSettingsAdditional.php:
$wgSharedDB = 'obs_assist'; # The $wgDBname for the wiki database holding the main interwiki table
$wgSharedPrefix = 'obs_'; # The $wgDBprefix for the database. Defaults to the prefix of the current wiki if not specified
$wgSharedTables = ['interwiki'];
If they are not, fix the Assist file above.

Current interwikis:

* epod
* cmcs
* ctms
* obs
* cportal
* cvision
* cwcs
* cwms

To add a new/edit an existing interwiki:

* ''Wiki Tools/Special pages''
* ''View and Edit InterWiki data''
* New
** Click ''Add an interwiki or language prefix''
** Prefix: new unique prefix
** Forward - ticked
** Transclude - ticked
** URL: the assist URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/Index.php?title=$1</nowiki>
** API: the API URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/api.php</nowiki>
** Click '''Add'''. (You may have to enter a reason).
* Edit
** Click the Edit link against the interwiki and make the changes you need, then click '''Edit'''. (You may have to enter a reason).

{{Note}}You need to be a sysop (a member of the Administrators group) to edit interwiki links. Currently that is the Admin user. See following section.

=== Maintaining User Rights ===
You must be an Administrator to do this. Currently that is the Admin user.

Use the ''Wiki Tools/Special pages'' link.

* User group rights - the rights associated to each group - this is maintained in the LocalSettings*.php files and will likely not change. Check this for a list of the rights that you want to assign. For example, if
* User list - a list of the users
* User rights - allows you to change the groups associated to each user, and therefore the rights allowed.
** Find the user ID and click '''Load User Rights'''
** Tick the boxes that you want them to have the rights to under Groups you can change
*** autoconfirmed user - has confirmed login through email address.
*** bot - leave unchecked/unassigned - no bots in this system.
*** administrator - admin/sysop (superuser) rights, patrol other users' unpatrolled edits. Basically everything
*** interface administrator - amend site CSS and Javascript i.e. a system maintainer.
*** bureaucrat - auto-patrolled edits
*** suppressor - revision maintainer
** You can also set the following against certain groups:
*** Expires: - the expiration date - use below instead if required.
*** Does not expire - check this instead.

== Support Issues ==

=== Seeing a Cat in the Background ===
There is a cat.svg linked from Timeless skin. (/calidus-assist/OBS/skins/Timeless/resources/images/cat.svg). This is the default.

This is configurable in skin.json in the Timeless directory for your Wiki. i.e. D:\xampp\htdocs\calidus-assist\OBS\skins\Timeless\skin.json

Solution: Set this to user-grey.svg instead.<pre>
"config": {
"TimelessBackdropImage": {
"value": "user-grey.svg",
"description": "Set it as you would $wgLogo to an appropriate background image. Recommendation is an svg set to 500-750px wide"
},
</pre>With multiple wiki installs, this is onerous. To facilitate changing multiple wiki installs, there is a directory in D:\Assist Install Files\MW-add-files called skins.

To apply:

* Copy the directory skins.
* Navigate to your Assist main folder e.g. D:\xampp\htdocs\calidus-assist\WMS
* Paste - this will overwrite the config file with the corrected one.

{{Warning}}This file is delivered with MediaWiki. A new install will overwrite this file. If you have updated MediaWiki or installed a new version of the Timeless skin, then compare the saved skin.json file with the new one and update with any new/changed attributes.
[[Category:Assist Guides]]
[[Category:ASSIST]]

Assist Support Guide

2026-02-20T12:14:13Z

Anw: Added user rights and expanded Interwiki section

The intention of this guide is to provide support information, and a general knowledge base and tips for the ongoing maintenance of Assist implementations.

== Requirements ==
MySQL WorkBench

Access to the Assist server.

== Hosted Systems ==
All hosted systems are documented in SharePoint, along with users and passwords.

You must have access to the SharePoint to read this document.

https://apteanonline.sharepoint.com/teams/CALIDUS-CONNECTIONS/Shared%20Documents/Forms/AllItems.aspx?id=%2Fteams%2FCALIDUS%2DCONNECTIONS%2FShared%20Documents%2FCalidus%20Assist&viewid=fffc6c78%2D04de%2D4e7d%2Db3ec%2D62168ff125fb

== Updating Data En Mass==
By default, MySQL will not allow updating of data without explicit WHERE or LIMIT clauses. To enable this:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Safe Updates"
* Restart MySQL WorkBench.
{{Warning}} You will then be able to (for example) delete all data inadvertently, so enable this option with care.

== Viewing BLOB fields ==
By default, MySQL WorkBench displays all text fields as "BLOB", which you must then right-click and choose "Open Value in Editor". To enable viewing the text directly in the results, do the following:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Treat BINARY/VARBINARY as nonbinary character string"
* Restart MySQL WorkBench.
{{Note}} Enabling this option comes with a performance hit - some text fields contain the entire page data, so enable this with care.

== Recovering passwords from MYSQL Workbench ==
First go check where your encrypted file is. Usually it is stored at %AppData%\MySQL\Workbench\workbench_user_data.dat

If different, amend the commands below.

Use Powershell

<pre>
Add-Type -AssemblyName System.Security
$cipher = Get-Content $env:APPDATA\MySQL\Workbench\workbench_user_data.dat -Encoding Byte -Raw
$scope = [System.Security.Cryptography.DataProtectionScope]::CurrentUser
$mysqlpwd = [System.Security.Cryptography.ProtectedData]::Unprotect( $cipher, $null, $scope )
[System.Text.UTF8Encoding]::UTF8.GetString($mysqlpwd)
</pre>

== Common Queries ==
<pre>
-- Assist SQL

-- Find the page ID
SELECT * FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%';

-- Find all revisions (to change comments)
SELECT * FROM obs_assist.obs_revision
where rev_page IN
(SELECT page_id FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%'
);

-- Find unpatrolled pages to set them patrolled
SELECT *
FROM obs_assist.obs_recentchanges
where rc_patrolled = 0;

UPDATE obs_assist.obs_recentchanges
SET rc_patrolled = 1
where rc_user_text = 'StylesC'

-- Check the logs for details of PDF production
SELECT * FROM mts_assist.oh_logging
where log_action ='PdfBook'
-- order by log_id desc

-- For v1.34 and later, comments have changed:
SELECT log.*, CONVERT(comment.comment_text USING utf8) comment
FROM epod_assist.epodlogging log
left join epod_assist.epodcomment comment
on comment.comment_id = log.log_comment_id
where log_action ='PdfBook'
--ORDER BY log_id DESC
--LIMIT 20
</pre>

== Assist Database Backup ==
Backup each database separately.

Use MySQL Administrator Data Export option.

Always check boxes as follows:
* Dump Stored Procedures and Functions
* Dump Events
* Dump Triggers
* Export to Self-contained File
** Name with the name of the Assist on the start of the dump.
* Include Create Schema

Advanced Options button
* Comments
* Create-options
* quote-names
* lock-tables
* dump-date
* disable-keys
* tz-utc
* add-locks
* extended-insert

Start Export

== Assist Database Restore ==
If required, drop the database from MySQL Administrator:
* On Schema explorer, right click on schema and select Drop Schema.

Use MySQL Administrator Data Import/Restore option.
* Import from self-contained file
* Select the database backup dump
* Click Start Import
* Refresh the schema explorer when done - the database should be present.

Restore database users, passwords and permissions when complete.

Will need to create the assist owner with username and password from LocalSettings.php
* From MySQL Admin Management Explorer
* Users and Privileges
* Add Account
** Login Name and Password - as per LocalSettings.php
* Administrative Roles tab - check DBA, which checks everything
* Schema Privileges - add entry
** Selected Schema
** Check everything (click Select 'ALL' button)
* Click Apply

Normal Assist users will need to be reset either by the users through 2FA, or through [[#Resetting User Passwords]].

== Creating Users/Resetting User Passwords ==
It is ALWAYS better to create a new user on the Wiki from the Special page "Create Account". In here, you should create the user and enter the email. This will send an email to the user to reset their own password.

However, in the event of coreecting a problem, this can be done from the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\createAndPromote.php {uname} {pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

You can also add some parameters to promote the user with group rights, as follows:
--bureaucrat Add the account to the bureaucrat group
--sysop Add the account to the sysop group
--interface-admin Add the account to the interface-admin group
--custom-groups Comma-separated list of groups to add the user to. This allows adding the user to any custom group.
Since MW 1.27, a user is only added to a custom group, if this group actually exists according to $wgGroupPermissions and $wgRevokePermissions. Non-existing groups are ignored.
--force If account already exists, just grant it rights or change password. Do not create a new account in this case.

In the event of needing to change a password, it is ALWAYS better to get the user to do it themselves - if the email has been set up, they can access the reset from there.

System admins can also force the sending of the reset password link from Special:ResetPassword.

In the event that this is simply correcting a previously set password, you can use the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\changePassword.php --user={uname} --password={pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

== Upgrading a Wiki from 1.16 Upwards ==
The following is a checklist of actions.

{SYSTEM}
* Extracted - INCOMPLETE
* DB Import - INCOMPLETE
* DB User - INCOMPLETE
** {SYSTEM}_owner/{PASSWORD}
* Version 1.31.6 - INCOMPLETE
** Move old extensions to old folder - INCOMPLETE
** Recreate LocalSettings.php
** Update password sender and emergency contact
* Version 1.34.4 - INCOMPLETE
** Leave LocalSettings.php
** May need to remove some extensions like numberformat and variables
* Version 1.39.8 - INCOMPLETE
** Leave LocalSettings.php
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - INCOMPLETE
** admin/Liverpool123
** anw/Liverpool123
* Problems
** NONE

== Creating a Brand New Wiki ==
The following is a checklist of actions.
* Copy version 1.39.8 to a WIKI name - INCOMPLETE
** Create LocalSettings.php
** xxx_owner with appropriate password
** Note the password!
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - ensure that there is at least an Admin user with full user rights. Note the password:
** Log in as administrative user
** Special:Create Account
** Create admin account - note the password.
** Special:User Rights
** Check Administrator, Interface Administrator, Bureaucrat and Suppressor
** Save user groups

== Extracting Hacks ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
MediaWiki:Common.js
MediaWiki:Group-user.css
MediaWiki:Common.css
MediaWiki:Vector.css
MediaWiki:Timeless.css
MediaWiki:Gadget-veCenterLoader.js
MediaWiki:Gadget-autonum
MediaWiki:Gadget-autonum.js
MediaWiki:Gadget-autonum.css
MediaWiki:Gadget-veCenterLoader
MediaWiki:Gadget-veCenter.js
MediaWiki:Gadgets-definition
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-hacks.xml

== Extracting Templates ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
Template:DocLink
Template:Doc_Title
Template:Comment
Template:Incomplete
Template:Note
Template:Hint
Template:Warning
Template:Xref
PageTemplate
DocTemplate
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Templates.xml

== Extracting Common Additional Files ==
Take the following from an Assist implementation that has them:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* Special:All Pages
* Enter start of file name in "Display pages starting at:"
* Select File Namespace from drop-down list and then click Go.
* Click on the file until a full-screen version appears.
* Right-click, Save Image As
* Save to your chosen directory.

== Extracting Namespace Files ==
* Extract from an existing Assist
* Special Pages
* Export Pages
* Add the pages specifically below, replacing the namespace with the namespace of the Assist system - in this case this is from CTMS Assist:
CTMS:Privacy_policy
CTMS:General_disclaimer
CTMS:Copyrights
CTMS:About
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Namespace.xml

{{Note}} You will then need to amend the About page to change the product name and copyright dates.

== Importing Additional Files, Templates and Hacks into a Wiki ==
* Ensure that all additional files from MW-add-files have been added.
* Upload additional files:
** Special:Upload Multiple Files
** Add a description if you want
** Select the following files:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* As soon as you select the files, the files will be uploaded. The page will indicate if there is any error uploading the files (for example if they already exist)
* Upload hacks and templates:
** Special Pages
** Import Pages
** Browse for the file to import, one of (do both)
*** MW-hacks.xml
*** MW-Templates.xml
** Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
** Add a comment if you want.
** Ensure option "Import to original namespace" is selected
** Upload File.

== Importing Namespace Files ==
* Special Pages
* Import Pages
* Browse for the file to import
** MW-Namespace.xml
* Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
* Add a comment if you want.
* Ensure option "Import to a namespace" is selected
* Select the namespace from the drop-down list that matches the Assist being imported into, for example, MTS for CTMS, EPOD for C-ePOD, etc
* Upload File.

== Additional Actions ==
The following are additional actions that are required, with some sample pages.

* MediaWiki:Pagetitle-view-mainpage - change this text to define the title of the wiki e.g. Assist - OBS Hub
* Update the main page - the MTS one is the one with all the best notes in.
* Update the Did You Know page with the common Assist-based help topics - there is an example in this Assist of a Did You Know page which can be copied or exported, imported and then edited.
* "Download as PDF" to "Print as PDF" - e.g. "Print as PDF tab in the tab bar, typically on the top of the screen".

You can use the files on this Assist as templates:
* [[OBS:About]]
* [[OBS:General_disclaimer]]
* [[OBS:Privacy_policy]]
* [[OBS:Copyrights]]

== MediaWiki ==
You can find the MediaWiki license, contributors, FOSS attributions and components here:
* [[Special:Version]].

== Other Actions ==

=== Managing Revisions ===
Sometimes, you may want to roll-back edits, or delete or hide revisions to a page, perhaps to remove dangerous content.

This is controlled through user rights and groups - see below for more information on that.

Using the rollback feature (for administrators and users with the "rollback" right)

* Go to the page history, the user contributions page, or a diff page.
* Find the "rollback" link next to the consecutive edits you want to revert. It appears before the "undo" link.
* Click the "rollback" link. The page will automatically revert to the previous version by another user, and a pre-filled edit summary will appear.
* Save the edit. The change is marked as a "minor" edit in the history.
* Important: After using rollback, it's recommended to check the recent revisions to ensure all disruptive edits were reverted and no constructive edits were accidentally removed.

Using the undo feature (for any user)

* Navigate to the page history.
* Find the specific edit you want to undo in the list.
* Click the "undo" link at the end of that edit's line.
* An edit page will load with the changes from that edit removed. Later edits are retained by default.
* You can modify the default edit summary if needed.
* Click "Save page" to revert the single edit.

When to use which method

* Use rollback for reverting a large number of consecutive bad edits, such as vandalism, by the most recent user. It's a one-click process for authorized users.
* Use undo to revert a single edit or to manually edit the page to combine or resolve conflicts with later edits. The undo feature is available to all users.

You can permanently flatter all history in a page using the command line.

* For page histories: Run the script from your MediaWiki installation's directory. You can delete all old revisions by using the flag or by specifying the page ID.
* Example command (once in your wiki's maintenance directory):
** <code>{InstallDrive}:\xampp\php\php.exe deleteOldRevisions.php --delete 123</code>
* (Replace 123 with the page ID gathered from the page information).
* Note that running this script without <code>--delete</code> will just list the count of revisions that will be removed.

To delete a specific revision in MediaWiki, use the RevisionDelete feature, which administrators can enable to hide revisions from public view. This feature allows you to hide the content, username, or edit summary of one or more revisions without permanently removing them. First, enable the permission, then go to the page history, select the revisions using the checkboxes, and click "Change visibility of selected revisions" to hide them.

For administrators using RevisionDelete

# Enable the permission: Ensure your user account has the permission. This may require editing LocalSettings.php.
# Go to the page history: Navigate to the page and click the "View history" tab.
# Select revisions: Check the boxes next to the revisions you want to hide.
# Change visibility: Click the "Change visibility of selected revisions" button.
# Choose what to hide: Select the options to hide the content, usernames, or summaries.
# Apply changes: Add a log comment and click the "Apply to selected revisions" button.

=== Managing Interwikis ===
See here for an explanation of what we use this for: [[Assist Editing Guide#Interwiki|Interwiki]].

Each product wiki SHOULD be set up so that interwiki links are configured within the CALIDUS HUB only, and then disseminated to the individual Assists.

This is done in the following way:

in LocalSettingsAdditional.php:
$wgSharedDB = 'obs_assist'; # The $wgDBname for the wiki database holding the main interwiki table

$wgSharedPrefix = 'obs_'; # The $wgDBprefix for the database. Defaults to the prefix of the current wiki if not specified

$wgSharedTables = ['interwiki'];
If they are not, fix the Assist file above.

Current interwikis:

* epod
* cmcs
* ctms
* obs
* cportal
* cvision
* cwcs
* cwms

To add a new/edit an existing interwiki:

* ''Wiki Tools/Special pages''
* ''View and Edit InterWiki data''
* New
** Click ''Add an interwiki or language prefix''
** Prefix: new unique prefix
** Forward - ticked
** Transclude - ticked
** URL: the assist URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/Index.php?title=$1</nowiki>
** API: the API URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/api.php</nowiki>
** Click '''Add'''. (You may have to enter a reason).
* Edit
** Click the Edit link against the interwiki and make the changes you need, then click '''Edit'''. (You may have to enter a reason).

{{Note}}You need to be a sysop (a member of the Administrators group) to edit interwiki links. Currently that is the Admin user. See following section.

=== Maintaining User Rights ===
You must be an Administrator to do this. Currently that is the Admin user.

Use the ''Wiki Tools/Special pages'' link.

* User group rights - the rights associated to each group - this is maintained in the LocalSettings*.php files and will likely not change. Check this for a list of the rights that you want to assign. For example, if
* User list - a list of the users
* User rights - allows you to change the groups associated to each user, and therefore the rights allowed.
** Find the user ID and click '''Load User Rights'''
** Tick the boxes that you want them to have the rights to under Groups you can change
*** autoconfirmed user - has confirmed login through email address.
*** bot - leave unchecked/unassigned - no bots in this system.
*** administrator - admin/sysop (superuser) rights, patrol other users' unpatrolled edits. Basically everything
*** interface administrator - amend site CSS and Javascript i.e. a system maintainer.
*** bureaucrat - auto-patrolled edits
*** suppressor - revision maintainer
** You can also set the following against certain groups:
*** Expires: - the expiration date - use below instead if required.
*** Does not expire - check this instead.

== Support Issues ==

=== Seeing a Cat in the Background ===
There is a cat.svg linked from Timeless skin. (/calidus-assist/OBS/skins/Timeless/resources/images/cat.svg). This is the default.

This is configurable in skin.json in the Timeless directory for your Wiki. i.e. D:\xampp\htdocs\calidus-assist\OBS\skins\Timeless\skin.json

Solution: Set this to user-grey.svg instead.<pre>
"config": {
"TimelessBackdropImage": {
"value": "user-grey.svg",
"description": "Set it as you would $wgLogo to an appropriate background image. Recommendation is an svg set to 500-750px wide"
},
</pre>With multiple wiki installs, this is onerous. To facilitate changing multiple wiki installs, there is a directory in D:\Assist Install Files\MW-add-files called skins.

To apply:

* Copy the directory skins.
* Navigate to your Assist main folder e.g. D:\xampp\htdocs\calidus-assist\WMS
* Paste - this will overwrite the config file with the corrected one.

{{Warning}}This file is delivered with MediaWiki. A new install will overwrite this file. If you have updated MediaWiki or installed a new version of the Timeless skin, then compare the saved skin.json file with the new one and update with any new/changed attributes.
[[Category:Assist Guides]]
[[Category:ASSIST]]

Assist Support Guide

2026-02-20T11:53:58Z

Anw: Added details of Interwiki maintenance

The intention of this guide is to provide support information, and a general knowledge base and tips for the ongoing maintenance of Assist implementations.

== Requirements ==
MySQL WorkBench

Access to the Assist server.

== Hosted Systems ==
All hosted systems are documented in SharePoint, along with users and passwords.

You must have access to the SharePoint to read this document.

https://apteanonline.sharepoint.com/teams/CALIDUS-CONNECTIONS/Shared%20Documents/Forms/AllItems.aspx?id=%2Fteams%2FCALIDUS%2DCONNECTIONS%2FShared%20Documents%2FCalidus%20Assist&viewid=fffc6c78%2D04de%2D4e7d%2Db3ec%2D62168ff125fb

== Updating Data En Mass==
By default, MySQL will not allow updating of data without explicit WHERE or LIMIT clauses. To enable this:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Safe Updates"
* Restart MySQL WorkBench.
{{Warning}} You will then be able to (for example) delete all data inadvertently, so enable this option with care.

== Viewing BLOB fields ==
By default, MySQL WorkBench displays all text fields as "BLOB", which you must then right-click and choose "Open Value in Editor". To enable viewing the text directly in the results, do the following:
* Go to "Edit/Preferences"
* Choose "SQL Editor" Under "Query Results"
* Check "Treat BINARY/VARBINARY as nonbinary character string"
* Restart MySQL WorkBench.
{{Note}} Enabling this option comes with a performance hit - some text fields contain the entire page data, so enable this with care.

== Recovering passwords from MYSQL Workbench ==
First go check where your encrypted file is. Usually it is stored at %AppData%\MySQL\Workbench\workbench_user_data.dat

If different, amend the commands below.

Use Powershell

<pre>
Add-Type -AssemblyName System.Security
$cipher = Get-Content $env:APPDATA\MySQL\Workbench\workbench_user_data.dat -Encoding Byte -Raw
$scope = [System.Security.Cryptography.DataProtectionScope]::CurrentUser
$mysqlpwd = [System.Security.Cryptography.ProtectedData]::Unprotect( $cipher, $null, $scope )
[System.Text.UTF8Encoding]::UTF8.GetString($mysqlpwd)
</pre>

== Common Queries ==
<pre>
-- Assist SQL

-- Find the page ID
SELECT * FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%';

-- Find all revisions (to change comments)
SELECT * FROM obs_assist.obs_revision
where rev_page IN
(SELECT page_id FROM obs_assist.obs_page
WHERE PAGE_TITLE LIKE '%SDD_366558%'
);

-- Find unpatrolled pages to set them patrolled
SELECT *
FROM obs_assist.obs_recentchanges
where rc_patrolled = 0;

UPDATE obs_assist.obs_recentchanges
SET rc_patrolled = 1
where rc_user_text = 'StylesC'

-- Check the logs for details of PDF production
SELECT * FROM mts_assist.oh_logging
where log_action ='PdfBook'
-- order by log_id desc

-- For v1.34 and later, comments have changed:
SELECT log.*, CONVERT(comment.comment_text USING utf8) comment
FROM epod_assist.epodlogging log
left join epod_assist.epodcomment comment
on comment.comment_id = log.log_comment_id
where log_action ='PdfBook'
--ORDER BY log_id DESC
--LIMIT 20
</pre>

== Assist Database Backup ==
Backup each database separately.

Use MySQL Administrator Data Export option.

Always check boxes as follows:
* Dump Stored Procedures and Functions
* Dump Events
* Dump Triggers
* Export to Self-contained File
** Name with the name of the Assist on the start of the dump.
* Include Create Schema

Advanced Options button
* Comments
* Create-options
* quote-names
* lock-tables
* dump-date
* disable-keys
* tz-utc
* add-locks
* extended-insert

Start Export

== Assist Database Restore ==
If required, drop the database from MySQL Administrator:
* On Schema explorer, right click on schema and select Drop Schema.

Use MySQL Administrator Data Import/Restore option.
* Import from self-contained file
* Select the database backup dump
* Click Start Import
* Refresh the schema explorer when done - the database should be present.

Restore database users, passwords and permissions when complete.

Will need to create the assist owner with username and password from LocalSettings.php
* From MySQL Admin Management Explorer
* Users and Privileges
* Add Account
** Login Name and Password - as per LocalSettings.php
* Administrative Roles tab - check DBA, which checks everything
* Schema Privileges - add entry
** Selected Schema
** Check everything (click Select 'ALL' button)
* Click Apply

Normal Assist users will need to be reset either by the users through 2FA, or through [[#Resetting User Passwords]].

== Creating Users/Resetting User Passwords ==
It is ALWAYS better to create a new user on the Wiki from the Special page "Create Account". In here, you should create the user and enter the email. This will send an email to the user to reset their own password.

However, in the event of coreecting a problem, this can be done from the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\createAndPromote.php {uname} {pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

You can also add some parameters to promote the user with group rights, as follows:
--bureaucrat Add the account to the bureaucrat group
--sysop Add the account to the sysop group
--interface-admin Add the account to the interface-admin group
--custom-groups Comma-separated list of groups to add the user to. This allows adding the user to any custom group.
Since MW 1.27, a user is only added to a custom group, if this group actually exists according to $wgGroupPermissions and $wgRevokePermissions. Non-existing groups are ignored.
--force If account already exists, just grant it rights or change password. Do not create a new account in this case.

In the event of needing to change a password, it is ALWAYS better to get the user to do it themselves - if the email has been set up, they can access the reset from there.

System admins can also force the sending of the reset password link from Special:ResetPassword.

In the event that this is simply correcting a previously set password, you can use the command line:

{InstallDrive}:\xampp\php\php.exe {InstallDrive}:\xampp\htdocs\calidus-assist\{wikiname}\maintenance\changePassword.php --user={uname} --password={pwd}

{{Warning}} You must change to the root of the install drive or this will not work e.g. enter "{InstallDrive}:" at the command prompt BEFORE the previous command.

== Upgrading a Wiki from 1.16 Upwards ==
The following is a checklist of actions.

{SYSTEM}
* Extracted - INCOMPLETE
* DB Import - INCOMPLETE
* DB User - INCOMPLETE
** {SYSTEM}_owner/{PASSWORD}
* Version 1.31.6 - INCOMPLETE
** Move old extensions to old folder - INCOMPLETE
** Recreate LocalSettings.php
** Update password sender and emergency contact
* Version 1.34.4 - INCOMPLETE
** Leave LocalSettings.php
** May need to remove some extensions like numberformat and variables
* Version 1.39.8 - INCOMPLETE
** Leave LocalSettings.php
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - INCOMPLETE
** admin/Liverpool123
** anw/Liverpool123
* Problems
** NONE

== Creating a Brand New Wiki ==
The following is a checklist of actions.
* Copy version 1.39.8 to a WIKI name - INCOMPLETE
** Create LocalSettings.php
** xxx_owner with appropriate password
** Note the password!
* New Extensions and files - INCOMPLETE
** Overwrite MW-add-files - INCOMPLETE
* LocalSettings.php - INCOMPLETE
** require_once "$IP/LocalSettingsAdditional.php";
* Gadgets and MediaWiki css/js hacks - INCOMPLETE
** Import MW-hacks.xml file - INCOMPLETE
* Templates - INCOMPLETE
** Import MW-Templates.xml - INCOMPLETE
* Additional Files - INCOMPLETE
** C:\Users\twalker\OneDrive - Aptean-online\Documents\Work\Assist\OBS Templates Export
*** Aptean_Logo.png
*** Attention_niels_epting.png
*** Bulbgraph.png
*** Hint.png
* About/General Disclaimer/Privacy Policy - INCOMPLETE
* Users - ensure that there is at least an Admin user with full user rights. Note the password:
** Log in as administrative user
** Special:Create Account
** Create admin account - note the password.
** Special:User Rights
** Check Administrator, Interface Administrator, Bureaucrat and Suppressor
** Save user groups

== Extracting Hacks ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
MediaWiki:Common.js
MediaWiki:Group-user.css
MediaWiki:Common.css
MediaWiki:Vector.css
MediaWiki:Timeless.css
MediaWiki:Gadget-veCenterLoader.js
MediaWiki:Gadget-autonum
MediaWiki:Gadget-autonum.js
MediaWiki:Gadget-autonum.css
MediaWiki:Gadget-veCenterLoader
MediaWiki:Gadget-veCenter.js
MediaWiki:Gadgets-definition
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-hacks.xml

== Extracting Templates ==
* Extract from MTS Assist
* Special Pages
* Export Pages
* Add the pages specifically below
Template:DocLink
Template:Doc_Title
Template:Comment
Template:Incomplete
Template:Note
Template:Hint
Template:Warning
Template:Xref
PageTemplate
DocTemplate
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Templates.xml

== Extracting Common Additional Files ==
Take the following from an Assist implementation that has them:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* Special:All Pages
* Enter start of file name in "Display pages starting at:"
* Select File Namespace from drop-down list and then click Go.
* Click on the file until a full-screen version appears.
* Right-click, Save Image As
* Save to your chosen directory.

== Extracting Namespace Files ==
* Extract from an existing Assist
* Special Pages
* Export Pages
* Add the pages specifically below, replacing the namespace with the namespace of the Assist system - in this case this is from CTMS Assist:
CTMS:Privacy_policy
CTMS:General_disclaimer
CTMS:Copyrights
CTMS:About
* Ensure the following are checked/unchecked:
** Include only the current revision, not the full history - CHECKED
** Include templates - UNCHECKED
** Save as file - CHECKED
* Export to MW-Namespace.xml

{{Note}} You will then need to amend the About page to change the product name and copyright dates.

== Importing Additional Files, Templates and Hacks into a Wiki ==
* Ensure that all additional files from MW-add-files have been added.
* Upload additional files:
** Special:Upload Multiple Files
** Add a description if you want
** Select the following files:
Aptean_Logo.png
Attention_niels_epting.png
hint.png
Bulbgraph.png
* As soon as you select the files, the files will be uploaded. The page will indicate if there is any error uploading the files (for example if they already exist)
* Upload hacks and templates:
** Special Pages
** Import Pages
** Browse for the file to import, one of (do both)
*** MW-hacks.xml
*** MW-Templates.xml
** Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
** Add a comment if you want.
** Ensure option "Import to original namespace" is selected
** Upload File.

== Importing Namespace Files ==
* Special Pages
* Import Pages
* Browse for the file to import
** MW-Namespace.xml
* Set InterWiki prefix to the name of the Wiki e.g. MTS, Portal, CTLTMS, etc
* Add a comment if you want.
* Ensure option "Import to a namespace" is selected
* Select the namespace from the drop-down list that matches the Assist being imported into, for example, MTS for CTMS, EPOD for C-ePOD, etc
* Upload File.

== Additional Actions ==
The following are additional actions that are required, with some sample pages.

* MediaWiki:Pagetitle-view-mainpage - change this text to define the title of the wiki e.g. Assist - OBS Hub
* Update the main page - the MTS one is the one with all the best notes in.
* Update the Did You Know page with the common Assist-based help topics - there is an example in this Assist of a Did You Know page which can be copied or exported, imported and then edited.
* "Download as PDF" to "Print as PDF" - e.g. "Print as PDF tab in the tab bar, typically on the top of the screen".

You can use the files on this Assist as templates:
* [[OBS:About]]
* [[OBS:General_disclaimer]]
* [[OBS:Privacy_policy]]
* [[OBS:Copyrights]]

== MediaWiki ==
You can find the MediaWiki license, contributors, FOSS attributions and components here:
* [[Special:Version]].

== Other Actions ==

=== Managing Revisions ===
Sometimes, you may want to roll-back edits, or delete or hide revisions to a page, perhaps to remove dangerous content.

Using the rollback feature (for administrators and users with the "rollback" right)

* Go to the page history, the user contributions page, or a diff page.
* Find the "rollback" link next to the consecutive edits you want to revert. It appears before the "undo" link.
* Click the "rollback" link. The page will automatically revert to the previous version by another user, and a pre-filled edit summary will appear.
* Save the edit. The change is marked as a "minor" edit in the history.
* Important: After using rollback, it's recommended to check the recent revisions to ensure all disruptive edits were reverted and no constructive edits were accidentally removed.

Using the undo feature (for any user)

* Navigate to the page history.
* Find the specific edit you want to undo in the list.
* Click the "undo" link at the end of that edit's line.
* An edit page will load with the changes from that edit removed. Later edits are retained by default.
* You can modify the default edit summary if needed.
* Click "Save page" to revert the single edit.

When to use which method

* Use rollback for reverting a large number of consecutive bad edits, such as vandalism, by the most recent user. It's a one-click process for authorized users.
* Use undo to revert a single edit or to manually edit the page to combine or resolve conflicts with later edits. The undo feature is available to all users.

You can permanently flatter all history in a page using the command line.

* For page histories: Run the script from your MediaWiki installation's directory. You can delete all old revisions by using the flag or by specifying the page ID.
* Example command (once in your wiki's maintenance directory):
** <code>{InstallDrive}:\xampp\php\php.exe deleteOldRevisions.php --delete 123</code>
* (Replace 123 with the page ID gathered from the page information).
* Note that running this script without <code>--delete</code> will just list the count of revisions that will be removed.

To delete a specific revision in MediaWiki, use the RevisionDelete feature, which administrators can enable to hide revisions from public view. This feature allows you to hide the content, username, or edit summary of one or more revisions without permanently removing them. First, enable the permission, then go to the page history, select the revisions using the checkboxes, and click "Change visibility of selected revisions" to hide them.

For administrators using RevisionDelete

# Enable the permission: Ensure your user account has the permission. This may require editing LocalSettings.php.
# Go to the page history: Navigate to the page and click the "View history" tab.
# Select revisions: Check the boxes next to the revisions you want to hide.
# Change visibility: Click the "Change visibility of selected revisions" button.
# Choose what to hide: Select the options to hide the content, usernames, or summaries.
# Apply changes: Add a log comment and click the "Apply to selected revisions" button.

=== Managing Interwikis ===
See here for an explanation of what we use this for: [[Assist Editing Guide#Interwiki|Interwiki]].

Each product wiki SHOULD be set up so that interwiki links are configured within the CALIDUS HUB only, and then disseminated to the individual Assists.

This is done in the following way:

in LocalSettingsAdditional.php:
$wgSharedDB = 'obs_assist'; # The $wgDBname for the wiki database holding the main interwiki table

$wgSharedPrefix = 'obs_'; # The $wgDBprefix for the database. Defaults to the prefix of the current wiki if not specified

$wgSharedTables = ['interwiki'];
If they are not, fix the Assist file above.

To add a new/edit an existing interwiki:

* ''Wiki Tools/Special pages''
* ''View and Edit InterWiki data''
* New
** Click ''Add an interwiki or language prefix''
** Prefix: new unique prefix
** Forward - ticked
** Transclude - ticked
** URL: the assist URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/Index.php?title=$1</nowiki>
** API: the API URL e.g. <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/api.php</nowiki>
** Click '''Add'''. (You may have to enter a reason).
* Edit
** Click the Edit link against the interwiki and make the changes you need, then click '''Edit'''. (You may have to enter a reason).

== Support Issues ==

=== Seeing a Cat in the Background ===
There is a cat.svg linked from Timeless skin. (/calidus-assist/OBS/skins/Timeless/resources/images/cat.svg). This is the default.

This is configurable in skin.json in the Timeless directory for your Wiki. i.e. D:\xampp\htdocs\calidus-assist\OBS\skins\Timeless\skin.json

Solution: Set this to user-grey.svg instead.<pre>
"config": {
"TimelessBackdropImage": {
"value": "user-grey.svg",
"description": "Set it as you would $wgLogo to an appropriate background image. Recommendation is an svg set to 500-750px wide"
},
</pre>With multiple wiki installs, this is onerous. To facilitate changing multiple wiki installs, there is a directory in D:\Assist Install Files\MW-add-files called skins.

To apply:

* Copy the directory skins.
* Navigate to your Assist main folder e.g. D:\xampp\htdocs\calidus-assist\WMS
* Paste - this will overwrite the config file with the corrected one.

{{Warning}}This file is delivered with MediaWiki. A new install will overwrite this file. If you have updated MediaWiki or installed a new version of the Timeless skin, then compare the saved skin.json file with the new one and update with any new/changed attributes.
[[Category:Assist Guides]]
[[Category:ASSIST]]

Assist Editing Guide

2026-02-20T11:23:54Z

Anw: Minor update

==General==
Before editing, you should log in - the Assist system will not allow you to edit the documents unless you have, so that all changes can be tracked to the user that made them.

==Document Editing==
When you find a page that needs editing, you can do it in one of to ways:
* Source Editing - typing in plain text with WikiText markup language - not too complicated, but a bit of a barrier for new users. Click the ''Edit Source'' button to start source editing. {{Note}}Source editing is stored in the browser, but will not persist of you close the browser. That makes it easy to lose a lot of changes if you are editing in source editor. Visual Editor changes will persist - it will remember your last changes in the session (as long as the session is still there!). So it's a lot harder to lose your changes between sessions with Visual Editor (as well as being a lot easier to use). You should only use Source Editing for certain things (like manually making small changes, adding "noinclude" tags, making a table searchable, etc - these exceptions are all called out below.
* Visual Editing - like a simple version of your favourite document editing application. You can do most things (but not all) with Visual Editing. Click the ''Edit'' link against a page to start Visual Editing.

You can also flip between visual and source editing when you're in there, so don't worry if you clicked the wrong one.

This guide will show you how to do everything here in each of the editing methods, to help reduce those barriers and make documentation easier.

== Source Editing ==
WikiText markup can seem daunting, but it's not meant to be. This guide won't try and describe everything that you can do with WikiText markup, but will describe how the tools can make it easier to do.

This section will introduce you to the source editing toolbar and some basic concepts.

When source editing you will have a toolbar for basic edits.
So start typing, and when you want to format something, you can use the toolbar.

If I want something in '''bold''', I click the '''Bold Text''' button - the WikiText markup will be put in the editing window for me, with the text in between the markup ready for editing.

The same is true for:
* ''Italic text''
* Headings (level 2-5)
* Bulleted lists (like this one) or
# Numbered list items like this one
* No Wiki formatting (turns off WikiText markup, hugely useful when writing a guide like this one!)
* New Line
* <big>Big text</big> or <small>Small text</small>
* <sup>Superscript text</sup> or <sub>Subscript text</sub>
* Links to other pages, like [[Did You Know]].
* <code>Code</code>.
* "Noinclude" tags.

You can also highlight the text you want to format and then click the button - the editor will tag the text you highlighted.

You have a '''Preview''' button - this shows you what you're WikiText changes look like in real formatting in near real time. You can't edit it there. but it's useful to see you're getting it right.

Other essential page formatting is more complicated:

Tables can be inserted easily enough using the '''Table''' button. Click the button, choose your number of columns and rows (and any properties of the table, like sortable) and click '''Insert'''. The editor will insert the table for you in shorthand, like below:

{| class="wikitable"
|+ Caption text
|-
! Header text !! Header text !! Header text
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|}

Then you can edit it. We typically do not use captions, so you could remove that line if you want. To change the cell content, simply change the text between the vertical bars (or exclamation points, if it's the header row).

Tables also support being searchable - it's not a property that is supported by the Table tool, so you have to edit it in yourself using the source editor.
* Add "apt-searchable" to the table class
<nowiki> {| class="wikitable apt-searchable" </nowiki>
* You can then make rows non-searchable by adding a class to the row "|-" element as follows:
<nowiki> |- class="non-searchable" </nowiki>

Images are covered in a following section.

== Visual Editing ==
Visual editing formats the text like it would do on the final page (in most cases). It's almost completely invisible to you as an editor that in the background this is generating the WikiText markup for you, so makes it much easier. There are however some things that the Visual Editor can't do which source editing is very useful for.

This section will introduce you to the visual editing toolbar and some basic concepts.

When visual editing you will have a toolbar for basic edits.
So start typing, and when you want to format something, you can use the toolbar or the provided shortcuts.

If I want something in '''bold''', I click the '''Style Text''' button and choose ''Bold'' or press <code>CTRL-B</code> - the text I type will be in bold from now on. You can turn it off in the same way.

{{Note}} The visual editor can use keyboard shortcuts, and the editor will tell you the shortcut keys next to the toolbar option you are selecting, if there is one.

Standard shortcut keys are also supported, like cut/copy/paste:
* <code>CTRL-X</code> - Cut.
* <code>CTRL-C</code> - Copy.
* <code>CTRL-V</code> - Paste (formatted).
* <code>CTRL-SHIFT-V</code> - Paste (plain text).

Additional formatting:
* <code>CTRL-I</code> - ''Italic text''
* <big>Big text</big> or <small>Small text</small>
* <sup>Superscript text</sup> or <sub>Subscript text</sub>
* <code>Computer code formatting</code>
* <code>CTRL-U</code> - <u>Underline</u>

and many more.

You can also highlight the text you want to format and then click the button - the editor will tag the text you highlighted.

Similarly with links to other pages, like [[Did You Know]]. Either click the Links button in the toolbar, enter the page name and click '''Done'''. You then have the opportunity to edit alternative text directly over the link. The same is true for an existing link when you click on it.

Bullets and numbered lists (and indentation) can be accessed from the '''Structure''' button.
* Bulleted lists (like this one). There's no shortcut key, but you can start a bulleted list by entering an asterisk followed by a space.
# Numbered list items like this one. There's no shortcut key, but you can start a numbered list by entering a number followed by a full stop and a space. Or a hash symbol followed by a space for a new numbered list.

Paragraph formatting can be accessed from the '''Paragraph Formatting''' drop-down list in the toolbar.
* Headings (level 2-5)
* Preformatted Code formatting
* Centre text

and many more.

{{Warning}} You currently can't mark anything as <code>nowiki</code> formatting, or as <code>noinclude</code>. Sorry - you have to use the Source Editor for that.

You have undo and redo buttons (and their normal shortcut keys (<code>CTRL-Z</code> and <code>CTRL-Y</code>).

If you are familiar with WikiText markup and start typing in the syntax from WikiText (like <nowiki>{{</nowiki> to insert a template), the Visual Editor is going to recognise that and either format the text or popup the dialogue associated to that WikiText markup - in the example above, it will open up the ''Insert Template'' dialogue for you, so the markup can be used as shortcuts in most cases. It doesn't work for bold and italic or images, but pretty much for everything else, so handy to know.

If you paste WikiText markup from source editing into the Visual Editor, it will convert the text for you, rather than see it as plain text - super useful when copying between pages.

Other essential page formatting is more complicated:

Tables can be inserted easily enough using the '''Insert''' button and selecting ''Table''. Click the button and a table is inserted into the page.

You can use the buttons to add columns and rows. You can also edit the properties of the table with the '''Properties''' button, for example, to get rid of the caption if you don't want it.

Editing the contents of the table is directly in the cells themselves - much easier.

{{Warning}} Unfortunately, you can't (yet) add searchable tables through the visual editor. You should switch to source editing to add this functionality.

Images are covered in a following section.

== Standards ==
To maintain a fairly standard set of documentation, use the following guidelines:
* Buttons should be in '''Bold'''.
* Tabs and menu options should be in ''italics''.
* Keyboard shortcuts or code should be in <code>Code or Preformatted</code> format.
* Leave two lines between sections.
* Use templates - see [[#Templates|Templates]] section below.
* Reuse documentation where possible - if there is already a page describing how to use or do something, include that page - see [[#Transcluding|Transcluding]] below.

== Images ==
Images must be uploaded to be used in pages, which is a bit of a pain, but really aids in reusability of images.

{{Warning}} Bear in mind that, with either Source or Visual editing, you can't trim or edit the image when it's uploaded, so make sure what you're uploading is what you want to see in the final document.

{{Warning}}Be very wary of using scalable graphics formats, such as SVG. Although they look fine in the web pages, the images do not render in the PDF print at this time.

'''When source editing:'''

These images need to be saved first.

Easiest is to use an image editing application such as MS Paint, which makes this fast and easily editable.
* Take a screenshot of your screen (<code>CTRL-PrtSc</code>) or the active window (<code>ALT-PrtSc</code>).
* Paste into Paint.
* Crop and Save to a local file - use PNG format by preference.
Alternatively, use the Windows Snip and Sketch tool to do the same.

Clicking the '''Image''' button will show a dialogue to enter:
* ''Filename'': enter a filename for an image that has been uploaded, or enter a new name. Keep it relevant, like "VEhub_Login.PNG"
* ''Caption'': optional
* ''Alternative text'': optional
* ''Size'': optional, but any image that you ware uploading that is greater than 1000px wide should be reduced to that or 800px, to make them fit in the PDF when produced.
* ''Align'': ''Left'', ''Center'', ''Right'' or ''None''.
* ''Format'': Choose ''None''.

You have an '''Upload''' button here, so you can upload the image you have already saved to your PC.

'''When visual editing:'''

You have lots of options to create a new image.
* You can take a screenshot of a screen or window as above or copy an image from a document or filesystem, then just paste (<code>CTRL-V</code>) in the editor - the ''Image'' dialogue will appear, showing a thumbnail, allowing you to name the image, then edit any properties. Steps:
** Paste the image - the image popup will appear.
** The image will initially be named "image.png" - that's OK, as we will change it in a minute - Check "This is my own work" and then click '''Upload'''.
** Enter a name - make sure that this is unique and relevant, , like "VEhub_Login.png" or "Tesla Order Search 1.png".
** Enter a description - the dialogue forces you to enter a description - you could just copy in the filename, or (preferably) enter a description, maybe also a unique ID like the screen name.
** Click '''Save''' - the properties box will be displayed - see below..
* You can drag and drop a local image from your PC straight to the window. When you drop it, the ''Image'' dialogue will appear, showing a thumbnail, allowing you to name the image (which will default to the name of the file being uploaded). From that point, it's similar to the above process, of uploading, naming, saving and editing properties.
* You can choose images you have recently uploaded by selecting the '''Insert''' button on the toolbar and selecting ''Images and Media''. You can then select the image from the ''Search'' tab, select it, click '''Use this image''' and then amend the properties. This is super-useful when combined with batch uploading of images (below).
* You can choose to re-use images that have already been uploaded onto the Assist by anyone - select the '''Insert''' button on the toolbar and selecting ''Images and Media''. You can then search for images by their name from the ''Search'' tab. When you find an appropriate image, you can select it, click '''Use this image''' and then amend the properties.
* You can directly upload a saved image by selecting the '''Insert''' button on the toolbar and selecting ''Images and Media''. You can then select the image from the ''Search'' tab and then amend the properties.

The properties you can edit are:
* ''Caption'': optional
* ''Alternative text'': optional
* ''Position'': Left, Center, Right or None. Choose Center or None. If will turn itself off if you select a Basic image.
* ''Image Type'': Choose Basic.
* ''Image Size'': optional, but any image that you ware uploading that is greater than 1000px wide should be reduced to that or 800px, to make them fit in the PDF when produced.

Then you can insert the image.

For updating an image that already exists, however, your options are more limited. It's important that we update images, rather than upload new ones. If you attempt to paste in an image and call it the same thing as something that already exists, Visual Editor will throw an error.

To update the image, you have to save as a picture file first:

* From a Word document, right-click, Save as Picture, give it a name and save.
* From printscreen, paste into your paint application and save as PNG.
* From Snip and Sketch, save as PNG.

You can then:

* click on the image link and upload a new version from the upload page.
* click ''Upload File'' from the Wiki Tools toolbar on the left and upload a new copy.
* batch upload the file - see below for details.

Regardless of which editor you are are using, you also have the ability to batch upload images. So, if you have created all the images you need and named them appropriately, you can upload those images using the Special page "''Upload Multiple Files''". From there, you can drag and drop or multi-select all of your images into the system, then use them in your page.

* Save your images to local files in a unique and reasonable filename - if it's reusable for other things, make them relevant, as above.
** From a Word document, right-click, Save as Picture, give it a name and save.
** From printscreen, paste into your paint application and save as PNG.
** From Snip and Sketch, save as PNG.
* Go to the Assist Special pages
* Select ''Upload Multiple Files''
* Enter a description if you want - it's optional, but can be useful. For example, if uploading a load of images relating to a Tesla Support document, you might enter "Tesla Support Images". But you can also leave this blank - that's perfectly fine.
* Either
** Select all your images in a Windows explorer and drag and drop to the appropriate place on the page
** Click the button, multi-select from the popup explorer and confirm.
* The files you selected will be shown in a list on the page.
* As they are uploaded, they will change colour to show whether they uploaded successfully or not
** If they turn green, all good.
** If they turn red, they didn't upload - check the error reason and correct.
* {{Warning}}Uploading a file that already exists will create a new version of that file - you should check where this image has been used before and make sure that the image you have uploaded is appropriate to all pages that use it.

== Templates ==
Where possible, the templates created for you should be used when creating and within the document.

We use Templates when we want a consistent look to certain things, from simple things like a notation, to more complicated things like a full document.

You can add templates quite easily:
* Source Editing:
** Just type in double-curly bracket notation like <code><nowiki>{{Warning}}</nowiki></code>
** Or Click the '''Template''' button, type the name or part of the name of the template you want to use, for example "War" then select it and '''Insert'''.
* Visual Editing: click the '''Insert''' toolbar option, then ''Template''. Type the name or part of the name of the template you want to use, for example "War" then select it and '''Insert'''.
Some more complicated templates have parameters that can be passed to them. In the example above, "Warning" can accept a single parameter of the warning text itself. It's optional in this case, but some really complicated templates (like Doc Title) have lots that are required to be entered - you use it like this:

* Source Editing:
** With positional parameters, just vertical bar delimit the parameters like so: <code><nowiki>{{Warning|My warning text}}</nowiki></code>
** Some templates support named parameters, like so:
<nowiki>{{Xref
|Type=Example
|Num=1
|Text=The text describing the cross-reference
}} </nowiki>
** Or Click the '''Template''' button, type the name or part of the name of the template you want to use, for example "War" then select it. You can then enter the parameters and '''Insert'''.
* Visual Editing: click the '''Insert''' toolbar option, then ''Template''. Type the name or part of the name of the template you want to use, for example "War" then select it. You can then enter the parameters and '''Insert'''.

Some simple templates:
* Note - This provides a note graphic {{Note}}like so
* Warning - This provides a warning graphic {{Warning}}like so
* Hint - this provides a hint note {{Hint}}Like so.
* Xref - this provides a cross-reference in a standard format. Use it like so: <nowiki>{{Xref|Type=Image|Num=1|Text=An image of something}}</nowiki>
* Incomplete - this adds a warning that the document is incomplete, and adds the document to an Incomplete category, so it can be easily found and completed. Use it like so: <nowiki>{{Incomplete}}</nowiki>
* Generic glossaries have been provided for the ''CALIDUS'' products -
** You will find them in the [[:Category:Glossaries|Glossaries]] category.
** These can be added to and amended if required by clicking on the glossary template in the editing screen.
** {{Note}} All Glossaries are now maintained in this Assist, the Calidus HUB. That means that you can add them to your pages or documents or refer to them, but they are all referred to as part of the "obs" namespace. This is a special bit of functionality known as Interwiki, and is dealt with below.
* Test Plan templates are available to construct test plan cycles - see the Functional Specification template for details on how these work.
* A Comment template has been added to identify comments added to a reviewed document easily {{comment|text=like so
|sign=[[User:Anw]]|date=31/1/2012 16:33:36}}

Some complicated templates:
* Doc Title - creates a document title page.
* Doc Appendix - creates a document appendix page.

Some full document templates:
Document templates have been produced for the following document types:
* Requirements
* Estimates
* Functional Specifications
* Small Change Requests
* Test Plans
* ERs
* Patches

and many more.

Full document templates can also be accessed through the [[Help:CreateNewPage]] page.

The links on that page will help you generate a new document or page.
* Enter the title of the page or document you are creating in the right entry box for the document that you want to create.
* Click the button.

The system will copy everything required in the template into a brand new page created for you, so that you can complete editing it.

There are pretty extensive guides in the [[:Category:ASSIST|Assist]] category on creating pages (specifically release notes) from Templates - it is advised that you look there for more information.

== Transcluding ==
Tranclusion is all about re-using pages that you have already created. We can (and should) do this, as "edit once, edit everywhere" applies, meaning that the pages are updated in every other page or category that uses them, massively reducing the amount of effort required to get changes into the right places.

Say for example, you have documented the Resource Allocation process in a page called "Allocate Resources". That screen is called from the Planning Screen and from the Waterfall screen, which are also documented. You want to describe resource allocation in the documentation of those pages, but you don't want to have to type it all in again, or have to keep updating multiple pages because a small change has happened to that Resource Allocation screen. You could just add it as a like , for example, "see Allocate Resources for more information", but you really want a complete document here. Transclusion helps here.

In the Planning page, you add a Header for "Allocating Resources"
* Source Editing: <code><nowiki>== Allocating Resources ==</nowiki></code>
* Visual Editing: Choose the ''Heading 2'' format from the toolbar and type "Allocating Resources".

Then we can transclude the page:
* Source Editing: <code><nowiki>{{:Allocating Resources}}</nowiki></code>
* Visual Editing: On a new line, click the '''Insert''' toolbar option, then ''Template''. Type a colon, followed by the page e.g. :Allocating Resources, then select it and '''Insert'''.

That's it - the page will be included at that point in your Planning page. Whenever Allocating Resources changes, the planning page will also update.

You can see wherever a page in included or linked to in any other pages really easily. Click "''What links here''" in the "''More''" toolbox section. That will show you a list of all:
* ''Transclusions'' - directly used in a page.
* ''Redirects'' - stub pages that immediately redirect to this page
* ''Links'' - just a link has been added.

That way, when you edit a page, if this edit fundamentally affects a document that is produced from those linked pages, you can edit those if necessary, perhaps to increment a version or modified date, if these pages are producing a PDF book.

== Interwiki ==
As you know, the Assist systems are based on MediaWiki, then engine that powers Wikimedia.

Each product has its own instance of this, so we have Assist (wiki) instances of (amongst others):
* OBS - Calidus HUB
* MTS - Calidus TMS
* WCS - Calidus WCS
* WMS - Calidus WMS 3pl
* Portal - Calidus Portal (all types)
* MCS - Calidus MCS
In the interests of reducing duplication and possible out of date guides existing within other pages, each of these Assists can use pages out of the other Assists by using a defined interwiki reference.

What that means is you can link to or transclude ANY page from any other Assist, like you would for any page on your Assist.

So, the interwiki shortcuts are:
* Calidus HUB - "obs"
* Calidus TMS - "ctms"
* Calidus WCS - "cwcs"
* Calidus WMS 3pl - "cwms"
* Calidus Portal - "cportal"
* Calidus MCS - "cmcs"

Essentially, you use the Interwiki prefix before the page or template you want to use.

* To use a template from another wiki, the syntax is <code><nowiki>{{iw:TemplateName}}</nowiki></code>.
* To link to a page from another wiki, the syntax is <code><nowiki>[[iw:PageName]]</nowiki></code>.
* To transclude a page from another wiki, the syntax is <code><nowiki>{{:iw:PageName}}</nowiki></code>.
* To use an interwiki link for a DocLink, the syntax is <code><nowiki>{{DocLink|:iw:PageName}}</nowiki></code>.

As mentioned above, Glossaries for all systems are maintained within the Calidus HUB Assist. The page exists in the local wiki, but it transcludes the Calidus HUB version. So, you can continue to use the template <code><nowiki>{{WMS Glossary}}</nowiki></code> as normal. But you could also use <code><nowiki>{{obs:WMS Glossary}}</nowiki></code> instead and get the same result.

Best use cases for Interwiki functionality are:
* Repetitively-maintained and used data, for example Glossaries.
* Technical guides linking to customer-facing guides, for example on this wiki [[CTMS Paragon Interface]], where the customer-facing guide maintained in the CTMS Assist is both linked to and transcluded.
* Product-specific pages linking to technical specs, for example, in WMS, you would find [[cwms:PoD Guide|PoD Guide]], which links to the Port of Dover SDD on this Assist [[SDD 350229 Port of Dover Solution Design]] as a DocLink to download the PDF i.e. <code><nowiki>{{DocLink|obs:SDD 350229 Port of Dover Solution Design}}</nowiki></code>

In this way, we further promote the "write once, write everywhere" mentality and reduce effort, which providing a more connected, more up to date documentation set to our customers.

== Categories ==
Categories are used to group pages together. A category can be used to see all pages in that category, and can also be used to produce a combined PDF book of all pages in that category.

You add categories like this if you are editing the source page: <code><nowiki>[[Category:Assist Guides]]</nowiki></code>

When using the Visual Editor, you can add Categories from the '''Menu''' button on the top-right of the Visual Editor toolbar, and click ''Categories''.

Any categories already on the page will be listed here. You can remove them, or add to existing ones by searching for the category in the box, or even create new categories - the search box will suggest what to do as you type.

When adding pages to categories that are intended to form part of a PDF book, then we want the pages sorted in a custom way, as opposed to the default, which is alphabetical.

When editing source, you do this as follows:
<nowiki>[[Category:Assist Guides|A-099]]</nowiki>

Here, we are saying that this page should be sorted in the category as A-099. Other pages will be sorted similarly, and therefore will appear in the correct sequence.

For example:

You have several pages, and you want them in this order on a category "Accounts":
* Accounts Title
* Accounts
* Contracts
* Invoices
* Debrief by Invoice
* Service Offerings
* Internal Recharging
* Accounts Appendix

If these pages were just added to the "Accounts" without sorting like <code><nowiki>[[Category:Accounts]]</nowiki></code>, they would appear in this sequence:
* Accounts
* Accounts Appendix
* Accounts Title
* Contracts
* Debrief by Invoice
* Internal Recharging
* Invoices
* Service Offerings

So, what we should do is add them with a sort key, for example:
* Accounts Title - added as <code><nowiki>[[Category:Accounts|000]]</nowiki></code>
* Accounts - added as <code><nowiki>[[Category:Accounts|100]]</nowiki></code>
* Contracts - added as <code><nowiki>[[Category:Accounts|110]]</nowiki></code>
* Invoices - added as <code><nowiki>[[Category:Accounts|120]]</nowiki></code>
* Debrief by Invoice - added as <code><nowiki>[[Category:Accounts|130]]</nowiki></code>
* Service Offerings - added as <code><nowiki>[[Category:Accounts|140]]</nowiki></code>
* Internal Recharging - added as <code><nowiki>[[Category:Accounts|150]]</nowiki></code>
* Accounts Appendix - added as <code><nowiki>[[Category:Accounts|999]]</nowiki></code>
The numbering leaves sufficient room to insert more pages in the place that we want them.

A page might (and very much should) be part of several categories.

For example, the Accounts page above is a page that is used as follows:
* Part of the Accounts PDF book
* Part of the CTMS Modules PDF Book
* Part of the CTMS User Guide PDF Book

So that page can be categorised into multiple categories like so:
<nowiki>
[[Category:Accounts|100]]
[[Category:C-TMS Modules|C-100]]
[[Category:C-TMS User Guide|BC-100]]
</nowiki>

{{Warning}} When you add categories to a page, and then you use that page in another page (see Transcluding), the other page will by default inherit the sub-page categories - we don't want this.

So, by default, categories should be included within a <nowiki><noinclude>...</noinclude></nowiki> tag, like so:
<nowiki>
<noinclude>
[[Category:Accounts|100]]
[[Category:C-TMS Modules|C-100]]
[[Category:C-TMS User Guide|BC-100]]
</noinclude>
</nowiki>

Pages that have been added to categories will be shown in the ''Categories'' section of the toolbar - clicking these links will take you to all pages in that category.

== Saving your Changes ==
Each change you make, however small, is included in the document's history. To ensure that these comments are not included, you should mark the change as minor when saving your changes. However, this should not be marked as minor if the edit fundamentally changes the document.

Comments should be added whenever saving edits. If you have edited a section directly, rather than the whole document, a comment will already be entered for you. You can leave this there, replace with a new comment or add your comment after this one.

Your comments should reflect the changes. It's good practice to reference any call numbers or system versions associated to the change of you know them. Avoid client names if you can - remember this is standard documentation! For example, for a SalesForce or DevOps change 123465 for customer ABC Travel, adding a new Customer Ref field to a screen, consider entering your comment as follows:
Added new Customer Ref field (123456)

As documentation should always be updated when software patches or releases are made available or released to a customer system, then consider using the ER/patch/release number in the comment, for example:
ER CTMS 047-101 - Added (some functionality) to the screen

When a document is going to be changed to a new version, you '''should''' change the version and date within the document, and add the version number to the start of the comment. For example:
* v0.02 - Draft issue for review
* v1.00 - Ready for Issue.

How this works is slightly different for each editor.

For Source Editing:
* Enter a summary comment.
* Check whether this is a ''Minor edit''.
* Optionally you can ''Watch this page'' - if anyone edits it in the future, you'll get an email. You can manage your watchlist from user preferences accessed from your user name.

Once you have selected, you can do the following:
* '''Save changes''' - if you haven't entered a summary comment you will be reminded, or the changes will just be saved.
* '''Show preview''' - as you are probably using realtime previews, probably not required. If you do use it, the changes will be shown on the top of the page, but remember your changes have not yet been saved - use the '''Save changes''' button as above to commit them.
* '''Show changes''' - show all changes in text differences showing each line changed, added or modified in a list. Remember your changes have not yet been saved - use the '''Save changes''' button as above to commit them.

From Visual Editing:
* Click '''Save Changes'''
* You will be shown a popup - enter your summary here.
* Check whether this is a ''Minor edit''.
* Optionally you can ''Watch this page'' - if anyone edits it in the future, you'll get an email. You can manage your watchlist from user preferences accessed from your user name.

You then have options.
* '''Save changes''' - if you haven't entered a summary comment you will be reminded, or the changes will just be saved.
* '''Review your changes''' - show all changes in differences. The changes will be shown in Visual ode with colour highlighting - you can switch to the text differences above as well if that suits you better. Remember your changes have not yet been saved - use the '''Save changes''' button as above to commit them.

== Some Final Notes ==
{{Note|
* When creating a new document, you should ensure that the Category tags are added relevant to that document type and client. This allows for easy searching of documents. See the following section on Categories.
* A document should be checked that it exports to PDF correctly - in most cases, documents will export with no issues. However, it has been known that a document does not correctly format into PDF. If this is the case, the document should be referred to the Assist maintainer for checking. Documents can be exported to PDF from the toolbar.}}

==Issuing Documents to a Client==
* Documents should be issued in PDF form.
* The document title should follow the standard document template, with a version number, so:
** EST 123456 CUSTREF Title v1.0.pdf
* If you use the standard document template with the Doc_Title title page and you specify a version, when you download the PDF, the document will be appended with the version number automatically.
* Whilst the Assist system is being adopted, these documents should be held in the standard development or project document folder - please consult your project or product documentation for details.

<noinclude>
[[Category:Assist Guides]]
[[Category:ASSIST]]
</noinclude>

Process - Functional Specification

2026-02-20T11:10:56Z

Anw: Categorisation

This page clarifies the Functional Specification Process

== Pre-Requirements ==

* One or many of:
** BRD
** SDD
** EST (spreadsheet and document)
** SOW
** Combined EST

== Process ==

* Requirement and functional overview created by PS lead for the project/change. Also technical notes as to how this was estimated.
* Handover to R&D.
* Testplan created at this stage, wrt scenarios (see below)
* R&D to create technical notes to implement the change as requested.

{{Note}} Regardless of who is doing the FS, the technical aspects should already have been discussed with R&D and noted.

== Creating an FS ==

The Functional Specification may be created as a Word doc or within Assist Calidus Hub and exported as a PDF.

== Using the FS Word Template ==

* Double click on the FS Template - this will create a new document
* Replace placeholder text with your text.
* Copy the requirements from the EST/BRD into the Client Requirement section
* Copy the Solution into the Solution section.
* Take any scoping comments from the Solution and move to Scoping.
** Strongly scope - if there are things that are not included or limited in the solution, make that clear in this section.
* Ensure that Pre-requisites are populated if required.
* Data section should include any backing data that should be set up and indicate whether this will be done by the client or by Aptean. Indicate whether this will be automated through a script at release, or post-implementation task.
* Implementation Advice should show whether anything else should be setup e.g. EDI, ORS reports, recreating reports, plus details.
* Functional Description should expand on the solution, focussing on detailing the functional components that will change (or not change) as part of this change.
** For example, the solution overview may say that a screen is changing to add a new field X. The Functional description should include a prototype screen layout or detailed description of where this field should be, what screen, etc.
** {{Note}} This section is critical - this section is what is signed off by the customer. Use customer wording or phrases if appropriate, to ensure that the customer understands the functionality in detail. Explain why this solution will fulfil their requirements.
* Technical notes may be structured and formatted in any way you please. However, this section is to be written/reviewed by R&D BEFORE release to the customer.
* The Test Plan should be created (from a template) and embedded in the document in this section, or pasted into this section, as long as this section is landscape.
** The test plan should be focussed more on scenario testing than unit testing. It is expected that the R&D operative will conduct appropriate unit and limit testing WITHOUT having to have explicit instructions, UNLESS that unit/limit testing is core to this change.
* Paste in the estimate values. Ensure that you account for your time, plus any time to issue/review the FS.
** If multiple departments/people are involved in the specification of this change, then you should note your time on the estimate in hours in total (plus delta if you have returned to this following review) as a review note.
** One of the authors should be assigned the final review, to total up all this time and amend the FS time, and remove any notes relating to this.
* Save as FS-{CaseNo}-{Client} {Desc} v{Version}.docx

{{Note|
* Document properties should be used for the following:
** Title - without references
** Version - 2dp e.g. 0.01
** Yearcopyright - e.g. 2025
** Client Company Name - {Client Name}
** Area or Project/System - {System & Release Version}
** Reference - {Case No - Cust Ref}
* These are used in the Heading, Footing and title pages.
* You can refresh all referenecs in each section using <code>[CTRL-A]-[F9]</code>
}}

== Using Assist Calidus Hub to create an FS ==

{{Note}} You must be logged in to be able to create new pages in Assist.

* Click the link here: [[Help:CreateNewPage#Functional_Specification|Create New FS from Template]]
* Enter the FS name following convention FS-{CaseNo}-{Client} {Desc}. {{Note}} No version in the page name.
* This will start an editor - this may be in Source mode or Visual Editing mode.
* Enter the #vardefine values, following the guidelines in the template.
* Enter text in all sections following the guidelines for the Word Template above.
* Enter the estimate values in the Appendix template provided.
* Save and provide reasonable change notes e.g. v0.01 - initial creation.
* Export the PDF using the link provided - this will append the version number.

{{Note|
* Follow the guidelines and help here: [[Assist Editing Guide]].
}}

== General Notes ==

{{Note}} All technical restrictions should be referred to the project PS lead in a timely fashion. This should not be an email or automated devops - this is directly affecting progress on development - organise a meeting asap to resolve the technical restriction. Bring examples and possibilities to the meeting.

<noinclude>[[Category:Processes]][[Category:ASSIST]]</noinclude>

Process - Estimate Document

2026-02-20T11:10:07Z

Anw: Categorisation

This page clarifies the Estimation process, specifically production of an EST document.

== Pre-Requirements ==

* One or many of:
** BRD
** SDD
** Combined EST

== Process ==

{{Note}} Regardless of who is doing the FS, the technical aspects should already have been discussed with R&D and noted.

== Creating an EST ==

The Estimate may be created as a Word doc or within Assist Calidus Hub and exported as a PDF.

== Using the EST Word Template ==

{{Note}} If an EST spreadsheet of any form has not been done yet, do this now. Instructions for doing this are here: [[Process - Using Office Templates]]

* Double click on the EST Template - this will create a new document
* Replace placeholder text with your text.
* Populate the header
* Copy the requirements from the EST/SDD/BRD into the Client Requirement section
* Create the Solution into the Solution section.
** Strongly scope - if there are things that are not included or limited in the solution, make that clear in this section.
* Paste in the estimate values. Ensure that you account for your time, plus any time to issue/review the EST.
** If multiple departments/people are involved in the specification of this change, then you should note your time on the estimate in hours in total (plus delta if you have returned to this following review) as a review note.
** One of the authors should be assigned the final review, to total up all this time and amend the FS time, and remove any notes relating to this.
* Save as EST-{CaseNo}-{Client} {Desc} v{Version}.docx

{{Note|
* Document properties should be used for the Title.
* These are used in the Heading.
* You can refresh all references in the title using [CTRL-A]-[F9] when in the title section.

== Using Assist Calidus Hub to create an EST ==

{{Note}} You must be logged in to be able to create new pages in Assist.

* Click the link here: [[Help:CreateNewPage#Estimate|Create New EST from Template]]
* Enter the EST name following convention EST-{CaseNo}-{Client} {Desc}. {{Note}} No version in the page name.
* This will start an editor - this may be in Source mode or Visual Editing mode.
* Enter the #vardefine values, following the guidelines in the template.
* Enter text in all sections following the guidelines for the Word Template above.
* Enter the estimate values in the Appendix template provided.
* Save and provide reasonable change notes e.g. v0.01 - initial creation.
* Export the PDF using the link provided - this will append the version number.

{{Note|
* Follow the guidelines and help here: [[Assist Editing Guide]].
}}

== General Notes ==

{{Note}} This document should NEVER contain technical notes e.g. packages/procedures, form names, etc. Be general - describe what is being provided, call out which areas are being changed and what is being changed and why this will fulfil the requirements. The ONLY exception is when this estimate is being provided to technical representatives rather than direct to the customers' operational staff.

<noinclude>[[Category:Processes]][[Category:ASSIST]]</noinclude>

Help:PDF Book

2026-02-20T11:07:32Z

Anw: Minor correction

This page is intended to help with the automated production of PDF Books from the Assist pages.

There are two ways of creating a PDF document:
* As a single page
* As a book - generated from multiple categorized pages.

== Single Page ==
For a single page, use the templates provided [[Help:CreateNewPage|here]]. These are designed to help you create new pages or documents, using templates to make the documents work properly.

==Creation of a Book==
*Create a title page, as the Document title plus the word "Title" on the end. The page can be created using the template provided. In addition, the footer must be configured on this page, utilising comments. For example:
<pre>
<nowiki>
{{Doc_Title|System=Calidus ''Vision''|Title=Vision Coding and Release|Reference=236343|Version=1.0|Date=9th May 2011}}
</nowiki>
</pre>
*Add this and all pages to be printed as part of the PDF book to a category of the same name, for example:
<pre>
<nowiki>
[[Category:Vision Coding and Release Doc|000]]
</nowiki>
</pre>
Note that the Category Sort value should be set to 000 for the title page. All other articles included in the document should have a sort value assigned to them to indicate the position in the document.
*If required, create an appendix page. This [[Template:Doc_Appendix|Template]] can be used as an example. This page should be named as the document title plus the word "Appendix" on the end. Note that the Category Sort should be set to 999 or ZZZ (last in the list of pages).
*Create the Category page as in the following example:
<pre>
<nowiki>
=Vision Coding and Release=
This category encompasses pages that collate technical information of how the system is built and installed.
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook&notitle}} Download this selection of articles as a PDF book.]
</nowiki>
</pre>

==Production of the PDF==
Click the link on the category entry created above, or click the Download/Print as PDF link in the toolbar from the category or from the single page.

==Setup Requirements==
See [[Assist PDF Production Code]] for details, but the PDF Book extension should already have been enabled in all Assist instances for you.

[[Category:Assist Guides]]
[[Category:ASSIST]]

Assist Help Config in Other Systems

2026-02-20T11:05:22Z

Anw: Minor update

Assist Help Configuration in Other Systems

== CTMS ==

Access to the database is required.

<pre>
SELECT * FROM ADM_SYSTEM_PARAM
WHERE PARAM_NAME LIKE '%ASSIST%'
</pre>

Update parameter CALIDUS_ASSIST_BASE_URL:
* If set to "/calidus-assist/MTS/index.php" then uses the base URL of the system you're accessing as the start.
* You can set the whole thing with something like: "https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/index.php"

<pre>
UPDATE ADM_SYSTEM_PARAM
SET VALUE = 'https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/index.php'
WHERE PARAM_NAME = 'CALIDUS_ASSIST_BASE_URL'
</pre>

== EPOD ==
Log on to the APP machine

Find the appropriate APP directory e.g. "C:\Program Files (x86)\Calidus.epod\EPOD_CTYPRD.app"

Edit the file "web&period;config" in Administrator mode

Find key "AssistURL" and set to the appropriate Assist system e.g.

<pre>
<add key="AssistURL" value="https://calidusassist.adcservices.apteancloud.com/calidus-assist/EPOD/index.php?title=" />
</pre>

Save.

== CTL ==

Log on to the APP machine

Find the appropriate APP directory e.g. "C:\Program Files (x86)\Calidus.CTL\CTYPRD"

Edit the file "web&period;config" in Administrator mode

Find key "HelpDocument" and set to the appropriate Assist system e.g.

<pre>
<add key="HelpDocument" value="https://calidusassist.adcservices.apteancloud.com/calidus-assist/CTL-TMS/index.php/" />
</pre>

Save.

==WMS==

Log on to the system.

Go to Setup/System Registry

Go to Global/General Settings.

Set WikiURL to <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/</nowiki>

Set WikiSubPath to WMS/index.php/Main_Page

Save.

{{Warning}}This is not confirmed as working.

{{Note}}This is not accessible from the Help menu Screen Help and Contents and Index menu items, but solely from Help/About, then clicking the Calidus Wiki button.

This functionality (to access context sensitive help) has been requested from the R&D team - this guide should be updated if/when this is complete.

==Bay Diary==

Log on to the APP machine

Find the appropriate APP directory.

Edit the file "web&period;config" in Administrator mode

Find (or add) key "AssistURL" and set to the appropriate Assist system e.g.

<pre>
<add key="AssistURL" value="https://calidusassist.adcservices.apteancloud.com/calidus-assist/WMS/index.php?title=" />
</pre>

Save.
==TCM==
{{Incomplete}}

==TOC==
{{Incomplete}}

== Portal ==
{{Incomplete}}

<noinclude>
[[Category:Technical Guides]][[Category:ASSIST]]
</noinclude>

Assist Converting Documents into MediaWiki Format

2026-02-20T11:02:53Z

Anw: Minor update

This guide is intended to show the processes that can be followed to convert a document (DOCX by preference) into an Assist page.

There are multiple methods and processes, including some not documented here, such as using LibreOffice or a Word extension, neither having produced reasonable results or time savings.

The processes below will automate vast tracts of the process and make the conversion of documents much easier and less time consuming.

== Tools ==

Recommended initial editing tool - NOTEPAD++
* https://notepad-plus-plus.org/downloads/

Create Macro - Assist Cleanup
* See documentation - [[Assist Cleanup Macro]]

Create Macro - Vertopal Cleanup
* See documentation - [[Assist Clean Up Vertopal Macro]]

Recommended - PowerToys
* https://learn.microsoft.com/en-us/windows/powertoys/install

AI

* Aurora/Direct ChatGPT
* Gemini

Online Conversion tool:

* https://www.vertopal.com/en/convert/docx-to-wiki-mediawiki

== Manual Process ==
The Visual Editor will convert documents safely and reasonably in most cases, with the exception of images. For very long or image-heavy documents, the process below is recommended.

For manual conversion:

* You must be logged in.
* Copy the appropriate text from your document.
* Create a new page
** For a blank page, easiest is to search for the title of the page you want to create in the Search bar, then click the red link to create the new page.
** For a particular document type or template, use the templates provided on [[Help:CreateNewPage|Create a new page]] from the home page. See the guides for this, but simply put:
*** Find the document type you want to create in the list
*** Enter a title - follow the guidelines shown.
*** Click the button - the page will be started for you with the appropriate templates (headers, footers, etc) all created for you and with sample headings ready to be entered.
*** {{Note}}Word automatically converts quotes and hyphens to "smart" quotes and dashes. These do not print well in PDF. You should consider using Find/Replace to remove/replace these.
* For each image in the document
** see if there is an appropriate image for that screen that you can already use search for pages on that screen and reuse if you can
** If not, copy the image, then paste into the Visual Editor. See the user guide for more details on this process, but simply put
*** Upload the file
*** Name the file appropriately so it can be found later - say, after the document, or the screen being documented.
*** Make it a basic image, no larger than 800px.
*** You can centre using the Paragraph drop-down in the toolbar.
* Categorize your page - see the user guide for more details, but simply:
** Choose Categories from the hamburger menu in the editor bar.
** Start typing your categories and add them.

== Process using On-line Converter ==
Convert document using Vertopal online conversion tool
* https://www.vertopal.com/en/convert/docx-to-wiki-mediawiki

Use DOC/DOCx - PDF doesn't work very well.

NOTE: This does not convert embedded objects like excel, attachments, Visio or Word diagrams. If your document contains these, then save these as PNG images to add to the document later.

Download and Extract to subfolder

Rename and Edit wiki file

Run Macro - Assist Cleanup

Run Macro - Clean Up Vertopal

Essentially this does the following:

<pre>
<span.*</span> with nothing

\[\[File\:vertopal_392608dac46847cb99daf0bb8d5090ed/media/image with \[\[File\:TTM-

\.png\|.*?\]\] with \.png\|800px\]\] (if mostly huge images) or \.png\]\] (if mostly small images)

<\/?blockquote> with nothing

<ol.*>\n<li> with \n

</li></ol> with nothing

= <br />\n with "= " (without the quotes)

\{\| with \{\| class="wikitable" border="1"

!width="\d*%"\| with !
</pre>

{{Note}} Replace in the above - this assumes replacing for a document for TTM - replace TTM- with the name of your Assist and doc being converted e.g. WMS-, PORTAL-TTM-ARCH-, EPOD-DEVICE-, CTLTMS-, etc

The Vertopal Cleanup macro will put in "SYS-DESC-", so replace that.

Go through and ensure images are named with a reasonable name

e.g. if in home section in TTM, change file from TTM-1.png to TTM-HOME-1.PNG

Check all images now have a name - search for File\:

Any inline icons, make size 16px - search for file\: and any that are within paragraphs will need manipulation

Put into Assist

Rename images - Recommend using PowerRename from PowerToys.
* Select all images to be renamed, then right-click and Select Rename with PowerRename.
* If from Vertopal, the images are in a media subdirectory, names as image1, image2, etc.
* Tick "User regular expressions"
* From name: image(.*)
* To name: SYS-DESC-$1

Example:
* From name: image(.*)
* To name: TTM-WMS-$1

{| class="wikitable"
|+ Results
|-
! From !! To
|-
| Image1 || TTM-WMS-1
|-
| Image2 || TTM-WMS-2
|-
| Image10 || TTM-WMS-10
|-
| Image11 || TTM-WMS-11
|-
| Image20a-text || TTM-WMS-20a-text
|}

{{Note}}If there is any media in funky formats (like WMF/WMV. Visio or other objects directly embedded), then these will need to be manually converted - use screenshots, paint, etc to achieve that. This is not covered in this guide.

When renamed, use the Upload Multiple Files Special page to upload the files in bulk:
* Go to Special pages
* Click Upload multiple files.
* Enter a description for the images (otherwise this will default to something useless).
* Drag your images to be uploaded to the appropriate place on the page.
* The images will upload automatically, showing the progress on the screen.
* If any images should fail, try re-uploading them - sometimes bulk uploading >40 images at a time will cause some issues.

If you are doing this manually instead, upload the images by clicking on the image in the document and then manually upload the correct "imageX" file using the numbers as guide.

Finally, check the sizes of all pictures - remove or add |800px if necessary.

== Process using AI/Manual ==
This process does not use an on-line converter process, but instead leverages AI to do a lot of the conversion work for you (after you have trained it appropriately). This is slightly more long-winded than using an online converter, but is much quicker than typing, copying and pasting manually.

'''Steps:'''

'''Convert the text to MediaWiki format'''

* Open the document
* Get rid of titles and final appendices - these will be added later using templates.
* Break the text down into chunks - it's easier to work with smaller segments
* Ask your favoured AI to convert the text to MediaWiki format.
** {{Note}}These steps are proven working for the AI's listed.
** E.g. Gemini process including prompts:
*** ''Please convert this text to Mediawiki format.''
*** Paste in text
*** ''Please remove the table of contents and the first page before that.''
*** ''Please lose the DIV elements''
*** ''The first heading is level 1, so please reflect that and reduce all other headings by 1 level''
*** ''Please remove the numbering from the headings.''
*** ''Please remove any smart quotes or dashes and replace with plain quotes and hyphens.''
*** ''The text I pasted in had images. Can you identify where those images were and put a placeholder in there of <nowiki>[[File:SYS-DESC.png|800px]]</nowiki>''
*** ''Can you make the placeholder count please? e.g. SYS-DESC-1.png, SYS-DESC-2.png, etc''
*** ''Any A.# headings should be level 2. Same for B.#, C.#.''
** E.g. Aurora/ChatGPT including prompts:
*** ''Please convert my text into mediawiki format''
*** Paste in text
*** ''Please make sure there are two line breaks between each section''
*** ''The first heading is level 1, so please reflect that and reduce all other headings by 1 level''
*** ''Please remove any smart quotes or dashes and replace with plain quotes and hyphens.''
*** ''The text I pasted in had images. Can you identify where those images were and put a placeholder in there of <nowiki>[[File:SYS-DESC.png|800px]]</nowiki>''
*** ''Can you make the placeholder count please? e.g. SYS-DESC-1.png, SYS-DESC-2.png, etc''
** More prompts may be required on your document to get the format right, such as numbered lists, tables etc. In my tests, these all converted well, but you may have other preferences. For example:
*** ''Please add "apt-searchable" as a class to the wikitables''
*** ''Please add width="100%" to the tables''
*** ''Please add border="1" to the tables.''
** Depending on your document, you may want to make the images start at a particular number. You can ask the AI, for example:
*** ''Please start the image numbering from the last section''
*** ''Please reset image placeholder numbering to 1''
*** ''Please start image placeholder numbering at 3''
** The AI may be limited to the amount of text that can be uploaded, or the amount of text that can be output. In the latter case, you may then be able to prompt the AI to give you the next section, piece by piece. E.g., for ChatGPT:
*** ''Please now output the next section of the text, starting where you left off''
*** ''Please continue''
** The output may be formatted by the AI renderer (for example, numbered lists look bold and large, line breaks are missing. You can ask for the plain wikitext code as opposed to the rendered output.
*** ''Please display the raw wikitext''
*** ''Please put 3 backticks at the start of the output''
** However, when you have trained your AI to give you the correct output, this should stick for further document conversions.
*** {{Warning}}You WILL lose all of your training is you close down the chat with your AI, so keep it open to preserve your requests for formatting.
* Create a new page in Assist
* Copy the converted text into your page, and continue until complete.

'''Extract Images/Media:'''

* Make a copy of your DOCX file and rename it to ZIP instead.
* Open the zip
* Go to word/media
* Copy all of the image files from here into folder.

{{Note}}If there is any media in funky formats (like WMF/WMV. Visio or other objects directly embedded), then these will need to be manually converted - use screenshots, paint, etc to achieve that. This is not covered in this guide.

'''Rename Images:'''

Recommend using PowerRename from PowerToys.
* Select all images to be renamed, then right-click and Select Rename with PowerRename.
* If from Vertopal, the images are in a media subdirectory, names as image1, image2, etc.
* Tick "User regular expressions"
* From name: image(.*)
* To name: SYS-DESC-$1
'''Upload Images'''

Use Assist batch upload to upload the images:

* Go to Special Pages
* Click Upload multiple files.
* Enter a description for the images (otherwise this will default to something useless).
* Drag your images to be uploaded to the appropriate place on the page.
* The images will upload automatically, showing the progress on the screen.
* If any images should fail, try re-uploading them - sometimes bulk uploading >40 images at a time will cause some issues.

'''Manual insertion of Images:'''

If you have not trained the AI to insert image placeholders as suggested above, you may need to manually insert images in the correct place in the document.

* You can use the VisualEditor copy and paste or upload.
* You can instead batch upload the images first.
* You can paste in <nowiki>[[File:SYS-DESC-1.png||800px]]</nowiki> for the first image, and then update as you go along.

Finally, check the sizes of all pictures - remove or add |800px if necessary.
[[Category:Assist Guides]]
[[Category:ASSIST]]

Assist Converting Documents into MediaWiki Format

2026-02-20T11:00:31Z

Anw: Added manual process

This guide is intended to show the processes that can be followed to convert a document (DOCX by preference) into an Assist page.

There are multiple methods and processes, including some not documented here, such as using LibreOffice or a Word extension, neither having produced reasonable results or time savings.

The processes below will automate vast tracts of the process and make the conversion of documents much easier and less time consuming.

== Tools ==

Recommended initial editing tool - NOTEPAD++
* https://notepad-plus-plus.org/downloads/

Create Macro - Assist Cleanup
* See documentation - [[Assist Cleanup Macro]]

Create Macro - Vertopal Cleanup
* See documentation - [[Assist Clean Up Vertopal Macro]]

Recommended - PowerToys
* https://learn.microsoft.com/en-us/windows/powertoys/install

AI

* Aurora/Direct ChatGPT
* Gemini

Online Conversion tool:

* https://www.vertopal.com/en/convert/docx-to-wiki-mediawiki

== Manual Process ==
The Visual Editor will convert documents safely and reasonably in most cases, with the exception of images. For image-heavy documents, the process below is recommended.

For manual conversion:

* You must be logged in.
* Copy the appropriate text from your document.
* Create a new page
** For a blank page, easiest is to search for the title of the page you want to create in the Search bar, then click the red link to create the new page.
** For a particular document type or template, use the templates provided on [[Help:CreateNewPage|Create a new page]] from the home page. See the guides for this, but simply put:
*** Find the document type you want to create in the list
*** Enter a title - follow the guidelines shown.
*** Click the button - the page will be started for you with the appropriate templates (headers, footers, etc) all created for you and with sample headings ready to be entered.
* For each image in the document
** see if there is an appropriate image for that screen that you can already use search for pages on that screen and reuse if you can
** If not, copy the image, then paste into the Visual Editor. See the user guide for more details on this process, but simply put
*** Upload the file
*** Name the file appropriately so it can be found later - say, after the document, or the screen being documented.
*** Make it a basic image, no larger than 800px.
*** You can centre using the Paragraph drop-down in the toolbar.
* Categorize your page - see the user guide for more details, but simply:
** Choose Categories from the hamburger menu in the editor bar.
** Start typing your categories and add them.

== Process using On-line Converter ==
Convert document using Vertopal online conversion tool
* https://www.vertopal.com/en/convert/docx-to-wiki-mediawiki

Use DOC/DOCx - PDF doesn't work very well.

NOTE: This does not convert embedded objects like excel, attachments, Visio or Word diagrams. If your document contains these, then save these as PNG images to add to the document later.

Download and Extract to subfolder

Rename and Edit wiki file

Run Macro - Assist Cleanup

Run Macro - Clean Up Vertopal

Essentially this does the following:

<pre>
<span.*</span> with nothing

\[\[File\:vertopal_392608dac46847cb99daf0bb8d5090ed/media/image with \[\[File\:TTM-

\.png\|.*?\]\] with \.png\|800px\]\] (if mostly huge images) or \.png\]\] (if mostly small images)

<\/?blockquote> with nothing

<ol.*>\n<li> with \n

</li></ol> with nothing

= <br />\n with "= " (without the quotes)

\{\| with \{\| class="wikitable" border="1"

!width="\d*%"\| with !
</pre>

{{Note}} Replace in the above - this assumes replacing for a document for TTM - replace TTM- with the name of your Assist and doc being converted e.g. WMS-, PORTAL-TTM-ARCH-, EPOD-DEVICE-, CTLTMS-, etc

The Vertopal Cleanup macro will put in "SYS-DESC-", so replace that.

Go through and ensure images are named with a reasonable name

e.g. if in home section in TTM, change file from TTM-1.png to TTM-HOME-1.PNG

Check all images now have a name - search for File\:

Any inline icons, make size 16px - search for file\: and any that are within paragraphs will need manipulation

Put into Assist

Rename images - Recommend using PowerRename from PowerToys.
* Select all images to be renamed, then right-click and Select Rename with PowerRename.
* If from Vertopal, the images are in a media subdirectory, names as image1, image2, etc.
* Tick "User regular expressions"
* From name: image(.*)
* To name: SYS-DESC-$1

Example:
* From name: image(.*)
* To name: TTM-WMS-$1

{| class="wikitable"
|+ Results
|-
! From !! To
|-
| Image1 || TTM-WMS-1
|-
| Image2 || TTM-WMS-2
|-
| Image10 || TTM-WMS-10
|-
| Image11 || TTM-WMS-11
|-
| Image20a-text || TTM-WMS-20a-text
|}

{{Note}}If there is any media in funky formats (like WMF/WMV. Visio or other objects directly embedded), then these will need to be manually converted - use screenshots, paint, etc to achieve that. This is not covered in this guide.

When renamed, use the Upload Multiple Files Special page to upload the files in bulk:
* Go to Special pages
* Click Upload multiple files.
* Enter a description for the images (otherwise this will default to something useless).
* Drag your images to be uploaded to the appropriate place on the page.
* The images will upload automatically, showing the progress on the screen.
* If any images should fail, try re-uploading them - sometimes bulk uploading >40 images at a time will cause some issues.

If you are doing this manually instead, upload the images by clicking on the image in the document and then manually upload the correct "imageX" file using the numbers as guide.

Finally, check the sizes of all pictures - remove or add |800px if necessary.

== Process using AI/Manual ==
This process does not use an on-line converter process, but instead leverages AI to do a lot of the conversion work for you (after you have trained it appropriately). This is slightly more long-winded than using an online converter, but is much quicker than typing, copying and pasting manually.

'''Steps:'''

'''Convert the text to MediaWiki format'''

* Open the document
* Get rid of titles and final appendices - these will be added later using templates.
* Break the text down into chunks - it's easier to work with smaller segments
* Ask your favoured AI to convert the text to MediaWiki format.
** {{Note}}These steps are proven working for the AI's listed.
** E.g. Gemini process including prompts:
*** ''Please convert this text to Mediawiki format.''
*** Paste in text
*** ''Please remove the table of contents and the first page before that.''
*** ''Please lose the DIV elements''
*** ''The first heading is level 1, so please reflect that and reduce all other headings by 1 level''
*** ''Please remove the numbering from the headings.''
*** ''Please remove any smart quotes or dashes and replace with plain quotes and hyphens.''
*** ''The text I pasted in had images. Can you identify where those images were and put a placeholder in there of <nowiki>[[File:SYS-DESC.png|800px]]</nowiki>''
*** ''Can you make the placeholder count please? e.g. SYS-DESC-1.png, SYS-DESC-2.png, etc''
*** ''Any A.# headings should be level 2. Same for B.#, C.#.''
** E.g. Aurora/ChatGPT including prompts:
*** ''Please convert my text into mediawiki format''
*** Paste in text
*** ''Please make sure there are two line breaks between each section''
*** ''The first heading is level 1, so please reflect that and reduce all other headings by 1 level''
*** ''Please remove any smart quotes or dashes and replace with plain quotes and hyphens.''
*** ''The text I pasted in had images. Can you identify where those images were and put a placeholder in there of <nowiki>[[File:SYS-DESC.png|800px]]</nowiki>''
*** ''Can you make the placeholder count please? e.g. SYS-DESC-1.png, SYS-DESC-2.png, etc''
** More prompts may be required on your document to get the format right, such as numbered lists, tables etc. In my tests, these all converted well, but you may have other preferences. For example:
*** ''Please add "apt-searchable" as a class to the wikitables''
*** ''Please add width="100%" to the tables''
*** ''Please add border="1" to the tables.''
** Depending on your document, you may want to make the images start at a particular number. You can ask the AI, for example:
*** ''Please start the image numbering from the last section''
*** ''Please reset image placeholder numbering to 1''
*** ''Please start image placeholder numbering at 3''
** The AI may be limited to the amount of text that can be uploaded, or the amount of text that can be output. In the latter case, you may then be able to prompt the AI to give you the next section, piece by piece. E.g., for ChatGPT:
*** ''Please now output the next section of the text, starting where you left off''
*** ''Please continue''
** The output may be formatted by the AI renderer (for example, numbered lists look bold and large, line breaks are missing. You can ask for the plain wikitext code as opposed to the rendered output.
*** ''Please display the raw wikitext''
*** ''Please put 3 backticks at the start of the output''
** However, when you have trained your AI to give you the correct output, this should stick for further document conversions.
*** {{Warning}}You WILL lose all of your training is you close down the chat with your AI, so keep it open to preserve your requests for formatting.
* Create a new page in Assist
* Copy the converted text into your page, and continue until complete.

'''Extract Images/Media:'''

* Make a copy of your DOCX file and rename it to ZIP instead.
* Open the zip
* Go to word/media
* Copy all of the image files from here into folder.

{{Note}}If there is any media in funky formats (like WMF/WMV. Visio or other objects directly embedded), then these will need to be manually converted - use screenshots, paint, etc to achieve that. This is not covered in this guide.

'''Rename Images:'''

Recommend using PowerRename from PowerToys.
* Select all images to be renamed, then right-click and Select Rename with PowerRename.
* If from Vertopal, the images are in a media subdirectory, names as image1, image2, etc.
* Tick "User regular expressions"
* From name: image(.*)
* To name: SYS-DESC-$1
'''Upload Images'''

Use Assist batch upload to upload the images:

* Go to Special Pages
* Click Upload multiple files.
* Enter a description for the images (otherwise this will default to something useless).
* Drag your images to be uploaded to the appropriate place on the page.
* The images will upload automatically, showing the progress on the screen.
* If any images should fail, try re-uploading them - sometimes bulk uploading >40 images at a time will cause some issues.

'''Manual insertion of Images:'''

If you have not trained the AI to insert image placeholders as suggested above, you may need to manually insert images in the correct place in the document.

* You can use the VisualEditor copy and paste or upload.
* You can instead batch upload the images first.
* You can paste in <nowiki>[[File:SYS-DESC-1.png||800px]]</nowiki> for the first image, and then update as you go along.

Finally, check the sizes of all pictures - remove or add |800px if necessary.
[[Category:Assist Guides]]
[[Category:ASSIST]]

DHL Automotive Process

2026-02-20T10:47:49Z

Anw: Added label sample

{{Incomplete}}

The purpose of this page is show base functionality that is in use within the Automotive Alliance system, as well as any particular options that a customer process may use.
==Systems==
*CALIDUS Systems
**CTMS ('''Base''')
**WCS ('''Base''')
**PORTAL
*Client Systems
**My Supply Chain ('''Base''')
**Microlise
**MixMove

==Process==
===Order Creation===
'''Base''':
*Order created in Fixed Schedule

Options:
*Add items via WCS Order Creation
**Loose Items and Assets (Roll Cases, pre-identified with fixed barcode)
**Label production from WCS
*Add Items and Contents via WCS Order Creation
*Item creation through EDI
*Item Content creation through EDI
*Customer Order identification through EDI
[[File:DHL AA Item Label.png|none|thumb|Sample label]]

===Execution===
'''Base''':
*WCS Loading of Order Items
**[[ctms:Loading Management]] - release to WCS for loading.
*Cross-dock operation (manual)
*Mixmove cross-dock scanning

Options:
*Microlise Delivery of Order Items
**Automatic Debrief of Order and Trip Stop/Trip.

===Tracking===
'''Base''':
*My Supply Chain Interface

Options:
*Portal TTM/TMS
*Customer Tracking Interface

===Returns===
'''Base''':
*Manual updates via customer systems

Options:
*Portal TMS Returns of Cages.
*Portal TMS Returns of Product
*Portal TMS Return Label Production.

==Config==
===Customer===
[[ctms:Customers]]

New customer setup.

Optional:

* ''Params'' tab:
** ''Consolidate Orders''
** ''Use Own Packaging''

===Locations===
[[ctms:Locations]]

Location required for source of product ('''Base'''). This will be:
*Client Warehouse
**Option: Special/WCS Item to Asset - controls FCA process (Items to Asset)
*Client RDC/XDock locations ('''Base''')
**Special/RF Cross-dock
*Dealerships
**As any other BRANCH location.
{{Note}}If you are setting up a completely new depot (RDC or Warehouse), you must also configure the OAQ tables for this depot - see section [[DHL Automotive Process#OAQ Configuration|OAQ Configuration]] below.

{{Note}}YOU MUST SET "RF_SUPPLIER" flag to "Y" on GEO_LOCATION manually in the background.

===Decodes===
[[ctms:Imports#Decodes]]

Decodes depend on the import (mostly) and export processes in use by the system.

These are used by these processes to convert the client data field content to CTMS data.

Samples of existing decodes below.
{| class="wikitable"
|-
!DECODE_NAME!!DECODE_TYPE
|-
|BMW_ASSET_TYPE||DU_TYPE
|-
|BMW_RET_TYPE||REFERENCE
|-
|BMW_TRANSPORT||REFERENCE
|-
|BMW_WAREHOUSE||LOCATION
|-
|FIAT_DEALERSHIP||LOCATION
|-
|FIAT_DUS||DU_TYPE
|-
|FORD_DEALERSHIP||LOCATION
|-
|FORD_DU||DU_TYPE
|-
|FORD_LOCATION||LOCATION
|-
|TESLA_DEALERSHIPS||REFERENCE
|-
|TESLA_DU_TYPES||REFERENCE
|-
|TOY_ASSET_TYPE||DU_TYPE
|-
|TOY_DEALERSHIP||LOCATION
|-
|TOY_PACKAGE_CODE||DU_TYPE
|-
|TOY_PACK_TYPE||REFERENCE
|-
|WCS_DEALERSHIP||LOCATION
|}

In general, the dealership locations are set against the imports/exports. If importing or exporting from another system, the locations are likely to be reused.

e.g. Location 11258 for Toyota may/will not be the same as location11258 for Ford.

In order to combat this, the locations are decoded. So 1148 arriving for a Ford order is perhaps decoded to e.g. F11258.

Similarly outbound - the locations are decodes in reverse.

DHL Link may also do a similar decoding.

As can be seen, any inbound interface would also need to decode customer-specific asset types, DU types, etc.

===Fixed Schedules===
[[ctms:Fixed Templates]]

The dealerships are strategically determined to have a delivery several times a week (perhaps even Daily).

The client works out where they will be delivering to each dealership and at what time, based on resources.

They also work out the collection time each day from the stock holding location (customer warehouse) to closest DHL hub.

This is saved onto the fixed schedule and the dealerships informed of their scheduled deliveries.

===EDI===
[[ctms:EDI Maintenance]]

'''Base''':
*MySC/ConnectedView Tracking EDI - Outbound
**CNV_ACC_AAMP
**CNV_OFDC_AAMPENROUTE
**CNV_OFDC_AAMPCOMPL
*Microlise - execution of initial pickup/final delivery/returns pickup
*MixMove - cross-dock processing/debrief
**ACCEPT_MIXMOVE_TRUNKS - Outbound - INT_XML_OUT2.AUTO_ACCEPTED
**MIXMOVE_SCNS - Inbound
**MIXMOVE - Outbound

Options:
*Order Inbound processes
**BMW
***BMW_INBOUND_ORDERS - Inbound - DP_BMW_EDI_IN.PROCESS_FILES
***BMW_CLAIM_ORDERS - Outbound - DP_BMW_EDI_OUT.SEND_CLAIMS
**Tesla - TESLA_ORDERS - Inbound - DP_TESLA_EDI_IN.IMPORT_ORDERS
***[[Tesla Orders EDI]]
***[[Support - Tesla EDI Inbound Guide]]
**Toyota - TOYOTA_ORDER_ITEMS - Inbound - DP_TOY_EDI_IN.P_PROCESS_FILES
**Ford - FORD_EDI_IN - Inbound - [[Ford Orders EDI]]
**Scania - SCANIA_ORDER_ITEMS - Inbound
*Customer-Specific Tracking EDI
**Tesla - TESLA_TRACKING - Outbound
***[[Support - Tesla EDI Outbound Guide]]
**FCA/FIAT - CLICK_OUTBOUND - Outbound
**Ford (TBC)

=== WCS Maintenance ===
[[ctms:WCS Maintenance]] controls the basic configuration of WCS and should realistically only need to be done once.

If you are creating a new depot, you MUST confirm/check the following:

* All CTMS configuration has been completed and data sent to WCS.
* You can log onto to WCS Maintenance and see the new depot.
** You MUST configure the depot the same as the existing depots before testing commences - side by side comparison.
* Set up TMS Users using the appropriate screen for RDT users. Assign to the depot.
* Set up any required WCS printers.
** To do a test print, use Data File, select All files, use "E:\Program Files\Warehouse Control Server\Bin\Label Formats\ZPL_4x2in_TMSASSET_AUT_v7 - TEST.lbl"
** Then click Test Print - the printer must be ON.

=== Assets ===
Permanent assets need to be set up in CTMS for customers.

[[ctms:Asset Management]]

{{Note}} At least 1 permanent asset for the customer must be set up BEFORE any others can be set up in the screen.

* Create a dummy one in the database first. Simply setup a new ASSET_DETAIL with the new owner, following the layout of an existing asset (e.g. NEW).

=== OAQ Configuration ===
If you are setting up a new depot (in the Locations section above), add your depot and link to agent on APP_AGENT table, for example:
{| class="wikitable"
!DEPOT
!AGENT
!Q_SCHEMA
!PRIMARY_AGENT
|-
|DHLMIDD
|AG_AUTO
|MTS_OWNER
|N
|}

== Reports/Imports/Exports ==

=== Reports ===
{| class="wikitable"
|AA Delivery Status Report External
|AA_DEL_STAT
|-
|AA Delivery Status Report Internal
|AA_DEL_STAT
|-
|AA Trip Sheet
|AA_TRIP_SHEET.rep
|}

=== Extracts ===
See [[ctms:Extracts - WCS Scanning]]

Also:
{| class="wikitable"
|Automotive Planning Report
|Planning_Report
|DP_CSV2.PLANNING_REPORT
|-
|BMW Asset Dwell
|AUTO_ASSET_DWELL
|DP_CSV3.AUTO_AFTERMARKET_BMW
|}
[[Category:DHLT]]
[[Category:DHL AA]]

File:DHL AA Item Label.png

2026-02-19T10:19:36Z

Anw:

DHL AA Item Label from WCS

DHL Automotive Process

2026-02-18T12:18:22Z

Anw: Added details of RF_SUPPLIER flag.

{{Incomplete}}

The purpose of this page is show base functionality that is in use within the Automotive Alliance system, as well as any particular options that a customer process may use.
==Systems==
*CALIDUS Systems
**CTMS ('''Base''')
**WCS ('''Base''')
**PORTAL
*Client Systems
**My Supply Chain ('''Base''')
**Microlise
**MixMove

==Process==
===Order Creation===
'''Base''':
*Order created in Fixed Schedule

Options:
*Add items via WCS Order Creation
**Loose Items and Assets (Roll Cases, pre-identified with fixed barcode)
*Add Items and Contents via WCS Order Creation
*Item creation through EDI
*Item Content creation through EDI
*Customer Order identification through EDI

===Execution===
'''Base''':
*WCS Loading of Order Items
**[[ctms:Loading Management]] - release to WCS for loading.
*Cross-dock operation (manual)
*Mixmove cross-dock scanning

Options:
*Microlise Delivery of Order Items
**Automatic Debrief of Order and Trip Stop/Trip.

===Tracking===
'''Base''':
*My Supply Chain Interface

Options:
*Portal TTM/TMS
*Customer Tracking Interface

===Returns===
'''Base''':
*Manual updates via customer systems

Options:
*Portal TMS Returns of Cages.
*Portal TMS Returns of Product
*Portal TMS Return Label Production.

==Config==
===Customer===
[[ctms:Customers]]

New customer setup.

Optional:

* ''Params'' tab:
** ''Consolidate Orders''
** ''Use Own Packaging''

===Locations===
[[ctms:Locations]]

Location required for source of product ('''Base'''). This will be:
*Client Warehouse
**Option: Special/WCS Item to Asset - controls FCA process (Items to Asset)
*Client RDC/XDock locations ('''Base''')
**Special/RF Cross-dock
*Dealerships
**As any other BRANCH location.
{{Note}}If you are setting up a completely new depot (RDC or Warehouse), you must also configure the OAQ tables for this depot - see section [[DHL Automotive Process#OAQ Configuration|OAQ Configuration]] below.

{{Note}}YOU MUST SET "RF_SUPPLIER" flag to "Y" on GEO_LOCATION manually in the background.

===Decodes===
[[ctms:Imports#Decodes]]

Decodes depend on the import (mostly) and export processes in use by the system.

These are used by these processes to convert the client data field content to CTMS data.

Samples of existing decodes below.
{| class="wikitable"
|-
!DECODE_NAME!!DECODE_TYPE
|-
|BMW_ASSET_TYPE||DU_TYPE
|-
|BMW_RET_TYPE||REFERENCE
|-
|BMW_TRANSPORT||REFERENCE
|-
|BMW_WAREHOUSE||LOCATION
|-
|FIAT_DEALERSHIP||LOCATION
|-
|FIAT_DUS||DU_TYPE
|-
|FORD_DEALERSHIP||LOCATION
|-
|FORD_DU||DU_TYPE
|-
|FORD_LOCATION||LOCATION
|-
|TESLA_DEALERSHIPS||REFERENCE
|-
|TESLA_DU_TYPES||REFERENCE
|-
|TOY_ASSET_TYPE||DU_TYPE
|-
|TOY_DEALERSHIP||LOCATION
|-
|TOY_PACKAGE_CODE||DU_TYPE
|-
|TOY_PACK_TYPE||REFERENCE
|-
|WCS_DEALERSHIP||LOCATION
|}

In general, the dealership locations are set against the imports/exports. If importing or exporting from another system, the locations are likely to be reused.

e.g. Location 11258 for Toyota may/will not be the same as location11258 for Ford.

In order to combat this, the locations are decoded. So 1148 arriving for a Ford order is perhaps decoded to e.g. F11258.

Similarly outbound - the locations are decodes in reverse.

DHL Link may also do a similar decoding.

As can be seen, any inbound interface would also need to decode customer-specific asset types, DU types, etc.

===Fixed Schedules===
[[ctms:Fixed Templates]]

The dealerships are strategically determined to have a delivery several times a week (perhaps even Daily).

The client works out where they will be delivering to each dealership and at what time, based on resources.

They also work out the collection time each day from the stock holding location (customer warehouse) to closest DHL hub.

This is saved onto the fixed schedule and the dealerships informed of their scheduled deliveries.

===EDI===
[[ctms:EDI Maintenance]]

'''Base''':
*MySC/ConnectedView Tracking EDI - Outbound
**CNV_ACC_AAMP
**CNV_OFDC_AAMPENROUTE
**CNV_OFDC_AAMPCOMPL
*Microlise - execution of initial pickup/final delivery/returns pickup
*MixMove - cross-dock processing/debrief
**ACCEPT_MIXMOVE_TRUNKS - Outbound - INT_XML_OUT2.AUTO_ACCEPTED
**MIXMOVE_SCNS - Inbound
**MIXMOVE - Outbound

Options:
*Order Inbound processes
**BMW
***BMW_INBOUND_ORDERS - Inbound - DP_BMW_EDI_IN.PROCESS_FILES
***BMW_CLAIM_ORDERS - Outbound - DP_BMW_EDI_OUT.SEND_CLAIMS
**Tesla - TESLA_ORDERS - Inbound - DP_TESLA_EDI_IN.IMPORT_ORDERS
***[[Tesla Orders EDI]]
***[[Support - Tesla EDI Inbound Guide]]
**Toyota - TOYOTA_ORDER_ITEMS - Inbound - DP_TOY_EDI_IN.P_PROCESS_FILES
**Ford - FORD_EDI_IN - Inbound - [[Ford Orders EDI]]
**Scania - SCANIA_ORDER_ITEMS - Inbound
*Customer-Specific Tracking EDI
**Tesla - TESLA_TRACKING - Outbound
***[[Support - Tesla EDI Outbound Guide]]
**FCA/FIAT - CLICK_OUTBOUND - Outbound
**Ford (TBC)

=== WCS Maintenance ===
[[ctms:WCS Maintenance]] controls the basic configuration of WCS and should realistically only need to be done once.

If you are creating a new depot, you MUST confirm/check the following:

* All CTMS configuration has been completed and data sent to WCS.
* You can log onto to WCS Maintenance and see the new depot.
** You MUST configure the depot the same as the existing depots before testing commences - side by side comparison.
* Set up TMS Users using the appropriate screen for RDT users. Assign to the depot.
* Set up any required WCS printers.
** To do a test print, use Data File, select All files, use "E:\Program Files\Warehouse Control Server\Bin\Label Formats\ZPL_4x2in_TMSASSET_AUT_v7 - TEST.lbl"
** Then click Test Print - the printer must be ON.

=== Assets ===
Permanent assets need to be set up in CTMS for customers.

[[ctms:Asset Management]]

{{Note}} At least 1 permanent asset for the customer must be set up BEFORE any others can be set up in the screen.

* Create a dummy one in the database first. Simply setup a new ASSET_DETAIL with the new owner, following the layout of an existing asset (e.g. NEW).

=== OAQ Configuration ===
If you are setting up a new depot (in the Locations section above), add your depot and link to agent on APP_AGENT table, for example:
{| class="wikitable"
!DEPOT
!AGENT
!Q_SCHEMA
!PRIMARY_AGENT
|-
|DHLMIDD
|AG_AUTO
|MTS_OWNER
|N
|}

== Reports/Imports/Exports ==

=== Reports ===
{| class="wikitable"
|AA Delivery Status Report External
|AA_DEL_STAT
|-
|AA Delivery Status Report Internal
|AA_DEL_STAT
|-
|AA Trip Sheet
|AA_TRIP_SHEET.rep
|}

=== Extracts ===
See [[ctms:Extracts - WCS Scanning]]

Also:
{| class="wikitable"
|Automotive Planning Report
|Planning_Report
|DP_CSV2.PLANNING_REPORT
|-
|BMW Asset Dwell
|AUTO_ASSET_DWELL
|DP_CSV3.AUTO_AFTERMARKET_BMW
|}
[[Category:DHLT]]
[[Category:DHL AA]]

DHL Automotive Process

2026-02-18T11:05:37Z

Anw: Expanded WCS Maintenance section

{{Incomplete}}

The purpose of this page is show base functionality that is in use within the Automotive Alliance system, as well as any particular options that a customer process may use.
==Systems==
*CALIDUS Systems
**CTMS ('''Base''')
**WCS ('''Base''')
**PORTAL
*Client Systems
**My Supply Chain ('''Base''')
**Microlise
**MixMove

==Process==
===Order Creation===
'''Base''':
*Order created in Fixed Schedule

Options:
*Add items via WCS Order Creation
**Loose Items and Assets (Roll Cases, pre-identified with fixed barcode)
*Add Items and Contents via WCS Order Creation
*Item creation through EDI
*Item Content creation through EDI
*Customer Order identification through EDI

===Execution===
'''Base''':
*WCS Loading of Order Items
**[[ctms:Loading Management]] - release to WCS for loading.
*Cross-dock operation (manual)
*Mixmove cross-dock scanning

Options:
*Microlise Delivery of Order Items
**Automatic Debrief of Order and Trip Stop/Trip.

===Tracking===
'''Base''':
*My Supply Chain Interface

Options:
*Portal TTM/TMS
*Customer Tracking Interface

===Returns===
'''Base''':
*Manual updates via customer systems

Options:
*Portal TMS Returns of Cages.
*Portal TMS Returns of Product
*Portal TMS Return Label Production.

==Config==
===Customer===
[[ctms:Customers]]

New customer setup.

Optional:

* ''Params'' tab:
** ''Consolidate Orders''
** ''Use Own Packaging''

===Locations===
[[ctms:Locations]]

Location required for source of product ('''Base'''). This will be:
*Client Warehouse
**Option: Special/WCS Item to Asset - controls FCA process (Items to Asset)
*Client RDC/XDock locations ('''Base''')
**Special/RF Cross-dock
*Dealerships
**As any other BRANCH location.
{{Note}}If you are setting up a completely new depot (RDC or Warehouse), you must also configure the OAQ tables for this depot - see section [[DHL Automotive Process#OAQ Configuration|OAQ Configuration]] below.

===Decodes===
[[ctms:Imports#Decodes]]

Decodes depend on the import (mostly) and export processes in use by the system.

These are used by these processes to convert the client data field content to CTMS data.

Samples of existing decodes below.
{| class="wikitable"
|-
!DECODE_NAME!!DECODE_TYPE
|-
|BMW_ASSET_TYPE||DU_TYPE
|-
|BMW_RET_TYPE||REFERENCE
|-
|BMW_TRANSPORT||REFERENCE
|-
|BMW_WAREHOUSE||LOCATION
|-
|FIAT_DEALERSHIP||LOCATION
|-
|FIAT_DUS||DU_TYPE
|-
|FORD_DEALERSHIP||LOCATION
|-
|FORD_DU||DU_TYPE
|-
|FORD_LOCATION||LOCATION
|-
|TESLA_DEALERSHIPS||REFERENCE
|-
|TESLA_DU_TYPES||REFERENCE
|-
|TOY_ASSET_TYPE||DU_TYPE
|-
|TOY_DEALERSHIP||LOCATION
|-
|TOY_PACKAGE_CODE||DU_TYPE
|-
|TOY_PACK_TYPE||REFERENCE
|-
|WCS_DEALERSHIP||LOCATION
|}

In general, the dealership locations are set against the imports/exports. If importing or exporting from another system, the locations are likely to be reused.

e.g. Location 11258 for Toyota may/will not be the same as location11258 for Ford.

In order to combat this, the locations are decoded. So 1148 arriving for a Ford order is perhaps decoded to e.g. F11258.

Similarly outbound - the locations are decodes in reverse.

DHL Link may also do a similar decoding.

As can be seen, any inbound interface would also need to decode customer-specific asset types, DU types, etc.

===Fixed Schedules===
[[ctms:Fixed Templates]]

The dealerships are strategically determined to have a delivery several times a week (perhaps even Daily).

The client works out where they will be delivering to each dealership and at what time, based on resources.

They also work out the collection time each day from the stock holding location (customer warehouse) to closest DHL hub.

This is saved onto the fixed schedule and the dealerships informed of their scheduled deliveries.

===EDI===
[[ctms:EDI Maintenance]]

'''Base''':
*MySC/ConnectedView Tracking EDI - Outbound
**CNV_ACC_AAMP
**CNV_OFDC_AAMPENROUTE
**CNV_OFDC_AAMPCOMPL
*Microlise - execution of initial pickup/final delivery/returns pickup
*MixMove - cross-dock processing/debrief
**ACCEPT_MIXMOVE_TRUNKS - Outbound - INT_XML_OUT2.AUTO_ACCEPTED
**MIXMOVE_SCNS - Inbound
**MIXMOVE - Outbound

Options:
*Order Inbound processes
**BMW
***BMW_INBOUND_ORDERS - Inbound - DP_BMW_EDI_IN.PROCESS_FILES
***BMW_CLAIM_ORDERS - Outbound - DP_BMW_EDI_OUT.SEND_CLAIMS
**Tesla - TESLA_ORDERS - Inbound - DP_TESLA_EDI_IN.IMPORT_ORDERS
***[[Tesla Orders EDI]]
***[[Support - Tesla EDI Inbound Guide]]
**Toyota - TOYOTA_ORDER_ITEMS - Inbound - DP_TOY_EDI_IN.P_PROCESS_FILES
**Ford - FORD_EDI_IN - Inbound - [[Ford Orders EDI]]
**Scania - SCANIA_ORDER_ITEMS - Inbound
*Customer-Specific Tracking EDI
**Tesla - TESLA_TRACKING - Outbound
***[[Support - Tesla EDI Outbound Guide]]
**FCA/FIAT - CLICK_OUTBOUND - Outbound
**Ford (TBC)

=== WCS Maintenance ===
[[ctms:WCS Maintenance]] controls the basic configuration of WCS and should realistically only need to be done once.

If you are creating a new depot, you MUST confirm/check the following:

* All CTMS configuration has been completed and data sent to WCS.
* You can log onto to WCS Maintenance and see the new depot.
** You MUST configure the depot the same as the existing depots before testing commences - side by side comparison.
* Set up TMS Users using the appropriate screen for RDT users. Assign to the depot.
* Set up any required WCS printers.
** To do a test print, use Data File, select All files, use "E:\Program Files\Warehouse Control Server\Bin\Label Formats\ZPL_4x2in_TMSASSET_AUT_v7 - TEST.lbl"
** Then click Test Print - the printer must be ON.

=== Assets ===
Permanent assets need to be set up in CTMS for customers.

[[ctms:Asset Management]]

{{Note}} At least 1 permanent asset for the customer must be set up BEFORE any others can be set up in the screen.

* Create a dummy one in the database first. Simply setup a new ASSET_DETAIL with the new owner, following the layout of an existing asset (e.g. NEW).

=== OAQ Configuration ===
If you are setting up a new depot (in the Locations section above), add your depot and link to agent on APP_AGENT table, for example:
{| class="wikitable"
!DEPOT
!AGENT
!Q_SCHEMA
!PRIMARY_AGENT
|-
|DHLMIDD
|AG_AUTO
|MTS_OWNER
|N
|}

== Reports/Imports/Exports ==

=== Reports ===
{| class="wikitable"
|AA Delivery Status Report External
|AA_DEL_STAT
|-
|AA Delivery Status Report Internal
|AA_DEL_STAT
|-
|AA Trip Sheet
|AA_TRIP_SHEET.rep
|}

=== Extracts ===
See [[ctms:Extracts - WCS Scanning]]

Also:
{| class="wikitable"
|Automotive Planning Report
|Planning_Report
|DP_CSV2.PLANNING_REPORT
|-
|BMW Asset Dwell
|AUTO_ASSET_DWELL
|DP_CSV3.AUTO_AFTERMARKET_BMW
|}
[[Category:DHLT]]
[[Category:DHL AA]]

Oracle SQL Optimization - Intro

2026-02-17T10:20:31Z

Anw: Minor formatting change

= Identifying Poorly Performing SQL in Oracle: A Developer's Guide =
'''Author:''' Database Engineering Team

This technical guide explains practical, developer-focused techniques for identifying and diagnosing poorly performing SQL statements in Oracle databases. It covers built-in Oracle performance views and tools, shows example queries, and provides guidance on interpreting execution plans, wait events, and prioritization criteria to focus tuning efforts where they matter most.

== Overview ==
Poorly performing SQL is one of the most common root causes of slow applications in Oracle environments. Identifying these statements early allows developers to reduce response times, lower database load, and improve overall system stability.

Oracle provides several built-in performance monitoring views and reports that make it possible to find high-impact SQL without third-party tools. This document focuses on practical usage of AWR, V$SQL, ASH, and SQL Monitor from a developer perspective.

== Why SQL Performance Matters ==
Inefficient SQL can consume excessive CPU, memory, and I/O, directly impacting other sessions on the same database. A single bad query can degrade the performance of an entire application. From a development standpoint, understanding SQL performance helps:

Prevent scalability issues.

Reduce operational costs.

Shorten incident resolution time when performance problems occur in production.

== Top Methods to Identify Poorly Performing SQL ==
Oracle offers multiple complementary tools to analyze SQL performance. Each tool answers different questions, such as which SQL uses the most resources over time or which SQL is slow right now.

{| class="wikitable"
|+ Oracle Performance Tools and Use Cases
! Tool !! Primary Use Case !! Typical Scenario
|-
| AWR (Automatic Workload Repository) || Historical analysis of top SQL by resource usage || Investigating performance issues that occurred in the past
|-
| V$SQL || Current and recent SQL execution statistics || Finding SQL with high CPU or elapsed time right now
|-
| ASH (Active Session History) || Session-level wait and activity analysis || Understanding where time is spent during slow periods
|-
| SQL Monitor || Detailed execution monitoring for individual SQL || Diagnosing long-running or parallel queries
|}

=== Using AWR to Find High-Impact SQL ===
AWR reports rank SQL statements by metrics such as elapsed time, CPU time, logical reads, and physical reads. These rankings help identify SQL that contributes most to overall database load. Developers commonly start with the 'SQL ordered by Elapsed Time' or 'SQL ordered by CPU Time' sections of the AWR report to locate tuning candidates.
+2

=== Using VSQLforReal−TimeAnalysis===
TheVSQL view provides execution statistics for SQL statements currently in the shared pool. It is useful for identifying SQL with high average execution time or excessive buffer gets. Developers should focus on per-execution metrics rather than total values to avoid being misled by frequently executed but inexpensive SQL.

{| class="wikitable"
|+ Example V$SQL Metrics
! Metric !! Description
|-
| ELAPSED_TIME / EXECUTIONS || Average elapsed time per execution in microseconds
|-
| BUFFER GETS / EXECUTIONS || Logical I/O per execution
|-
| DISK_READS / EXECUTIONS || Physical reads per execution
|}

=== Using ASH to Understand Waits ===
Active Session History (ASH) samples active database sessions and records what they are waiting for. ASH is especially useful when performance problems are intermittent. By grouping ASH data by SQL_ID and wait event, developers can identify which SQL statements are blocked by I/O, locks, or CPU contention.
+2

=== Using SQL Monitor for Long-Running SQL ===
SQL Monitor automatically captures execution details for SQL statements that run longer than a threshold or use parallel execution. It provides step-by-step execution progress, row counts, and time spent in each operation, making it ideal for diagnosing complex queries.
+1

== Sample Queries ==
The following examples illustrate how developers can query Oracle dynamic performance views to identify poorly performing SQL.

{| class="wikitable"
! Purpose !! Example Query
|-
| Find SQL with highest average elapsed time
|<pre>
SELECT sql_id, executions,
elapsed_time/executions avg_elapsed
FROM vsql WHERE executions > 0 ORDERBY avgelapsed DESC</pre>
|-
|Find SQL with highest buffer gets per execution
|<pre>SELECTsql
id, buffergets/executionsavg gets
FROM vsql
WHERE executions > 0
ORDER BY avg_gets DESC
</pre>
|}

== Execution Plan Analysis ==
Execution plans explain how Oracle accesses data and joins tables. Poor performance often correlates with inefficient access paths or join methods. Developers should look for:

Full table scans on large tables.

Unexpected nested loop joins.

Significant differences between estimated and actual row counts.

== Common Red Flags and Wait Events ==
Certain patterns frequently indicate SQL that requires tuning. These red flags can often be spotted directly in execution plans or performance views.

{| class="wikitable"
|+ Typical SQL Performance Red Flags
! Red Flag !! Why It Matters
|-
| Full table scan on large tables || Causes excessive I/O and CPU usage
|-
| High buffer gets per execution || Indicates inefficient data access
|-
| Large difference between estimated and actual rows || Leads to suboptimal execution plans
|-
| Frequent hard parsing || Increases CPU usage and latch contention
|}

Wait events provide insight into why SQL is slow.

{| class="wikitable"
|+ Common Oracle Wait Events
! Wait Event !! Typical Cause
|-
| db file sequential read || Single-block I/O, often index access
|-
| db file scattered read || Multi-block I/O, often full table scans
|-
| CPU + Wait for CPU || CPU contention due to inefficient SQL
|-
| enq: TX - row lock contention || Blocking due to concurrent DML
|}

== Prioritization Checklist ==
Not all slow SQL should be tuned first. Developers should prioritize based on business impact and resource consumption.

{| class="wikitable"
|+ SQL Tuning Prioritization Checklist
! Criterion !! Question to Ask
|-
| Execution frequency || Is this SQL executed thousands of times per hour?
|-
| User impact || Does it affect critical user-facing functionality?
|-
| Resource usage || Does it consume significant CPU or I/O?
|-
| Ease of fix || Can indexing or query rewrite provide quick gains?
|}

[[Category:Oracle]]

Oracle SQL Optimization - Intro

2026-02-13T15:10:12Z

Anw: Categorisation

= Identifying Poorly Performing SQL in Oracle: A Developer's Guide =
'''Author:''' Database Engineering Team

This technical guide explains practical, developer-focused techniques for identifying and diagnosing poorly performing SQL statements in Oracle databases. It covers built-in Oracle performance views and tools, shows example queries, and provides guidance on interpreting execution plans, wait events, and prioritization criteria to focus tuning efforts where they matter most.
+1

== Overview ==
Poorly performing SQL is one of the most common root causes of slow applications in Oracle environments. Identifying these statements early allows developers to reduce response times, lower database load, and improve overall system stability.
+1

Oracle provides several built-in performance monitoring views and reports that make it possible to find high-impact SQL without third-party tools. This document focuses on practical usage of AWR, V$SQL, ASH, and SQL Monitor from a developer perspective.
+1

== Why SQL Performance Matters ==
Inefficient SQL can consume excessive CPU, memory, and I/O, directly impacting other sessions on the same database. A single bad query can degrade the performance of an entire application. From a development standpoint, understanding SQL performance helps:
+1

Prevent scalability issues.

Reduce operational costs.

Shorten incident resolution time when performance problems occur in production.

== Top Methods to Identify Poorly Performing SQL ==
Oracle offers multiple complementary tools to analyze SQL performance. Each tool answers different questions, such as which SQL uses the most resources over time or which SQL is slow right now.

{| class="wikitable"
|+ Oracle Performance Tools and Use Cases
! Tool !! Primary Use Case !! Typical Scenario
|-
| AWR (Automatic Workload Repository) || Historical analysis of top SQL by resource usage || Investigating performance issues that occurred in the past
|-
| V$SQL || Current and recent SQL execution statistics || Finding SQL with high CPU or elapsed time right now
|-
| ASH (Active Session History) || Session-level wait and activity analysis || Understanding where time is spent during slow periods
|-
| SQL Monitor || Detailed execution monitoring for individual SQL || Diagnosing long-running or parallel queries
|}

=== Using AWR to Find High-Impact SQL ===
AWR reports rank SQL statements by metrics such as elapsed time, CPU time, logical reads, and physical reads. These rankings help identify SQL that contributes most to overall database load. Developers commonly start with the 'SQL ordered by Elapsed Time' or 'SQL ordered by CPU Time' sections of the AWR report to locate tuning candidates.
+2

=== Using VSQLforReal−TimeAnalysis===[cite
s

tart]TheVSQL view provides execution statistics for SQL statements currently in the shared pool. It is useful for identifying SQL with high average execution time or excessive buffer gets. Developers should focus on per-execution metrics rather than total values to avoid being misled by frequently executed but inexpensive SQL.
+2

{| class="wikitable"
|+ Example V$SQL Metrics
! Metric !! Description
|-
| ELAPSED_TIME / EXECUTIONS || Average elapsed time per execution in microseconds
|-
| BUFFER GETS / EXECUTIONS || Logical I/O per execution
|-
| DISK_READS / EXECUTIONS || Physical reads per execution
|}

=== Using ASH to Understand Waits ===
Active Session History (ASH) samples active database sessions and records what they are waiting for. ASH is especially useful when performance problems are intermittent. By grouping ASH data by SQL_ID and wait event, developers can identify which SQL statements are blocked by I/O, locks, or CPU contention.
+2

=== Using SQL Monitor for Long-Running SQL ===
SQL Monitor automatically captures execution details for SQL statements that run longer than a threshold or use parallel execution. It provides step-by-step execution progress, row counts, and time spent in each operation, making it ideal for diagnosing complex queries.
+1

== Sample Queries ==
The following examples illustrate how developers can query Oracle dynamic performance views to identify poorly performing SQL.

{| class="wikitable"
! Purpose !! Example Query
|-
| Find SQL with highest average elapsed time
| <syntaxhighlight lang="sql">
SELECT sql_id, executions,
elapsed_time/executions avg_elapsed
FROM vsqlWHEREexecutions>0ORDERBYavg
e

lapsedDESC</syntaxhighlight>∣−∣[cite
s

tart]FindSQLwithhighestbuffergetsperexecution[cite:39]∣<syntaxhighlightlang="sql">SELECTsql
i

d,buffer
g

ets/executionsavg
g

etsFROMvsql
WHERE executions > 0
ORDER BY avg_gets DESC
</syntaxhighlight>
|}

== Execution Plan Analysis ==
Execution plans explain how Oracle accesses data and joins tables. Poor performance often correlates with inefficient access paths or join methods. Developers should look for:
+1

Full table scans on large tables.

Unexpected nested loop joins.

Significant differences between estimated and actual row counts.

== Common Red Flags and Wait Events ==
Certain patterns frequently indicate SQL that requires tuning. These red flags can often be spotted directly in execution plans or performance views.

{| class="wikitable"
|+ Typical SQL Performance Red Flags
! Red Flag !! Why It Matters
|-
| Full table scan on large tables || Causes excessive I/O and CPU usage
|-
| High buffer gets per execution || Indicates inefficient data access
|-
| Large difference between estimated and actual rows || Leads to suboptimal execution plans
|-
| Frequent hard parsing || Increases CPU usage and latch contention
|}

Wait events provide insight into why SQL is slow.

{| class="wikitable"
|+ Common Oracle Wait Events
! Wait Event !! Typical Cause
|-
| db file sequential read || Single-block I/O, often index access
|-
| db file scattered read || Multi-block I/O, often full table scans
|-
| CPU + Wait for CPU || CPU contention due to inefficient SQL
|-
| enq: TX - row lock contention || Blocking due to concurrent DML
|}

== Prioritization Checklist ==
Not all slow SQL should be tuned first. Developers should prioritize based on business impact and resource consumption.

{| class="wikitable"
|+ SQL Tuning Prioritization Checklist
! Criterion !! Question to Ask
|-
| Execution frequency || Is this SQL executed thousands of times per hour?
|-
| User impact || Does it affect critical user-facing functionality?
|-
| Resource usage || Does it consume significant CPU or I/O?
|-
| Ease of fix || Can indexing or query rewrite provide quick gains?
|}

[[Category:Oracle]]

Oracle SQL Optimization - Intro

2026-02-13T15:09:18Z

Anw: Initial Creation

= Identifying Poorly Performing SQL in Oracle: A Developer's Guide =
'''Author:''' Database Engineering Team

This technical guide explains practical, developer-focused techniques for identifying and diagnosing poorly performing SQL statements in Oracle databases. It covers built-in Oracle performance views and tools, shows example queries, and provides guidance on interpreting execution plans, wait events, and prioritization criteria to focus tuning efforts where they matter most.
+1

== Overview ==
Poorly performing SQL is one of the most common root causes of slow applications in Oracle environments. Identifying these statements early allows developers to reduce response times, lower database load, and improve overall system stability.
+1

Oracle provides several built-in performance monitoring views and reports that make it possible to find high-impact SQL without third-party tools. This document focuses on practical usage of AWR, V$SQL, ASH, and SQL Monitor from a developer perspective.
+1

== Why SQL Performance Matters ==
Inefficient SQL can consume excessive CPU, memory, and I/O, directly impacting other sessions on the same database. A single bad query can degrade the performance of an entire application. From a development standpoint, understanding SQL performance helps:
+1

Prevent scalability issues.

Reduce operational costs.

Shorten incident resolution time when performance problems occur in production.

== Top Methods to Identify Poorly Performing SQL ==
Oracle offers multiple complementary tools to analyze SQL performance. Each tool answers different questions, such as which SQL uses the most resources over time or which SQL is slow right now.

{| class="wikitable"
|+ Oracle Performance Tools and Use Cases
! Tool !! Primary Use Case !! Typical Scenario
|-
| AWR (Automatic Workload Repository) || Historical analysis of top SQL by resource usage || Investigating performance issues that occurred in the past
|-
| V$SQL || Current and recent SQL execution statistics || Finding SQL with high CPU or elapsed time right now
|-
| ASH (Active Session History) || Session-level wait and activity analysis || Understanding where time is spent during slow periods
|-
| SQL Monitor || Detailed execution monitoring for individual SQL || Diagnosing long-running or parallel queries
|}

=== Using AWR to Find High-Impact SQL ===
AWR reports rank SQL statements by metrics such as elapsed time, CPU time, logical reads, and physical reads. These rankings help identify SQL that contributes most to overall database load. Developers commonly start with the 'SQL ordered by Elapsed Time' or 'SQL ordered by CPU Time' sections of the AWR report to locate tuning candidates.
+2

=== Using VSQLforReal−TimeAnalysis===[cite
s

tart]TheVSQL view provides execution statistics for SQL statements currently in the shared pool. It is useful for identifying SQL with high average execution time or excessive buffer gets. Developers should focus on per-execution metrics rather than total values to avoid being misled by frequently executed but inexpensive SQL.
+2

{| class="wikitable"
|+ Example V$SQL Metrics
! Metric !! Description
|-
| ELAPSED_TIME / EXECUTIONS || Average elapsed time per execution in microseconds
|-
| BUFFER GETS / EXECUTIONS || Logical I/O per execution
|-
| DISK_READS / EXECUTIONS || Physical reads per execution
|}

=== Using ASH to Understand Waits ===
Active Session History (ASH) samples active database sessions and records what they are waiting for. ASH is especially useful when performance problems are intermittent. By grouping ASH data by SQL_ID and wait event, developers can identify which SQL statements are blocked by I/O, locks, or CPU contention.
+2

=== Using SQL Monitor for Long-Running SQL ===
SQL Monitor automatically captures execution details for SQL statements that run longer than a threshold or use parallel execution. It provides step-by-step execution progress, row counts, and time spent in each operation, making it ideal for diagnosing complex queries.
+1

== Sample Queries ==
The following examples illustrate how developers can query Oracle dynamic performance views to identify poorly performing SQL.

{| class="wikitable"
! Purpose !! Example Query
|-
| Find SQL with highest average elapsed time
| <syntaxhighlight lang="sql">
SELECT sql_id, executions,
elapsed_time/executions avg_elapsed
FROM vsqlWHEREexecutions>0ORDERBYavg
e

lapsedDESC</syntaxhighlight>∣−∣[cite
s

tart]FindSQLwithhighestbuffergetsperexecution[cite:39]∣<syntaxhighlightlang="sql">SELECTsql
i

d,buffer
g

ets/executionsavg
g

etsFROMvsql
WHERE executions > 0
ORDER BY avg_gets DESC
</syntaxhighlight>
|}

== Execution Plan Analysis ==
Execution plans explain how Oracle accesses data and joins tables. Poor performance often correlates with inefficient access paths or join methods. Developers should look for:
+1

Full table scans on large tables.

Unexpected nested loop joins.

Significant differences between estimated and actual row counts.

== Common Red Flags and Wait Events ==
Certain patterns frequently indicate SQL that requires tuning. These red flags can often be spotted directly in execution plans or performance views.

{| class="wikitable"
|+ Typical SQL Performance Red Flags
! Red Flag !! Why It Matters
|-
| Full table scan on large tables || Causes excessive I/O and CPU usage
|-
| High buffer gets per execution || Indicates inefficient data access
|-
| Large difference between estimated and actual rows || Leads to suboptimal execution plans
|-
| Frequent hard parsing || Increases CPU usage and latch contention
|}

Wait events provide insight into why SQL is slow.

{| class="wikitable"
|+ Common Oracle Wait Events
! Wait Event !! Typical Cause
|-
| db file sequential read || Single-block I/O, often index access
|-
| db file scattered read || Multi-block I/O, often full table scans
|-
| CPU + Wait for CPU || CPU contention due to inefficient SQL
|-
| enq: TX - row lock contention || Blocking due to concurrent DML
|}

== Prioritization Checklist ==
Not all slow SQL should be tuned first. Developers should prioritize based on business impact and resource consumption.

{| class="wikitable"
|+ SQL Tuning Prioritization Checklist
! Criterion !! Question to Ask
|-
| Execution frequency || Is this SQL executed thousands of times per hour?
|-
| User impact || Does it affect critical user-facing functionality?
|-
| Resource usage || Does it consume significant CPU or I/O?
|-
| Ease of fix || Can indexing or query rewrite provide quick gains?
|}

Category:ER CTMS 048

2026-02-09T13:57:15Z

Anw: Initial Creation

All changes made since patch 48

Template:EstimateCostDetails2026

2026-01-26T13:11:33Z

Anw: Changed rates

<noinclude>
Usage:

<nowiki>
{{EstimateCostDetails</nowiki><br />
|Client=Client for estimate rates. Required if an estimate section is to be produced.<br />
|Year=Year for estimate rates. Required if an estimate section is to be produced.<br />
|REQ=Requirements Time. Defaults to zero.<br />
|EST=Estimate Time. Defaults to zero.<br />
|FS=Functional Specification Time. Defaults to zero.<br />
|TS=Technical Specification Time. Defaults to zero.<br />
|DEV=Development Time. Defaults to zero.<br />
|ST=Testing Time. Defaults to zero.<br />
|IMP=Implementation Time. Defaults to zero.<br />
|PM=Project Management Time. If omitted, line is not shown on estimate.<br />
|FSEST=Y if this estimate is for production in a functional specification. Omit if no separate estimate and functional specification sections are required. If the values in the estimate differ from the functional specification, use the fields EREQ, EEST, EFS, ETS, EDEV, ESTT, EIMP and EPM to identify the Estimate values. If these are omitted, the Functional Specification values in fields REQ, EST, FS, TS, DEV, ST, IMP and PM will be used.<br />
|EREQ=Estimate Requirements Time. Defaults to the value specified in REQ if omitted.<br />
|EEST=Estimate Estimate Time. Defaults to the value specified in EST if omitted.<br />
|EFS=Estimate Functional Specification Time. Defaults to the value specified in FS if omitted.<br />
|ETS=Estimate Technical Specification Time. Defaults to the value specified in TS if omitted.<br />
|EDEV=Estimate Development Time. Defaults to the value specified in DEV if omitted.<br />
|ESTT=Estimate Testing Time. Defaults to the value specified in ST if omitted.<br />
|EIMP=Estimate Implementation Time. Defaults to the value specified in IMP if omitted.<br />
|EPM=Estimate Project Management Time. Defaults to the value specified in PM if omitted.<br />
|FOC=Free of Charge - set this to Y to ensure no cost is associated. Defaults to N.<br />
|FIXEDCOST=Fixed Cost - set this to a value to ensure only this cost is associated.<br />
|NOFOOTER=Remove the footer - if omitted, will always be present<br />
|DiscountPerc=Discount Percentage<br />
|DiscountText=Text if discount percentage is non-0<br />
}}
</nowiki>

{{note}} If on a separate page Ensure that you include the relevant Category tag at the bottom of the page.

{{note}} Costs should be numeric. If one is not included, it will default to zero (0).

{{note|This page should be kept up-to-date with the latest cost changes for all clients, otherwise the costs will default to zero (0)}}

</noinclude>
{{#vardefine:TitleRate|Rate per hour (£)}}{{#vardefine:TitleCost|Cost (£ Exc. VAT)}}{{#vardefine:Currency|£}}{{#ifeq:{{{Client}}}|DHLT|
{{#vardefine:CostREQ|156.50}}
{{#vardefine:CostEST|156.50}}
{{#vardefine:CostFS|156.50}}
{{#vardefine:CostTS|156.50}}
{{#vardefine:CostDEV|156.50}}
{{#vardefine:CostST|156.50}}
{{#vardefine:CostIMP|156.50}}
{{#vardefine:CostPM|156.50}}
|
{{#ifeq:{{{Client}}}|LFS|
{{#vardefine:TitleRate|Rate per hour ($)}}{{#vardefine:TitleCost|Cost ($ Exc. GST)}}{{#vardefine:Currency|$}}
{{#vardefine:CostREQ|226.60}}
{{#vardefine:CostEST|226.60}}
{{#vardefine:CostFS|226.60}}
{{#vardefine:CostTS|226.60}}
{{#vardefine:CostDEV|226.60}}
{{#vardefine:CostST|226.60}}
{{#vardefine:CostIMP|226.60}}
{{#vardefine:CostPM|226.60}}
|
{{#ifeq:{{{Client}}}|CTY|
{{#vardefine:TitleRate|Rate per hour (£)}}{{#vardefine:TitleCost|Cost (£ Exc. VAT)}}{{#vardefine:Currency|£}}
{{#vardefine:CostREQ|175.10}}
{{#vardefine:CostEST|175.10}}
{{#vardefine:CostFS|175.10}}
{{#vardefine:CostTS|175.10}}
{{#vardefine:CostDEV|175.10}}
{{#vardefine:CostST|175.10}}
{{#vardefine:CostIMP|175.10}}
{{#vardefine:CostPM|175.10}}
|

{{#vardefine:Message|Unknown costs for client/year ({{{Client|No client}}}/{{{Year|No year}}})}}
{{#vardefine:CostREQ|0.00}}
{{#vardefine:CostEST|0.00}}
{{#vardefine:CostFS|0.00}}
{{#vardefine:CostTS|0.00}}
{{#vardefine:CostDEV|0.00}}
{{#vardefine:CostST|0.00}}
{{#vardefine:CostIMP|0.00}}
{{#vardefine:CostPM|0.00}}
}}
}}
}}{{#ifeq:{{{#var:COSTEST}}}||

{{#vardefine:Message|Unknown costs for client/year ({{{Client|No client}}}/{{{Year|No year}}})}}
}}{{#ifeq:{{{FOC|N}}}|Y|
{{#vardefine:Message| }}
{{#vardefine:CostREQ|0}}
{{#vardefine:CostEST|0}}
{{#vardefine:CostFS|0}}
{{#vardefine:CostTS|0}}
{{#vardefine:CostDEV|0}}
{{#vardefine:CostST|0}}
{{#vardefine:CostIMP|0}}
{{#vardefine:CostPM|0}}
}}{{#if: {{#var:Message}} |{{warning|{{#var:Message}}}} | }}
<table class="wikitable" border="1px" width="100%">
<tr><td bgcolor="silver" colspan={{#ifeq:{{{FSEST}}}|Y|5|4}}>'''Cost Details'''</td></tr>
<tr>
<td bgcolor="silver">'''Activity'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">'''Estimate<br />No. of Days'''</td>|}}
<td bgcolor="silver" align="center">'''Hours'''</td>
<td bgcolor="silver" align="center">'''{{#var:TitleRate}}'''</td>
<td bgcolor="silver" align="center">'''{{#var:TitleCost}}'''</td>
</tr>
<tr>
<td bgcolor="silver">Requirements</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EREQ|{{{REQ}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{REQ|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostREQ}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{REQ|0}}}*{{#var:CostREQ}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Change Request Evaluation</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EEST|{{{EST}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{EST|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostEST}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{EST|0}}}*{{#var:CostEST}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Functional Specification</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EFS|{{{FS}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{FS|0}}} |2}}</td>
<td bgcolor="silver" align="center">{{#var:CostFS}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{FS|0}}}*{{#var:CostFS}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Technical Specification</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{ETS|{{{TS}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{TS|0}}}|2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostTS}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{TS|0}}}*{{#var:CostTS}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Development</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EDEV|{{{DEV}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{DEV|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostDEV}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{DEV|0}}}*{{#var:CostDEV}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Testing and Release</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{ESTT|{{{ST}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{ST|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostST}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{ST|0}}}*{{#var:CostST}} }} |2}}</td>
</tr>
<tr>
<td bgcolor="silver">Implementation</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EIMP|{{{IMP}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{IMP|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostIMP}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{IMP|0}}}*{{#var:CostIMP}} }}|2 }}</td>
</tr>
{{#ifeq:{{{PM|X}}}|X||<tr>
<td bgcolor="silver">Project Management</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EPM|{{{PM|0}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{PM|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostPM}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{PM|0}}}*{{#var:CostPM}} }}|2 }}</td>
</tr>}}
<tr><td align="right" colspan={{#ifeq:{{{FSEST}}}|Y|5|4}}>{{#ifeq:{{{DiscountPerc|0}}}|0| |<font color="red"><strong>{{{DiscountText}}} {{{DiscountPerc}}}%</strong></font>}}</td></tr>
<tr>
{{#ifeq:{{{FIXEDCOST|N}}}|N|
<td bgcolor="silver">'''TOTAL'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{#expr: {{{EREQ|{{{REQ}}}}}}+{{{EEST|{{{EST}}}}}}+{{{EFS|{{{FS}}}}}}+{{{ETS|{{{TS}}}}}}+{{{EDEV|{{{DEV}}}}}}+{{{ESTT|{{{ST}}}}}}+{{{EIMP|{{{IMP}}}}}}+{{{EPM|{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}}}} }} |2 }}</td>|}}
<td align="center">{{#number_format: {{#expr: {{{REQ|0}}}+{{{EST|0}}}+{{{FS|0}}}+{{{TS|0}}}+{{{DEV|0}}}+{{{ST|0}}}+{{{IMP|0}}}+{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}} }} |2 }}</td>
<td bgcolor="silver"> </td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: (({{{REQ|0}}}* {{#var:CostREQ}})+({{{EST|0}}}* {{#var:CostEST}})+({{{FS|0}}}* {{#var:CostFS}})+({{{TS|0}}}* {{#var:CostTS}})+({{{DEV|0}}}* {{#var:CostDEV}})+({{{ST|0}}}* {{#var:CostST}})+({{{IMP|0}}}* {{#var:CostIMP}})+({{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}* {{#var:CostPM}})) * ((100 - {{{DiscountPerc|0}}}) / 100) }} |2 }}</td>
|<td bgcolor="silver">'''TOTAL (FIXED COST)'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{#expr: {{{EREQ|{{{REQ}}}}}}+{{{EEST|{{{EST}}}}}}+{{{EFS|{{{FS}}}}}}+{{{ETS|{{{TS}}}}}}+{{{EDEV|{{{DEV}}}}}}+{{{ESTT|{{{ST}}}}}}+{{{EIMP|{{{IMP}}}}}}+{{{EPM|{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}}}} }} |2 }}</td>|}}
<td align="center">{{#number_format: {{#expr: {{{REQ|0}}}+{{{EST|0}}}+{{{FS|0}}}+{{{TS|0}}}+{{{DEV|0}}}+{{{ST|0}}}+{{{IMP|0}}}+{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}} }} |2 }}</td>
<td bgcolor="silver"> </td>
<td align="right">{{#var:Currency}}{{#number_format:{{{FIXEDCOST}}} |2}}</td>
}}
</tr>
</table>
{{#ifeq:{{{NOFOOTER|N}}}|N|<table width="100%"><tr><td align="center">'''Estimate excludes training, release to live and go live support.'''</td></tr></table>}}
<noinclude>
[[Category:Templates|{{PAGENAME}}]]
</noinclude>

PATCH C-TMS P048

2026-01-16T10:32:13Z

Anw: Minor formatting change

<div class="noprint">
{{#vardefine:Client|CTMS}}
{{#vardefine:System|''CALIDUS'' TMS}}
{{#vardefine:Doc_Title|Release Notes}}
{{#vardefine:Version|1.0}}
{{#vardefine:Date|15 Nov 2025}}
{{#vardefine:Reference|048}}
{{#vardefine:Year|2025}}
</div>
{{Doc_Title
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=P{{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
}}

= SUMMARY INTRODUCTION =
== INTRODUCTION ==
The main aim of this document is to provide {{#var:System}} users with the level of detail required to accurately test all software included in the patch. The document also contains set-up and configuration details to enable the user to configure the system correctly for the new functionality to work.

=== GLOSSARY OF TERMS ===

{| border="1"
|- bgcolor="silver"
!Term !! Meaning
|-
|C-TMS || Transport Management System
|-
|C-WMS || Warehouse Management System
|-
|CR || Change Request
|-
|C-WCS || Warehouse Control System
|-
|C-ePOD || Electronic Proof of Delivery
|-
|C-MCS || Mobile Control System
|-
|C-TTM || Track and Trace Management
|-
|EDI || Electronic Data Interchange
|-
|TID || Testing Issue Development, or Log
|}


== TESTING PROCESS ==

===TIDs AND RESOLUTION===
If there are any areas of the functionality that are not acceptable or do not meet the requirement specified in the Change Request then these should be expressed by raising a TID.

=== FINAL 'END TO END' TESTING ===
Prior to release to a production database, a full 'End to End' test is required on the test system by all sites using the database. Once this is signed off, a release date can be arranged.

=== AUTHORISATION ===
Authorisation from nominated release personnel only will be required when requesting a release to a production environment

= CHANGE REQUESTS =


== Log Number: 528318 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Implement an interface for the new Courier system
|-
|'''Detail of Fix''' || New customer-specific courier development.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 645189 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Updating radial routing by zone
|-
|'''Detail of Fix''' || The radial routing code and region for a location will be updated as the location is added to, or deleted from, or made active or inactive, or included in, or excluded from, a zone when the location exists in the range of type 'LOCATION_ID'. The radial route code will be obtained from the stop for the zone which contains the location. This functionality will be active when the system parameter called 'GEO_LOC_RADIAL_ROUTES' is set to 'Y'.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 653514 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Carbon reporting
|-
|'''Detail of Fix''' || Add new columns to extracts, changed the source of some of the existing columns
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 672929 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Store OLPN number on order item contents
|-
|'''Detail of Fix''' || The OLPN number which is received as the 'caseID' will be stored as the description of the item's contents instead of the consolidated order reference.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 616866 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-06 Attach Exception Reports to the Waterfall screen
|-
|'''Detail of Fix''' || "The 'Trip Waterfall' screen includes a 'Run Report' option to produce a report. This development is linked to 03557646-05 and 03557646-07.

03557646-05: The user will be able to select multiple records but only to update the status of the trips. 03557646-06: The user will be able to open the 'Export' screen for a trip.

03557646-07: The user will be able to open the 'Planning' screen for a trip."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 616853 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-05: Multi-select and set ACCEPTED status from Waterfall screen.
|-
|'''Detail of Fix''' || "The users will be able to select multiple rows to update the status of the trips in the same block. This development is linked to 03557646-06 and 03557646-07.

03557646-05: The user will be able to select multiple records but only to update the status of the trips. 03557646-06: The user will be able to open the 'Export' screen for a trip.

03557646-07: The user will be able to open the 'Planning' screen for a trip."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 619888 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-08 Add route end time to Route Header screen
|-
|'''Detail of Fix''' || Added a field Route End Time to the screen Route Detail.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 619949 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-09 Add route end time to ORS report on routes
|-
|'''Detail of Fix''' || Includes the 'Route End' time to the 'FIX_ROUTE' ORS report.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 616907 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-03 Specific data reports, summing Tyres only
|-
|'''Detail of Fix''' || A new extract called RUN_FROM_WATERFALL is being added to the package.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 645362 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-25-Customer Onboarding - Do not overwrite load/unload rates
|-
|'''Detail of Fix''' || A new system parameter "DO_NOT_UPDATE_LOAD_RATES" can be set to Y to retain existing values for loading and unloading rates for a location in the customer import procedure.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 616827 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-04 Transfer Order - Trip Lookup to show route
|-
|'''Detail of Fix''' || Added new fields to the lookup of transfer order, to aid finding correct trip.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 645350 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-10 Planning: Support changing stops against a trip created from schedule engine.
|-
|'''Detail of Fix''' || Scheduling Engine changes for both 645350 and 619205.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620870 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-08-PSD PDF Label Format
|-
|'''Detail of Fix''' || New PSD pdf report
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620899 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-67-Maintain Original Delivery Type against an order.
|-
|'''Detail of Fix''' || Record the Original Delivery Type of the orders
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620889 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-56-Search orders by postcode or partial postal strings
|-
|'''Detail of Fix''' || Added filtering by post code to the orders screen
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620890 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-57-Prompt for and store reason for changing order delivery dates and times.
|-
|'''Detail of Fix''' || "Force entry of a Non Conformance record if dates have
changed and the NON_CON_DEL_DATES system
parameter is set to Y."
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 620883 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-48-Send email/SMS at a defined time the day before
|-
|'''Detail of Fix''' || New development for Day Before email messages
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620919 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-PORTAL-669852-62-Display additional order references
|-
|'''Detail of Fix''' || Remove certain order references from the xml export Ord messages
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620873 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-11-Order import processes to only match locations based on Name/Address 1/Postcode.
|-
|'''Detail of Fix''' || A new system parameter 'LIMIT_ADDRESS_MATCH' is created, this parameter will then be used in all order imports both CSV and XML to only use the following fields when matching an address: Address Lines 1-2 Postcode The address line 1, address line 2 and the postcode will be used to select an existing location to use for the order when the system parameter 'IMP_FULL_LOC_ADDR_MATCH' is not set to 'Y'.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 616806 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-19 Allow lookup of route numbers in Planning screen
|-
|'''Detail of Fix''' || A new system parameter was created called 'LOOKUP_FOR_ROUTE_CODES'. When set to 'Y', it will cause a new route look-up button to appear in the PLANNING screen (beside the 'Route Code' field).
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 645359 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-11/22-Depot Sweep
|-
|'''Detail of Fix''' || Added depot_sweep, find_route etc.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620914 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-PORTAL-669852-14-Allow update of client orders entered through Portal.
|-
|'''Detail of Fix''' || "Includes a function to validate the order in Portal.
Linked to 669852-100 for the ZPL labels."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 645363 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-26-Rebooking modifications
|-
|'''Detail of Fix''' || New rebooking code created
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 645360 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-23-Add Reset Auto-Scheduling and Carry Forward options to Planning screen.
|-
|'''Detail of Fix''' || Added Reset Auto-Scheduling and Carry Forward menu options to the Planning screen. Access to this new functionality is controlled by the new system parameter 'RESET_MANUAL_SCHEDULE' via a Y/N value setting. When active, the pop-up menu for orders at a stop will now include the new "Carry Forward" menu option. The "Reset Auto Scheduling" and "Carry Forward" options will be added to the popup menu on the order well. The "Move to Schedule" option in the popup menu of the order well will now in addition to the schedule movement, change the manual schedule flag on the selected orders to allow the orders to be replanned automatically. Note: when carrying forward, a pop-up of routes is displayed (and selected via clicking the desired row/route). The tester should refer to the data presented in the pop-up to reconcile the effects of the update. Order changes are recorded in the auditing information provided for orders.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 645364 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-18-configurable modules (location kept on, orders switched off.
|-
|'''Detail of Fix''' || New development for the Paragon interface package
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620915 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-52 - PSD ZPL Label Print
|-
|'''Detail of Fix''' || PSD label development.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620892 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-5A-Offer service levels by day of the week, customer and postal string (zone)
|-
|'''Detail of Fix''' || Various changes to determine the next working day.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 664597 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Prod-CTMS-669852-100
|-
|'''Detail of Fix''' || Produce PSD labels from Portal passing in items array etc.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620871 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-10-Modifications to Order Import CSV
|-
|'''Detail of Fix''' || Various changes to Order Import to split orders into Collections and Deliveries etc.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 645357 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-21-Non-working days changes
|-
|'''Detail of Fix''' || Changes to allow the capture, update and use of non working days
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 666361 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| New Customer - pre-advised packing process
|-
|'''Detail of Fix''' || Development of new process for tracing references for new customer
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 484373 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Flexipod-CTMS Integration -SCR-CTMS-03557646-12
|-
|'''Detail of Fix''' || Flexipod/APOD integration with CTMS.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620891 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-58-Signature/Signatory details from FlexiPOD to-and TTM.
|-
|'''Detail of Fix''' || The signature and the signatory details will be obtained from APOD and they will be stored in CTMS and passed to Portal TTM and included in the TIMI interface.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620535 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-13 Get price on orders TS 3.5
|-
|'''Detail of Fix''' || The total price of the order and the items can be set to send as attributes to APOD.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 645356 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-APOD-03557646-20-Electronic waste transfer note
|-
|'''Detail of Fix''' || "The locations can be imported via the API process to include references for the Permit Number for the delivering depot, the Licence Number for the delivering depot, the Unitary Authority for the delivery location.

The drop attributes for APOD can include the location references for the Permit Number for the delivering depot, the Licence Number for the delivering depot, the Unitary Authority for the delivery location, and the SIC Code for the customer of the order."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620918 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-PORTAL-669852-58A-APOD POD Upload
|-
|'''Detail of Fix''' || A new section for to include the JobReportName from APOD can be sent to Portal.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 710139 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| WREQ0117439 - Additional Requirements to Carbon Emissions Report - OMS ref
|-
|'''Detail of Fix''' || OMS ref added to Order movements extract
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620876 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-20-Quarantine process changes - Reason Codes
|-
|'''Detail of Fix''' || Changed screens to display QUAR action type view has been changed under SCR-19
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 715776 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Amendments to new customer packing process
|-
|'''Detail of Fix''' || Code updated to use EDI parameter to control functionality
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620894 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-60-Automatic rebooking
|-
|'''Detail of Fix''' || Rebook orders by item
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 620869 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-02-Owning Depot Assignment by specific postcode/postal string
|-
|'''Detail of Fix''' || Changes completed to allow zones to be used as postal regions for an address
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 696380 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Update to Order Interface
|-
|'''Detail of Fix''' || Despatched qty updated during import
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620900 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-68-Manual Rebook Extract
|-
|'''Detail of Fix''' || A new "Rebook Required" report has been added to the Oracle reporting suite. Changes were made to the Orders (wide) screen (and supporting database scripts were created).
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620880 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-25-Add Quarantine Items export to the configurable Reporting Suite.
|-
|'''Detail of Fix''' || Added Quarantine Items export ("QUAR_ITEMS") to the configurable Reporting Suite.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 715202 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| APOD results
|-
|'''Detail of Fix''' || Includes UpdateManifests API method.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620898 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-65-Modify Scheduling Engine
|-
|'''Detail of Fix''' || Scheduling engine updated to accommodate new functionality
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 710179 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-13 Get price on orders TS 3.5
|-
|'''Detail of Fix''' || The total price of the order and the items can be set to send as attributes to APOD.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 729244 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| CR - Reference Fields - 04262871
|-
|'''Detail of Fix''' || The 'Booking Ref' and the 'Del Point Ref' fields can be edited in the 'Wide Orders' screen when the 'Fast Order Entry' functionality is active.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 04262871 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| CR - Reference Fields - 04262871
|-
|'''Detail of Fix''' || The 'Booking Ref' and the 'Del Point Ref' fields can be edited in the 'Orders' and the 'Wide Orders' screens when the 'Fast Order Entry' functionality is active.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 725398 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Various changes to the APOD interface
|-
|'''Detail of Fix''' || Enables UpdateManifests to create and update manifests as per Route Execution.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620913 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| 620913 SCR-PORTAL-669852-06-Portal Order Entry - extend service level selection and validation by customer/address/zone
|-
|'''Detail of Fix''' || The dependent service levels are listed for selection by the user for the order in Portal.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 655161 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| CR - Implement an interface between TMS and Courier system
|-
|'''Detail of Fix''' || Further changes for customer carrier interface
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 739079 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Implement an interface between TMS and the Courier system
|-
|'''Detail of Fix''' || Changes for the customer carrier interface
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 620897 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-64-Paragon interface changes
|-
|'''Detail of Fix''' || New data and package created or paragon requirements
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620865 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| PROD-CTMS-669852-97-Do not send trips to Portal TTM at Tendered status
|-
|'''Detail of Fix''' || A new system parameter LOTS_SEND_TENDERED has been created to control this new functionality. Trigger points which currently check the status of a trip have been amended to check the new system parameter and they will not send any messages to LOTS if the parameter is inactive (i.e. where the setting value = "N"). The default setting is now "Y" (differs to the original requirement) to avoid stopping data being sent until it is specifically requested to be inhibited).
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620903 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-MCS-669852-15-Changes to Pallet Building
|-
|'''Detail of Fix''' || "Various changes for MCS.

This log includes MCS SCR-15, SCR-17, SCR-19, SCR-26 and SCR-28. Also BUG FIX SCR-101.
"
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 620878 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-23-Interface quarantine status for items out on delivery
|-
|'''Detail of Fix''' || "The attributes for APOD will be created in the databases and they will need to be confirmed with Paragon.

The attributes for the items will include a status to indicate if the item is on hold in quarantine or not."
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 620877 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-21-Quarantine Admin process
|-
|'''Detail of Fix''' || Admin process created
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 620885 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-55-Bespoke TIMI tracking export process
|-
|'''Detail of Fix''' || "The new system parameter that is called 'TIMI_EXTRACT' can be set to 'Y' so that data will be extracted for a file to send to the TIMI system.

New import decodes will need to be created for 'TIMI_TRACKING_REASON' which will be used to map the reason codes that are used for the items for the events in Calidus to the tracking codes that are used in TIMI."
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 744791 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Alerts - APOD Prod
|-
|'''Detail of Fix''' || Trips that are DELETED will only be sent to APOD when they have been ACCEPTED.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 746699 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Loginext carrier interface updates
|-
|'''Detail of Fix''' || Changes made to interface after testing
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 620896 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-61-Location opening windows
|-
|'''Detail of Fix''' || Import/Export functionally changed to handle multiple time windows. Default time windows are created (if none are supplied in the XML) when the new system parameter "MULTI_LOC_WINDOWS" is active i.e. set to "Y".
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 723304 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Amendments to LFE carrier POD update
|-
|'''Detail of Fix''' || The CARPOD process for LFE will ensure that the pre-packed orders can be identified by matching the HAWB to the customer’s reference.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 751795 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Customer courier interface changes
|-
|'''Detail of Fix''' || Changes to planning screen and interface after UAT
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 752036 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Customer courier interface changes
|-
|'''Detail of Fix''' || Changes to planning screen and interface after UAT
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 752710 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Customer Labels
|-
|'''Detail of Fix''' || Fixed label print issues
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620884 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-54A-New Reporting Suite formats for Portal Client Reports.
|-
|'''Detail of Fix''' || New reports created
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 753435 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Courier interface changes
|-
|'''Detail of Fix''' || Changes made to warn user about adding new stops after a trip has been sent to Loignext, and to allow trips to plan correctly using the Loginext carriers
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 755681 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Prevent any stops being added to a Loginext trip at TENDERED status
|-
|'''Detail of Fix''' ||
|- "Once a trip has been set to the LogiNext carrier no additional stops can be added to the trip changes are required in the planning screen in the following menu items
Apply to Stops
Insert Stop
Create Pickup
Create Delivery"
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 756076 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Use owning depot
|-
|'''Detail of Fix''' || Messages updated to use owning depot
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 760727 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Remove BST hour from dates sent to LogiNext
|-
|'''Detail of Fix''' || Added a function to amend dates
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 765489 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Align APOD
|-
|'''Detail of Fix''' || Includes changes from the branched versions for v1.9
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620908 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-MCS-669852-69-Despatch Confirmation to move entire order if scanned to new trip
|-
|'''Detail of Fix''' || New development to move orders in Mcs despatch.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 620872 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-10A-Allow Configurable CSV imports to be run automatically.
|-
|'''Detail of Fix''' || Allow Configurable CSV imports to be run automatically - without reprocess option
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 764220 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Trip Start Webhook Required
|-
|'''Detail of Fix''' || Added new trip start webhook
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 769731 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Error correction section of SCR-10A
|-
|'''Detail of Fix''' || "769731 is the pending functionalities in 620872(Automatic EDI FLOW). This covers Error correction and reprocess. After automatic EDI import, user can correct the errors and reprocess the records via Interface Error screen -> CSV IMPORTS Tab.
"
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 778740 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Customer UPS API Changes
|-
|'''Detail of Fix''' || Development of new values in ORS reporting extracts, changes to send carrier ref to TTM , changes to allow search by carrier ref in the orders screen.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 791073 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Add Tracking Ref to CN Trip and Order Detail Report
|-
|'''Detail of Fix''' || CN trip and order extract updated to include tracking references
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 736611 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Implement an interface between TMS and the new Courier system
|-
|'''Detail of Fix''' || Changes for the customer Loginext carrier interface
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 683460 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| WREQ0117439 - Carbon Emissions Reporting Changes
|-
|'''Detail of Fix''' || Change made to DP_ORS_FUNCS.sql to return x-dock locations
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 708427 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-26-Rebooking modifications
|-
|'''Detail of Fix''' || Rebooking Modifications
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 712174 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-03557646-26-Rebooking modifications
|-
|'''Detail of Fix''' || Further Rebooking Modifications
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 716175 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-5A-Offer service levels by day of the week, customer and postal string (zone)
|-
|'''Detail of Fix''' || Fixed the display of the Working Days field.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 722515 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-11-Order import processes to only match locations based on Name/Address 1/Postcode.
|-
|'''Detail of Fix''' || A new system parameter 'LIMIT_ADDRESS_MATCH' is created, this parameter will then be used in all order imports both CSV and XML to only use the following fields when matching an address:

- Address Lines 1-2
- Postcode

The address line 1, address line 2 and the postcode will be used to select an existing location to use for the order when the API parameter 'MATCH_FULL_LOC' is not set to 'Y'.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 725225 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-02-Owning Depot Assignment by specific postcode/postal string
|-
|'''Detail of Fix''' || Add new ranges to validation
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 725680 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-5A-Offer service levels by day of the week, customer and postal string (zone)
|-
|'''Detail of Fix''' || Change to the Schedule Rules screen.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 725768 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-10-Modifications to Order Import CSV
|-
|'''Detail of Fix''' || Modify customer import process to match v4 spec
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 728088 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-10-Modifications to Order Import CSV
|-
|'''Detail of Fix''' || Change made for import to derive the From location correctly.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 729295 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-08-PSD PDF Label Format
|-
|'''Detail of Fix''' || Changes to customer pdf and zpl labels print to display the service description.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 734074 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-10-Modifications to Order Import CSV
|-
|'''Detail of Fix''' || Modifications to Order Import
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 736388 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-10-Modifications to Order Import CSV
|-
|'''Detail of Fix''' || Changed to the import process to derive the time windows from the service level passed in if its passed in.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 738608 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-5A-Offer service levels by day of the week, customer and postal string (zone)
|-
|'''Detail of Fix''' || Various changes to determine the next working day.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 741277 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-08-PSD PDF Label Format
|-
|'''Detail of Fix''' || Changes to customer pdf and zpl labels print to display the service description.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 743790 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Manual Schedule set to Y for orders created by CSV Order Import
|-
|'''Detail of Fix''' || Create new system parameter CSV_DONT_UPDATE_MANUAL_SCHEDULE to control the setting of the manual schedule flag, use the parameter setting in the import to stop flag being set
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 747259 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-21-Quarantine Admin process
|-
|'''Detail of Fix''' || Trigger updated to create quarantine items for QUAR type reason codes
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 750484 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| CTMS / APOD Interface
|-
|'''Detail of Fix''' || The drop’s attributes will be omitted for the drops which are for the events at the depot, for example Pre-departure, Depot Depart, Depot Return, End of trip.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 753491 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-08-PDF Label Format
|-
|'''Detail of Fix''' || Various changes for the Mcs view and package.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 753169 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-21-Quarantine Admin process
|-
|'''Detail of Fix''' || Quarantine status set to "Quarantined" as a default upon creation.

Quarantine Admin Screen: Displays Reason description

Adding item to Quarantine:
Search criteria incorrect
deleted trips removed from the DDL.
Items shown are shown without a Status
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 752908 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-MCS-669852-28-Add and sort by drop number in despatch.
|-
|'''Detail of Fix''' || Add and sort by drop number in despatch.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 755677 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-60-Automatic rebooking
|-
|'''Detail of Fix''' || Change to rebooks, use the original external ref for REBOOK_EXT_REF and copy order references correctly.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 755678 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-60-Automatic rebooking
|-
|'''Detail of Fix''' || Set the references correctly and prevent rebooks correctly once the max number has been reached.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 753162 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-21-Quarantine Admin process
|-
|'''Detail of Fix''' || Updates for Admin Process
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 759291 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-61-Location opening windows
|-
|'''Detail of Fix''' || Added parameters for default windows, if no widows are present on a location and the defaults are populated for the cost centre the defaults will be used
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 758750 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-60-Automatic rebooking
|-
|'''Detail of Fix''' || Added a change to the trigger to only generate the REBOOK_REQUIRED reference if someone tries to rebook and the limit has already been reached.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 765676 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-54A-New Reporting Suite formats for Portal Client Reports.
|-
|'''Detail of Fix''' || Amended date comparison for KPI reports
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 764083 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-58-Signature/Signatory details from FlexiPOD to-and TTM.
|-
|'''Detail of Fix''' || Added context to package
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 765681 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-21-Quarantine Admin process
|-
|'''Detail of Fix''' || Add changes to Admin Screen
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 751231 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-MCS-669852-17-Scan location after scanning item in Receipt and Damages process.
|-
|'''Detail of Fix''' || Change to prompt for the receipt or quarantine location correctly from the receipt screen.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 758573 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-64-Paragon interface changes
|-
|'''Detail of Fix''' || Update scripts and package for new items
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 768995 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-21-Quarantine Admin process
|-
|'''Detail of Fix''' || Admin process updated
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 770198 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-16-Change FlexiPOD interface for final mile consolidation
|-
|'''Detail of Fix''' || Store the pallet ID against the item for the order
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 771479 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-MCS-669852-17-Scan location after scanning item in Receipt and Damages process.
|-
|'''Detail of Fix''' || Changes to MCS for SCR-17
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 741304 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| WebService TripOrderXML
|-
|'''Detail of Fix''' || Added USE_ITEM_ID EDI parameter to control the item identifier, if the parameter is active the value from the XML is used.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 772018 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-21-Quarantine Admin process
|-
|'''Detail of Fix''' || Corrections to list of values data, and new items status updated
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 771422 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-64-Paragon interface changes
|-
|'''Detail of Fix''' || Colour and shape to be handled in Paragon, fields updated to show the correct values for Paragon
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 772378 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-08-PDF Label Format
|-
|'''Detail of Fix''' || Updated labels to include location name
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 765716 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-MCS-669852-17-Scan Location
|-
|'''Detail of Fix''' || Changes around the despatching of damaged or quarantined items.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 773182 ==
{| width="100%"
|- SCR-CTMS-669852-21-Quarantine Admin process
|width="30%"|'''Summary of Call'''||
|-
|'''Detail of Fix''' || Updated Quarantine items screen to display details of both types of item reasons
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 775857 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-60-Automatic rebooking
|-
|'''Detail of Fix''' || Added exceptions to the sub references when the rebooked order is created
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 777617 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-64-Paragon interface changes
|-
|'''Detail of Fix''' || Paragon changes
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 775850 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-11-Order import process
|-
|'''Detail of Fix''' || Updated package to use limited address matching and standardise the location ID
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 776489 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-MCS-669852-28 - MCS Despatch - Parameterize Actual Arrival time
|-
|'''Detail of Fix''' || "Created parameters both set to 15 and NVL'd to 15, will be used when updating trip stop values
MCS_ARRIVAL_MINS

MCS_DEPART_MINS
"
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 776506 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-MCS-669852-28-Rename system parameter
|-
|'''Detail of Fix''' || Allow a setting of X for the system parameter , if set will not try and update the trip status. If the trip status is being set and fails an error will be logged but the process will continue.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 776499 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-16-Change FlexiPOD interface for final mile consolidation
|-
|'''Detail of Fix''' || The actual times for the stops will not be updated by APOD if they have been updated previously, for example by MCS or by manual debriefing.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 778452 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-16-Change FlexiPOD interface for final mile consolidation
|-
|'''Detail of Fix''' || The vertical scrollbar for the additional references for the order will extend when more than 8 records are available to display.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 776521 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-MCS-669852-17-Scan location after scanning item in Receipt and Damages process.
|-
|'''Detail of Fix''' || Added extra validation to the ctms package to prevent multiple holds from being raised if temperature or location scanning is in use.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 779463 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-16-Change FlexiPOD interface for final mile consolidation
|-
|'''Detail of Fix''' || "The following system parameters are available to confirm how the actual times of the trip’s stop are updated for the drops by APOD:

FLEXIPOD_DEPOT_DEPART_UPDATE_TIME
FLEXIPOD_DROP_UPDATE_TIME
FLEXIPOD_DEPOT_RETURN_UPDATE_TIME
FLEXIPOD_END_OF_TRIP_UPDATE_TIME
FLEXIPOD_PREDEPARTURE_UPDATE_TIME"
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 778992 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-21-Quarantine Admin process
|-
|'''Detail of Fix''' || Further changes to SCR-21
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 778948 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-21-Quarantine Admin process
|-
|'''Detail of Fix''' || Admin Process updated
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 779582 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SCR-CTMS-669852-60-Automatic rebooking
|-
|'''Detail of Fix''' || Updated weight on rebooked order lines
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

= SUPPORT INCIDENTS =


== Log Number: 652347 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Ord XML incorrect closing tags
|-
|'''Detail of Fix''' || Fixed to close the ORD tags correctly
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 665165 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Amendment to Trigger
|-
|'''Detail of Fix''' || Remove reference to Fleetcheck
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 652806 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Ord XML incorrect closing tags
|-
|'''Detail of Fix''' || Fixed to close the ORD tags correctly.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 680323 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Change to capture the OLPN in the Description field
|-
|'''Detail of Fix''' || Multiple cases for the boxes per order will be stored as the OLPN for the item’s contents.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 677708 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Correct error message for LOC_FLEXIPOD
|-
|'''Detail of Fix''' || "The customer onboarding process displays an incorrect error message for the length of the LOC_FLEXIPOD parameter.
The error message will be 'provided is too long as maximum length is 1 character'."
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 662958 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Reporting of cubic volume from ORS reports
|-
|'''Detail of Fix''' || The volume of the lines and the items will be calculated for the dimensions of the items when the volume is not provided
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 693543 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| POD Update request
|-
|'''Detail of Fix''' || Report updated to show units of measure cm and kg
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 748863 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Vehicles
|-
|'''Detail of Fix''' || "Added an index to EPOD_SERVICE_ACTIVITY.

Added update to DP_EXPORT_EVENTS to stop the reprocess of records which receive an invalid response from Elucid "
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 759798 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Adding SFTP to the various customer flows
|-
|'''Detail of Fix''' || Added SFTP processing
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 782274 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| User EPOD locking records on TMS
|-
|'''Detail of Fix''' || Speeded up the ctms epod webservices package for services processing for cty.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

= TID CHANGES =


== Log Number: 648341 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Prevention of some locks
|-
|'''Detail of Fix''' || Added a fix to improved the locking for Product updates from CTL
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 651637 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Missing col messages.
|-
|'''Detail of Fix''' || Re-added code to trigger
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 03885049 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Order Processing
|-
|'''Detail of Fix''' || "The volume and the weight of the order lines will be calculated based on its items when the manifest is confirmed as supplied.
This calculation will refer to the product type, DU type, commodity code, commodity class, height, width and length which may exist."
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 658588 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| No DEL message for job 6495
|-
|'''Detail of Fix''' || Quantities updated by epod message to ensure DEL message created for all call types
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 680896 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Bookings
|-
|'''Detail of Fix''' || Added more log messages to attempt to trace locking issues.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 685782 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Missing Service Items on device
|-
|'''Detail of Fix''' || A device fix has been coded in version 4.05.01.29 to reject a service product selected from the search results if that product is a service item (a tyre service item, a vehicle service item or a removal service item). This will prevent that service product being updated to be a physical product and so no longer appearing in the list of service items.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 694102 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| WCS Interfaces
|-
|'''Detail of Fix''' || Changes made to accommodate all xml structures
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 708331 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Carry Forward Route/Trip Lookup
|-
|'''Detail of Fix''' || "A new system parameter has been created called
'RESET_MANUAL_SCHEDULE'. When set to 'Y', it will include new menu functionality.
This release also covers issues resolutions for:
708335
708338
708339"
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 712699 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Packing process
|-
|'''Detail of Fix''' || System parameters used to determine URL
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 706682 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Invalid jobs in CTL
|-
|'''Detail of Fix''' || Added an error message to prevent Booking for orders with no items.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 708346 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Depot Sweep - checks 90 days into the future.
|-
|'''Detail of Fix''' || Rearranged the code to only check the schedule if the route is valid and the order needs processing.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 4256859 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Webfleet Orders
|-
|'''Detail of Fix''' || The 'ordertext' will include a maximum of 500 characters including 255 characters for the special instructions for an order.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 716848 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Rebooking
|-
|'''Detail of Fix''' || Updated sub reference value
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 716621 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Scheduler sets order to SCHED_DEL
|-
|'''Detail of Fix''' || Change customer scheduling engine to run on sched_name instead of the date/time windows. Changed logic to use next day trip based on schedule. Don’t update the date/time windows. User stop numbers 997,998,999.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 718133 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Scheduler sets order to SCHED_DEL
|-
|'''Detail of Fix''' || Fixes to the Scheduling Engine
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 715885 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| CTL Report
|-
|'''Detail of Fix''' || "A parameter is included to select the ORS report for the user in CTL when different users have the same
name of the report"
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 719713 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Carrier API using PUT not POST
|-
|'''Detail of Fix''' || Sending a manifest to the carrier API is using a PUT when it should use a POST, change to look at sub reference related to order
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 4267367 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Vehicle fleet maintenance
|-
|'''Detail of Fix''' || The view of the database for the vehicles for the customer locations has been optimised.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 712376 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Include Zone value on the ZONE ORS report
|-
|'''Detail of Fix''' || Zone added to report
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 720299 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| INC63493725 - CTMS Carbon extracts Orders extract change
|-
|'''Detail of Fix''' || Correct field mapping
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 4255786 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Delays between CTMS and Elucid
|-
|'''Detail of Fix''' || "Added processed by, processed date, reprocessed by and reprocessed date for auditing the processing and reprocessing of the XML control records.
Includes the trip or the order in the auditing of the messages and the control number in the auditing log."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 729745 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Trips display
|-
|'''Detail of Fix''' || Added some fixes to the scheduling engine to prevent additional PCL trips being created etc.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 732819 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| APOD Integration
|-
|'''Detail of Fix''' || The system called ‘FLEXIPOD_UNALLOCATED_DRIVER’ can be set to store a driver code, ‘UnallocatedRoute’ for example, to use for the ‘DriverUserCode’ for the manifest in APOD when a driver has not been set for the trip. The driver must exist in APOD.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 727465 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Scheduling Engine
|-
|'''Detail of Fix''' || Set the system parameter TRM_3PL_REROUTE to Y to ensure that the trip is validated and its distances and times are calculated for the trip to be sent correctly to APOD.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 727664 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Missing route
|-
|'''Detail of Fix''' || A missing start time or a missing end time for a missing route will be a warning not an error for an order.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 733748 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Stop numbers not resequencing
|-
|'''Detail of Fix''' || Fix to the scheduling engine to generate and sequence stops correctly.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 733060 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Manual schedule flag not checked
|-
|'''Detail of Fix''' || Added a fix to the TRM process to ensure the manual schedule flag is set when deleting a trip stop.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 735022 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Orders with no valid routes are still being planned onto a trip
|-
|'''Detail of Fix''' || Added check to scheduling engine for an invalid route.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 735611 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| APOD Pay on delivery flag
|-
|'''Detail of Fix''' || "The requests for the events at the depots in APOD will have to be setup and advised by Calidus when the UpdateManifests method is being used.

The requests for the events at the depots in APOD will be setup in APOD when the Add method is being used.

The setup of the new system parameters for STS will be:

FLEXIPOD_PREDEPARTURE_ACTION = N
FLEXIPOD_DEPOT_DEPART_ACTION = Y
FLEXIPOD_DEPOT_RETURN_ACTION = Y
FLEXIPOD_END_OF_TRIP_ACTION = Y"
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 735615 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Drops are not following the same drop order as Tyreman
|-
|'''Detail of Fix''' || Reinstated the location ID instead of the external reference to update the routes from Paragon for the locations in Calidus.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 738568 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Update call no to drop code
|-
|'''Detail of Fix''' || The drop number for the routes for the locations will use the drop code from Paragon.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 740462 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Variant addresses impacting drop numbers for STS
|-
|'''Detail of Fix''' || Added limit address match functionality to the STS code path for the xml order import process.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 741285 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| DP_LOGINEXT not using wallet files
|-
|'''Detail of Fix''' || Re-added wallet code
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 741398 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Drop number sequence
|-
|'''Detail of Fix''' || Fix to scheduling engine to sequence by drop number correctly.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 737679 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Call Logging jobs wont delete to Cancelled option
|-
|'''Detail of Fix''' || Error will be displayed if an order can't be unscheduled when a booking is cancelled
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 743714 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Schedule order
|-
|'''Detail of Fix''' || The orders for the collection desk should use the same start date as the schedule which is based on the delivery date of the orders.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 744746 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Some of the actual times not sent from APOD to TMS
|-
|'''Detail of Fix''' || "The signatory will be stored with 40 characters for the name that is captured in APOD.
The actual times for the stops will be set as advised for the event for the manifest in APOD."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 749834 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Scheduling Engine
|-
|'''Detail of Fix''' || "A new system parameter that is called ‘SCHED_ENG_3PL_BACKDATE’ will be available to backdate the schedules of the orders for the 3PL scheduling engine to reduce the number of orders which are processed.

The default value will be 0 days to use the current schedule as the base schedule for the orders to process."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 749988 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Paragon updates into TMS
|-
|'''Detail of Fix''' || System parameter PAR_PROXY will be used for the connections to Paragon to pass the orders for route execution and to import the routing information with the drop numbers.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 745583 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Carbon extracts report
|-
|'''Detail of Fix''' || Locations and distances now reported at trip level
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 753290 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Missing Haulage Activity
|-
|'''Detail of Fix''' || An order will not be planned to a deliver trip for the next route when it has not been planned to the despatching depot.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 721017 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Rebook required reference added to orders in error
|-
|'''Detail of Fix''' || Trigger corrected
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 741472 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Drop number 998 not displayed
|-
|'''Detail of Fix''' || Drop number set to 998 for DL stops without a valid drop number
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 755222 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Issue in Planning screen adding orders to Loginext trip
|-
|'''Detail of Fix''' || Updated planning screen to resolve issue, when adding new stops to an already TENDERED trip
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 736410 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Credit Limit clamp
|-
|'''Detail of Fix''' || Available credit checked when order header created - if customer has 0 or negative available credit order will be prevented
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 734319 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Unable to save address details for location ID 2021198
|-
|'''Detail of Fix''' || Restructured call to the HERE maps platform
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 755699 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| CCA Orders
|-
|'''Detail of Fix''' || System parameter TRM_3PL_SCHED_RUNS can include a comma-separated list of run numbers which are enclosed in double quotation marks to ensure that the 3PL carriers will be used in the fixed-drop scheduling engine when they do not contain a drop number for the delivery location and rerouting is active.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 735880 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Record Locking in CTL
|-
|'''Detail of Fix''' || Added additional logging to call logging package
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 755800 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| DP_PAR_API_STP utilize bind variables in plsql execute immediate
|-
|'''Detail of Fix''' || Queries changed to use bind variables
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 760470 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| No CL stop for some trips
|-
|'''Detail of Fix''' || The CL stops will be inserted when the trip is validated for its schedule via the Fixed Drop Scheduling Engine.
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 755801 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Drop number lost when trips are merged
|-
|'''Detail of Fix''' || "Includes the drop number from the original trip when a trip is split and the Fixed Drop Scheduling Engine is active.
Includes the drop number as 997 for PK stop or 998 for DL stops when trips are merged and the Fixed Drop Scheduling Engine is active."
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 744806 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Copy of orders does not contain price
|-
|'''Detail of Fix''' || New values added when copying/rebooking
|-
|'''Set-up and Configuration''' ||
|}

== Log Number: 749051 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Incorrect message for orders via API
|-
|'''Detail of Fix''' || "Some of the orders have been rejected because the customers or the locations for the external reference do not exist yet.
Some of the orders have been created due to concurrent processing by MuleSoft when MuleSoft should not be sending multiple messages for the orders.
The multiple messages were a result of an outage at MuleSoft when no orders were sent to CTMS for a few days.
The EDI parameter OMS_UNIQUE_EXT_REF can be set to Y to prevent duplicate orders for the same external reference and the same early collection date.
The message for the order API will use the key code to find the control record rather than find the latest order using the external reference when there is concurrent processing."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 763453 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Resources/Load Rates UI issues
|-
|'''Detail of Fix''' || Cleared insert block before display
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 763072 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Trip Times
|-
|'''Detail of Fix''' || "The fixed-drop scheduling engine will set the SU stop with a fixed start time for the route, then all subsequent stops will have their distances and times calculated from that start time.
The stops will use the sequence of the drop numbers for the route."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 764886 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Deleting empty stop not sending message to LogiNext
|-
|'''Detail of Fix''' || Amended trigger to send message when empty stop deleted. Amended package to default a . into an empty town value
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 748884 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| TMS Export to Elucid
|-
|'''Detail of Fix''' || "Moved ORD processing to before CAN processing
changed cursor names
added order by clauses"
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 752178 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Inspections report
|-
|'''Detail of Fix''' || Release scripts for ORS reporting
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 755804 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Reporting Suite
|-
|'''Detail of Fix''' || Variable reset at the beginning of the loop, report now executes without issue
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 762396 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| EDI Maintenance screen
|-
|'''Detail of Fix''' || Corrected issues on EDI Maintenance screen
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 767942 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| CTMS to PORTAL XML incorrect.
|-
|'''Detail of Fix''' || XML corrected and spelling mistake corrected.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 759775 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| APOD - DP_FLEXIPOD utilize bind variables in plsql execute immediate
|-
|'''Detail of Fix''' || "The attributes are sent to APOD using bind variables for the parameters for the functions.
Note that the control records for the attributes will need to use double quotation marks for these parameters.
Implementation will be required when this case is released to the 19c databases.

The ETA and ETD use the planned arrival and departure times for the stops.
PreDeparture and DepotDepart actions use the planned departure time to start the trip at the depot.
DepotReturn and EndOfTrip actions use the planned arrival time to close the trip at the depot."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 768223 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Return to depot has incorrect collection location
|-
|'''Detail of Fix''' || Update CL stops to be collected from the SU when they contain orders.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 770107 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Bookings issue
|-
|'''Detail of Fix''' || Adding extra debugging to track potential locking issues. Fixed cursor issue on WMS_PRODUCT_XREF.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 771166 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Create new trip fails
|-
|'''Detail of Fix''' || Planning screen updated to only check the LogiNext carrier on existing trips not on the creation of new trips
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 745199 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Prices displayed in APOD (Consolidation)
|-
|'''Detail of Fix''' || "System parameter FLEXIPOD_CONSOLIDATE_APOD can be set to Y to enable the orders to be consolidated as the shipping units for a drop.

System parameter FLEXIPOD_CONSOLIDATE_APOD_REF can be set to OMS, CUST, BOOK or DEL to use either the OMS reference, the customer’s reference, the booking reference, or the delivery point reference as the unique shipping unit ID when consolidation is active."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 772509 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| UTC timezones to be setup
|-
|'''Detail of Fix''' || "A new system parameter called FLEXIPOD_TIMEZONE can be set to a timezone to enable the times in the UpdateManifests API to be converted to UTC with respect to daylight saving for the APOD database.
"
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 769212 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Depot Sweep Not Scheduling Unscheduled Orders
|-
|'''Detail of Fix''' || Removed the restriction in CARRY FORWARD on the collect desk type orders
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 774163 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Orders planned onto COMPLETED/EN ROUTE trips
|-
|'''Detail of Fix''' || "New system level parameter SCHEDULE_ONLY_ON_PLANNED created , when set to Y orders will only be added to trips at PLANNED status.

Added exception handling to depot sweep

Added check to ensure schedule exists before updating orders in the depot sweep"
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 755470 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Route assignment
|-
|'''Detail of Fix''' || "The cutoff time of the route for the run number of the order will be assessed for the current time when the 3PL scheduling engine runs and the rerouting is not active for system parameter TRM_3PL_REROUTE.
If the order is being delivered on the same day, then the current time must be before the cutoff time of the route.
If the order is being delivered on the next day with a cutoff time for the current day, then the current time must be before the cutoff time of the route.
If the order is being delivered on the next day with a cutoff time for the next day, then the cutoff time will not be compared to the current time."
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 779373 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Depot Sweep Not Scheduling Unscheduled Orders
|-
|'''Detail of Fix''' || Added close to the cursor on sub refs
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 780350 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| LogiNext Interface debrief times issue
|-
|'''Detail of Fix''' || "Added new system parameters to control the adding/removing of an hour for BST

LOGINEXT_APPLY_BST_OUT

LOGINEXT_APPLY_BST_IN
"
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 772411 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| CTL - Call logging speed issue
|-
|'''Detail of Fix''' || Speeded up the ctl customer view
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 779094 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| 63560 Job not completed and is holding the stock
|-
|'''Detail of Fix''' || Updated trigger to send DEL to Elucid when qty delivered = 0
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 782606 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Pulse orders invalid
|-
|'''Detail of Fix''' || Amended date checks to be greater than or equal to
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 767012 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Outbound Illumina file
|-
|'''Detail of Fix''' || Added code to LOTS copy functionality to prevent records being resent if ftp fails
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 790845 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| LogiNext return to base booking error
|-
|'''Detail of Fix''' || Change RTB to Delivery only message
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 795109 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Update vehicle type in LogiNext booking message
|-
|'''Detail of Fix''' || " - Added vehicle type
- OrderNo updated to hold the trip id for sessions and adhocs
- Comments added for pick up and delivery"
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 796652 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| SFTP package causing multiple inserts into ADM_LOG
|-
|'''Detail of Fix''' || Inserts into adm log removed from functions which are not currently called directly from other packages.
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 795623 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Report generation failing due to incorrect linkage CTMS
|-
|'''Detail of Fix''' || Script created to resolve missing linkage
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 789840 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Key Item Report
|-
|'''Detail of Fix''' || Update valve cap and value extension functions to get data from acc_services
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 797473 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| Failure message in Epod (CTMS) Web Service Audit Screen
|-
|'''Detail of Fix''' || Changed error messages to be more meaningful
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

== Log Number: 790794 ==
{| width="100%"
|-
|width="30%"|'''Summary of Call'''|| API Events issues
|-
|'''Detail of Fix''' || Added extra logging for failures
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

= PRODUCT DEVELOPMENT =

== OBS Log Number: ==
{| width="100%"
|-
|width="30%"| '''Reporter:''' ||
|-
|'''Summary of Call'''||
|-
|'''Detail of Fix''' ||
|-
|'''Set-up and Configuration''' || No set-up/configuration required
|}

= MODULES DELIVERED =

{| border="1" width="100%"
|- bgcolor="silver"
!Module Name !! Version No !! Description !! Log Number
|-
| AT_CAL_DEP_NON_WORKING_DAY_645357.sql || 1.1 || Alter Table Script || 00645357
|-
| AT_CAL_NON_WORKING_DAY_645357.sql || 1.1 || Alter Table Script || 00645357
|-
| AT_CAL_RTE_NON_WORKING_DAY_645357.sql || 1.1 || Alter Table Script || 00645357
|-
| AT_GEO_LOCATION_00322441.sql || 1.1 || Alter Table Script || 00484373
|-
| AT_GEO_LOCATION_645364.sql || 1.1 || Alter Table Script || 00645364
|-
| AT_GEO_ROUTE_DTLS_645357.sql || 1.2 || Alter Table Script || 00645357
|-
| AT_INT_XML_CONTROL_04255786.sql || 1.1 || Alter Table Script || 04255786
|-
| AT_INT_XML_ORD_DETAILS_620535.sql || 1.1 || Alter Table Script || 00620535
|-
| AT_INT_XML_ORD_HEADER_620535.sql || 1.1 || Alter Table Script || 00620535
|-
| AT_LOGINEXT_AUDIT_746699.sql || 1.1 || Alter Table Script || 00746699
|-
| AT_MSG_SMS_FORMAT_620901.sql || 1.1 || Alter Table Script || 00620883
|-
| AT_ORS_MASTER_DATA_778740.sql || 1.1 || Alter Table Script || 00778740
|-
| AT_ORS_USER_DETAILS_778740.sql || 1.1 || Alter Table Script || 00778740
|-
| AT_REP_REPORT_03557646-03.sql || 1.1 || Alter Table Script || 00616907
|-
| AT_REP_REPORT_616866.sql || 1.1 || Alter Table Script || 00616866
|-
| AT_RES_CARRIER_00484373.sql || 1.1 || Alter Table Script || 00484373
|-
| AT_RES_CARRIER_528318.sql || 1.1 || Alter Table Script || 00528318
|-
| AT_RES_CARRIER_528318_1.sql || 1.1 || Alter Table Script || 00528318
|-
| AT_RES_CARRIER_653514.sql || 1.1 || Alter Table Script || 00653514
|-
| AT_RTE_ROUTE_645357.sql || 1.1 || Alter Table Script || 00645357
|-
| AT_SCH_ORD_620535.sql || 1.1 || Alter Table Script || 00620535
|-
| AT_SCH_ORD_620899.sql || 1.1 || Alter Table Script || 00620899
|-
| AT_SCH_ORD_ITEMS_620535.sql || 1.1 || Alter Table Script || 00620535
|-
| AT_SCH_ORD_ITEMS_HELD_620877.sql || 1.1 || Alter Table Script || 00620877
|-
| AT_SCH_ORD_ITEMS_HELD_753169.sql || 1.2 || Alter Table Script || 00753169
|-
| AT_SCH_ORD_ITEMS_HELD_HISTORY_753169.sql || 1.1 || Alter Table Script || 00753169
|-
| AT_SCH_ORD_REFERENCE_620885.sql || 1.1 || Alter Table Script || 00620885
|-
| AT_SCH_ORD_TYPES_620898.sql || 1.1 || Alter Table Script || 00620898
|-
| AT_SCH_TRIP_655161.sql || 1.1 || Alter Table Script || 00655161
|-
| AT_SCH_TRIP_STOP_645350.sql || 1.1 || Alter Table Script || 00645350
|-
| AT_SCH_TRIP_STOP_655161.sql || 1.1 || Alter Table Script || 00655161
|-
| AT_SCHED_RULES_620892.sql || 1.1 || Alter Table Script || 00620892
|-
| AT_TESLA_EDI_ORDER_DETAILS_680323.sql || 1.1 || Alter Table Script || 00680323
|-
| AT_WCS_LOCATION_620904.sql || 1.1 || Alter Table Script || 00620903
|-
| BDM.fmx || 2.112 || Business Data Form || 00620876
|-
| BDM.fmx || 2.113 || Business Data Form || 00620898
|-
| CAL.sql || 5.6 || Next working day calculation Module || 00645357
|-
| CSV.sql || 5.122 || CSV extract package || 00791073
|-
| CT_CSV_IMPORT_ERRORS_620872.sql || 1.1 || Create Table Script || 00620872
|-
| CT_FLEXIPOD_STAGING_00484373.sql || 1.1 || Create Table Script || 00484373
|-
| CT_FLEXIPOD_STAGING_LISTPENDING_00484373.sql || 1.1 || Create Table Script || 00484373
|-
| CT_FLEXIPOD_STAGING_READDROP_00484373.sql || 1.1 || Create Table Script || 00484373
|-
| CT_FLEXIPOD_WEB_AUDIT_00484373.sql || 1.1 || Create Table Script || 00484373
|-
| CT_FLX_ATTRIBUTES_API_00484373.sql || 1.2 || Create Table Script || 00484373
|-
| CT_FLX_JSON_IN_00484373.sql || 1.2 || Create Table Script || 00484373
|-
| CT_LOGINEXT_AUDIT_528318.sql || 1.1 || Create Table Script || 00528318
|-
| CT_SCH_ORD_ITEMS_HELD_620903.sql || 1.1 || Create Table Script || 00620903
|-
| CT_SCH_ORD_ITEMS_HELD_HISTORY_620903.sql || 1.1 || Create Table Script || 00620903
|-
| CT_SEQ_CALL_REF_00484373.sql || 1.1 || Create Table Script || 00484373
|-
| CT_SEQ_EDI_IMP_ERRORS_620872.sql || 1.2 || Create Table Script || 00620872
|-
| CT_SEQ_FLEXIPOD_WEB_AUDIT_00484373.sql || 1.1 || Create Table Script || 00484373
|-
| CT_SEQ_FLX_JSON_00484373.sql || 1.1 || Create Table Script || 00484373
|-
| CT_SEQ_FLX_SHIPPING_UNIT_00484373.sql || 1.1 || Create Table Script || 00484373
|-
| CT_SEQ_FLX_STAGING_SEQ_00484373.sql || 1.1 || Create Table Script || 00484373
|-
| CT_SEQ_SCH_ORD_ITEMS_HELD_620903.sql || 1.1 || Create Table Script || 00620903
|-
| CT_SEQ_TRACK_REF_00484373.sql || 1.1 || Create Table Script || 00484373
|-
| DATA_1_IMP_DECODE_758573.sql || 1.1 || Data Script || 00758573
|-
| DATA_1_MSG_TYPE_620872.sql || 1.1 || Data Script || 00620872
|-
| DATA_1_ORS_MASTER_DATA_260441.sql || 1.2 || Data Script || 00752178
|-
| DATA_1_ORS_MASTER_DATA_620884.sql || 1.1 || Data Script || 00620884
|-
| DATA_1_ORS_MASTER_DATA_752178.sql || 1.4 || Data Script || 00752178
|-
| DATA_1_ORS_SQL_00278514.sql || 1.1 || Data Script || 00752178
|-
| DATA_1_ORS_SQL_260441.sql || 1.4 || Data Script || 00752178
|-
| DATA_2_IMP_DECODE_ENTRY_655161.sql || 1.1 || Data Script || 00655161
|-
| DATA_2_IMP_DECODE_ENTRY_758573.sql || 1.1 || Data Script || 00758573
|-
| DATA_2_MSG_REQ_620872.sql || 1.1 || Data Script || 00620872
|-
| DATA_2_ORS_MASTER_DATA_0027851.sql || 1.1 || Data Script || 00752178
|-
| DATA_2_ORS_MASTER_DATA_260441.sql || 1.2 || Data Script || 00752178
|-
| DATA_2_ORS_SQL_260441.sql || 1.1 || Data Script || 00752178
|-
| DATA_2_ORS_USER_DETAILS_778740.sql || 1.1 || Data Script || 00778740
|-
| DATA_3_ORS_MASTER_DATA_260441.sql || 1.3 || Data Script || 00752178
|-
| DATA_3_ORS_SQL_260441.sql || 1.3 || Data Script || 00752178
|-
| DATA_4_ORS_MASTER_DATA_260441.sql || 1.3 || Data Script || 00752178
|-
| DATA_4_ORS_SQL_260441.sql || 1.2 || Data Script || 00752178
|-
| DATA_5_ORS_MASTER_DATA_260441.sql || 1.2 || Data Script || 00752178
|-
| DATA_5_ORS_SQL_260441.sql || 1.2 || Data Script || 00752178
|-
| DATA_6_ORS_MASTER_DATA_260441.sql || 1.5 || Data Script || 00752178
|-
| DATA_6_ORS_SQL_260441.sql || 1.2 || Data Script || 00752178
|-
| DATA_ADM_FORM_TAB_528318.sql || 1.1 || Data Script || 00528318
|-
| DATA_ADM_FORM_TABS_620872.sql || 1.1 || Data Script || 00620872
|-
| DATA_ADM_FUNCTION_620535.sql || 1.1 || Data Script || 00620535
|-
| DATA_ADM_LOG_PROG_NAME_00484373.sql || 1.1 || Data Script || 00484373
|-
| DATA_ADM_LOG_PROG_NAME_620872.sql || 1.1 || Data Script || 00620872
|-
| DATA_ADM_MENU_ITEM_620877.sql || 1.2 || Data Script || 00620877
|-
| DATA_ADM_MENU_ITEM_620877.sql || 1.4 || Data Script || 00753169
|-
| DATA_ADM_MSEL_FORM_620900.sql || 1.1 || Data Script || 00620900
|-
| DATA_ADM_MSEL_FORM_PARAM_620889.sql || 1.2 || Data Script || 00620889
|-
| DATA_ADM_MSEL_FORM_PARAM_645350.sql || 1.1 || Data Script || 00645350
|-
| DATA_ADM_SYSTEM_PARAM_00484373.sql || 1.2 || Data Script || 00484373
|-
| DATA_ADM_SYSTEM_PARAM_00620891.sql || 1.1 || Data Script || 00620891
|-
| DATA_ADM_SYSTEM_PARAM_00715202.sql || 1.1 || Data Script || 00715202
|-
| DATA_ADM_SYSTEM_PARAM_03557646.sql || 1.1 || Data Script || 00616806
|-
| DATA_ADM_SYSTEM_PARAM_528318.sql || 1.1 || Data Script || 00528318
|-
| DATA_ADM_SYSTEM_PARAM_619205.sql || 1.1 || Data Script || 00645350
|-
| DATA_ADM_SYSTEM_PARAM_620865.sql || 1.1 || Data Script || 00620865
|-
| DATA_ADM_SYSTEM_PARAM_620869.sql || 1.1 || Data Script || 00620869
|-
| DATA_ADM_SYSTEM_PARAM_620871.sql || 1.1 || Data Script || 00620871
|-
| DATA_ADM_SYSTEM_PARAM_620872.sql || 1.1 || Data Script || 00620872
|-
| DATA_ADM_SYSTEM_PARAM_620872.sql || 1.2 || Data Script || 00769731
|-
| DATA_ADM_SYSTEM_PARAM_620873.sql || 1.2 || Data Script || 00620873
|-
| DATA_ADM_SYSTEM_PARAM_620885.sql || 1.1 || Data Script || 00620885
|-
| DATA_ADM_SYSTEM_PARAM_620890.sql || 1.1 || Data Script || 00620890
|-
| DATA_ADM_SYSTEM_PARAM_620894.sql || 1.1 || Data Script || 00620894
|-
| DATA_ADM_SYSTEM_PARAM_620896.sql || 1.1 || Data Script || 00620896
|-
| DATA_ADM_SYSTEM_PARAM_620897.sql || 1.1 || Data Script || 00620897
|-
| DATA_ADM_SYSTEM_PARAM_620897.sql || 1.2 || Data Script || 00749988
|-
| DATA_ADM_SYSTEM_PARAM_620898.sql || 1.1 || Data Script || 00620898
|-
| DATA_ADM_SYSTEM_PARAM_620904.sql || 1.2 || Data Script || 00620903
|-
| DATA_ADM_SYSTEM_PARAM_620906.sql || 1.1 || Data Script || 00620903
|-
| DATA_ADM_SYSTEM_PARAM_620907.sql || 1.3 || Data Script || 00620903
|-
| DATA_ADM_SYSTEM_PARAM_620908.sql || 1.1 || Data Script || 00620908
|-
| DATA_ADM_SYSTEM_PARAM_620915.sql || 1.1 || Data Script || 00620915
|-
| DATA_ADM_SYSTEM_PARAM_645359.sql || 1.1 || Data Script || 00645359
|-
| DATA_ADM_SYSTEM_PARAM_645360.sql || 1.1 || Data Script || 00645360
|-
| DATA_ADM_SYSTEM_PARAM_645360.sql || 1.1 || Data Script || 00708331
|-
| DATA_ADM_SYSTEM_PARAM_645362.sql || 1.1 || Data Script || 00645362
|-
| DATA_ADM_SYSTEM_PARAM_645363.sql || 1.1 || Data Script || 00645363
|-
| DATA_ADM_SYSTEM_PARAM_645364.sql || 1.1 || Data Script || 00645364
|-
| DATA_ADM_SYSTEM_PARAM_655161.sql || 1.1 || Data Script || 00655161
|-
| DATA_ADM_SYSTEM_PARAM_666361.sql || 1.1 || Data Script || 00666361
|-
| DATA_ADM_SYSTEM_PARAM_712699.sql || 1.1 || Data Script || 00712699
|-
| DATA_ADM_SYSTEM_PARAM_715776.sql || 1.1 || Data Script || 00717566
|-
| DATA_ADM_SYSTEM_PARAM_715776.sql || 1.1 || Data Script || 00715776
|-
| DATA_ADM_SYSTEM_PARAM_725398.sql || 1.1 || Data Script || 00725398
|-
| DATA_ADM_SYSTEM_PARAM_732819.sql || 1.1 || Data Script || 00732819
|-
| DATA_ADM_SYSTEM_PARAM_732936.sql || 1.1 || Data Script || 00620903
|-
| DATA_ADM_SYSTEM_PARAM_735611.sql || 1.1 || Data Script || 00735611
|-
| DATA_ADM_SYSTEM_PARAM_743790.sql || 1.1 || Data Script || 00743790
|-
| DATA_ADM_SYSTEM_PARAM_745199.sql || 1.1 || Data Script || 00745199
|-
| DATA_ADM_SYSTEM_PARAM_749834.sql || 1.1 || Data Script || 00749834
|-
| DATA_ADM_SYSTEM_PARAM_755699.sql || 1.2 || Data Script || 00755699
|-
| DATA_ADM_SYSTEM_PARAM_759291.sql || 1.1 || Data Script || 00759291
|-
| DATA_ADM_SYSTEM_PARAM_772509.sql || 1.1 || Data Script || 00722509
|-
| DATA_ADM_SYSTEM_PARAM_774163.sql || 1.1 || Data Script || 00774163
|-
| DATA_ADM_SYSTEM_PARAM_776489.sql || 1.1 || Data Script || 00776489
|-
| DATA_ADM_SYSTEM_PARAM_778740.sql || 1.2 || Data Script || 00778740
|-
| DATA_ADM_SYSTEM_PARAM_778992.sql || 1.1 || Data Script || 00778992
|-
| DATA_ADM_SYSTEM_PARAM_779463.sql || 1.1 || Data Script || 00779463
|-
| DATA_ADM_SYSTEM_PARAM_780350.sql || 1.1 || Data Script || 00780350
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG.sql || 1.2 || Data Script || 00725768
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_528318.sql || 1.1 || Data Script || 00528318
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_620871.sql || 1.2 || Data Script || 00620871
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_620890.sql || 1.1 || Data Script || 00620890
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_620894.sql || 1.1 || Data Script || 00620894
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_620904.sql || 1.1 || Data Script || 00620903
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_620906.sql || 1.1 || Data Script || 00620903
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_620907.sql || 1.1 || Data Script || 00620903
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_620908.sql || 1.1 || Data Script || 00620908
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_645350.sql || 1.1 || Data Script || 00645350
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_645359.sql || 1.1 || Data Script || 00645359
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_666361.sql || 1.1 || Data Script || 00666361
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_712699.sql || 1.1 || Data Script || 00712699
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_725398.sql || 1.1 || Data Script || 00725398
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_732936.sql || 1.1 || Data Script || 00620903
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_743790.sql || 1.1 || Data Script || 00743790
|-
| DATA_ADM_SYSTEM_PARAM_CONFIG_759291.sql || 1.1 || Data Script || 00759291
|-
| DATA_FLX_ATTRIBUTES_API_00620535.sql || 1.1 || Data Script || 00620535
|-
| DATA_FLX_ATTRIBUTES_API_745199.sql || 1.1 || Data Script || 00745199
|-
| DATA_GEO_LOC_TYPE_620877.sql || 1.1 || Data Script || 00620877
|-
| DATA_IMP_DECODE_00484373.sql || 1.1 || Data Script || 00484373
|-
| DATA_IMP_DECODE_00620891.sql || 1.1 || Data Script || 00620891
|-
| DATA_IMP_DECODE_1_TYPE_620919.sql || 1.1 || Data Script || 00620919
|-
| DATA_IMP_DECODE_2_620919.sql || 1.1 || Data Script || 00620919
|-
| DATA_IMP_DECODE_528318.sql || 1.1 || Data Script || 00528318
|-
| DATA_IMP_DECODE_620885.sql || 1.1 || Data Script || 00620885
|-
| DATA_IMP_DECODE_620894.sql || 1.1 || Data Script || 00620894
|-
| DATA_IMP_DECODE_645363.sql || 1.1 || Data Script || 00645363
|-
| DATA_IMP_DECODE_655161.sql || 1.1 || Data Script || 00655161
|-
| DATA_IMP_DECODE_ENTRY_00620891.sql || 1.2 || Data Script || 00620891
|-
| DATA_IMP_DECODE_ENTRY_528318.sql || 1.1 || Data Script || 00528318
|-
| DATA_IMP_DECODE_ENTRY_620894.sql || 1.1 || Data Script || 00620894
|-
| DATA_IMP_DECODE_ENTRY_620900.sql || 1.1 || Data Script || 00620900
|-
| DATA_IMP_DECODE_ENTRY_620903.sql || 1.1 || Data Script || 00620903
|-
| DATA_IMP_DECODE_ENTRY_645363.sql || 1.1 || Data Script || 00645363
|-
| DATA_IMP_DECODE_ENTRY_655161.sql || 1.1 || Data Script || 00655161
|-
| DATA_IMP_DECODE_ENTRY_778740.sql || 1.3 || Data Script || 00778740
|-
| DATA_IMP_FIELD_620871.sql || 1.2 || Data Script || 00620871
|-
| DATA_IMP_FIELD_645357.sql || 1.1 || Data Script || 00645357
|-
| DATA_MSG_EVENT_TYPE_620872.sql || 1.1 || Data Script || 00620872
|-
| DATA_MSG_SMS_FORMAT_620872.sql || 1.1 || Data Script || 00620872
|-
| DATA_MSG_SMS_VALUES_620872.sql || 1.2 || Data Script || 00620872
|-
| DATA_ORS_MASTER_DATA_1_653514.sql || 1.1 || Data Script || 00653514
|-
| DATA_ORS_MASTER_DATA_2_653514.sql || 1.1 || Data Script || 00653514
|-
| DATA_ORS_MASTER_DATA_619949.sql || 1.3 || Data Script || 00619949
|-
| DATA_ORS_MASTER_DATA_620880.sql || 1.4 || Data Script || 00620880
|-
| DATA_ORS_MASTER_DATA_620900.sql || 1.1 || Data Script || 00620900
|-
| DATA_ORS_MASTER_DATA_710139.sql || 1.2 || Data Script || 00710139
|-
| DATA_ORS_MASTER_DATA_712376.sql || 1.1 || Data Script || 00712376
|-
| DATA_ORS_MASTER_DATA_720299.sql || 1.1 || Data Script || 00720299
|-
| DATA_ORS_MASTER_DATA_745583.sql || 1.1 || Data Script || 00745583
|-
| DATA_ORS_MASTER_DATA_765676.sqql || 1.1 || Data Script || 00765676
|-
| DATA_ORS_MASTER_DATA_778740.sql || 1.2 || Data Script || 00778740
|-
| DATA_ORS_SQL_1_653514.sql || 1.1 || Data Script || 00653514
|-
| DATA_ORS_SQL_2_653514.sql || 1.1 || Data Script || 00653514
|-
| DATA_ORS_SQL_620880.sql || 1.3 || Data Script || 00620880
|-
| DATA_ORS_SQL_620884.sql || 1.1 || Data Script || 00620884
|-
| DATA_ORS_SQL_620900.sql || 1.1 || Data Script || 00620900
|-
| DATA_ORS_SQL_720299.sql || 1.1 || Data Script || 00720299
|-
| DATA_ORS_SQL_745583.sql || 1.1 || Data Script || 00745583
|-
| DATA_ORS_SQL_778740.sql || 1.2 || Data Script || 00778740
|-
| DATA_ORS_SQL_795623.sql || 1.1 || Data Script || 00795623
|-
| DATA_ORS_USER_DETAILS_778740.sql || 1.1 || Data Script || 00778740
|-
| DATA_PAR_CALL_API_620896.sql || 1.1 || Data Script || 00620896
|-
| DATA_PAR_CALL_API_620897.sql || 1.1 || Data Script || 00620897
|-
| DATA_PAR_CALL_API_758573.sql || 1.1 || Data Script || 00758573
|-
| DATA_PAR_CALL_API_771422.sql || 1.1 || Data Script || 00771422
|-
| DATA_PAR_CUST_API_620897.sql || 1.1 || Data Script || 00620897
|-
| DATA_PAR_CUST_API_758573.sql || 1.1 || Data Script || 00758573
|-
| DATA_REP_REPORT_03557646-03.sql || 1.2 || Data Script || 00616907
|-
| DATA_REP_REPORT_620870.sql || 1.2 || Data Script || 00620870
|-
| DATA_REP_REPORT_PARAM_03557646.sql || 1.2 || Data Script || 00616907
|-
| DATA_REP_REPORT_PARAM_620870.sql || 1.1 || Data Script || 00620870
|-
| DATA_RES_LABEL_FORMATS_620903.sql || 1.1 || Data Script || 00620903
|-
| DATA_RES_LABEL_FORMATS_620903.sql || 1.2 || Data Script || 00752710
|-
| DATA_RES_LABEL_FORMATS_620915.sql || 1.3 || Data Script || 00620915
|-
| DATA_RES_LABEL_FORMATS_620915.sql || 1.3 || Data Script || 00664597
|-
| DATA_RES_LABEL_FORMATS_752710.sql || 1.1 || Data Script || 00752710
|-
| DATA_RES_LABEL_FORMATS_772378.sql || 1.1 || Data Script || 00772378
|-
| DATA_SCH_REASON_CODES_528318.sql || 1.1 || Data Script || 00528318
|-
| DP_3PL_SCHED.sql || 5.19 || 3PL Scheduling Engine Database Package || 00645350
|-
| DP_3PL_SCHED.sql || 5.21 || 3PL Scheduling Engine Database Package || 00645359
|-
| DP_3PL_SCHED.sql || 5.22 || 3PL Scheduling Engine Database Package || 00645357
|-
| DP_3PL_SCHED.sql || 5.23 || 3PL Scheduling Engine Database Package || 00708346
|-
| DP_3PL_SCHED.sql || 5.24 || 3PL Scheduling Engine Database Package || 00716621
|-
| DP_3PL_SCHED.sql || 5.26 || 3PL Scheduling Engine Database Package || 00718133
|-
| DP_3PL_SCHED.sql || 5.27 || 3PL Scheduling Engine Database Package || 00729745
|-
| DP_3PL_SCHED.sql || 5.28 || 3PL Scheduling Engine Database Package || 00727465
|-
| DP_3PL_SCHED.sql || 5.29 || 3PL Scheduling Engine Database Package || 00733748
|-
| DP_3PL_SCHED.sql || 5.30 || 3PL Scheduling Engine Database Package || 00735022
|-
| DP_3PL_SCHED.sql || 5.32 || 3PL Scheduling Engine Database Package || 00741398
|-
| DP_3PL_SCHED.sql || 5.33 || 3PL Scheduling Engine Database Package || 00743714
|-
| DP_3PL_SCHED.sql || 5.34 || 3PL Scheduling Engine Database Package || 00749834
|-
| DP_3PL_SCHED.sql || 5.35 || 3PL Scheduling Engine Database Package || 00753290
|-
| DP_3PL_SCHED.sql || 5.36 || 3PL Scheduling Engine Database Package || 00741472
|-
| DP_3PL_SCHED.sql || 5.37 || 3PL Scheduling Engine Database Package || 00755699
|-
| DP_3PL_SCHED.sql || 5.38 || 3PL Scheduling Engine Database Package || 00760470
|-
| DP_3PL_SCHED.sql || 5.39 || 3PL Scheduling Engine Database Package || 00763072
|-
| DP_3PL_SCHED.sql || 5.40 || 3PL Scheduling Engine Database Package || 00769212
|-
| DP_3PL_SCHED.sql || 5.41 || 3PL Scheduling Engine Database Package || 00774163
|-
| DP_3PL_SCHED.sql || 5.43 || 3PL Scheduling Engine Database Package || 00755470
|-
| DP_3PL_SCHED.sql || 5.44 || 3PL Scheduling Engine Database Package || 00779373
|-
| DP_ASSET_SCANNING.sql || 5.60 || Tag to Asset Scanning || 00528318
|-
| DP_CARRIER.sql || 1.101 || Carrier Management || 00729295
|-
| DP_CARRIER.sql || 1.102 || Carrier Management || 00620903
|-
| DP_CARRIER.sql || 1.103 || Carrier Management || 00752710
|-
| DP_CARRIER.sql || 1.98 || Carrier Management || 00664597
|-
| DP_CARRIER.sql || 1.99 || Carrier Management || 00620915
|-
| DP_CARRIER_API.sql || 5.13 || Carrier API Database Package || 00666361
|-
| DP_CARRIER_API.sql || 5.15 || Carrier API Database Package || 00712699
|-
| DP_CARRIER_API.sql || 5.16 || Carrier API Database Package || 00717566
|-
| DP_CARRIER_API.sql || 5.16 || Carrier API Database Package || 00715776
|-
| DP_CARRIER_API.sql || 5.17 || Carrier API Database Package || 00719713
|-
| DP_CSV_POD.sql || 1.8 || POD CSV Database Package || 00759798
|-
| DP_CSV6.sql || 1.46 || CSV Extract package || 00616907
|-
| DP_CSV6.sql || 1.47 || CSV Extract package || 00620885
|-
| DP_CTMS_IMPORT.sql || 5.53 || API Import Database Package || 00645362
|-
| DP_CTMS_IMPORT.sql || 5.54 || API Import Database Package || 00677708
|-
| DP_CTMS_IMPORT.sql || 5.55 || API Import Database Package || 00620535
|-
| DP_CTMS_IMPORT.sql || 5.56 || API Import Database Package || 00645356
|-
| DP_CTMS_IMPORT.sql || 5.57 || API Import Database Package || 00722515
|-
| DP_CTMS_IMPORT.sql || 5.58 || API Import Database Package || 00727664
|-
| DP_CTMS_IMPORT.sql || 5.59 || API Import Database Package || 00740462
|-
| DP_CTMS_IMPORT.sql || 5.60 || API Import Database Package || 00620896
|-
| DP_CTMS_IMPORT.sql || 5.61 || API Import Database Package || 00749051
|-
| DP_CTMS_IMPORT.sql || 5.62 || API Import Database Package || 00741304
|-
| DP_CTMS_IMPORT.sql || 5.63 || API Import Database Package || 00797473
|-
| DP_CUST_SERV.sql || 1.103 || Customer Service Package || 00648341
|-
| DP_CUST_SERV.sql || 1.104 || Customer Service Package || 00680896
|-
| DP_CUST_SERV.sql || 1.105 || Customer Service Package || 00685782
|-
| DP_CUST_SERV.sql || 1.106 || Customer Service Package || 00706682
|-
| DP_CUST_SERV.sql || 1.107 || Customer Service Package || 00737679
|-
| DP_CUST_SERV.sql || 1.108 || Customer Service Package || 00736410
|-
| DP_CUST_SERV.sql || 1.109 || Customer Service Package || 00735880
|-
| DP_CUST_SERV.sql || 1.110 || Customer Service Package || 00770107
|-
| DP_EPOD_WEB_SERVICE.sql || 1.272 || EPOD Web Service || 00658588
|-
| DP_EPOD_WEB_SERVICE.sql || 1.273 || EPOD Web Service || 00782274
|-
| DP_EPOD_WEB_SERVICE.sql || 1.36.1.46 || EPOD Web Service || 00666398
|-
| DP_EXPORT_EVENTS.sql || 5.43 || API Export Events Database Package || 04255786
|-
| DP_EXPORT_EVENTS.sql || 5.44 || API Export Events Database Package || 00748863
|-
| DP_EXPORT_EVENTS.sql || 5.45 || API Export Events Database Package || 00748884
|-
| DP_EXPORT_EVENTS.sql || 5.46 || API Export Events Database Package || 00790794
|-
| DP_FLEXIPOD.sql || 1.10 || Flexipod Package || 00620878
|-
| DP_FLEXIPOD.sql || 1.11 || Flexipod Package || 00620885
|-
| DP_FLEXIPOD.sql || 1.12 || Flexipod Package || 00744746
|-
| DP_FLEXIPOD.sql || 1.13 || Flexipod Package || 00750484
|-
| DP_FLEXIPOD.sql || 1.14 || Flexipod Package || 00764083
|-
| DP_FLEXIPOD.sql || 1.15 || Flexipod Package || 00765489
|-
| DP_FLEXIPOD.sql || 1.16 || Flexipod Package || 00759775
|-
| DP_FLEXIPOD.sql || 1.17 || Flexipod Package || 00745199
|-
| DP_FLEXIPOD.sql || 1.18 || Flexipod Package || 00722509
|-
| DP_FLEXIPOD.sql || 1.19 || Flexipod Package || 00776499
|-
| DP_FLEXIPOD.sql || 1.21 || Flexipod Package || 00779463
|-
| DP_FLEXIPOD.sql || 1.4 || Flexipod Package || 00484373
|-
| DP_FLEXIPOD.sql || 1.5 || Flexipod Package || 00715202
|-
| DP_FLEXIPOD.sql || 1.6 || Flexipod Package || 00725398
|-
| DP_FLEXIPOD.sql || 1.7 || Flexipod Package || 00732819
|-
| DP_FLEXIPOD.sql || 1.9 || Flexipod Package || 00735611
|-
| DP_FRD_EDI_IN.sql || 5.4 || Database package || 00694102
|-
| DP_INT_XML_CFX.sql || 1.8 || CFX Interface Database Package || 00759798
|-
| DP_LFE_POD.sql || 5.7 || LFE POD Database Package || 00723304
|-
| DP_LOGINEXT.sql || 1.1 || Loginext Package || 00655161
|-
| DP_LOGINEXT.sql || 1.10 || Loginext Package || 00760727
|-
| DP_LOGINEXT.sql || 1.11 || Loginext Package || 00764886
|-
| DP_LOGINEXT.sql || 1.12 || Loginext Package || 00768223
|-
| DP_LOGINEXT.sql || 1.13 || Loginext Package || 00764220
|-
| DP_LOGINEXT.sql || 1.14 || Loginext Package || 00780350
|-
| DP_LOGINEXT.sql || 1.16 || Loginext Package || 00790845
|-
| DP_LOGINEXT.sql || 1.17 || Loginext Package || 00795109
|-
| DP_LOGINEXT.sql || 1.2 || Loginext Package || 00739079
|-
| DP_LOGINEXT.sql || 1.2 || Loginext Package || 00736611
|-
| DP_LOGINEXT.sql || 1.3 || Loginext Package || 00741285
|-
| DP_LOGINEXT.sql || 1.4 || Loginext Package || 00746699
|-
| DP_LOGINEXT.sql || 1.6 || Loginext Package || 00751795
|-
| DP_LOGINEXT.sql || 1.6 || Loginext Package || 00752036
|-
| DP_LOGINEXT.sql || 1.7 || Loginext Package || 00753435
|-
| DP_LOGINEXT.sql || 1.8 || Loginext Package || 00755681
|-
| DP_LOGINEXT.sql || 1.9 || Loginext Package || 00756076
|-
| DP_MCS_SCANNING_PSD.sql || 1.10 || MCS Scanning Package || 00771479
|-
| DP_MCS_SCANNING_PSD.sql || 1.11 || MCS Scanning Package || 00765716
|-
| DP_MCS_SCANNING_PSD.sql || 1.12 || MCS Scanning Package || 00776506
|-
| DP_MCS_SCANNING_PSD.sql || 1.13 || MCS Scanning Package || 00776489
|-
| DP_MCS_SCANNING_PSD.sql || 1.15 || MCS Scanning Package || 00776521
|-
| DP_MCS_SCANNING_PSD.sql || 1.2 || MCS Scanning Package || 00620903
|-
| DP_MCS_SCANNING_PSD.sql || 1.3 || MCS Scanning Package || 00752710
|-
| DP_MCS_SCANNING_PSD.sql || 1.4 || MCS Scanning Package || 00753491
|-
| DP_MCS_SCANNING_PSD.sql || 1.5 || MCS Scanning Package || 00753169
|-
| DP_MCS_SCANNING_PSD.sql || 1.6 || MCS Scanning Package || 00752908
|-
| DP_MCS_SCANNING_PSD.sql || 1.7 || MCS Scanning Package || 00620908
|-
| DP_MCS_SCANNING_PSD.sql || 1.8 || MCS Scanning Package || 00751231
|-
| DP_MCS_SCANNING_PSD.sql || 1.9 || MCS Scanning Package || 00770198
|-
| DP_NOKIA_LOC_PLAT.sql || 1.52 || Nokia Location Platform Interface || 00734319
|-
| DP_ORS_FUNCS.sql || 5.34 || Change to DOOD status function || 00653514
|-
| DP_ORS_FUNCS.sql || 5.35 || Change to DOOD status function || 00683460
|-
| DP_ORS_FUNCS.sql || 5.36 || Change to DOOD status function || 00745583
|-
| DP_ORS_FUNCS.sql || 5.37 || Change to DOOD status function || 00620884
|-
| DP_ORS_FUNCS.sql || 5.39 || Change to DOOD status function || 00765676
|-
| DP_ORS_FUNCS.sql || 5.40 || Change to DOOD status function || 00789840
|-
| DP_PAR_API_PSD_STUB.sql || 1.1 || Database package || 00620897
|-
| DP_PAR_API_PSD_STUB.sql || 1.10 || Database package || 00777617
|-
| DP_PAR_API_PSD_STUB.sql || 1.2 || Database package || 00620896
|-
| DP_PAR_API_PSD_STUB.sql || 1.3 || Database package || 00759291
|-
| DP_PAR_API_PSD_STUB.sql || 1.5 || Database package || 00758573
|-
| DP_PAR_API_PSD_STUB.sql || 1.7 || Database package || 00771422
|-
| DP_PAR_API_STP.sql || 5.39 || STP Paragon API Database Package || 00645364
|-
| DP_PAR_API_STP.sql || 5.41 || STP Paragon API Database Package || 00645357
|-
| DP_PAR_API_STP.sql || 5.42 || STP Paragon API Database Package || 00735615
|-
| DP_PAR_API_STP.sql || 5.43 || STP Paragon API Database Package || 00738568
|-
| DP_PAR_API_STP.sql || 5.44 || STP Paragon API Database Package || 00749988
|-
| DP_PAR_API_STP.sql || 5.45 || STP Paragon API Database Package || 00755800
|-
| DP_PORTAL.sql || 5.22 || Portal Package || 00664597
|-
| DP_PORTAL.sql || 5.24 || Portal Package || 00620892
|-
| DP_PORTAL.sql || 5.25 || Portal Package || 00620871
|-
| DP_PORTAL.sql || 5.25 || Portal Package || 00725768
|-
| DP_PORTAL.sql || 5.26 || Portal Package || 00620913
|-
| DP_PULSE.sql || 1.52 || Pulse Interface Package || 00782606
|-
| DP_QR_BARCODE.sql || 1.1 || QR Barcode Package || 00620870
|-
| DP_REPORTS.sql || 5.77 || Reports package || 00620883
|-
| DP_REPORTS.sql || 5.78 || Reports package || 00715885
|-
| DP_SCHEDULING_ENGINE.sql || 5.185 || Scheduling Package || 00620869
|-
| DP_SCHEDULING_ENGINE.sql || 5.187 || Scheduling Package || 00620898
|-
| DP_SCHEDULING_ENGINE.sql || 5.188 || Scheduling Package || 00725225
|-
| DP_SFTP.sql || 5.2 || SFTP package || 00759798
|-
| DP_SFTP.sql || 5.3 || SFTP package || 00796652
|-
| DP_TES_EDI_IN.sql || 1.17 || EDI Package || 00672929
|-
| DP_TES_EDI_IN.sql || 1.18 || EDI Package || 00680323
|-
| DP_TES_EDI_IN.sql || 1.19 || EDI Package || 00696380
|-
| DP_TOMTOM.sql || 1.50 || TomTom Package || 04256859
|-
| EDI_MAINT.fmx || 10.19 || EDI Maintenance Screen || 00762396
|-
| EXPORTS.fmx || 2.37 || Exports screen || 00616866
|-
| GEO.sql || 5.37 || Location Processing || 00620915
|-
| GEO.sql || 5.38 || Location Processing || 00620869
|-
| GEO.sql || 5.39 || Location Processing || 00620903
|-
| GEOGRAPHY.fmx || 2.25 || Geography Screen || 00645357
|-
| GEOGRAPHY.fmx || 2.26 || Geography Screen || 00738608
|-
| IMP.sql || 5.239 || CSV Imports Package || 00620873
|-
| IMP.sql || 5.242 || CSV Imports Package || 00645357
|-
| IMP.sql || 5.244 || CSV Imports Package || 00620871
|-
| IMP.sql || 5.244 || CSV Imports Package || 00725768
|-
| IMP.sql || 5.245 || CSV Imports Package || 00728088
|-
| IMP.sql || 5.246 || CSV Imports Package || 00734074
|-
| IMP.sql || 5.247 || CSV Imports Package || 00736388
|-
| IMP.sql || 5.248 || CSV Imports Package || 00743790
|-
| IMP.sql || 5.249 || CSV Imports Package || 00620872
|-
| IMP.sql || 5.250 || CSV Imports Package || 00769731
|-
| IMP.sql || 5.251 || CSV Imports Package || 00775850
|-
| INT_ERR.fmx || 1.120 || Interface Errors || 00528318
|-
| INT_ERR.fmx || 1.121 || Interface Errors || 00746699
|-
| INT_ERR.fmx || 1.122 || Interface Errors || 00751795
|-
| INT_ERR.fmx || 1.122 || Interface Errors || 00752036
|-
| INT_ERR.fmx || 1.123 || Interface Errors || 00620872
|-
| INT_ERR.fmx || 1.124 || Interface Errors || 00769731
|-
| INT_MSG.sql || 5.47 || Interface Package || 00759798
|-
| INT_XML_EFX.sql || 5.20 || EFX XML Package || 00759798
|-
| INT_XML_IN.sql || 5.244 || Order Import Package || 04065982
|-
| INT_XML_IN.sql || 5.245 || Order Import Package || 00620873
|-
| INT_XML_IN.sql || 5.246 || Order Import Package || 00666361
|-
| INT_XML_IN.sql || 5.247 || Order Import Package || 00717566
|-
| INT_XML_IN.sql || 5.247 || Order Import Package || 00715776
|-
| INT_XML_IN.sql || 5.248 || Order Import Package || 00759798
|-
| INT_XML_MIC.sql || 5.159 || MIC interface || 00759798
|-
| INT_XML_OUT2.sql || 5.348 || Outbound XML Package || 00652806
|-
| INT_XML_OUT2.sql || 5.348 || Outbound XML Package || 00620919
|-
| INT_XML_OUT2.sql || 5.349 || Outbound XML Package || 00620918
|-
| INT_XML_OUT2.sql || 5.350 || Outbound XML Package || 00759798
|-
| INT_XML_OUT2.sql || 5.352 || Outbound XML Package || 00767942
|-
| INT_XML_OUT2.sql || 5.354 || Outbound XML Package || 00767012
|-
| INT_XML_OUT2.sql || 5.355 || Outbound XML Package || 00778740
|-
| INT_XML_OUT2.sql || 5.342.1.1 || Outbound XML Package || 00652347
|-
| LFS_TRIP_SHEET_POD_POC.rep || 1.8 || Trip Sum POD/POC Report || 00693543
|-
| LOCATION.fmx || 2.220 || Location Maintenance || 00645357
|-
| MSG_JOB.sql || 5.13 || Message job functionality || 00620883
|-
| MSG_MAINT.fmx || 2.34 || Message Maintenance screen || 00620883
|-
| MSG_PROCESSING.sql || 5.77 || Message Processing package || 00620883
|-
| OMS.sql || 5.337 || Order package || 00620914
|-
| OMS.sql || 5.338 || Order package || 00645363
|-
| OMS.sql || 5.339 || Order package || 00645357
|-
| OMS.sql || 5.340 || Order package || 00712174
|-
| OMS.sql || 5.341 || Order package || 00716848
|-
| OMS.sql || 5.342 || Order package || 00755677
|-
| OMS.sql || 5.343 || Order package || 00744806
|-
| OMS.sql || 5.345 || Order package || 00775857
|-
| OMS.sql || 5.346 || Order package || 00779582
|-
| ORDERS.fmx || 2.459 || Order Screen || 00729244
|-
| ORDERS.fmx || 2.459 || Order Screen || 04262871
|-
| ORDERS_WIDE.fmx || 1.63 || Orders Screen || 00620899
|-
| ORDERS_WIDE.fmx || 1.68 || Orders Screen || 00620890
|-
| ORDERS_WIDE.fmx || 1.69 || Orders Screen || 00620889
|-
| ORDERS_WIDE.fmx || 1.70 || Orders Screen || 00620894
|-
| ORDERS_WIDE.fmx || 1.72 || Orders Screen || 00620900
|-
| ORDERS_WIDE.fmx || 1.73 || Orders Screen || 00710179
|-
| ORDERS_WIDE.fmx || 1.74 || Orders Screen || 04262871
|-
| ORDERS_WIDE.fmx || 1.75 || Orders Screen || 00778452
|-
| ORDERS_WIDE.fmx || 1.77 || Orders Screen || 00778740
|-
| ORDERS_WIDE.fmx || 1.62.1.1 || Orders Screen || 00620535
|-
| ORDERS_WIDE.fmx || 1.69.1.1 || Orders Screen || 00729244
|-
| ORION.mmx || 1.52 || Orion Menu || 00620877
|-
| ORS.fmx || 1.40 || Oracle Reporting suite || 00755804
|-
| ORS.fmx || 1.41 || Oracle Reporting suite || 00778740
|-
| ORS.sql || 5.14 || Oracle Reporting suite || 00778740
|-
| PLANNING.fmx || 1.156 || Planning Screen || 00528318
|-
| PLANNING.fmx || 1.157 || Planning Screen || 00616853
|-
| PLANNING.fmx || 1.158 || Planning Screen || 00645350
|-
| PLANNING.fmx || 1.159 || Planning Screen || 00616827
|-
| PLANNING.fmx || 1.160 || Planning Screen || 00616806
|-
| PLANNING.fmx || 1.162 || Planning Screen || 00645360
|-
| PLANNING.fmx || 1.163 || Planning Screen || 00708331
|-
| PLANNING.fmx || 1.164 || Planning Screen || 00739079
|-
| PLANNING.fmx || 1.164 || Planning Screen || 00736611
|-
| PLANNING.fmx || 1.165 || Planning Screen || 00746699
|-
| PLANNING.fmx || 1.166 || Planning Screen || 00751795
|-
| PLANNING.fmx || 1.166 || Planning Screen || 00752036
|-
| PLANNING.fmx || 1.167 || Planning Screen || 00753435
|-
| PLANNING.fmx || 1.168 || Planning Screen || 00755222
|-
| PLANNING.fmx || 1.169 || Planning Screen || 00755681
|-
| PLANNING.fmx || 1.170 || Planning Screen || 00771166
|-
| PSD_LABEL.rep || 1.1 || PSD Label || 00620870
|-
| PSD_LABEL.rep || 1.10 || PSD Label || 00753491
|-
| PSD_LABEL.rep || 1.11 || PSD Label || 00772378
|-
| PSD_LABEL.rep || 1.3 || PSD Label || 00664597
|-
| PSD_LABEL.rep || 1.4 || PSD Label || 00620915
|-
| PSD_LABEL.rep || 1.6 || PSD Label || 00729295
|-
| PSD_LABEL.rep || 1.7 || PSD Label || 00620903
|-
| PSD_LABEL.rep || 1.8 || PSD Label || 00741277
|-
| PSD_LABEL.rep || 1.9 || PSD Label || 00752710
|-
| QUARANTINE_ITEMS.fmx || 1.1 || Quarantine Items || 00620877
|-
| QUARANTINE_ITEMS.fmx || 1.10 || Quarantine Items || 00778992
|-
| QUARANTINE_ITEMS.fmx || 1.11 || Quarantine Items || 00778948
|-
| QUARANTINE_ITEMS.fmx || 1.2 || Quarantine Items || 00753169
|-
| QUARANTINE_ITEMS.fmx || 1.5 || Quarantine Items || 00753162
|-
| QUARANTINE_ITEMS.fmx || 1.6 || Quarantine Items || 00765681
|-
| QUARANTINE_ITEMS.fmx || 1.7 || Quarantine Items || 00768995
|-
| QUARANTINE_ITEMS.fmx || 1.8 || Quarantine Items || 00772018
|-
| QUARANTINE_ITEMS.fmx || 1.9 || Quarantine Items || 00773182
|-
| RES_PERSON_CARRIER_UID.sql || 5.6 || Trigger || 00665165
|-
| RESOURCE.fmx || 2.211 || Resource Maintenance form || 00528318
|-
| RESOURCE.fmx || 2.212 || Resource Maintenance form || 00653514
|-
| RESOURCE.fmx || 2.213 || Resource Maintenance form || 00763453
|-
| ROUTES_MAINT.fmx || 2.58 || Fixed Routes Maintenance || 00619888
|-
| ROUTES_MAINT.fmx || 2.59 || Fixed Routes Maintenance || 00645357
|-
| SCHED_RULES.fmx || 1.36 || Scheduling Screen || 00620892
|-
| SCHED_RULES.fmx || 1.38 || Scheduling Screen || 00716175
|-
| SCHED_RULES.fmx || 1.39 || Scheduling Screen || 00725680
|-
| T_GEO_LOCATION_PLANNING.sql || 1.2 || Trigger || 00620869
|-
| T_SCH_TRIP_STOP_BIU.sql || 5.10 || Trigger || 00751795
|-
| T_SCH_TRIP_STOP_BIU.sql || 5.10 || Trigger || 00752036
|-
| T_SCH_TRIP_STOP_BIU.sql || 5.7 || Trigger || 00655161
|-
| T_SCH_TRIP_STOP_BIU.sql || 5.9 || Trigger || 00739079
|-
| T_SCH_TRIP_STOP_BIU.sql || 5.9 || Trigger || 00736611
|-
| T_SCH_TRIP_STOP_IUD.sql || 5.6 || Trigger || 00764886
|-
| TI_SCH_ORD_STATUS.sql || 1.33 || Trigger on SCH_ORD for status change || 00620885
|-
| TIU_TRIP_STATUS.sql || 5.58 || Trigger on SCH_TRIP for status change || 00655161
|-
| TIU_TRIP_STATUS.sql || 5.59 || Trigger on SCH_TRIP for status change || 00751795
|-
| TIU_TRIP_STATUS.sql || 5.59 || Trigger on SCH_TRIP for status change || 00752036
|-
| TRG_BOOKING_REF_FLX.sql || 1.2 || Trigger || 00484373
|-
| TRG_BOOKING_REF_FLX.sql || 1.3 || Trigger || 00715202
|-
| TRG_BOOKING_REF_FLX.sql || 1.4 || Trigger || 00725398
|-
| TRG_DELETE_FLX.sql || 1.2 || Trigger || 00484373
|-
| TRG_DELETE_FLX.sql || 1.3 || Trigger || 00715202
|-
| TRG_DELETE_FLX.sql || 1.4 || Trigger || 00744791
|-
| TRG_FLEXIPOD_WEB_AUDIT.sql || 1.1 || Trigger || 00484373
|-
| TRG_GEO_LOCATION_UID.sql || 5.7 || Trigger || 00645364
|-
| TRG_GEO_LOCATION_ZONE_IUD.sql || 1.1 || Trigger || 00645189
|-
| TRG_INT_XML_CONTROL_BI.sql || 5.2 || Trigger || 04255786
|-
| TRG_SCH_HAULAGE_FLX.sql || 1.2 || Trigger || 00484373
|-
| TRG_SCH_HAULAGE_FLX.sql || 1.3 || Trigger || 00715202
|-
| TRG_SCH_HAULAGE_FLX.sql || 1.4 || Trigger || 00725398
|-
| TRG_SCH_HAULAGE_FLX.sql || 1.6 || Trigger || 00620885
|-
| TRG_SCH_ORD_DEL_TYPE.sql || 1.1 || Trigger || 00620899
|-
| TRG_SCH_ORD_ITEMS_CONTENT_FLX.sql || 1.1 || Trigger || 00484373
|-
| TRG_SCH_ORD_ITEMS_CONTENT_FLX.sql || 1.2 || Trigger || 00715202
|-
| TRG_SCH_ORD_ITEMS_FLX.sql || 1.1 || Trigger || 00484373
|-
| TRG_SCH_ORD_ITEMS_FLX.sql || 1.2 || Trigger || 00715202
|-
| TRG_SCH_ORD_ITEMS_HELD_IU.sql || 1.1 || Trigger || 00620878
|-
| TRG_SCH_ORD_ITEMS_REASONS.sql || 5.16 || Trigger || 00747259
|-
| TRG_SCH_ORD_ITEMS_REASONS.sql || 5.17 || Trigger || 00753169
|-
| TRG_SCH_ORD_ITEMS_REASONS.sql || 5.18 || Trigger || 00773182
|-
| TRG_SCH_ORD_ITEMS_REASONS_SCAN.sql || 5.9 || Trigger || 00620885
|-
| TRG_SCH_ORD_REF_FLX.sql || 1.1 || Trigger || 00484373
|-
| TRG_SCH_ORD_REF_FLX.sql || 1.2 || Trigger || 00715202
|-
| TRG_SCH_ORD_REFERENCE_AI.sql || 1.10 || Trigger on SCH_ORD_REFERENCE || 00620885
|-
| TRG_SCH_ORD_REFERENCE_AI.sql || 1.8 || Trigger on SCH_ORD_REFERENCE || 00620919
|-
| TRG_SCH_ORD_REFERENCE_DELETE.sql || 1.1 || Trigger || 00620919
|-
| TRG_SCH_ORDER_LINE_FLX.sql || 1.1 || Trigger || 00484373
|-
| TRG_SCH_ORDER_LINE_FLX.sql || 1.2 || Trigger || 00715202
|-
| TRG_SCH_TRIP_DRV_FLX.sql || 1.2 || Trigger || 00484373
|-
| TRG_SCH_TRIP_DRV_FLX.sql || 1.3 || Trigger || 00715202
|-
| TRG_SCH_TRIP_DRV_FLX.sql || 1.4 || Trigger || 00725398
|-
| TRG_SCH_TRIP_STOP_XML_FLX.sql || 1.1 || Trigger || 00484373
|-
| TRG_SCH_TRIP_XML_FLX.sql || 1.2 || Trigger || 00484373
|-
| TRG_SCH_TRIP_XML_FLX.sql || 1.3 || Trigger || 00725398
|-
| TRG_SCH_TRIP_XML_INT.sql || 5.42 || Trigger || 00655161
|-
| TRG_SCH_TRIP_XML_INT.sql || 5.43 || Trigger || 00620865
|-
| TRG_SCH_TRIP_XML_INT.sql || 5.44 || Trigger || 00736611
|-
| TRG_SCH_TRIP_XML_INT.sql || 5.42.1.1 || Trigger || 00739079
|-
| TRG_SHA_LOTS.sql || 5.10 || Trigger || 00620865
|-
| TRG_SHA_XML.sql || 5.28 || Trigger || 00655161
|-
| TRG_SHA_XML.sql || 5.29 || Trigger || 00739079
|-
| TRG_SHA_XML.sql || 5.29 || Trigger || 00736611
|-
| TRG_SHA_XML.sql || 5.30 || Trigger || 00751795
|-
| TRG_SHA_XML.sql || 5.30 || Trigger || 00752036
|-
| TRG_SOI_XML.sql || 5.26 || Trigger || 00655161
|-
| TRG_SOI_XML.sql || 5.28 || Trigger || 00620885
|-
| TRG_SOI_XML.sql || 5.29 || Trigger || 00752036
|-
| TRG_SOI_XML.sql || 5.26.1.1 || Trigger || 00751795
|-
| TRG_SOIR_REBOOK.sql || 1.1 || Trigger || 00645363
|-
| TRG_SOIR_REBOOK.sql || 1.2 || Trigger || 00620894
|-
| TRG_SOIR_REBOOK.sql || 1.3 || Trigger || 00721017
|-
| TRG_SOIR_REBOOK.sql || 1.4 || Trigger || 00755677
|-
| TRG_SOIR_REBOOK.sql || 1.5 || Trigger || 00755678
|-
| TRG_SOIR_REBOOK.sql || 1.6 || Trigger || 00758750
|-
| TRG_SOL_XML.sql || 5.57 || Trigger || 00651637
|-
| TRG_SOL_XML.sql || 5.58 || Trigger || 00779094
|-
| TRG_SOM_SUPP_CONF.sql || 5.21 || Trigger || 03885049
|-
| TRG_STS_XML_OUT.sql || 5.40 || Trip Stop Trigger || 00620865
|-
| TRIP_OVERVIEW.fmx || 1.79 || Trip Waterfall || 00616866
|-
| TRIP_OVERVIEW.fmx || 1.81 || Trip Waterfall || 00616853
|-
| TRIPDTL.fmx || 2.233 || Trip Debrief || 00645363
|-
| TRIPDTL.fmx || 2.233 || Trip Debrief || 00708427
|-
| TRIPDTL.fmx || 2.234 || Trip Debrief || 00712174
|-
| TRM.sql || 5.232 || Trip manipulation package || 00528318
|-
| TRM.sql || 5.233 || Trip manipulation package || 00616853
|-
| TRM.sql || 5.234 || Trip manipulation package || 00666361
|-
| TRM.sql || 5.235 || Trip manipulation package || 00708346
|-
| TRM.sql || 5.236 || Trip manipulation package || 00715776
|-
| TRM.sql || 5.237 || Trip manipulation package || 00733748
|-
| TRM.sql || 5.238 || Trip manipulation package || 00733060
|-
| TRM.sql || 5.239 || Trip manipulation package || 00752036
|-
| TRM.sql || 5.240 || Trip manipulation package || 00755801
|-
| TRM.sql || 5.233.1.1 || Trip manipulation package || 00751795
|-
| TRM.sql || 5.234.1.1 || Trip manipulation package || 00717566
|-
| TRM.sql || 5.238.1.1 || Trip manipulation package || 00762220
|-
| V_CTL_CUSTLOC.sql || 5.7 || View || 00772411
|-
| V_MCS_LOCATION.sql || 1.1 || View || 00620903
|-
| V_MCS_REASON_CODE.sql || 1.2 || View || 00620903
|-
| V_MCS_SITE.sql || 1.6 || View || 00620903
|-
| V_MCS_TRIP_ITEM.sql || 1.17 || Trip Items View || 00620903
|-
| V_MCS_TRIP_ITEM.sql || 1.18 || Trip Items View || 00753491
|-
| V_MCS_TRIP_ITEM.sql || 1.19 || Trip Items View || 00752908
|-
| V_MCS_TRIP_ITEM.sql || 1.20 || Trip Items View || 00620908
|-
| V_RES_VEHICLE_CUST_LOC.sql || 1.4 || View || 04267367
|-
| V_ROUTES.sql || 1.3 || View || 00645360
|-
| V_ROUTES.sql || 1.3 || View || 00708331
|-
| WCS_MAINT.fmx || 1.12 || WCS Maintenance || 00620903
|-
|}

= ADDITIONAL CHANGES =
== WCS ==

A WCS change is required for the following logs:
* Log
OR

There are no WCS changes required.

== EPOD/T2A ==

An ePOD/T2A change is required for the following logs:
* Log
OR

There are no ePOD/T2A changes required.

== MCS ==

An MCS change is required for the following logs:
* Log
OR

There are no MCS changes required.

== PORTAL/TTM ==

A Portal change is required for the following logs:
* Log
OR

There are no Portal changes required.

== EDI ==

An EDI change is required for the following logs:
* Log
OR

There are no EDI changes required.

[[Category:{{#var:Client}} PATCH]]

Template:EstimateCostDetails2026

2026-01-06T11:41:37Z

Anw: Updated

<noinclude>
Usage:

<nowiki>
{{EstimateCostDetails</nowiki><br />
|Client=Client for estimate rates. Required if an estimate section is to be produced.<br />
|Year=Year for estimate rates. Required if an estimate section is to be produced.<br />
|REQ=Requirements Time. Defaults to zero.<br />
|EST=Estimate Time. Defaults to zero.<br />
|FS=Functional Specification Time. Defaults to zero.<br />
|TS=Technical Specification Time. Defaults to zero.<br />
|DEV=Development Time. Defaults to zero.<br />
|ST=Testing Time. Defaults to zero.<br />
|IMP=Implementation Time. Defaults to zero.<br />
|PM=Project Management Time. If omitted, line is not shown on estimate.<br />
|FSEST=Y if this estimate is for production in a functional specification. Omit if no separate estimate and functional specification sections are required. If the values in the estimate differ from the functional specification, use the fields EREQ, EEST, EFS, ETS, EDEV, ESTT, EIMP and EPM to identify the Estimate values. If these are omitted, the Functional Specification values in fields REQ, EST, FS, TS, DEV, ST, IMP and PM will be used.<br />
|EREQ=Estimate Requirements Time. Defaults to the value specified in REQ if omitted.<br />
|EEST=Estimate Estimate Time. Defaults to the value specified in EST if omitted.<br />
|EFS=Estimate Functional Specification Time. Defaults to the value specified in FS if omitted.<br />
|ETS=Estimate Technical Specification Time. Defaults to the value specified in TS if omitted.<br />
|EDEV=Estimate Development Time. Defaults to the value specified in DEV if omitted.<br />
|ESTT=Estimate Testing Time. Defaults to the value specified in ST if omitted.<br />
|EIMP=Estimate Implementation Time. Defaults to the value specified in IMP if omitted.<br />
|EPM=Estimate Project Management Time. Defaults to the value specified in PM if omitted.<br />
|FOC=Free of Charge - set this to Y to ensure no cost is associated. Defaults to N.<br />
|FIXEDCOST=Fixed Cost - set this to a value to ensure only this cost is associated.<br />
|NOFOOTER=Remove the footer - if omitted, will always be present<br />
|DiscountPerc=Discount Percentage<br />
|DiscountText=Text if discount percentage is non-0<br />
}}
</nowiki>

{{note}} If on a separate page Ensure that you include the relevant Category tag at the bottom of the page.

{{note}} Costs should be numeric. If one is not included, it will default to zero (0).

{{note|This page should be kept up-to-date with the latest cost changes for all clients, otherwise the costs will default to zero (0)}}

</noinclude>
{{#vardefine:TitleRate|Rate per hour (£)}}{{#vardefine:TitleCost|Cost (£ Exc. VAT)}}{{#vardefine:Currency|£}}{{#ifeq:{{{Client}}}|DHLT|
{{#vardefine:CostREQ|156.56}}
{{#vardefine:CostEST|156.56}}
{{#vardefine:CostFS|156.56}}
{{#vardefine:CostTS|156.56}}
{{#vardefine:CostDEV|156.56}}
{{#vardefine:CostST|156.56}}
{{#vardefine:CostIMP|156.56}}
{{#vardefine:CostPM|156.56}}
|
{{#ifeq:{{{Client}}}|LFS|
{{#vardefine:TitleRate|Rate per hour ($)}}{{#vardefine:TitleCost|Cost ($ Exc. GST)}}{{#vardefine:Currency|$}}
{{#vardefine:CostREQ|226.60}}
{{#vardefine:CostEST|226.60}}
{{#vardefine:CostFS|226.60}}
{{#vardefine:CostTS|226.60}}
{{#vardefine:CostDEV|226.60}}
{{#vardefine:CostST|226.60}}
{{#vardefine:CostIMP|226.60}}
{{#vardefine:CostPM|226.60}}
|
{{#ifeq:{{{Client}}}|CTY|
{{#vardefine:TitleRate|Rate per hour (£)}}{{#vardefine:TitleCost|Cost (£ Exc. VAT)}}{{#vardefine:Currency|£}}
{{#vardefine:CostREQ|175.10}}
{{#vardefine:CostEST|175.10}}
{{#vardefine:CostFS|175.10}}
{{#vardefine:CostTS|175.10}}
{{#vardefine:CostDEV|175.10}}
{{#vardefine:CostST|175.10}}
{{#vardefine:CostIMP|175.10}}
{{#vardefine:CostPM|175.10}}
|

{{#vardefine:Message|Unknown costs for client/year ({{{Client|No client}}}/{{{Year|No year}}})}}
{{#vardefine:CostREQ|0.00}}
{{#vardefine:CostEST|0.00}}
{{#vardefine:CostFS|0.00}}
{{#vardefine:CostTS|0.00}}
{{#vardefine:CostDEV|0.00}}
{{#vardefine:CostST|0.00}}
{{#vardefine:CostIMP|0.00}}
{{#vardefine:CostPM|0.00}}
}}
}}
}}{{#ifeq:{{{#var:COSTEST}}}||

{{#vardefine:Message|Unknown costs for client/year ({{{Client|No client}}}/{{{Year|No year}}})}}
}}{{#ifeq:{{{FOC|N}}}|Y|
{{#vardefine:Message| }}
{{#vardefine:CostREQ|0}}
{{#vardefine:CostEST|0}}
{{#vardefine:CostFS|0}}
{{#vardefine:CostTS|0}}
{{#vardefine:CostDEV|0}}
{{#vardefine:CostST|0}}
{{#vardefine:CostIMP|0}}
{{#vardefine:CostPM|0}}
}}{{#if: {{#var:Message}} |{{warning|{{#var:Message}}}} | }}
<table class="wikitable" border="1px" width="100%">
<tr><td bgcolor="silver" colspan={{#ifeq:{{{FSEST}}}|Y|5|4}}>'''Cost Details'''</td></tr>
<tr>
<td bgcolor="silver">'''Activity'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">'''Estimate<br />No. of Days'''</td>|}}
<td bgcolor="silver" align="center">'''Hours'''</td>
<td bgcolor="silver" align="center">'''{{#var:TitleRate}}'''</td>
<td bgcolor="silver" align="center">'''{{#var:TitleCost}}'''</td>
</tr>
<tr>
<td bgcolor="silver">Requirements</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EREQ|{{{REQ}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{REQ|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostREQ}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{REQ|0}}}*{{#var:CostREQ}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Change Request Evaluation</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EEST|{{{EST}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{EST|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostEST}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{EST|0}}}*{{#var:CostEST}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Functional Specification</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EFS|{{{FS}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{FS|0}}} |2}}</td>
<td bgcolor="silver" align="center">{{#var:CostFS}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{FS|0}}}*{{#var:CostFS}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Technical Specification</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{ETS|{{{TS}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{TS|0}}}|2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostTS}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{TS|0}}}*{{#var:CostTS}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Development</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EDEV|{{{DEV}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{DEV|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostDEV}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{DEV|0}}}*{{#var:CostDEV}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Testing and Release</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{ESTT|{{{ST}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{ST|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostST}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{ST|0}}}*{{#var:CostST}} }} |2}}</td>
</tr>
<tr>
<td bgcolor="silver">Implementation</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EIMP|{{{IMP}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{IMP|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostIMP}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{IMP|0}}}*{{#var:CostIMP}} }}|2 }}</td>
</tr>
{{#ifeq:{{{PM|X}}}|X||<tr>
<td bgcolor="silver">Project Management</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EPM|{{{PM|0}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{PM|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostPM}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{PM|0}}}*{{#var:CostPM}} }}|2 }}</td>
</tr>}}
<tr><td align="right" colspan={{#ifeq:{{{FSEST}}}|Y|5|4}}>{{#ifeq:{{{DiscountPerc|0}}}|0| |<font color="red"><strong>{{{DiscountText}}} {{{DiscountPerc}}}%</strong></font>}}</td></tr>
<tr>
{{#ifeq:{{{FIXEDCOST|N}}}|N|
<td bgcolor="silver">'''TOTAL'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{#expr: {{{EREQ|{{{REQ}}}}}}+{{{EEST|{{{EST}}}}}}+{{{EFS|{{{FS}}}}}}+{{{ETS|{{{TS}}}}}}+{{{EDEV|{{{DEV}}}}}}+{{{ESTT|{{{ST}}}}}}+{{{EIMP|{{{IMP}}}}}}+{{{EPM|{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}}}} }} |2 }}</td>|}}
<td align="center">{{#number_format: {{#expr: {{{REQ|0}}}+{{{EST|0}}}+{{{FS|0}}}+{{{TS|0}}}+{{{DEV|0}}}+{{{ST|0}}}+{{{IMP|0}}}+{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}} }} |2 }}</td>
<td bgcolor="silver"> </td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: (({{{REQ|0}}}* {{#var:CostREQ}})+({{{EST|0}}}* {{#var:CostEST}})+({{{FS|0}}}* {{#var:CostFS}})+({{{TS|0}}}* {{#var:CostTS}})+({{{DEV|0}}}* {{#var:CostDEV}})+({{{ST|0}}}* {{#var:CostST}})+({{{IMP|0}}}* {{#var:CostIMP}})+({{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}* {{#var:CostPM}})) * ((100 - {{{DiscountPerc|0}}}) / 100) }} |2 }}</td>
|<td bgcolor="silver">'''TOTAL (FIXED COST)'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{#expr: {{{EREQ|{{{REQ}}}}}}+{{{EEST|{{{EST}}}}}}+{{{EFS|{{{FS}}}}}}+{{{ETS|{{{TS}}}}}}+{{{EDEV|{{{DEV}}}}}}+{{{ESTT|{{{ST}}}}}}+{{{EIMP|{{{IMP}}}}}}+{{{EPM|{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}}}} }} |2 }}</td>|}}
<td align="center">{{#number_format: {{#expr: {{{REQ|0}}}+{{{EST|0}}}+{{{FS|0}}}+{{{TS|0}}}+{{{DEV|0}}}+{{{ST|0}}}+{{{IMP|0}}}+{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}} }} |2 }}</td>
<td bgcolor="silver"> </td>
<td align="right">{{#var:Currency}}{{#number_format:{{{FIXEDCOST}}} |2}}</td>
}}
</tr>
</table>
{{#ifeq:{{{NOFOOTER|N}}}|N|<table width="100%"><tr><td align="center">'''Estimate excludes training, release to live and go live support.'''</td></tr></table>}}
<noinclude>
[[Category:Templates|{{PAGENAME}}]]
</noinclude>

Template:EstimateCostDetails2025

2026-01-06T11:40:38Z

Anw: Updated

<noinclude>
Usage:

<nowiki>
{{EstimateCostDetails</nowiki><br />
|Client=Client for estimate rates. Required if an estimate section is to be produced.<br />
|Year=Year for estimate rates. Required if an estimate section is to be produced.<br />
|REQ=Requirements Time. Defaults to zero.<br />
|EST=Estimate Time. Defaults to zero.<br />
|FS=Functional Specification Time. Defaults to zero.<br />
|TS=Technical Specification Time. Defaults to zero.<br />
|DEV=Development Time. Defaults to zero.<br />
|ST=Testing Time. Defaults to zero.<br />
|IMP=Implementation Time. Defaults to zero.<br />
|PM=Project Management Time. If omitted, line is not shown on estimate.<br />
|FSEST=Y if this estimate is for production in a functional specification. Omit if no separate estimate and functional specification sections are required. If the values in the estimate differ from the functional specification, use the fields EREQ, EEST, EFS, ETS, EDEV, ESTT, EIMP and EPM to identify the Estimate values. If these are omitted, the Functional Specification values in fields REQ, EST, FS, TS, DEV, ST, IMP and PM will be used.<br />
|EREQ=Estimate Requirements Time. Defaults to the value specified in REQ if omitted.<br />
|EEST=Estimate Estimate Time. Defaults to the value specified in EST if omitted.<br />
|EFS=Estimate Functional Specification Time. Defaults to the value specified in FS if omitted.<br />
|ETS=Estimate Technical Specification Time. Defaults to the value specified in TS if omitted.<br />
|EDEV=Estimate Development Time. Defaults to the value specified in DEV if omitted.<br />
|ESTT=Estimate Testing Time. Defaults to the value specified in ST if omitted.<br />
|EIMP=Estimate Implementation Time. Defaults to the value specified in IMP if omitted.<br />
|EPM=Estimate Project Management Time. Defaults to the value specified in PM if omitted.<br />
|FOC=Free of Charge - set this to Y to ensure no cost is associated. Defaults to N.<br />
|FIXEDCOST=Fixed Cost - set this to a value to ensure only this cost is associated.<br />
|NOFOOTER=Remove the footer - if omitted, will always be present<br />
|DiscountPerc=Discount Percentage<br />
|DiscountText=Text if discount percentage is non-0<br />
}}
</nowiki>

{{note}} If on a separate page Ensure that you include the relevant Category tag at the bottom of the page.

{{note}} Costs should be numeric. If one is not included, it will default to zero (0).

{{note|This page should be kept up-to-date with the latest cost changes for all clients, otherwise the costs will default to zero (0)}}

</noinclude>
{{#vardefine:TitleRate|Rate per hour (£)}}{{#vardefine:TitleCost|Cost (£ Exc. VAT)}}{{#vardefine:Currency|£}}{{#ifeq:{{{Client}}}|DHLT|
{{#vardefine:CostREQ|152.00}}
{{#vardefine:CostEST|152.00}}
{{#vardefine:CostFS|152.00}}
{{#vardefine:CostTS|152.00}}
{{#vardefine:CostDEV|152.00}}
{{#vardefine:CostST|152.00}}
{{#vardefine:CostIMP|152.00}}
{{#vardefine:CostPM|152.00}}
|
{{#ifeq:{{{Client}}}|LFS|
{{#vardefine:TitleRate|Rate per hour ($)}}{{#vardefine:TitleCost|Cost ($ Exc. GST)}}{{#vardefine:Currency|$}}
{{#vardefine:CostREQ|220.00}}
{{#vardefine:CostEST|220.00}}
{{#vardefine:CostFS|220.00}}
{{#vardefine:CostTS|220.00}}
{{#vardefine:CostDEV|220.00}}
{{#vardefine:CostST|220.00}}
{{#vardefine:CostIMP|220.00}}
{{#vardefine:CostPM|220.00}}
|
{{#ifeq:{{{Client}}}|CTY|
{{#vardefine:TitleRate|Rate per hour (£)}}{{#vardefine:TitleCost|Cost (£ Exc. VAT)}}{{#vardefine:Currency|£}}
{{#vardefine:CostREQ|170.00}}
{{#vardefine:CostEST|170.00}}
{{#vardefine:CostFS|170.00}}
{{#vardefine:CostTS|170.00}}
{{#vardefine:CostDEV|170.00}}
{{#vardefine:CostST|170.00}}
{{#vardefine:CostIMP|170.00}}
{{#vardefine:CostPM|170.00}}
|

{{#vardefine:Message|Unknown costs for client/year ({{{Client|No client}}}/{{{Year|No year}}})}}
{{#vardefine:CostREQ|0.00}}
{{#vardefine:CostEST|0.00}}
{{#vardefine:CostFS|0.00}}
{{#vardefine:CostTS|0.00}}
{{#vardefine:CostDEV|0.00}}
{{#vardefine:CostST|0.00}}
{{#vardefine:CostIMP|0.00}}
{{#vardefine:CostPM|0.00}}
}}
}}
}}{{#ifeq:{{{#var:COSTEST}}}||

{{#vardefine:Message|Unknown costs for client/year ({{{Client|No client}}}/{{{Year|No year}}})}}
}}{{#ifeq:{{{FOC|N}}}|Y|
{{#vardefine:Message| }}
{{#vardefine:CostREQ|0}}
{{#vardefine:CostEST|0}}
{{#vardefine:CostFS|0}}
{{#vardefine:CostTS|0}}
{{#vardefine:CostDEV|0}}
{{#vardefine:CostST|0}}
{{#vardefine:CostIMP|0}}
{{#vardefine:CostPM|0}}
}}{{#if: {{#var:Message}} |{{warning|{{#var:Message}}}} | }}
<table class="wikitable" border="1px" width="100%">
<tr><td bgcolor="silver" colspan={{#ifeq:{{{FSEST}}}|Y|5|4}}>'''Cost Details'''</td></tr>
<tr>
<td bgcolor="silver">'''Activity'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">'''Estimate<br />No. of Days'''</td>|}}
<td bgcolor="silver" align="center">'''Hours'''</td>
<td bgcolor="silver" align="center">'''{{#var:TitleRate}}'''</td>
<td bgcolor="silver" align="center">'''{{#var:TitleCost}}'''</td>
</tr>
<tr>
<td bgcolor="silver">Requirements</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EREQ|{{{REQ}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{REQ|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostREQ}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{REQ|0}}}*{{#var:CostREQ}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Change Request Evaluation</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EEST|{{{EST}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{EST|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostEST}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{EST|0}}}*{{#var:CostEST}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Functional Specification</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EFS|{{{FS}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{FS|0}}} |2}}</td>
<td bgcolor="silver" align="center">{{#var:CostFS}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{FS|0}}}*{{#var:CostFS}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Technical Specification</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{ETS|{{{TS}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{TS|0}}}|2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostTS}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{TS|0}}}*{{#var:CostTS}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Development</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EDEV|{{{DEV}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{DEV|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostDEV}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{DEV|0}}}*{{#var:CostDEV}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Testing and Release</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{ESTT|{{{ST}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{ST|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostST}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{ST|0}}}*{{#var:CostST}} }} |2}}</td>
</tr>
<tr>
<td bgcolor="silver">Implementation</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EIMP|{{{IMP}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{IMP|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostIMP}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{IMP|0}}}*{{#var:CostIMP}} }}|2 }}</td>
</tr>
{{#ifeq:{{{PM|X}}}|X||<tr>
<td bgcolor="silver">Project Management</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EPM|{{{PM|0}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{PM|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostPM}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{PM|0}}}*{{#var:CostPM}} }}|2 }}</td>
</tr>}}
<tr><td align="right" colspan={{#ifeq:{{{FSEST}}}|Y|5|4}}>{{#ifeq:{{{DiscountPerc|0}}}|0| |<font color="red"><strong>{{{DiscountText}}} {{{DiscountPerc}}}%</strong></font>}}</td></tr>
<tr>
{{#ifeq:{{{FIXEDCOST|N}}}|N|
<td bgcolor="silver">'''TOTAL'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{#expr: {{{EREQ|{{{REQ}}}}}}+{{{EEST|{{{EST}}}}}}+{{{EFS|{{{FS}}}}}}+{{{ETS|{{{TS}}}}}}+{{{EDEV|{{{DEV}}}}}}+{{{ESTT|{{{ST}}}}}}+{{{EIMP|{{{IMP}}}}}}+{{{EPM|{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}}}} }} |2 }}</td>|}}
<td align="center">{{#number_format: {{#expr: {{{REQ|0}}}+{{{EST|0}}}+{{{FS|0}}}+{{{TS|0}}}+{{{DEV|0}}}+{{{ST|0}}}+{{{IMP|0}}}+{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}} }} |2 }}</td>
<td bgcolor="silver"> </td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: (({{{REQ|0}}}* {{#var:CostREQ}})+({{{EST|0}}}* {{#var:CostEST}})+({{{FS|0}}}* {{#var:CostFS}})+({{{TS|0}}}* {{#var:CostTS}})+({{{DEV|0}}}* {{#var:CostDEV}})+({{{ST|0}}}* {{#var:CostST}})+({{{IMP|0}}}* {{#var:CostIMP}})+({{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}* {{#var:CostPM}})) * ((100 - {{{DiscountPerc|0}}}) / 100) }} |2 }}</td>
|<td bgcolor="silver">'''TOTAL (FIXED COST)'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{#expr: {{{EREQ|{{{REQ}}}}}}+{{{EEST|{{{EST}}}}}}+{{{EFS|{{{FS}}}}}}+{{{ETS|{{{TS}}}}}}+{{{EDEV|{{{DEV}}}}}}+{{{ESTT|{{{ST}}}}}}+{{{EIMP|{{{IMP}}}}}}+{{{EPM|{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}}}} }} |2 }}</td>|}}
<td align="center">{{#number_format: {{#expr: {{{REQ|0}}}+{{{EST|0}}}+{{{FS|0}}}+{{{TS|0}}}+{{{DEV|0}}}+{{{ST|0}}}+{{{IMP|0}}}+{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}} }} |2 }}</td>
<td bgcolor="silver"> </td>
<td align="right">{{#var:Currency}}{{#number_format:{{{FIXEDCOST}}} |2}}</td>
}}
</tr>
</table>
{{#ifeq:{{{NOFOOTER|N}}}|N|<table width="100%"><tr><td align="center">'''Estimate excludes training, release to live and go live support.'''</td></tr></table>}}
<noinclude>
[[Category:Templates|{{PAGENAME}}]]
</noinclude>

Template:Estimate Template

2026-01-05T11:26:44Z

Anw: Updated

{{Template:EstimateNew
|Supimix_Client_Code=Client_Code
|Supimix_Project_Code=Project_Code
|Supimix_Site_Code=Site_Code
|Supimix_Client_Reference=Client_Reference
|Supimix_Number=SF_Ref
|The_version_of_the_document=0.01
|Your_Name=Your_Name
|Supimix_PO_Reference=-
|Supimix_Priority=-
|Date_(DD/MM/YY)=Date
|Clients_Customer=Client_Customer
|System_Version_being_changed=SysVer
|Client_Request=Client_Request
|OBS_Solution=Aptean_Solution
|Requirements_Days=0
|Estimation_Days=0
|Functional_Specification_Days=0
|Technical_Specification_Days=0
|Development_Days=0
|Testing_and_Release_Days=0
|Implementation_Days=0
|Project_Management_Days=0
|Year=2025
|Free_Of_Charge=N
|FIXEDCOST=N
|NOFOOTER=N
|DiscountPerc=0
|DiscountText=
}}

Template:Estimate Template

2026-01-05T11:25:23Z

Anw: Updated

Template:EstimateCostDetails2026

2026-01-05T11:14:15Z

Anw: Initial Creation

<noinclude>
Usage:

<nowiki>
{{EstimateCostDetails</nowiki><br />
|Client=Client for estimate rates. Required if an estimate section is to be produced.<br />
|Year=Year for estimate rates. Required if an estimate section is to be produced.<br />
|REQ=Requirements Time. Defaults to zero.<br />
|EST=Estimate Time. Defaults to zero.<br />
|FS=Functional Specification Time. Defaults to zero.<br />
|TS=Technical Specification Time. Defaults to zero.<br />
|DEV=Development Time. Defaults to zero.<br />
|ST=Testing Time. Defaults to zero.<br />
|IMP=Implementation Time. Defaults to zero.<br />
|PM=Project Management Time. If omitted, line is not shown on estimate.<br />
|FSEST=Y if this estimate is for production in a functional specification. Omit if no separate estimate and functional specification sections are required. If the values in the estimate differ from the functional specification, use the fields EREQ, EEST, EFS, ETS, EDEV, ESTT, EIMP and EPM to identify the Estimate values. If these are omitted, the Functional Specification values in fields REQ, EST, FS, TS, DEV, ST, IMP and PM will be used.<br />
|EREQ=Estimate Requirements Time. Defaults to the value specified in REQ if omitted.<br />
|EEST=Estimate Estimate Time. Defaults to the value specified in EST if omitted.<br />
|EFS=Estimate Functional Specification Time. Defaults to the value specified in FS if omitted.<br />
|ETS=Estimate Technical Specification Time. Defaults to the value specified in TS if omitted.<br />
|EDEV=Estimate Development Time. Defaults to the value specified in DEV if omitted.<br />
|ESTT=Estimate Testing Time. Defaults to the value specified in ST if omitted.<br />
|EIMP=Estimate Implementation Time. Defaults to the value specified in IMP if omitted.<br />
|EPM=Estimate Project Management Time. Defaults to the value specified in PM if omitted.<br />
|FOC=Free of Charge - set this to Y to ensure no cost is associated. Defaults to N.<br />
|FIXEDCOST=Fixed Cost - set this to a value to ensure only this cost is associated.<br />
|NOFOOTER=Remove the footer - if omitted, will always be present<br />
|DiscountPerc=Discount Percentage<br />
|DiscountText=Text if discount percentage is non-0<br />
}}
</nowiki>

{{note}} If on a separate page Ensure that you include the relevant Category tag at the bottom of the page.

{{note}} Costs should be numeric. If one is not included, it will default to zero (0).

{{note|This page should be kept up-to-date with the latest cost changes for all clients, otherwise the costs will default to zero (0)}}

</noinclude>
{{#vardefine:TitleRate|Rate per hour (£)}}{{#vardefine:TitleCost|Cost (£ Exc. VAT)}}{{#vardefine:Currency|£}}{{#ifeq:{{{Client}}}|DHLT|
{{#vardefine:CostREQ|156.56}}
{{#vardefine:CostEST|156.56}}
{{#vardefine:CostFS|156.56}}
{{#vardefine:CostTS|156.56}}
{{#vardefine:CostDEV|156.56}}
{{#vardefine:CostST|156.56}}
{{#vardefine:CostIMP|156.56}}
{{#vardefine:CostPM|156.56}}
|
{{#ifeq:{{{Client}}}|LFS|
{{#vardefine:TitleRate|Rate per hour ($)}}{{#vardefine:TitleCost|Cost ($ Exc. GST)}}{{#vardefine:Currency|$}}
{{#vardefine:CostREQ|226.60}}
{{#vardefine:CostEST|226.60}}
{{#vardefine:CostFS|226.60}}
{{#vardefine:CostTS|226.60}}
{{#vardefine:CostDEV|226.60}}
{{#vardefine:CostST|226.60}}
{{#vardefine:CostIMP|226.60}}
{{#vardefine:CostPM|226.60}}
|

{{#vardefine:Message|Unknown costs for client/year ({{{Client|No client}}}/{{{Year|No year}}})}}
{{#vardefine:CostREQ|0.00}}
{{#vardefine:CostEST|0.00}}
{{#vardefine:CostFS|0.00}}
{{#vardefine:CostTS|0.00}}
{{#vardefine:CostDEV|0.00}}
{{#vardefine:CostST|0.00}}
{{#vardefine:CostIMP|0.00}}
{{#vardefine:CostPM|0.00}}
}}
}}{{#ifeq:{{{#var:COSTEST}}}||

{{#vardefine:Message|Unknown costs for client/year ({{{Client|No client}}}/{{{Year|No year}}})}}
}}{{#ifeq:{{{FOC|N}}}|Y|
{{#vardefine:Message| }}
{{#vardefine:CostREQ|0}}
{{#vardefine:CostEST|0}}
{{#vardefine:CostFS|0}}
{{#vardefine:CostTS|0}}
{{#vardefine:CostDEV|0}}
{{#vardefine:CostST|0}}
{{#vardefine:CostIMP|0}}
{{#vardefine:CostPM|0}}
}}{{#if: {{#var:Message}} |{{warning|{{#var:Message}}}} | }}
<table class="wikitable" border="1px" width="100%">
<tr><td bgcolor="silver" colspan={{#ifeq:{{{FSEST}}}|Y|5|4}}>'''Cost Details'''</td></tr>
<tr>
<td bgcolor="silver">'''Activity'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">'''Estimate<br />No. of Days'''</td>|}}
<td bgcolor="silver" align="center">'''Hours'''</td>
<td bgcolor="silver" align="center">'''{{#var:TitleRate}}'''</td>
<td bgcolor="silver" align="center">'''{{#var:TitleCost}}'''</td>
</tr>
<tr>
<td bgcolor="silver">Requirements</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EREQ|{{{REQ}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{REQ|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostREQ}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{REQ|0}}}*{{#var:CostREQ}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Change Request Evaluation</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EEST|{{{EST}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{EST|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostEST}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{EST|0}}}*{{#var:CostEST}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Functional Specification</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EFS|{{{FS}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{FS|0}}} |2}}</td>
<td bgcolor="silver" align="center">{{#var:CostFS}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{FS|0}}}*{{#var:CostFS}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Technical Specification</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{ETS|{{{TS}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{TS|0}}}|2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostTS}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{TS|0}}}*{{#var:CostTS}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Development</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EDEV|{{{DEV}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{DEV|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostDEV}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{DEV|0}}}*{{#var:CostDEV}} }} |2 }}</td>
</tr>
<tr>
<td bgcolor="silver">Testing and Release</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{ESTT|{{{ST}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{ST|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostST}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{ST|0}}}*{{#var:CostST}} }} |2}}</td>
</tr>
<tr>
<td bgcolor="silver">Implementation</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EIMP|{{{IMP}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{IMP|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostIMP}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{IMP|0}}}*{{#var:CostIMP}} }}|2 }}</td>
</tr>
{{#ifeq:{{{PM|X}}}|X||<tr>
<td bgcolor="silver">Project Management</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{{EPM|{{{PM|0}}}}}} |2 }}</td>|}}
<td align="center">{{#number_format: {{{PM|0}}} |2 }}</td>
<td bgcolor="silver" align="center">{{#var:CostPM}}</td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: {{{PM|0}}}*{{#var:CostPM}} }}|2 }}</td>
</tr>}}
<tr><td align="right" colspan={{#ifeq:{{{FSEST}}}|Y|5|4}}>{{#ifeq:{{{DiscountPerc|0}}}|0| |<font color="red"><strong>{{{DiscountText}}} {{{DiscountPerc}}}%</strong></font>}}</td></tr>
<tr>
{{#ifeq:{{{FIXEDCOST|N}}}|N|
<td bgcolor="silver">'''TOTAL'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{#expr: {{{EREQ|{{{REQ}}}}}}+{{{EEST|{{{EST}}}}}}+{{{EFS|{{{FS}}}}}}+{{{ETS|{{{TS}}}}}}+{{{EDEV|{{{DEV}}}}}}+{{{ESTT|{{{ST}}}}}}+{{{EIMP|{{{IMP}}}}}}+{{{EPM|{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}}}} }} |2 }}</td>|}}
<td align="center">{{#number_format: {{#expr: {{{REQ|0}}}+{{{EST|0}}}+{{{FS|0}}}+{{{TS|0}}}+{{{DEV|0}}}+{{{ST|0}}}+{{{IMP|0}}}+{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}} }} |2 }}</td>
<td bgcolor="silver"> </td>
<td align="right">{{#var:Currency}}{{#number_format: {{#expr: (({{{REQ|0}}}* {{#var:CostREQ}})+({{{EST|0}}}* {{#var:CostEST}})+({{{FS|0}}}* {{#var:CostFS}})+({{{TS|0}}}* {{#var:CostTS}})+({{{DEV|0}}}* {{#var:CostDEV}})+({{{ST|0}}}* {{#var:CostST}})+({{{IMP|0}}}* {{#var:CostIMP}})+({{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}* {{#var:CostPM}})) * ((100 - {{{DiscountPerc|0}}}) / 100) }} |2 }}</td>
|<td bgcolor="silver">'''TOTAL (FIXED COST)'''</td>
{{#ifeq:{{{FSEST}}}|Y|<td bgcolor="silver" align="center">{{#number_format: {{#expr: {{{EREQ|{{{REQ}}}}}}+{{{EEST|{{{EST}}}}}}+{{{EFS|{{{FS}}}}}}+{{{ETS|{{{TS}}}}}}+{{{EDEV|{{{DEV}}}}}}+{{{ESTT|{{{ST}}}}}}+{{{EIMP|{{{IMP}}}}}}+{{{EPM|{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}}}}} }} |2 }}</td>|}}
<td align="center">{{#number_format: {{#expr: {{{REQ|0}}}+{{{EST|0}}}+{{{FS|0}}}+{{{TS|0}}}+{{{DEV|0}}}+{{{ST|0}}}+{{{IMP|0}}}+{{#ifeq:{{{PM|X}}}|X|0|{{{PM|0}}}}} }} |2 }}</td>
<td bgcolor="silver"> </td>
<td align="right">{{#var:Currency}}{{#number_format:{{{FIXEDCOST}}} |2}}</td>
}}
</tr>
</table>
{{#ifeq:{{{NOFOOTER|N}}}|N|<table width="100%"><tr><td align="center">'''Estimate excludes training, release to live and go live support.'''</td></tr></table>}}
<noinclude>
[[Category:Templates|{{PAGENAME}}]]
</noinclude>