# Kiwiplan - Bag of Tricks for ESP and MAP/MES

## Agents

# Agents

## ESP Agent Retry Errors Setup

Agent can be set up to retry errors so that the system reprocesses failed requests.

### InfClient/Section/Agent General

**Name Scope Value**

Restart Error Text whole Automation error

Maximum Automatic Retry Count For Failed Requests whole 3

### InfClient/Section/Agent Errors To Retry

**Name Scope Value**

Agent exited without completing request whole Agent exited

Cannot find matching dockets whole Cannot find matching dockets

changed by another user whole changed by another user

Clipboard whole Clipboard

Deadlock whole deadlock

Execution canceled whole Execution canceled

Operation Cancelled whole Operation canceled

PalletMovement whole PalletMovement

Updated by another user whole Updated by another user

## Application Shortcut Line Options

The **1** equals true and the 0 equals false. You can also use **True** or **False** those will also turn these options on or off.

All of these options have the semicolon to separate the option with the True or False

Ex: <u>PrintToFile</u>**<u>:</u>**<u>1</u> or <u>PrintToFile</u>**<u>:</u>**<u>True</u>

## KiwiXplor &amp; Agent Options

### DBServer:

This is the hostname of the SQL server.

### DBName:

This is the DataBase name to use on the SQL server.

### DBPassword:

This is to specify a SQL DataBase password to log into SQL server.

### DBLogin:

This is to specify a NT/Network SQL DataBase Login to log into SQL server.

### NTLogin:

Replaces the Domain user name to the one specified.

### Plant:

Is the plant code (from MAP) in GEN/PL

### SQLLog:

This enables logging of calls to the SQL DataBase

### Width:

Is the width of the ESP window that opens by default

### Height:

Is the length of the ESP window that opens by default

### Object Log:

Logs object usage in ESP, an interval defined in seconds

### HostDebugLevel:

Is the Tcp connection between ESP and the Unix system (aka KIDS) debugging level 0 - 5 (5 = most detailed)

## KiwiXplor Options Only

### HostName:

This is to change the Linux server

### HostDataSet:

This is to access the MAP DataSet that is specified in the KIDSENV file. For more info on this parameter look at the “First Time Installation Guide”.

### HostUser:

This is to specify the Unix server login name to log into the MAP DataSet.

### HostPassword:

This is to specify the Unix server login password to log into the MAP DataSet.

### DBTimeOut:

Is a setting for the amount of time in seconds before the database should give up waiting for a reply from the SQL DataBase.

## Agent Options Only (depreciated after 7.80)

### AgentNumber:

This is used when more than one Agent has been setup in ESP to handle different types of requests

### PrintToFile:

This is used if printing documents to a file instead of physically printing (good for testing).

### ShowWord:

This is used if Word is to display the populating of templates as Word documents are printing

## Freeze a ESP dataset in time

Freezes your dataset in time. To use this you will have to create a file in the ESPServ folder and call it “**profile.ini**” and then add the following within the file

```ini
[SheetPlant]
StartDateTime=10/30/2014 16:25:25
TimeZone=Eastern Standard Time
LocaleID=1033

[CHH]
StartDateTime=02/10/03 14:45:00
TimeZone=New Zealand Standard Time
LocaleID=5129
```

Using this option on the properties command line you have to use it like this

```
profilesection:CHH
```

Reference [https://kall.kiwiplan.co.nz/kall/kiwiplan/issueViewer.do?action=viewIssue&amp;searchId=7&amp;issueId=72725](https://kall.kiwiplan.co.nz/kall/kiwiplan/issueViewer.do?action=viewIssue&searchId=7&issueId=72725)

## Example of KiwiXplor Options

### KiwiXplor Target Line

 Example of a target:

```
“K:\Kiwiplan\Kiwiplan\KiwiXplor.exe” HOSTUSER:john HOSTPASSWORD:doe HOSTNAME:192.168.242.129 HOSTDATASET:Cinncinati DBSERVER:172.16.6.16 DBNAME:espbox
```

 Note: Make sure that there is a space between each of the options e.g.: HOSTUSER:john(space)

## Example of Agent Options

### Agent Target Line

 Example of a target:

```
K:\Kiwiplan\Kiwiplan\EspAgent.exe AgentNumber:3
```

## Tricks &amp; Shortcuts

### Main Keys

<u>F4</u> is a shortcut key used to display a combo field box (drop down box).

Simply click into the field and hit **F4**.

<u>F5</u> is a shortcut key used to bring up another window from within the current one you are in.

Simply click into the field (even if it is grayed out) and hit **F5**

E.g.: If you are in the Product Design window you can click on the company field, press F5, and another window will open, displaying the company.

<u>F8</u> is a shortcut key used to bring up special instructions in any Comment or Special Instruction field. These special instructions are stored in the Macro section of the relevant application.

Simply click into the field and hit **F8**

## Alternative Manual Invoice/Credit Parameter

Several of the external Word docs in ESP are designed to allow for multiple templates of the same document. For example, it’s possible to have many different invoices. The standard invoice template is used unless a different template file is specified on the Documentation tab on the Company form for a particular company. This is the same for order confirmations, price lists, dockets etc.

The manual invoice and credit are not set up this way. You cannot attach a different manual invoice template or manual credit template to a customer. However, there are two parameters that allow for the use of alternative template files for manual invoices and credits:

```
EspClient/Invoicing/ Alternative Manual Invoice Template Formula
EspClient/Invoicing/ Alternative Manual Credit Template Formula 
```

These parameters specify the template to be used for the manual invoice and manual credit using a business rule in the Value field.

### **Example:**

If the parameter has the value:

```vb.net
iif([company.region]="Export", "ExportInvoice", iif([productcode]="Tool", "ServiceInvoice", "ManualInvoice"))
```

Then:

- If the region for the company is set to *Export*, then the *ExportInvoice* template is used.
- If the region is not set to *Export* and the Product code is *Tool* then the *ServiceInvoice* template is used.
- In all other cases, the *ManualInvoice* template is used.