AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This...

137
Page 1 of 137 AIMS Administrator Manual Software AIMS v4.0 30 th January 2015

Transcript of AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This...

Page 1: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 1 of 137

AIMS

Administrator

Manual Software AIMS v4.0

30th January 2015

Page 2: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 2 of 137

Introduction ........................................................................................................ 5

Key Site Information............................................................................................. 6

What is AIMS? ..................................................................................................... 8 Statistics Mode .................................................................................................. 8 Audit Mode ....................................................................................................... 8 Verification Mode ............................................................................................... 8 Lookup Mode .................................................................................................... 8

Software and Hardware Configurations ................................................................. 10 AIMS DataStation ............................................................................................ 10

32-Bit versus 64-Bit ...................................................................................... 10 System Configuration .................................................................................... 10 Installed by AIMS ......................................................................................... 10

IMOS PC ......................................................................................................... 11 Minimum Requirements ................................................................................. 11 Installed by AIMS ......................................................................................... 11

Management PC .............................................................................................. 11 Minimum Requirements ................................................................................. 11 Installed by AIMS ......................................................................................... 11

Anti-Virus and Malware Protection Software ........................................................ 11 Network Configurations .................................................................................... 12

Dedicated LAN .............................................................................................. 13 Static VLAN (Static Virtual LAN)...................................................................... 14 Firewall ....................................................................................................... 15

Installer and Setup ............................................................................................. 21 User Access Control (UAC) Prerequisites ............................................................. 21

Windows 7 ................................................................................................... 21 Windows Server 2003 R2 ............................................................................... 21 Windows Server 2008 R2 ............................................................................... 21

Logon As A Service And Read / Write / Delete Prerequisites .................................. 21 Windows 7 ................................................................................................... 21 Windows Server 2003 R2 ............................................................................... 21 Windows Server 2008 R2 ............................................................................... 22

Firewall (Software) .......................................................................................... 22 Power Options ................................................................................................. 22 Installing IIS Prerequisite ................................................................................. 22

Windows 7 ................................................................................................... 22 Windows Server 2003 R2 ............................................................................... 25 Windows Server 2008 R2 ............................................................................... 29

AIMS Installer / Update Installer ....................................................................... 36 Command-Line Parameters ............................................................................ 43 Permissions ................................................................................................. 45 Log On As A Service ...................................................................................... 48

Modifying Installation ....................................................................................... 48 Change Authentication Type ........................................................................... 50 Change AIMS Service Account ........................................................................ 50

Setting Up AIMS on IMOS .................................................................................... 51 Network Connection ......................................................................................... 51 Machine Name and Machine Id Setup ................................................................. 53 Job Setup ....................................................................................................... 54

Job Number Control Mode .............................................................................. 55 AIMS Mode .................................................................................................. 55

Label Setup .................................................................................................... 56 Security Check ............................................................................................. 57 Data log enabled .......................................................................................... 57

Page 3: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 3 of 137

Job Number Characters ................................................................................. 57 Label Machine Control (Custom Codes) ............................................................ 57

Running AIMS for First Time ................................................................................ 58 Accessing AIMS ............................................................................................... 58 Simulator (IMOS AIMS Simulator) ..................................................................... 59

Output Management Software Compatibility .......................................................... 61 Closed Loop Description ................................................................................... 61

Print Machine 4 Specific Status Changes .......................................................... 62 Standard OMS Compatibility ............................................................................. 62

Load and Edit Standard Job Configuration ........................................................ 63 Job Allocation File (JAF) ................................................................................. 63 Document Barcode (or 2D Data Matrix) ........................................................... 65 Job Reprint File (JRF) .................................................................................... 66 Job Complete File (JCF) ................................................................................. 67

Non Standard OMS Compatibility ....................................................................... 68 Error (.err) ..................................................................................................... 69

Audit Mode ........................................................................................................ 70 Audit Job Complete File (JCF) ......................................................................... 70 Audit Job Reprint File (JRF) ............................................................................ 71

Job Configuration Wizard ..................................................................................... 73 Job Allocation File (JAF) .................................................................................... 73

Provision of Job Allocation File ........................................................................ 73 Format of Job Allocation File .......................................................................... 73

Job Progress File (JPF) ..................................................................................... 74 Provision of Job Progress File ......................................................................... 74 Format of Job Progress File ............................................................................ 74

Job Complete File (JCF) .................................................................................... 75 Provision of Job Complete File ........................................................................ 75 Format of Job Complete File ........................................................................... 75

Job Reprint File (JRF) ....................................................................................... 75 Provision of Job Reprint File ........................................................................... 75 Format of Job Reprint File .............................................................................. 76

Job Good File (JGF) .......................................................................................... 76 Provision of Job Good File .............................................................................. 76 Format of Job Good File ................................................................................. 76

Job Missed File (JMF) ....................................................................................... 77 Provision of Job Missed File ............................................................................ 77 Format of Job Missed File ............................................................................... 77

General Settings.............................................................................................. 77 Configuration Name ...................................................................................... 77 Type of Import ............................................................................................. 78 Successful Import Directory ........................................................................... 78 Error Import Directory ................................................................................... 78 Check IMOS Job Name .................................................................................. 78 Close Job ..................................................................................................... 78 Reprint Job .................................................................................................. 78 Document Mark ............................................................................................ 79 Cost Centre Accounting ................................................................................. 79 Reprocessing Oversized ................................................................................. 79 Dispositions ................................................................................................. 79 Trigger Files ................................................................................................. 79

Scripting ........................................................................................................... 80 AIMS Namespace ............................................................................................ 80

Properties .................................................................................................... 80 Methods ...................................................................................................... 82

Page 4: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 4 of 137

Machine Data ..................................................................................................... 85

Administration Tab ............................................................................................. 91 User Accounts ................................................................................................. 91

AIMS Authentication...................................................................................... 91 Windows / Active Directory User Authentication ................................................ 91 Windows / Active Directory Group Authentication ............................................. 92 Changing Between Authentication Methods ...................................................... 92

Machines ........................................................................................................ 93 Change Password ............................................................................................ 94 Alerts ............................................................................................................. 95 Command Queue ............................................................................................. 96 Configurations ................................................................................................. 97 Backup & Restore ............................................................................................ 98

Backup Schedules ......................................................................................... 98 Restore Backup ............................................................................................ 99

Logs ............................................................................................................. 100 System Settings ............................................................................................. 101

Settings ...................................................................................................... 101 Licensing .................................................................................................... 101

Disaster Recovery Failover Plan ........................................................................... 102 Control Marks on Document ............................................................................. 103 Disaster Recovery AIMS DataStation ................................................................. 104

Detailed Instructions .................................................................................... 104 Job Configuration Change ................................................................................ 108

Detailed Instructions .................................................................................... 109

Diagnosing Issues ............................................................................................. 115 Possible Errors ............................................................................................... 115

Image (or PDF) fail to display on webpage ...................................................... 115 “ASP.NET Ajax client-side framework failed to load.” ........................................ 115 Cannot login to AIMS with any user account .................................................... 115 Username is blank when changed to Windows Authentication ............................ 115 Installation fails during installation of SQL Server Express 2005 SP4 .................. 115 Error installing SQL Server Express 2005 SP4 relating to InprocServer ............... 130 Problem Importing or Exporting Files ............................................................. 131 IMOS appears to be setup correctly but AIMS will not respond to connections ..... 132 The NetworkTestTool (Simulator) does not connect to AIMS DataStation ............ 132 Object reference not set to an instance of an object ......................................... 132 NeopostIO Service Starts and then immediately stops ...................................... 132 Machine Not Connecting to AIMS ................................................................... 133

Database Maintenance .................................................................................... 133 Logs ............................................................................................................. 133

Useful Information ............................................................................................ 135 Creating a Shared Directory (Workgroup to Domain) .......................................... 135 Database Utility .............................................................................................. 135

Removing / Merging Machines or Users from AIMS........................................... 136 Delete Unused Jobs ...................................................................................... 137

Page 5: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 5 of 137

Introduction This document is the Administration Manual for Automated Insertion Management

System (AIMS). It is intended that this document be read by anyone who installs or

maintains AIMS.

Page 6: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 6 of 137

Key Site Information Contacts List:

Neopost Project Leader: Tel:

Email:

Customer Project Leader: Tel:

Email:

Customer Technical Contact: Tel:

Email:

AIMS DataStation:

Install Windows / Domain Account:

Password:

Running Windows / Domain Account:

Password:

Logon As A Service? Yes / No

IP Address:

Port: 2002

AIMS DataStation Name:

Operating System:

Anti-Virus? Yes / No

Firewall? Yes / No

AIMS Client Pages:

Login Authentication? AIMS / Windows User / Windows Groups

Multi-Language? Yes / No

Default Language:

Job Allocation Files Directory:

Directory:

Directory Permissions Set? Yes / No

Job Progress Files Directory:

Directory:

Directory Permissions Set? Yes / No

Job Complete Files Directory:

Directory:

Page 7: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 7 of 137

Directory Permissions Set? Yes / No

Job Reprint Files Directory:

Directory:

Directory Permissions Set? Yes / No

Job Good Envelopes Files Directory:

Directory:

Directory Permissions Set? Yes / No

Job Missed Mailpieces Files Directory:

Directory:

Directory Permissions Set? Yes / No

Successful Import Directory:

Directory:

Directory Permissions Set? Yes / No

Error Import Directory:

Directory:

Directory Permissions Set? Yes / No

IMOS Job:

Job Name:

Job Number Control Mode:

AIMS Mode:

Machine Control? Label / AIMS

Page 8: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 8 of 137

What is AIMS? AIMS stands for Automated Insertion Management System. AIMS extends the

functionality of the IMOS operating system, enabling the management of insertion and

analysis of job runs.

AIMS consists of components within the IMOS operating system, a collection of

databases, a browser-based client front-end, and interfaces to external systems.

There are four AIMS modes of operation within the IMOS operating system. These are

Statistics, Audit, Verification, and Lookup.

Statistics Mode Statistics mode is primarily used to gain an overview of the effectiveness of the IMOS

operated folder inserter. Statistics mode generates a mailpiece id without reference to

any Barcode / 2D Data Matrix on the paper being processed. This enables Statistics

mode to be used where there is no Barcode / 2D Data Matrix, where OMR is used, or

where a Barcode / 2D Data Matrix does not contain a unique mailpiece id. When

operating in Statistics mode, any machine control information would need to either be

held in a Barcode / 2D Data Matrix / OMR, or be defined in the IMOS operating system.

The user of the AIMS browser-based client front-end can analyse jobs to discover their

effectiveness and go to mailpiece level to determine individual issues that have

occurred, however these individual issues cannot be related back to an individual

physical mailpiece as the mailpiece id was not read from this mailpiece’s physical paper.

Statistics mode does not expect any links to external systems. In Statistics mode the

job id can be read from the mailpiece, auto generated, or entered on the IMOS

operating system. Statistics mode is available with AIMS-100, AIMS-500, and AIMS-

1000.

Audit Mode Audit mode provides all of the analysis available in Statistics mode but with the added

advantage of reading the mailpiece id from the Barcode / 2D Data Matrix held on the

mailpiece. Audit mode will also prevent more than one mailpiece with the same

mailpiece id from being processed except where it is a reprint. When operating in Audit

mode, machine control information could either be held in a Barcode / 2D Data Matrix,

or be defined in the IMOS operating system. Audit mode can be seen as being

advanced data logging. Audit mode will not work with OMR. Audit mode does not

expect any links to external systems. In Statistics mode the job id can be read from the

mailpiece, auto generated, or entered on the IMOS operating system. Audit mode is

available with AIMS-100, AIMS-500, and AIMS-1000.

Verification Mode Verification mode operates in a similar way to Audit mode however each mailpiece id is

also checked against a preloaded database of mailpieces. Only mailpiece id’s that match

are allowed to continue. This database of mailpieces will have been imported into AIMS

from a text file supplied by an external system. During the job run it is possible to

create progress files and at the end of a job run a reprint file or a complete file can be

produced. Unlike Statistics mode and Audit mode, it is not possible to use an auto

generated job id when using Verification mode, as the job id reported from IMOS must

match the job id found in the imported database of mailpieces. Verification mode is

available with AIMS-500, and AIMS-1000.

Lookup Mode Lookup mode operates in a similar way to Verification mode except that machine control

commands come from AIMS having originally been interpreted from the imported

database of mailpieces. Unlike Statistics mode and Audit mode, it is not possible to use

an auto generated job id when using Lookup mode, as the job id reported from IMOS

Page 9: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 9 of 137

must match the job id found in the imported database of mailpieces. Lookup mode is

available with AIMS-500, and AIMS-1000.

Page 10: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 10 of 137

Software and Hardware Configurations Neopost’s Automated Insertion Management System (AIMS) operates across the IMOS

PC and AIMS DataStation. The minimum configuration would consist of a AIMS

DataStation and an IMOS PC running the folder inserter. A separate client can also be

used to view management statistics and other AIMS functionality (Management PC).

AIMS DataStation The AIMS solution requires a dedicated system configuration that meets its minimum

specification. This system configuration is supplied by Neopost and has been carefully

selected to ensure the speed requirements of AIMS.

32-Bit versus 64-Bit

AIMS has been designed to work on both 32-bit and 64-bit operating systems in the

system configuration supplied by Neopost. All new AIMS systems are supplied with a

64-bit operating system. When installed on a 64-bit operating system some

components operate with Microsoft’s WOW (Windows on Windows).

System Configuration

Processor: Intel Xeon X5660 Processor (2.80GHz, 6C, 12M Cache, 6.40

GT/s QPI, 95W TDP, Turbo, HT), DDR3-1333MHz

Or

Intel Xeon E5-2430 v2 Processor (2.50GHz, 15M Cache, 7.2GT/s

QPI, Turbo, 6C, 80W), DDR3-1600MHz

Or

Intel® Core™ i5 3.2Ghz Quad Core

Operating System: New BaseStation Installs

Microsoft Windows 7 Professional (64-bit English)

New BaseStation Extra Installs

Microsoft Windows Server 2008 R2 (64-bit English)

Or

Microsoft Windows 7 Ultimate (64-bit English)

Current Installs Only

Microsoft Windows Server 2003 R2 (32-bit English)

Microsoft Windows Server 2008 (32-bit English)

Intranet Server: Microsoft IIS 6 (Microsoft Windows Server 2003 R2)

Microsoft IIS 7 (Microsoft Windows Server 2008)

Microsoft IIS 7.5 (Microsoft Windows 7 Professional or Microsoft

Windows Server 2008 R2)

RAM: 4Gb

Local Storage: 420Gb Available

Network Connection: See AIMS Network Requirements

Network Card(s): Intel® Pro/1000 GT Desktop Adapter PCI or equivalent (2 Ports

Required)

Fixed IP Address

Access: Local Admin Rights

Shared Use: No – Must be Computer Dedicated to AIMS

Anti-Virus Software: No – See Anti-Virus and Malware Protection Software section of

this document

Installed by AIMS

Framework: Microsoft .Net 4.0 (and below)

Packages: Microsoft Visual C++ Runtime 9.0

Microsoft XML Parser 6.0

Microsoft Internet Explorer 8

Microsoft MDAC Refresh 2.8

Page 11: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 11 of 137

Microsoft Windows Installer 3.1

Database: Microsoft SQL Server 2012 Express SP1 and Management

Console. (If upgrade may stay on Microsoft SQL Server Express

2005 SP4)

Front End: ASPX Pages and DLLs, Style Sheets, JavaScript, and Config files

Windows Service: Audit Service (NeopostAudit)

Enterprise Server (NeopostEnterprise)

Neopost Monitoring Service (NeopostIO)

USB Software: SafeNet Sentinel

IMOS PC The AIMS solution can require the addition of a specific network card into the IMOS PC.

This is to enable the high-speed data transfers required by AIMS. New IMOS PCs are

delivered with a compatible on-board network card.

Minimum Requirements

PC: Standard Neopost Supplied PC

Network Card: Intel® Pro/1000 GT Desktop Adapter PCI or equivalent on-board

network adapter

Anti-Virus Software: No – See Anti-Virus and Malware Protection Software section of

this document

Installed by AIMS

AIMS components are included within standard IMOS installation.

Management PC The AIMS front end is browser based. There is no specific hardware or operating system

requirement and any standard network card can be used.

Minimum Requirements

PC: Any

Network Card: Any 10/100/1000 TCP/IP

Browser: Chrome/Firefox/Safari/IE8 (or above)

JavaScript: Enabled

Anti-Virus Software: OK

Installed by AIMS

Nothing

Anti-Virus and Malware Protection Software Neopost’s Automated Insertion Management System (AIMS) requires fast, near real-

time, communication between the folder inserter and the AIMS DataStation. It has been

found that Anti-Virus and Malware Protection software, on either the IMOS PC or the

AIMS DataStation, can slow the response times needed to maintain a real-time system.

This is particularly the case when this software is monitoring network traffic or file

operations that relate to AIMS.

Where security is a concern it is recommended that a firewall is setup between the AIMS

DataStation and the customer’s corporate network. This firewall should be setup to only

allow HTTP traffic on network port 80 (for use of AIMS browser front-end), and the files

required for integrating with a parent ADF system (in the case of AIMS-500 or AIMS-

1000).

Page 12: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 12 of 137

If it is an absolute requirement that anti-virus or malware protection software is

installed on the AIMS DataStation then it should be setup to ignore network traffic on

the network adaptor used for the AIMS dedicated network. It should also ignore any file

operations carried out in the AIMS installation directory and data storage directory (if

different to the installation directory).

Should there be any subsequent problems with the AIMS installation, the customer will

be asked to switch off anti-virus and malware protection software completely to see

whether problem persists.

Network Configurations Neopost’s Automated Insertion Management System (AIMS) can be configured for use in

a Static VLAN or Dedicated LAN environment. Wherever possible it is preferable to

configure a Dedicated LAN environment.

In both configurations, the connection between Neopost network and the Corporate

network is via the AIMS DataStation. This AIMS DataStation and the Neopost Folder

Inserter (Driven By IMOS) must use TCP/IP, have fixed IP Addresses on the same

Subnet, they must not connect through any more than one network device, and they

must use the Intel® Pro/1000 GT Desktop Adapter PCI network card (or equivalent)

running at least 100Mb/sec.

A description of the two possible network configurations follows on the next page.

Page 13: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 13 of 137

Dedicated LAN

A Dedicated LAN containing the Neopost’s Automated Insertion Management System

(AIMS), a Dedicated Switch, and the Neopost Folder Inserter (Driven By IMOS) is the

preferred network configuration. In this configuration no unrelated data communication

is able to impact the speed of the solution. ADF control files can still be retrieved from

or saved to the Client Network and management of AIMS can still be carried out from

the Client Network through the second network card in the AIMS DataStation.

The Dedicated LAN configuration is the Neopost preferred solution and should be used

wherever possible.

An example of a Dedicated LAN configuration is shown below.

LAN One

LAN Two

Corporate Network Switch

ADF Controller (Parent ADF System)

Neopost’s Automated Insertion Management System (AIMS)

DataStation has two network cards. An Intel® Pro/1000 GT

Desktop Adapter PCI network card on LAN One to communicate with the Neopost Folder Inserter (Powered By IMOS), and a second network card on LAN Two to communicate with the ADF Controller.

Client Browser AIMS DataStation

Dedicated Switch

Neopost Folder Inserter (Powered By IMOS)

Figure 1: Dedicated LAN Configuration

Page 14: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 14 of 137

Static VLAN (Static Virtual LAN)

Setting up a Static VLAN can enable an organisation to divide their physical network into

multiple virtual networks. Each of these virtual networks can operate separately even

though they are using the same physical hardware.

There are two types of VLAN. These are known as Static VLAN and Dynamic VLAN. The

main difference between the two is that Static VLAN (also known as Port-Based VLAN)

requires the physical ports in the network switch to be configured to the VLAN that shall

be used from that port, whereas the Dynamic LAN (also known as Software-Based

VLAN) sends the VLAN identifier with each network communication that is made from a

network device such as a computer.

Both of these types of VLAN have their own advantages and disadvantages. With

concern to AIMS, the Dynamic VLAN can cause issues with the speed of the Neopost

Folder Inserter (Driven By IMOS). This speed issue is caused by the additional overhead

of the VLAN identifier in each data communication and the additional time it takes the

switch to decide which of its ports it is allowed to send the data communication to. It is

therefore important that, where a VLAN is required, the Static VLAN is used.

Where a VLAN is used, it is required that the Switch has a processor powerful enough

that it can handle data communications on the Neopost VLAN in real-time unaffected by

any data communications that are occurring on another VLAN using the same physical

Switch.

The Static VLAN configuration is acceptable subject to network testing. The Dynamic

VLAN configuration is not acceptable for use with Neopost’s Automated Insertion

Management System (AIMS).

An example of a Static VLAN configuration is shown below.

VLAN A

VLAN B

AIMS DataStation

Neopost Folder Inserter (Powered By IMOS)

Switch With Static

(Port-Based) VLAN Enabled

ADF Controller

(Parent ADF System)

Neopost’s Automated Insertion Management System (AIMS)

DataStation has two network cards. An Intel® Pro/1000 GT Desktop Adapter PCI network card on VLAN A to communicate

with the Neopost Folder Inserter (Powered By IMOS), and a

second network card on VLAN B to communicate with the ADF Controller.

Client Browser

Figure 2: VLAN Configuration

Page 15: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 15 of 137

Firewall

If a firewall is placed between the AIMS DataStation and the corporate LAN then certain

ports will need to be unblocked to allow AIMS required functionality. These should allow

for files to be transferred between the networks and for access to the AIMS client pages

to be available from the corporate network.

Port Reason

53 (TCP) DNS (Domain Name System)

80 (TCP) HTTP traffic for AIMS client.

88 (TCP) Kerberos (Windows Authentication)

135 (TCP) File Sharing

136 (TCP) File Sharing

137 (TCP) File Sharing

138 (TCP) File Sharing

139 (TCP) File Sharing

445 (TCP) Windows Shares

If there is a requirement to enable the Windows software firewall then the following

ports need to be unblocked.

Port Reason

2002 (TCP) Inbound Communication between IMOS and

AIMS

2003 (TCP) Inbound Communication within AIMS

80 (TCP) Inbound HTTP traffic for AIMS client.

88 (TCP) Inbound / Outbound Kerberos (Windows Authentication)

135 (TCP) Inbound / Outbound File Sharing

136 (TCP) Inbound / Outbound File Sharing

137 (TCP) Inbound / Outbound File Sharing

138 (TCP) Inbound / Outbound File Sharing

139 (TCP) Inbound / Outbound File Sharing

445 (TCP) Inbound / Outbound Windows Shares

The Windows software firewall can be found by going to “Start > Control Panel >

Windows Firewall”. You should then click on Advanced Settings.

Detailed screenshots are shown below.

Page 16: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 16 of 137

Click on Windows Firewall Properties.

For each Profile ensure the Firewall state is “On” and the inbound connections and

outbound connections are set to “Block”. Do not choose “Block all connections”. Click

Apply and then Ok to close the dialog.

Page 17: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 17 of 137

Click on “Inbound Rules” to display these rules. Then Right click on “Inbound Rules”

and choose “New Rule”. When the dialog is displayed choose “Port” and then click the

“Next” button.

Choose “TCP” and enter the specific local ports. Where the inbound communication is

from the IMOS PC these ports should be “2002, 2003”. Click the “Next” button.

Page 18: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 18 of 137

Select “Allow the connection” and click the “Next” button.

Place a tick against all profiles. Click the “Next” button to continue.

Page 19: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 19 of 137

Name the rule and then click the “Next” button to continue.

Select all inbound rules except the rule that you have just created. Right click and

select to disable the rules. The only rule that is now enabled is the rule that you have

just created.

Page 20: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 20 of 137

These instructions should be repeated for the ports required for file transfer with the

corporate network and the port required for access to the browser based AIMS front

end.

The rule for ports required for file transfer should be repeated on the Outbound Rules

list.

Page 21: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 21 of 137

Installer and Setup The AIMS DataStation comes preinstalled with the latest version of AIMS software. The

following instructions can be carried out where there is a requirement to update this

software or check the configuration of the AIMS DataStation. This section is primarily

supplied for information only.

Neopost’s Automated Insertion Management System (AIMS) can be installed using the

simple self-extracting installer. However for more complex installations command-line

parameters can be provided.

Before running the AIMS installer a small number of prerequisite steps need to be

carried out. These are User Access Control rights, Logon As A Service rights, disabling

firewall, changing Power Options, and installing IIS.

User Access Control (UAC) Prerequisites User Access Control is known to cause problems when installing software onto the

Windows 7 and Windows Server 2008 R2 operating systems. User Access Control

should be reduced down to “Never Notify”. Please remember after the installation to

return the User Access Control to its original level.

Windows 7

User Access Control can be found under “Control Panel” > “User Accounts” > “Change

User Access Control Settings”.

Windows Server 2003 R2

Not Applicable

Windows Server 2008 R2

User Access Control can be found under “Control Panel” > “User Accounts” > “User

Accounts” > “Change User Access Control Settings”.

Logon As A Service And Read / Write / Delete Prerequisites The AIMS Services need to run under a Windows or Domain Account. This Account

needs to have Logon As A Service rights, that can be set by the local administrator as

shown below, and Read / Write / Delete permissions to the directories used to share

files with other OMS systems. These Read / Write / Delete permissions will need to be

set by the local IT Department.

Windows 7

Local Security Policy can be found under “Control Panel” > “Administrative Tools” >

“Local Security Policy”. In the console tree, double-click “Local Policies”, and then click

“User Rights Assignment”. In the details pane, double-click “Log on as a service”.

Click “Add User or Group”, and then add the appropriate account to the list of accounts

that possess the Log on as a service right.

Windows Server 2003 R2

Local Security Policy can be found under “Control Panel” > “Administrative Tools” >

“Local Security Policy”. In the console tree, double-click “Local Policies”, and then click

“User Rights Assignment”. In the details pane, double-click “Log on as a service”.

Click “Add User or Group”, and then add the appropriate account to the list of accounts

that possess the Log on as a service right.

Page 22: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 22 of 137

Windows Server 2008 R2

Local Security Policy can be found under “Control Panel” > “Administrative Tools” >

“Local Security Policy”. In the console tree, double-click “Local Policies”, and then click

“User Rights Assignment”. In the details pane, double-click “Log on as a service”.

Click “Add User or Group”, and then add the appropriate account to the list of accounts

that possess the Log on as a service right.

Firewall (Software) The firewall on the dedicated network between the Folder Inserter and the AIMS

DataStation needs to be disabled.

Power Options Power Options within the operating system on the AIMS DataStation should be changed

to High Performance and sleep mode changed to never.

Installing IIS Prerequisite The installer does not install Microsoft IIS (Internet Information Services). This will

need to be installed prior to the AIMS installation following the instructions below.

There are different instructions depending on the operating system. Check the

operating system and follow the instructions in the appropriate section below:

Windows 7

Select “Control Panel” > “Programs and Features”.

Select “Turn Windows feature on or off”.

Expand “Internet Information Services”.

Page 23: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 23 of 137

Do not expand or tick any of the “FTP Server” options.

Expand “Web Management Tools” and tick option “IIS Management Console”.

Expand “World Wide Web Services” and expand and tick all options below it. This will

result in the “World Wide Web Services” option being ticked. It is not possible to just

tick the “World Wide Web Services” option.

Page 24: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 24 of 137

Click “OK” and wait while changes are enabled.

Page 25: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 25 of 137

Open IIS by selecting “Control Panel” > “Administrative Tools” > “Internet Information

Services (IIS) Manager”.

Expand the connections tree and select “Remove” to remove the default web site.

Close “Internet Information Services (IIS) Manager” and Restart computer.

Once the computer has restarted, run the AIMS installation.

Windows Server 2003 R2

You may need the Windows Server 2003 R2 installation and Windows 2003 Service Pack

2 discs.

Select “Control Panel” > “Add or Remove Programs”.

Page 26: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 26 of 137

Select “Add/Remove Windows Components”.

Select option “Application Server” and click the “Details” button.

Page 27: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 27 of 137

Ensure options “Application Server Console”, “ASP.NET”, “Enable network COM+

access”, “Enable network DTC access”, and “Internet Information Services (IIS)” are

ticked.

Select option “Internet Information Services (IIS)” and click the “Details” button.

Ensure options “Common Files”, “Internet Information Services Manager”, and “World

Wide Web Service” are ticked.

Select option “World Wide Web Service” and click the “Details” button.

Page 28: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 28 of 137

Ensure options “Active Server Pages” and “World Wide Web Service” are ticked.

Click the “OK” buttons until you are back on the “Windows Components” screen and

then click the “Next” button.

The components will be installed. You may be prompted for the Windows Server 2003

installation disks.

Click “OK” and wait while changes are enabled.

Open IIS by selecting “Control Panel” > “Administrative Tools” > “Internet Information

Services (IIS) Manager”

Page 29: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 29 of 137

Expand the “web sites” section of the connections tree and right click on the “Default”

web site. Select “Delete” to remove the default web site.

Close “Internet Information Services (IIS) Manager” and Restart computer.

Once the computer has restarted, run the AIMS installation.

Windows Server 2008 R2

Select “Control Panel” > “Programs and Features” > “Turn Windows feature on or off”.

If IIS is already installed click on “Roles > Web Server (IIS)” and right click on “Add

Role Services” to add the appropriate services as shown in the “Select Role Services”

screen shot below.

Page 30: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 30 of 137

Right click on “Roles” and select “Add Roles”.

The “Add Roles Wizard” will now be displayed.

Click the “Next” button

Page 31: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 31 of 137

Tick the “Web Server (IIS)” Role and then click the “Next” button.

Click the “Next” button.

Page 32: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 32 of 137

Tick all of the options under sections “Common HTTP Features”, “Application

Development”, “Health and Diagnostics”, “Security”, and “Performance”.

Whilst ticking these options the user may be prompted to also install prerequisite Roles

such as displayed above. Click the “Add Required Role Services” button.

Under the “Management Tools” section the option for “IIS Management Console” should

be ticked.

Click the “Next” button.

Page 33: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 33 of 137

The confirmation screen is now displayed. Click the “Install” button to start the

installation of the IIS Role.

The installation will now take place.

Page 34: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 34 of 137

Once installation is complete this will be highlighted with the above screen. Click the

“Close” button to finish.

Open IIS through the “Server Manager” by expanding “Roles” > “Web Server (IIS)” >

“Internet Information Services (IIS) Manager”.

Page 35: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 35 of 137

Expand the “Sites” folder on the connections tree and select “Remove” to remove the

default web site.

Close “Internet Information Services (IIS) Manager” and Restart computer.

Page 36: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 36 of 137

Once the computer has restarted, run the AIMS installation.

AIMS Installer / Update Installer The AIMS DataStation comes preinstalled with the latest version of AIMS software.

Where there is a requirement to update this software the following instructions can be

carried out.

Full installation setup discs are only released in cases where the AIMS DataStation has

become corrupted and a full reinstallation of an AIMS DataStation is required.

In the case of a downloaded Update Installer, the AIMS installation should be copied

onto the AIMS DataStation being installed upon.

Some of the following steps will not be contained within the Update installer as the

prerequisite software will already be installed on the AIMS DataStation.

Right click on “setup.exe” and select “Run As Administrator” (Windows 7 / Server 2008

R2) or “Run As” (Server 2003 R2). If there is a prompt regarding restricted access then

ensure the option to run in “Run this program with restricted access” is not selected.

The AIMS setup will show a progress bar while it extracts. After this process the main

installation will start. There may be a period when there is no noticeable setup process

occurring (e.g. no setup screen). This is normal and should only last up to 60 seconds

depending on the speed of your AIMS DataStation.

Page 37: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 37 of 137

The AIMS setup will check to ensure all prerequisites have been installed before

continuing. IIS must be installed prior to running the AIMS setup. Where there is

prerequisite that can be installed by the AIMS setup this is listed. A prerequisite may

require the AIMS DataStation to be restarted. Click the “Next” button to install the

prerequisites.

The screen above shows the Microsoft SQL Server Express 2012 (or 2005) prerequisite

being installed. Similar screens may be displayed for other prerequisites.

Page 38: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 38 of 137

Once the prerequisites have been installed, the main AIMS setup can begin. Click the

“Next” button to continue.

The user installing AIMS must tick the checkbox to confirm agreement to the license

agreement and then click the “Next” button to continue. If the user does not agree to

the license agreement then the setup cannot continue.

Page 39: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 39 of 137

The user installing AIMS must enter their name and organisation and then click the

“Next” button to continue.

The “Authentication Type” page of the installation wizard allows selection of the type of

authentication security to be applied to users logging into AIMS.

The “AIMS Users” option creates an account called “Administrator” and expects other

accounts to be creating within AIMS after the installation wizard has been run.

Page 40: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 40 of 137

The “Windows / Active Directory Users” option allows initial login and then expects

references to Windows / Active Directory accounts to be created within AIMS after the

installation wizard has been run. Passwords are managed by Windows / Active

Directory and accounts can be disabled by Windows / Active Directory.

The “Windows / Active Directory Groups” option allows initial login to ensure Groups

have been setup correctly. Individual login accounts are controlled by Windows / Active

Directory Groups and so each user that requires access to AIMS must be in one or more

of these Windows / Active Directory Groups. The names of these Windows / Active

Directory Groups can be specified on the next page of the installation wizard (if

“Windows / Active Directory Groups” option is chosen) and can be amended on the

“Administration > System Settings” page within AIMS under “Login Authentication”.

For the setup guide the “AIMS User” option shall be chosen. Click the “Next” button to

continue.

The installation wizard allows a different location to be used to install AIMS. Where

possible the default location should be used. The rest of this document assumes that

the default location has been chosen. AIMS should not be installed onto a network

drive. To change the location to install AIMS click the “Change” button. Once you are

happy with the installation directory click the “Next” button to continue.

Page 41: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 41 of 137

The installation wizard allows a different location to be used to install the databases and

transaction files. Where possible the default location should be used. The rest of this

document assumes that the default location has been chosen. The databases and

transaction files should not be installed onto a network drive. To change the location to

install AIMS click the “Change” button. Once you are happy with the installation

directory click the “Next” button to continue.

The AIMS Services require a Windows / Active Directory Account to run under the

authority of. The default Windows Account used is “NT AUTHORITY\NetworkService”

however this Windows Account may not have access to the directory used to share ADF

Page 42: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 42 of 137

files if this directory is at another network location. Where this is a problem another

Windows / Active Directory Account and Password can be specified here. Where

possible the default Windows Account should be used. Click the “Next” button to

continue.

The AIMS installation has now been configured. Click the “Next” button to install AIMS.

AIMS is now installing. There may be a period when there is no noticeable setup

process occurring. This is normal.

Page 43: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 43 of 137

Once the installation has completed you will be prompted to restart the AIMS

DataStation. This step is very important, as there are aspects of AIMS that will not

work correctly until a restart has been performed. Ensure the “Restart now” tick box is

ticked and then click the Finish button. The AIMS DataStation will then shut down and

restart.

Once restarted AIMS can be accessed through a web browser at address:

http://localhost/login.aspx

If logging in from another computer the IP Address or Hostname should replace the

“localhost” section of the above address.

Command-Line Parameters

Command-line parameters enable the installer to install components of AIMS into

different locations and under different security restrictions to a standard installation.

The command-line parameters should not be used unless fully understood.

Parameter Possible Values Notes

AIMS_SQL_INSTANCE [SQL Instance (e.g.

AIMS)]

The name of the

SQL Server instance

to use or install.

AIMS_IIS_INSTANCE The name of the IIS

instance to use or

install.

AIMS_IIS_APPLICATION_POOL The name of the IIS

Application Pool to

use or install.

AIMS_SQL_SERVER_INSTALL_DIRECTORY [Directory path] If there is a space in

a specified path,

surround the path

with quotes. End

Page 44: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 44 of 137

every path with a

trailing backslash

(\).

AIMS_AUTHENTICATION AIMS

Windows

Windows Groups

The authentication

method to use for

users logging into

the AIMS web front

end.

AIMS_ALLOW_LOGIN Required if

Authentication is

“Windows Groups”.

AIMS_IS_ADMINISTRATOR Required if

Authentication is

“Windows Groups”.

AIMS_ALLOW_MARK_LATE_DIVERT Required if

Authentication is

“Windows Groups”.

AIMS_ALLOW_REPRINT_JOB Required if

Authentication is

“Windows Groups”.

AIMS_ALLOW_COMPLETE_JOB Required if

Authentication is

“Windows Groups”.

AIMS_ALLOW_DELETE_JOB Required if

Authentication is

“Windows Groups”.

AIMS_ALLOW_RESET_JOB Required if

Authentication is

“Windows Groups”.

AIMS_ALLOW_CREATE_REPORTS Required if

Authentication is

“Windows Groups”.

AIMS_ALLOW_CREATE_ALERTS Required if

Authentication is

“Windows Groups”.

AIMS_ALLOW_MARK_HAND_MAILED Required if

Authentication is

“Windows Groups”.

AIMS_ALLOW_MARK_REMOVED Required if

Authentication is

“Windows Groups”.

AIMS_SERVICE_ACCOUNT This is the Windows

Service account that

shall run the

Neopost Services.

Must have already

been granted “Log

On As A Service”

rights as found in

Local Security

Settings > Local

Policies > User

Rights Assignment.

Or domain

equivalent.

AIMS_SERVICE_PASSWORD The password for the

Windows service to

run the Neopost

Services.

AIMS_SQL_SERVER_ACCOUNT This is the Windows

Page 45: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 45 of 137

Service account that

shall run the

instance of SQL

Server. Must have

already been

granted “Log On As

A Service” rights as

found in Local

Security Settings >

Local Policies > User

Rights Assignment.

Or domain

equivalent.

AIMS_SQL_SERVER_PASSWORD The password for the

Windows service to

run the instance for

SQL Server.

AIMS_PORT The Port that AIMS

shall listen on for

communication with

the Neopost folder

inserter.

AIMS_INTERNAL_PORT The Port that AIMS

shall use for internal

communications

within the AIMS

DataStation.

AIMS_TARGET_DIRECTORY The directory in

which the main

AIMS application.

AIMS_SQL_DATABASE_DIRECTORY The directory in

which to install

databases.

AIMS_SQL_LOGS_DIRECTORY The directory in

which to install the

log files of

databases.

Permissions

Neopost’s Automated Insertion Management System (AIMS) runs on Windows

architecture. As part of this the execution of the Services, SQL Server commands, and

the Website are controlled with Windows authentication. This can either be through

local Windows Accounts or through Active Directory Accounts. As these accounts will be

used to run Windows Services, these accounts must have “Log On As A Service” rights

(see “Log On As A Service” section of this document).

If the AIMS Services will be importing or exporting files to directories not held on the

AIMS DataStation then the Account using to run the AIMS Services must have

permissions to do so. This will likely mean it should be a domain account. The default

account shown below assumes the import and export directories are on the same AIMS

DataStation as the AIMS Services.

Default Accounts

Account Account Default

<IIS Service Account> NT AUTHORITY\NETWORK SERVICE

<AIMS Service Account> NT AUTHORITY\NETWORK SERVICE

<SQL Server Service Account> NT AUTHORITY\NETWORK SERVICE

Page 46: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 46 of 137

SQL Server Express 2012 (or 2005)

The AIMS solution requires the use of SQL Server Express 2012 (or 2005). The

following Windows permissions are required. The installer should implement these

permissions.

Server Instance

Account Information

<SQL Server Service Account> This is the account used to run SQL Server Express

2012 (or 2005). Individual accounts logged into SQL

Server Express 2012 (or 2005) hand off to this

account to perform operations such as backups.

Server Logins

Account Server Roles Information

<IIS Service Account> Public This is the account used to run

IIS. Individual accounts logged

into IIS hand off to this account

to allow pooling of database

connection.

<AIMS Service Account> dbcreator

public

This is the account used to run

the Neopost Services

(NeopostAudit,

NeopostEnterprise, and

NeopostIO).

IVSMain

User Account Role Members

AimsServices <AIMS Service Account> db_datareader

db_datawriter

db_owner

AimsWeb <IIS Service Account> db_datareader

db_datawriter

JobTemplate

User Account Role Members

AimsServices <AIMS Service Account> db_backupoperator

db_datareader

db_datawriter

db_owner

AimsWeb <IIS Service Account> db_datareader

db_datawriter

Neopost_AIMS

User Account Role Members

AimsServices <AIMS Service Account> db_datareader

db_datawriter

db_owner

AimsWeb <IIS Service Account> db_datareader

db_datawriter

Windows Services

The AIMS solution requires the use of Windows Services. The following Windows

permissions are required. The installer should implement these permissions.

NeopostAudit

Account Information

<AIMS Service Account> This is the account used to run the Neopost Services

(NeopostAudit, NeopostEnterprise, and NeopostIO).

NeopostEnterprise

Account Information

Page 47: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 47 of 137

<AIMS Service Account> This is the account used to run the Neopost Services

(NeopostAudit, NeopostEnterprise, and NeopostIO).

NeopostIO

Account Information

<AIMS Service Account> This is the account used to run the Neopost Services

(NeopostAudit, NeopostEnterprise, and NeopostIO).

Directories

The AIMS solution requires the use of various directories on the AIMS DataStation. The

following Windows permissions are required. The installer should implement these

permissions. Subdirectories should be set-up to inherit permissions.

Installation Location

Account Information

<IIS Service Account> This is the account used to run IIS. Individual accounts

logged into IIS hand off to this account to allow pooling

of database connection.

<AIMS Service Account> This is the account used to run the Neopost Services

(NeopostAudit, NeopostEnterprise, and NeopostIO).

<SQL Server Service Account> This is the account used to run SQL Server Express

2012 (or 2005). Individual accounts logged into SQL

Server Express 2012 (or 2005) hand off to this account

to perform operations such as backups.

Import Locations

Account Information

<AIMS Service Account> Full Control (Read / Write / Add Directories / Delete) is

required.

This is the account used to run the Neopost Services

(NeopostAudit, NeopostEnterprise, and NeopostIO).

Export Locations

Account Information

<AIMS Service Account> Full Control (Read / Write / Add Directories / Delete) is

required.

This is the account used to run the Neopost Services

(NeopostAudit, NeopostEnterprise, and NeopostIO).

Scripting Location

Account Information

<AIMS Service Account> Full Control (Read / Write / Add Directories / Delete) is

required.

This is the account used to run the Neopost Services

(NeopostAudit, NeopostEnterprise, and NeopostIO).

The Microsoft .Net engine carries out scripting for AIMS. Temporoary files are saved

and then read in the Windows Temp directory (e.g. “C:\Windows\Temp”).

Audit Temporary Location

Account Information

<SQL Server Service Account> Full Control (Read / Write / Add Directories / Delete) is

required.

This is the account used to run SQL Server Express

2012 (or 2005). Individual accounts logged into SQL

Server Express 2012 (or 2005) hand off to this account

Page 48: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 48 of 137

to perform operations such as backups.

At the present time the NeopostAudit Service creates a backup and restores from a

location outside of the installation directory structure. This location is defined by the

account used to run the Service. An example location is a follows:

C:\Documents and Settings\<AIMS Service Account>\Local Settings\Temp

Permissions For Files

To ensure that files within the above folders have the required permissions for use with

AIMS, the files should either be created within these directories or copied into these

directories. Within Windows a movement of a file from another directory will not

automatically enable the file with the new directory permissions. Therefore a Cut and

Paste operation, or a Drag operation may not automatically leave the file with its new

parent’s access permissions.

Log On As A Service

Remember that Accounts that are used to run Neopost Services, IIS, and SQL Server

Express 2012 (or 2005) will require “Log On As A Service” rights. This applies to local

Windows Accounts and Active Directory Accounts. The default installed Accounts

already have this right, however if you choose an alternative Account this will need to

be set up.

The setting of the “Log On As A Service” must be performed on the local AIMS

DataStation running AIMS.

Information on how to do this can be found in the “Logon As A Service And Read / Write

/ Delete Prerequisites” section of this document.

Restart the AIMS DataStation before starting the AIMS setup.

Modifying Installation It is possible to modify the installation after completing the setup process. Both the

Authentication Type and the Windows / Active Directory Account used to run the

Windows Services can be changed after installation.

When these have to be changed, they should be changed through use of the Installer.

To modify the installation go to “Control Panel > Programs and Features” and select

“AIMS”. Click “Change” and then choose “Modify Available Options”. You will then be

presented with the option to modify or uninstall. Choose “Modify Available Options”.

You will then be taken through the key parts of the wizard.

If there is a requirement to change the installation directory then you will need to

uninstall AIMS first. Please note that an uninstall will not remove the databases and

these will need to be moved manually.

Page 49: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 49 of 137

Figure 3: Choose “Modify Available Options”

Figure 4: Select Appropriate Authentication Type

Page 50: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 50 of 137

Figure 5: Enter the Windows / Active Directory Credentials for AIMS Services

Change Authentication Type

The Authentication Type can be changed between AIMS Users, Windows / Active

Directory Users, and Windows / Active Directory Groups. The Windows / Active

Directory Account that the Neopost Services run under the authority of can also be

changed.

Change AIMS Service Account

The AIMS Service Account can be changed to any account that is local on the installed

computer or on the network where Active Directory credentials are used. It should be

remembered that this account must have “Logon As A Service” rights and should have

full read / write / delete / modify permissions on any directories used for file transfers

(e.g. JAF, JRF, JCF) or Backup and Restore.

Page 51: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 51 of 137

Setting Up AIMS on IMOS AIMS must be setup on the IMOS driven folder inserter in order for the data to be set to

and received from the AIMS DataStation.

Network Connection The following instructions should be followed to change the connection details on the

Neopost Folder Inserter.

Step 1: Within IMOS click on the “Menu” button.

Page 52: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 52 of 137

Step 2: Click on the “Engineering” button.

Step 3: Click on the “Network Devices” button.

Page 53: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 53 of 137

Step 4: Click on the “IP Address” button and enter the IP Address of the AIMS

DataStation. Click on the “Port Number” button and enter the Port Number of

the AIMS DataStation (most likely 2002). This needs to be done for both the

Input Channel and the Output Channel. Remember these are the VLAN /

Dedicated LAN IP Address and Port Numbers.

Step 5: Click the “OK” button, click the “Run Screen” button, and close down

IMOS. Reopen IMOS and use as normal.

It is very important to fully close IMOS and then reopen IMOS after changing the

network device settings.

Machine Name and Machine Id Setup Where there is more than one folder inserter connected to the AIMS DataStation it is

essential to uniquely identify each folder inserter. This must be done on the “Admin”

screen. On IMOS, go to the “Admin” screen, select “Machine Name” and enter a unique

name (e.g. LoughtonOne). Then select “Machine Id” and enter a numeric id (e.g. 123).

The machine name will be displayed on AIMS. The default settings, if no machine name

is entered, shall be “NeoDS_IMOS“.

Page 54: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 54 of 137

Job Setup All mailpieces processed through AIMS must be associated with a Job Id. In IMOS this

is known as “Job Number Control”. If there is not a Job Id within the mailpiece being

processed then this can be manually entered or automatically generated by IMOS at the

start of a Job run.

To setup “Job Number Control” on IMOS, go to the “Jobs” screen, select your Job, and

then click the “Edit” button.

The “Job number control mode” and “AIMS Mode” need to be set for AIMS to work.

“AIMS Header data mode” is currently not used.

Page 55: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 55 of 137

Job Number Control Mode

Click on the “Job number control mode” button and select the appropriate control mode.

Auto Generated

In this mode the Job Id does not appear on the prime document. In this case IMOS will

generate a Job Id for statistics and data logging within AIMS. The operator will be

prompted to either keep the last auto generated Job Id or receive a new automatically

incremented Job Id each time a new run is started. This mode can be used where a

prime document is either ‘dumb’ (i.e. no machine control marks), OMR, or where only

Mailpiece Id is present.

Manual Entry

In this mode the operator shall be prompted to enter a Job Id at the start of each run.

The Job Id will be sent to the AIMS and also sent to the folder inserter prime document

channel so that the mailpieces being processed can be checked against the Job Id where

this security option is turned on.

Manual entry (no external checking)

This mode is not used for AIMS jobs.

Read from Prime

In this mode the Job Id is read from the first page of each mailpiece to be processed on

the prime document channel.

AIMS Mode

Depending on the mailpieces being processed and the operational requirements of the

installed AIMS solution, different modes of AIMS should be used.

Statistics

This Statistics mode should be used when no Label (BCR/2d/OCR) is read, from the

prime document to uniquely identify it. This could mean there are only machine control

Page 56: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 56 of 137

characters in the label, or it could be a situation where there are possible duplicate

references in the label and the logging of these references is not important.

In this mode a Mailpiece Id is system-generated and used in AIMS to show how the

folder inserter has processed the mailpiece. This is done in order to generate data for

the Dashboard and Analysis modules of AIMS

Audit

The Audit mode should be used when there is a Label (BCR/2d/OCR) and each mailpiece

within a Job has a unique identifier, but where there is no database with which to verify

the existence of each Mailpiece Id during processing.

Audit mode can be used to create a log of each item processed by the inserter in

AIMS, using a MailPiece ID read from the Label (BCR/2d/OCR) on the document.

Audit mode is the operating mode of AIMS that is most similar to the traditional IMOS

Data Logs.

Verification

The Verification mode should be used where there is a Label (BCR/2d/OCR) and each

mailpiece within a Job has a unique identifier, and where there is a database with which

to verify the existence of each Mailpiece Id during processing. This database must first

be created within AIMS through a manual or automatic import process.

In Verification mode the existence, validity, and status of each mailpiece is checked with

AIMS before the mailpiece is allowed to continue processing through the folder inserter.

Once a mailpiece starts being processed within one folder inserter, a duplicate mailpiece

will be prevented from running through the same or another folder inserter unless the

original mailpiece has been sent for reprint.

Once the operator no longer has physical mailpieces to process they can request a

reprint within AIMS. A reprint file will be created that will contain the mailpieces that

were not completed correctly. This will include the mailpieces that were removed from

the folder inserter due to an error, but also mailpieces that were never seen by the

folder inserter, but are known to exist due to their inclusion in the originally imported

database.

This mode provides a Closed Loop with external print software.

Lookup (File Based Machine Control)

The Lookup mode operates in the same way as Verification mode but has the addition of

sending machine control information to the folder inserter. The machine control

information operates at mailpiece level and will control the use of Feeders, Jog, Ink

Mark, etc. The machine control does not control at page level and therefore cannot be

used to Split a pack or add Sequence marks.

Label Setup Where the IMOS Job is setup to run in Audit, Verification, or Lookup (File Based Machine

Control) AIMS modes, then the Label must also be setup for AIMS. The “Piece Id

characters” setting must be set. The “Job number characters” and “Security check”

must be set if there is a Job Id in the Label on the mailpiece.

Page 57: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 57 of 137

Security Check

The setting “Job number characters” should be set. With this setting selected a check

will be carried out on each mailpiece within a run to ensure the Job Id does not change.

If the Job Id does change within a run then an error shall be displayed on IMOS and the

mailpiece will be stopped.

Data log enabled

The existing IMOS data logs are still produced (if a Label is being read). It is

recommended that input logging is also turned on when using Job Id and Mailpiece Id.

The “First page + every label” option should be set.

Job Number Characters

The Start Position and Length of the Job Id found in the Label should be entered here.

Label Machine Control (Custom Codes)

Custom Code 20 has been developed for use with AIMS when operating in Lookup (File

Based Machine Control).

This code is designed to have very little (or no) folder inserter control in it, as the

control is provided by the database (See NTL BCR Specification for details).

Form Sequence within a Group can be defined on the document and used if required

The Forms in Group information, if not contained in the label MUST be in the database

(LookUp /Verification modes). It is recommended that it is also used with Audit mode.

Page 58: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 58 of 137

Running AIMS for First Time

Accessing AIMS Once AIMS has been installed, AIMS can be accessed by opening a browser window and

navigating to “http://localhost/”.

The user shall be presented with a login screen. If “AIMS Users” authentication was

chosen during installation the user must choose a password for the Administrator user.

This is done by attempting to login with a username of “Administrator” and then clicking

“Login”. The user should type in a password and then confirm their password by typing

it in a second time.

If “Windows / Active Directory Users” or “Windows / Active Directory Groups”

authentication was chosen during installation the user will be presented with a login

screen showing their current Windows account name. The user should click the “Login”

button. On doing this, a check is made to see if any Windows / Active Directory

accounts have been authenticated onto AIMS. If there are no authenticated Windows /

Active Directory accounts then the user is directed to the Administration page.

Page 59: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 59 of 137

The user is now given the options of creating references to Windows / Active Directory

users by clicking on the “User Accounts” button, or creating references to Windows /

Active Directory Groups by clicking on the “System Settings” button. The user should

type in a password and then confirm their password by typing it in a second time.

More information on setting up Aims Users, Windows / Active Directory Users, or

Windows / Active Directory Groups can be found in the “User Accounts” section of this

document.

Simulator (IMOS AIMS Simulator) The IMOS AIMS Simulator uses the OMS Configuration that is already preloaded into

AIMS. If the OMS Configuration has been removed then then it must be re-added prior

to running the IMOS AIMS Simulator. This can be achieved by logging into AIMS and

going to “Administration > Job Configuration > Add Configuration”. Then click the

“Save” button to save an empty configuration. You will now be back on the page listing

all Job Configurations. The empty Job Configuration that has just been created will have

a name of “[new]”. To the right of this listing click on the “Upload Job Configuration

File” button and then browse to the “C:\Program Files (x86)\AIMS\Configurations\”

directory. Choose “oms_integration_v1_4_0.txt” and select “Upload”. Once this file is

uploaded the AIMS Simulator can be run.

Page 60: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 60 of 137

The AIMS Simulator can be found in the “C:\Program Files (x86)\AIMS\TestTool”

directory and is called “IMOSAIMSSimulator.exe”.

Page 61: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 61 of 137

Output Management Software Compatibility Neopost’s Automated Insertion Management System (AIMS) can be easily configured to

work with Output Management Software (OMS) through use of a standard Job

Configuration. This functionality is not available in AIMS-100 and is limited to

the Standard OMS Compatibility in AIMS-500. For more complex configurations the

Job Configuration Wizard in AIMS-1000 can be used to specify the rules.

Closed Loop Description When AIMS is intended for use with a Closed Loop, its second network card must be

connected to a network that also has access to the OMS. The OMS should not be on the

same LAN as the folder inserter as large print files could disrupt the real time aspect of

AIMS.

LAN One

LAN Two

Corporate

Network Switch

ADF Controller (Parent ADF System)

(1) OMS creates documents. A unique Job Id is created for each new set of mailpieces. Each mailpiece is given a unique Mailpiece Id within the Job. Documents are sent to a printer and a JAF file is sent to the AIMS shared directory.

(2) AIMS polls the shared directory and imports the JAF file. (3) Operator transfers physical paper documents from printer to folder inserter. The paper is loaded and the operator presses

the run button on IMOS.

(4) The folder inserter feeds the first page from the paper stack and reads the barcode / 2D data matrix. The Job Id and

Mailpiece Id are extracted and the Job Id is sent to AIMS. AIMS then responds that the Job is available. The Mailpiece Id is then sent to AIMS for each new mailpiece that is fed into the folder inserter. Each Mailpiece Id is checked against AIMS and only allowed to continue into the folder inserter with its permission. Machine control information for each individual mailpiece may be received from AIMS with this permission.

(5) As the mailpiece exits the folder inserter, either correctly or in error, information is updated in AIMS showing what happened during its progression. For example, have many inserters and from what stations, where did the mailpiece exit.

(6) Once all of the printed mailpieces have been processed through the folder inserter, the Operator presses the Reprint button

on AIMS. This generates a JRF file containing a list of only the mailpieces that require reprinting. The JRF file is added to the shared directory.

(7) OMS polls the shared directory and imports the JRF file.

(8) OMS creates reprint documents and sends them to the printer. A new JAF file is not created as these reprints still contain the original Job Id. This processing of mailpieces and reprint loop can continue until all mailpieces have been successfully processed.

(9) Once all the mailpieces have been successfully processed, the Operator presses the Close button on AIMS. This generates a JCF file containing a list of all the mailpieces in the original JAF file. The JCF file is added to the shared directory.

(10) OMS polls the shared directory and imports the JCF file. The OMS uses the dispositions held in the JCF file to update the

status of each mailpiece. If the OMS requires to reprint any of the mailpieces from this Job it would need to generate a new Job Id as this Job is now closed within AIMS.

Client Browser AIMS Server

Dedicated Switch

Neopost Folder Inserter (Powered By IMOS)

Manual Movement of Paper

(1)

(2)

(3)

(4)

(5)

(6)

(7) (8)

(9)

(10)

Figure 6: Closed Loop Configuration

Page 62: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 62 of 137

Should mailpieces from a closed Job need to be reprinted, these must be printed within

a new Job with a new Job Id.

Print Machine 4 Specific Status Changes

Print Machine Process Mailpiece (Envelope) Status

Job Printed for First

Time

Mailpieces are sent to printer.

JAF file is created.

Mailpiece (Envelope) set to

“Printed”

JRF is processed Mailpiece (Envelope) is OK Mailpiece (Envelope) keeps

the status of “Printed”

Mailpiece (Envelope) is Not OK Mailpiece (Envelope) set to

“Ready to Print”

Job Printed for

Subsequent Time

(Reprinting of failed

mailpieces)

Mailpieces that are at status of “Ready

to Print” are sent to printer.

No JAF file is created.

Mailpiece (Envelope) set to

“Printed”

JCF is processed Mailpiece (Envelope) is OK Mailpiece (Envelope) set to

“Inserted”

Mailpiece (Envelope) is Not OK Mailpiece (Envelope) set to

“Ready to Print”.

AIMS Job Id is deleted so

that a new Job Id is

generated when reprinting

this Mailpiece (Envelope).

Reprint (Dashboard)

Warning – This will

Reprint the entire

Job.

Mailpiece (Envelope) is “Inserted” New AIMS Job Id is

generated and used for all

Mailpieces (Envelopes)

which are already at

“Inserted” status and

Reprinted with this run.

Mailpiece (Envelope) is “Printed” Existing AIMS Job Id is

used.

Recover (Dashboard)

Warning – This will

affect the entire Job.

Mailpiece (Envelope) is at any status. New AIMS Job Id is

generated and used for all

Mailpieces (Envelopes) that

are to be Printed with this

run.

Standard OMS Compatibility In order for OMS to work with AIMS with its standard compatibility, the OMS must be

able to create a Job Allocation File (JAF) in the format detailed below. For closed-loop

operations the OMS must also be able to read in a Job Reprint File (JRF) and / or a Job

Complete File (JCF).

Please note that the Job Id can contain alpha and numeric characters. The Job Id itself

should not contain space characters or special characters (e.g. “![]\|” etc). If the Job Id

is less that the length required in the JAF, it should be padded to the left with space

characters (i.e. “MyJobId1” should become “ MyJobId1” – note two space characters at

the beginning). These space characters will be removed during importing into AIMS and

added again during export from AIMS. The document barcode (or 2D Data Matrix)

should not include these space characters.

Page 63: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 63 of 137

Please note that the Mail Piece Id must be unique within a Job. This means each line

within a file should have a different Mail Piece Id. The Mail Piece Id can contain alpha

and numeric characters. Each Mail Piece Id should be of the same length. The Mail

Piece Id itself should not contain space characters or special characters (e.g. “![]\|” etc).

If the Mail Piece Id is less that the length required in the JAF, it should be padded to the

left with space characters (i.e. “MyMailId1” should become “ MyMailId1” – note one

space character at the beginning). These preceding space characters will be

automatically removed during importing into AIMS and added again during export from

AIMS. The document barcode (or 2D Data Matrix) should not include these space

characters.

Please note the Customer Id is available for customer identifying information that is not

specifically required for AIMS integration. The Customer Id does not have to be unique

within a Job.

Load and Edit Standard Job Configuration

To use the standard OMS compatibility, the latest OMS Integration Job Configuration will

need to be loaded into AIMS (the latest OMS Integration Job Configuration available at

the time of install was loaded during initial installation of AIMS). A new Job

Configuration can be loaded over the top of the currently installed Job Configuration by

using the Job Configuration Wizard found at “Administration > Job Configuration”. Once

on this page find the Job Configuration that has the name “OMS Integration” together

with a version number. If there is none present then click the “Add Configuration”

button and then click “Save” to save an empty Job Configuration. You will now be back

on the page listing all Job Configurations. The empty Job Configuration that has just

been created will have a name of “[new]”. To the right of this listing click on the

“Upload Job Configuration File” button and then browse to the “C:\Program Files

(x86)\AIMS\Configurations\” directory (where “C:\Program Files (x86)\AIMS\” is the

installation directory of AIMS). Choose “oms_integration_v1_4_0.txt” and select

“Upload”.

If the standard directories are not used for the transfer of JAF, JRF, and JCF, then the

Job Configuration Wizard will need to be opened for the standard OMS compatibility Job

Configuration. Within this Job Configuration, only the “Directory” and “Document Mark”

fields should be changed where necessary.

The following definitions are for “OMS Integration v1.4”.

Job Allocation File (JAF)

The OMS shall produce a Job Allocation File (JAF) and save it into a directory that is also

visible to AIMS. AIMS will require full read, write, create, and delete permissions on this

directory.

Once the JAF has been successfully imported into AIMS the JAF shall be moved to a new

directory for archiving. A failed importing of the JAF into AIMS shall lead to a “.err” file

being created for the JAF (e.g. MyJobId1.jaf.err). A Job with the same Job Id will not be

allowed to be imported until this “.err” file has been removed.

The JAF should contain a Header record (first line) and Body records (subsequent lines),

which are a list of mail pieces that have been printed by the OMS. This file is a standard

ASCII text file with one line representing one mail piece. The filename should be the

same as the Job Id plus the suffix “.jaf”.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

Page 64: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 64 of 137

The JAF should be formatted as fixed width fields within the header and each Mail Piece

record. For example, each Mail Piece Id field should be the same length as the next. All

JAFs should be structured in the same way according to the structure detailed below.

The Header record line of the JAF should contain the following (OMS v1.4):

Field Name Length Example

Header Marker 1 “H”

Job Id 10 “ MyJobId1” (Format: A-Z a-z 0-

9 [PRECEEDING SPACE])

SLA Date/Time 19 “2011-10-06 10:42:30”

(Format: “YYYY-MM-DD

hh:mm:ss”)

Creation Date/Time 19 “2011-10-06 10:42:30”

(Format: “YYYY-MM-DD

hh:mm:ss”)

Job Name 32 “My Customer Job ”

(Format: A-Z a-z 0-9 [SPACE])

IMOS Job Name 20 “My IMOS Job ”

(Format: A-Z a-z 0-9 [SPACE])

Each Mail Piece record line of the JAF should contain the following (OMS v1.4):

Field Name Length Example

Body Marker 1 “B”

Job Id 10 “ MyJobId1” (Format: A-Z a-z 0-

9 [PRECEEDING SPACE])

Mail Piece Id 10 “ 000001” (Format: A-Z a-z 0-9

[PRECEEDING SPACE])

Customer Id 32 “123-456-678-9-A”

(Format: A-Z a-z 0-9 [SPACE]

and Special Characters)

Total Prime Documents 3 “001”

Feeder 1 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 2 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 3 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 4 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 5 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 6 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 7 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 8 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 9 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 10 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 11 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 12 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 13 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 14 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 15 Count 1 “1” (Format: 1 = Yes 0 = No)

Feeder 16 Count 1 “1” (Format: 1 = Yes 0 = No)

Envelope Divert 1 1 “1” (Format: 1 = Yes 0 = No)

Envelope Divert 2 1 “1” (Format: 1 = Yes 0 = No)

Envelope Divert 3 1 “1” (Format: 1 = Yes 0 = No)

Form Divert 1 1 “1” (Format: 1 = Yes 0 = No)

Form Divert 2 1 “1” (Format: 1 = Yes 0 = No)

Franker 1 1 “1” (Format: 1 = Yes 0 = No)

Franker 2 1 “1” (Format: 1 = Yes 0 = No)

Halt 1 “1” (Format: 1 = Yes 0 = No)

Ink Mark 1 / Jog 1 “1” (Format: 1 = Yes 0 = No)

Ink Mark 2 / Pulse Conveyor 1 “1” (Format: 1 = Yes 0 = No)

Page 65: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 65 of 137

No Seal 1 “1” (Format: 1 = Yes 0 = No)

Auto End 1 “1” (Format: 1 = Yes 0 = No)

Full Name 50 “Mr J Smith ”

(Format: A-Z a-z 0-9 [SPACE])

Organisation 50 “My Org ”

(Format: A-Z a-z 0-9 [SPACE])

Address Line 1 50 “Something House ”

(Format: A-Z a-z 0-9 [SPACE])

Address Line 2 50 “The Street ”

(Format: A-Z a-z 0-9 [SPACE])

Address Line 3 50 “London ”

(Format: A-Z a-z 0-9 [SPACE])

Address Line 4 50 “ ”

(Format: A-Z a-z 0-9 [SPACE])

Postal Code 50 “SW11 1AA ”

(Format: A-Z a-z 0-9 [SPACE])

User Field 1 50 “ ”

(Format: A-Z a-z 0-9 [SPACE])

User Field 2 50 “ ”

(Format: A-Z a-z 0-9 [SPACE])

User Field 3 50 “ ”

(Format: A-Z a-z 0-9 [SPACE])

Full Format Pack Divert 1 “1” (Format: 1 = Yes 0 = No)

Where Verification mode shall be used on the IMOS Folder Inserter, fields other than

Body Marker, Job Id, Mail Piece Id, and Customer Id fields can be added as zeros. The

Customer Id field can be added as space characters if not required.

Marker Fields

Marker fields should be either a “H” to denote the header line or “B” to denote a line

representing a mailpiece record.

Verification Fields

Verification fields should be added as included in the barcode / 2d. If the value in the

barcode / 2d is shorter than the length allowed for in these fields, then the value in the

JAF file should be padded to the left with space characters.

Informative Fields

Informative fields should be added as space characters if not required or not known.

Machine Control Fields

Used for Lookup Mode. Machine control fields can be added as zeros where not used or

when Verification Mode is used. The “0” character should be used instead of the space

character to pad these fields.

Document Barcode (or 2D Data Matrix)

A barcode (or 2D Data Matrix) should appear on every page of the printed documents

within the Job in the case of Simplex printing. Where Duplex printing is used, the

barcode should only appear on the side of the page that the reader is intended to read.

The barcode should contain the Job Id (compulsory), Mail Piece Id (compulsory), and

Page Number (recommended). The barcode can also contain the required Machine

Control Characters for scenarios where the customer chooses not to use Machine Control

Characters received from the AIMS DataStation, or when only Verification mode is

chosen on the IMOS Folder Inserter.

Page 66: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 66 of 137

Job Reprint File (JRF)

The AIMS DataStation shall produce the Job Reprint File (JRF) and save it into a

directory that is also visible to the OMS. AIMS will require full read, write, create, and

delete permissions on this directory. This directory can be the same directory used for

the JAF transfer as different suffixes are used.

The OMS can use the JRF to determine which Mail Pieces to reprint. Only Mail Pieces

that require reprinting shall be included in the JRF. The JRF is a standard ASCII text file

with a Header record (first line) and Body records (subsequent lines) representing each

mail piece. The filename shall be the same as the Job Id plus a suffix of “.jrf”. If there

is already a file in this directory with the same name, it shall be overwritten.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

The whole mail piece should always be reprinted, not just the “wrecked” sheet of paper.

The JRF shall be formatted as fixed width fields within each Mail Piece record. For

example, each Mail Piece Id field shall be the same length as the next.

If the customer wishes to use the same Job Id for the reprinted Mail Pieces (Reducing

Loop) then the OMS should not create a new Job Allocation File. However if the

customer wants to use a new Job Id for the reprinted Mail Pieces (New Loop) then a new

Job Allocation File will need to be produced. This should be an option for the customer.

The advantage of using the same Job Id is that the customer can see the percentage of

successfully completed Mail Pieces move towards 100% within the same Job. This

Reducing Loop is recommended where it is possible.

The Header record line of the JRF shall contain the following (OMS v1.4):

Field Name Length Example

Header Marker 1 “H”

Job Id 10 “ MyJobId1” (Format: A-Z a-z 0-

9 [PRECEEDING SPACE])

SLA Date/Time 19 “2011-10-06 10:42:30”

(Format: “YYYY-MM-DD

hh:mm:ss”)

Creation Date/Time 19 “2011-10-06 10:42:30”

(Format: “YYYY-MM-DD

hh:mm:ss”)

Each Mail Piece record line of the JRF shall contain the following (OMS v1.4):

Field Name Length Example

Body Marker 1 “B”

Job Id 10 “ MyJobId1” (Format: A-Z a-z 0-

9 [PRECEEDING SPACE])

Mail Piece Id 10 “ 000001” (Format: A-Z a-z 0-9

[PRECEEDING SPACE])

Disposition Code (Result) 2 “10”

Timestamp (Result) 19 Date/Time Processed

“2011-10-06 10:42:30”

(Format: “YYYY-MM-DD

hh:mm:ss” If not processed there

will be 19 space characters.)

Customer Id 32 “123-456-678-9-A”

(Format: A-Z a-z 0-9 [SPACE]

and Special Characters)

Page 67: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 67 of 137

Job Complete File (JCF)

The AIMS DataStation shall produce the Job Complete File (JCF) and save it into a

directory that is also visible to the OMS. AIMS will require full read, write, create, and

delete permissions on this directory. This directory can be the same directory used for

the JAF transfer as different suffixes are used.

The OMS can use the JCF to determine what happened to all of the Mail Pieces. All of

the Mail Pieces present in the JAF shall be included in the JCF. The JCF is a standard

ASCII text file with a Header record (first line) and Body records (subsequent lines)

representing each mail piece. The filename shall be the same as the Job Id plus a suffix

of “.jcf”. If there is already a file in this directory with the same name, it shall be

overwritten.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

The JCF shall be formatted as fixed width fields within each Mail Piece record. For

example, each Mail Piece Id field shall be the same length as the next.

A JCF is only produced once a Job has been closed within AIMS. Therefore any reprints

that are determined to be necessary by the OMS will need to be created in a new Job

with a new Job Id.

The Header record line of the JCF shall contain the following (OMS v1.4):

Field Name Length Example

Header Marker 1 “H”

Job Id 10 “ MyJobId1” (Format: A-Z a-z 0-

9 [PRECEEDING SPACE])

SLA Date/Time 19 “2011-10-06 10:42:30”

(Format: “YYYY-MM-DD

hh:mm:ss”)

Creation Date/Time 19 “2011-10-06 10:42:30”

(Format: “YYYY-MM-DD

hh:mm:ss”)

Each Mail Piece record line of the JCF shall contain the following (OMS v1.4):

Field Name Length Example

Body Marker 1 “B”

Job Id 10 “ MyJobId1” (Format: A-Z a-z 0-

9 [PRECEEDING SPACE])

Mail Piece Id 10 “ 000001” (Format: A-Z a-z 0-9

[PRECEEDING SPACE])

Disposition Code (Result) 2 “40”

Timestamp (Result) 19 Date/Time Processed

“2011-10-06 10:42:30”

(Format: “YYYY-MM-DD

hh:mm:ss” If not processed there

will be 19 [SPACE] characters.)

Customer Id 32 “123-456-678-9-A”

(Format: A-Z a-z 0-9 [SPACE]

and Special Characters)

Prime Documents (Result) 3 “001”

Feeder 1 Count (Result) 2 “01”

Feeder 2 Count (Result) 2 “01”

Feeder 3 Count (Result) 2 “01”

Feeder 4 Count (Result) 2 “01”

Feeder 5 Count (Result) 2 “01”

Page 68: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 68 of 137

Feeder 6 Count (Result) 2 “01”

Feeder 7 Count (Result) 2 “01”

Feeder 8 Count (Result) 2 “01”

Feeder 9 Count (Result) 2 “01”

Feeder 10 Count (Result) 2 “01”

Feeder 11 Count (Result) 2 “01”

Feeder 12 Count (Result) 2 “01”

Feeder 13 Count (Result) 2 “01”

Feeder 14 Count (Result) 2 “01”

Feeder 15 Count (Result) 2 “01”

Feeder 16 Count (Result) 2 “01”

Envelope Divert 1 (Result) 1 “1” (Format: 1 = Yes 0 = No)

Envelope Divert 2 (Result) 1 “1” (Format: 1 = Yes 0 = No)

Envelope Divert 3 (Result) 1 “1” (Format: 1 = Yes 0 = No)

Form Divert 1 (Result) 1 “1” (Format: 1 = Yes 0 = No)

Form Divert 2 (Result) 1 “1” (Format: 1 = Yes 0 = No)

Franked (Result) 1 “1” (Format: 1 = Yes 0 = No)

Franker 2 1 “1” (Format: 1 = Yes 0 = No)

Halt 1 “1” (Format: 1 = Yes 0 = No)

Ink Mark 1 / Jog (Result) 1 “1” (Format: 1 = Yes 0 = No)

Ink Mark 2 / Pulse Conveyor (Result) 1 “1” (Format: 1 = Yes 0 = No)

No Seal (Result) 1 “1” (Format: 1 = Yes 0 = No)

Auto End (Result) 1 “1” (Format: 1 = Yes 0 = No)

Full Name 50 “Mr J Smith ”

(Format: A-Z a-z 0-9 [SPACE])

Organisation 50 “My Org ”

(Format: A-Z a-z 0-9 [SPACE])

Address Line 1 50 “Something House ”

(Format: A-Z a-z 0-9 [SPACE])

Address Line 2 50 “The Street ”

(Format: A-Z a-z 0-9 [SPACE])

Address Line 3 50 “London ”

(Format: A-Z a-z 0-9 [SPACE])

Address Line 4 50 “ ”

(Format: A-Z a-z 0-9 [SPACE])

Postal Code 50 “SW11 1AA ”

(Format: A-Z a-z 0-9 [SPACE])

User Field 1 50 “ ”

(Format: A-Z a-z 0-9 [SPACE])

User Field 2 50 “ ”

(Format: A-Z a-z 0-9 [SPACE])

User Field 3 50 “ ”

(Format: A-Z a-z 0-9 [SPACE])

Full Format Pack Divert (Result) 1 “1” (Format: 1 = Yes 0 = No)

If the customer wishes to generate reprints using the dispositions found in the JCF and

also wishes to use the same Job Id for the reprinted Mail Pieces then the original Job

should be deleted in the AIMS DataStation. A new JAF will need to be produced by the

OMS.

A list of Disposition Codes and their meaning can be found in the “Machine Data” section

of this document.

Non Standard OMS Compatibility For integration of AIMS with more complex Document Creation Software or Parent ADF

systems the Job Configuration Wizard can be used. For more information see the “Job

Configuration Wizard” section of this document.

Page 69: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 69 of 137

Error (.err) If there is an error during the importing of a Job into AIMS then an “.err” file shall be

produced. This file shall take the filename from the JAF file originally being imported

and shall add the suffix “.err” onto the end. This file shall be placed into the “Error

Import Directory” directory, which by default is the same as the File Drop location of the

“JAF” file. The “Error Import Directory” can be changed on the last page of the Job

Configuration Wizard. Where the “Error Import Directory” is different from the original

File Drop location the “JAF” file is moved to this “Error Import Directory” along with the

“.err” file. If AIMS creates an “.err” file for a Job then the Job can no longer be

automatically imported. The Job can however be imported by clicking on the “Import

Job” button on the Jobs screen and then selecting the Job manually if the “Error Import

Directory” is the same as the File Drop location. The User will be prompted to confirm

that they wish to import a Job that has previously been shown to have an error.

Reasons for wanting to attempt this import again could include modifying the Job

Configuration. If AIMS detects an “.err” file that it has not created then the

corresponding Job will not be automatically imported (if this had been its original

setting) and the User will need to manually import the Job via the “Import Job” screen.

However unlike the above functionality the User will only be prompted whether to

import the Job, not that there was a previous error, as the error was not within AIMS.

Page 70: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 70 of 137

Audit Mode Neopost’s Automated Insertion Management System (AIMS) can be easily configured to

create an Audit Job Complete File when operating in Audit Mode. By default this is

turned off. This functionality is not available in AIMS-100.

To turn on the creation of an Audit Job Complete File, log in to AIMS and navigate to

Administration > Configurations. On the list of Configurations, choose the “Statistics”

Configuration. Then click the “Next” button to go to the page of the wizard related to

the Job Complete File. Once on this page, enter a directory to save the Audit Job

Complete File to, choose a Suffix, and ensure that the option “Required” is ticked.

Optionally, you can choose a header. If you are saving the Audit Job Control File into

the same directory as the Output Management Software’s Job Control File it is important

that you choose a unique Suffix. This is because the format of the Audit Job Control File

is different to the format of the Output Management Software’s Job Control File.

Audit Job Complete File (JCF)

The AIMS DataStation shall produce the Audit Job Complete File (JCF) and save it into a

directory. AIMS will require full read, write, create, and delete permissions on this

directory. This directory can be the same directory used for the Output Management

Software’s JCF transfer as long as different suffixes are used.

The Audit JCF can be used to determine what happened to all of the Mail Pieces read

into the folder inserter. The Audit JCF is a standard ASCII text file with an optional

Header record (first line) and Body records (subsequent lines) representing each mail

piece. The filename shall be the same as the Job Id plus a chosen suffix. If there is

already a file in this directory with the same name, it shall be overwritten.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

The Audit JCF shall be formatted as fixed width fields within each Mail Piece record. For

example, each Mail Piece Id field shall be the same length as the next.

Only fields whose values are generated within the folder inserter can be used in the

Audit JCF. These are denoted in the configuration as having “(Result)” at the end of

them.

An Audit JCF is only produced once a Job has been closed within AIMS. Therefore any

reprints that are determined to be necessary by the OMS will need to be created in a

new Job with a new Job Id.

The following format is fixed for the Audit JCF in AIMS-500. This can be kept in AIMS-

1000 or changed as required.

The optional Header record line of the Audit JCF shall contain the following:

Field Name Length Example

Job Id (Result) 10 “ MyJobId1” (Format: A-Z a-z 0-

9 [PRECEEDING SPACE])

Each Mail Piece record line of the Audit JCF shall contain the:

Field Name Length Example

Job Id (Result) 10 “ MyJobId1” (Format: A-Z a-z 0-

9 [PRECEEDING SPACE])

Mail Piece Id (Result) 10 “ 000001” (Format: A-Z a-z 0-9

[PRECEEDING SPACE])

Disposition Code (Result) 2 “40”

Page 71: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 71 of 137

Timestamp (Result) 19 “2011-10-06 10:42:30”

(Format: “YYYY-MM-DD

hh:mm:ss”)

Prime Documents (Result) 3 “001”

Feeder 1 Count (Result) 2 “01”

Feeder 2 Count (Result) 2 “01”

Feeder 3 Count (Result) 2 “01”

Feeder 4 Count (Result) 2 “01”

Feeder 5 Count (Result) 2 “01”

Feeder 6 Count (Result) 2 “01”

Feeder 7 Count (Result) 2 “01”

Feeder 8 Count (Result) 2 “01”

Feeder 9 Count (Result) 2 “01”

Feeder 10 Count (Result) 2 “01”

Feeder 11 Count (Result) 2 “01”

Feeder 12 Count (Result) 2 “01”

Feeder 13 Count (Result) 2 “01”

Feeder 14 Count (Result) 2 “01”

Feeder 15 Count (Result) 2 “01”

Feeder 16 Count (Result) 2 “01”

Envelope Divert 1 (Result) 1 “1” (Format: 1 = Yes 0 = No)

Envelope Divert 2 (Result) 1 “1” (Format: 1 = Yes 0 = No)

Envelope Divert 3 (Result) 1 “1” (Format: 1 = Yes 0 = No)

Form Divert 1 (Result) 1 “1” (Format: 1 = Yes 0 = No)

Form Divert 2 (Result) 1 “1” (Format: 1 = Yes 0 = No)

Franked (Result) 1 “1” (Format: 1 = Yes 0 = No)

Ink Mark 1 / Jog (Result) 1 “1” (Format: 1 = Yes 0 = No)

Ink Mark 2 / Pulse Conveyor (Result) 1 “1” (Format: 1 = Yes 0 = No)

No Seal (Result) 1 “1” (Format: 1 = Yes 0 = No)

Auto End (Result) 1 “1” (Format: 1 = Yes 0 = No)

Full Format Pack Divert (Result) 1 “1” (Format: 1 = Yes 0 = No)

If the customer wishes to generate reprints using the dispositions found in the JCF and

also wishes to use the same Job Id for the reprinted Mail Pieces then the original Job

should be deleted in the AIMS DataStation.

A list of Disposition Codes and their meaning can be found in the “Machine Data” section

of this document.

Audit Job Reprint File (JRF)

The AIMS DataStation shall produce the Audit Job Reprint File (JCF) and save it into a

directory. AIMS will require full read, write, create, and delete permissions on this

directory. This directory can be the same directory used for the Output Management

Software’s JRF transfer as long as different suffixes are used.

The Audit JRF can be used to determine which Mail Pieces require reprinting. The Audit

JRF is a standard ASCII text file with an optional Header record (first line) and Body

records (subsequent lines) representing each mail piece. The filename shall be the

same as the Job Id plus a chosen suffix. If there is already a file in this directory with

the same name, it shall be overwritten.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

The Audit JRF shall be formatted as fixed width fields within each Mail Piece record. For

example, each Mail Piece Id field shall be the same length as the next.

Page 72: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 72 of 137

Only fields whose values are generated within the folder inserter can be used in the

Audit JRF. These are denoted in the configuration as having “(Result)” at the end of

them.

The following format is fixed for the Audit JRF in AIMS-500. This can be kept in AIMS-

1000 or changed as required.

The optional Header record line of the Audit JRF shall contain the following:

Field Name Length Example

Job Id (Result) 10 “ MyJobId1” (Format: A-Z a-z 0-

9 [PRECEEDING SPACE])

Each Mail Piece record line of the Audit JCF shall contain the:

Field Name Length Example

Job Id (Result) 10 “ MyJobId1” (Format: A-Z a-z 0-

9 [PRECEEDING SPACE])

Mail Piece Id (Result) 10 “ 000001” (Format: A-Z a-z 0-9

[PRECEEDING SPACE])

Disposition Code (Result) 2 “40”

Timestamp (Result) 19 “2011-10-06 10:42:30”

(Format: “YYYY-MM-DD

hh:mm:ss”)

A list of Disposition Codes and their meaning can be found in the “Machine Data” section

of this document.

Page 73: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 73 of 137

Job Configuration Wizard The Job Configuration Wizard enables Neopost’s Automated Insertion Management

System (AIMS) to import and export complex mail run information from and to external

systems. This functionality is not available in AIMS-100 and is limited in AIMS-

500. The Job Configuration Wizard allows a number of rules to be set concerning

importing, reprinting, progressing, and closing Jobs. In most scenarios the Job

Configuration Wizard should only need to be run through once, assuming that all

subsequent jobs are run with the same structure, location, and requirement of files.

The Job Configuration Wizard consists of seven pages. It may be possible to use the

standard document creation software compatibility. See the “Standard Document

Creation Software Compatibility” section of this document.

Job Configurations can be saved to a XML based text file for safe keeping or for

transferring between AIMS DataStation by clicking on the “Download Job Configuration

File” button found at the right hand side of Job Configuration name on the

Configurations list.

Job Configurations can be uploaded from a XML based text file by clicking on the

“Upload Job Configuration File” button found at the right hand side of Job Configuration

name on the Configurations list.

Scripting using VB.Net can be used wherever there is a “Format” textbox. This scripting

can be used to store variables between import and export, or to rearrange data for

external systems (e.g. date format). For more information on scripting, please see the

“Scripting” section of this document.

Job Allocation File (JAF)

Provision of Job Allocation File

There must be a Job Allocation File (JAF) for each Verification or Lookup type Job and

the Parent ADF shall provide this. The location and format of the JAF should be

specified using the “Directory”, “Suffix”, and “Format” text fields. The “Format” text

field allows scripting to be performed on the incoming file. It can, for example, allow

the Job Id to be extracted from part of the filename. If the “Format” text field is empty

then a JAF shall be searched for using the Suffix and the rest of the filename, excluding

suffix, shall be assumed to be the Job Id.

The Parent ADF shall produce the JAF and save it into the directory specified that is also

visible to AIMS. AIMS will require full read, write, create, and delete permissions on this

directory.

Once the JAF has been successfully imported into AIMS the JAF shall be moved to a new

directory for archiving. A failed importing of the JAF into AIMS shall lead to a “.err” file

being created for the JAF (e.g. MyJobId1.txt.err). A Job with the same Job Id will not be

allowed to be imported until this “.err” file has been removed.

Format of Job Allocation File

The JAF can optionally contain a Header record on the first line of the file. If there is no

Header record then the selection “First Line Is Header” should have a cross next to it

instead of a tick, and the Header section should be greyed out. It is compulsory for the

JAF to contain at least one Body record. Each Body record line refers to one mail piece.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

Page 74: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 74 of 137

The JAF should be formatted as fixed width fields within the header (if available) and

each Mail Piece record. For example, each Mail Piece Id field should be the same length

as the next.

The location in the Header record (if available) and in each Body record of required

parameters, such as Mail Piece Id, should be recorded in the available text fields on this

page. Where necessary it is possible to specify rules using VBScript within the “Format”

text field to convert incoming data such as machine control characters to the format

recognised by the Neopost Folder Inserter (Driven By IMOS).

As a minimum the required fields are the Job Id and the Mailpiece Id. All other fields

should be mapped to characters within the JAF where these fields are required for user

information or for use in exported files.

Job Progress File (JPF)

Provision of Job Progress File

Within the job configuration it is possible to specify whether or not to create a Job

Progress File (JPF). If there is no requirement for the JPF then the selection “Required”

should have a cross next to it instead of a tick, and the Header and Body sections

should be greyed out.

The location and format of the JPF should be specified using the “Directory”, “Suffix”,

and “Format” text fields. The “Format” text field allows scripting to be performed on the

outgoing file. It can, for example, allow the Job Id to be including as part of the

filename. If the “Format” text field is empty then a JPF shall be created within the Job

Id and the Suffix only.

AIMS will require full read, write, create, and delete permissions on this directory. If

there is already a file with the same name it shall be appended to.

The JPF shall be produced regularly during the running of the Job on the Neopost Folder

Inserter (Driven By IMOS), and shall show all mail pieces that have been or have

attempted to be processed through the Neopost Folder Inserter (Driven By IMOS)

together with data relating to their progress. The frequency at which this JPF is

produced can be controlled from the “System Settings” page at “Administration >

System Settings > Timers > Job Progress File”.

Format of Job Progress File

The JPF can optionally contain a Header record on the first line of the file. If there is no

need for a Header record then the selection “Include Header” should have a cross next

to it instead of a tick, and the Header section should be greyed out. It is compulsory for

the JAF to contain at least one Body record. Each Body record line refers to one

mailpiece.

The location in the Header record (if required) and in each Body record of required

parameters, such as Mail Piece Id, should be recorded in the available text fields on this

page. Where necessary it is possible to specify rules using VBScript within the “Format”

text field to convert data stored within AIMS such as machine control characters to the

format required by other systems.

The JPF can record data received from the incoming Job Allocation File (JAF) as well as

data received from the processing of mailpieces on the Neopost Folder Inserters. For

more information about the data that can be recorded from the Neopost Folder Inserters

see the Machine Data section of this document.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

Page 75: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 75 of 137

Job Complete File (JCF)

Provision of Job Complete File

Within the job configuration it is possible to specify whether or not to create a Job

Complete File (JCF). If there is no requirement for the JCF then the selection “Required”

should have a cross next to it instead of a tick, and the Header and Body sections

should be greyed out.

The location and format of the JCF should be specified using the “Directory”, “Suffix”,

and “Format” text fields. The “Format” text field allows scripting to be performed on the

outgoing file. It can, for example, allow the Job Id to be including as part of the

filename. If the “Format” text field is empty then a JCF shall be created within the Job

Id and the Suffix only.

AIMS will require full read, write, create, and delete permissions on this directory. If

there is already a file with the same name it shall be overwritten.

The JCF shall be produced once the Job is marked as “Closed”, and shall show all mail

pieces, whether they have been processed or not, together with data relating to their

progress.

Format of Job Complete File

The JCF can optionally contain a Header record on the first line of the file. If there is no

need for a Header record then the selection “Include Header” should have a cross next

to it instead of a tick, and the Header section should be greyed out. The JCF should

have the same number of body records as the original Job Allocation File (JAF). Each

Body record line refers to one mail piece.

The location in the Header record (if required) and in each Body record of required

parameters, such as Mail Piece Id, should be recorded in the available text fields on this

page. Where necessary it is possible to specify rules using VBScript within the “Format”

text field to convert data stored within AIMS such as machine control characters to the

format required by other systems.

The JCF can record data received from the incoming Job Allocation File (JAF) as well as

data received from the processing of mail pieces on the Neopost Folder Inserters. For

more information about the data that can be recorded from the Neopost Folder Inserters

see the Machine Data section of this document.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

Job Reprint File (JRF)

Provision of Job Reprint File

Within the job configuration it is possible to specify whether or not to create a Job

Reprint File (JRF). If there is no requirement for the JRF then the selection “Required”

should have a cross next to it instead of a tick, and the Header and Body sections

should be greyed out.

The location and format of the JRF should be specified using the “Directory”, “Suffix”,

and “Format” text fields. The “Format” text field allows scripting to be performed on the

outgoing file. It can, for example, allow the Job Id to be including as part of the

filename. If the “Format” text field is empty then a JRF shall be created within the Job

Id and the Suffix only.

Page 76: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 76 of 137

AIMS will require full read, write, create, and delete permissions on this directory. If

there is already a file with the same name it shall be overwritten.

The JRF shall be produced once the Job is marked for Reprint, and shall show only the

mail pieces that have not been successfully completed.

Format of Job Reprint File

The JRF can optionally contain a Header record on the first line of the file. If there is no

need for a Header record then the selection “Include Header” should have a cross next

to it instead of a tick, and the Header section should be greyed out. The JRF may not

have any Body records if all mail pieces have been successfully completed. Each Body

record line refers to one mail piece.

The location in the Header record (if required) and in each Body record of required

parameters, such as Mail Piece Id, should be recorded in the available text fields on this

page. Where necessary it is possible to specify rules using VBScript within the “Format”

text field to convert data stored within AIMS such as machine control characters to the

format required by other systems.

The JRF can record data received from the incoming Job Allocation File (JAF) as well as

data received from the processing of mail pieces on the Neopost Folder Inserters. For

more information about the data that can be recorded from the Neopost Folder Inserters

see the Machine Data section of this document.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

Job Good File (JGF)

Provision of Job Good File

Within the job configuration it is possible to specify whether or not to create a Job Good

File (JGF). If there is no requirement for the JGF then the selection “Required” should

have a cross next to it instead of a tick, and the Header and Body sections should be

greyed out.

The location and format of the JGF should be specified using the “Directory”, “Suffix”,

and “Format” text fields. The “Format” text field allows scripting to be performed on the

outgoing file. It can, for example, allow the Job Id to be including as part of the

filename. If the “Format” text field is empty then a JGF shall be created within the Job

Id and the Suffix only.

AIMS will require full read, write, create, and delete permissions on this directory. If

there is already a file with the same name it shall be overwritten.

The JGF shall be produced once the Job is marked for Complete, and shall show only the

mailpieces that have been successfully completed.

Format of Job Good File

The JGF can optionally contain a Header record on the first line of the file. If there is no

need for a Header record then the selection “Include Header” should have a cross next

to it instead of a tick, and the Header section should be greyed out. The JGF may not

have any Body records if no mailpieces have been successfully completed. Each Body

record line refers to one mailpiece.

The location in the Header record (if required) and in each Body record of required

parameters, such as Mail Piece Id, should be recorded in the available text fields on this

page. Where necessary it is possible to specify rules using VBScript within the “Format”

Page 77: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 77 of 137

text field to convert data stored within AIMS such as machine control characters to the

format required by other systems.

The JGF can record data received from the incoming Job Allocation File (JAF) as well as

data received from the processing of mailpieces on the Neopost Folder Inserters. For

more information about the data that can be recorded from the Neopost Folder Inserters

see the Machine Data section of this document.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

Job Missed File (JMF)

Provision of Job Missed File

Within the job configuration it is possible to specify whether or not to create a Job

Missed File (JMF). If there is no requirement for the JMF then the selection “Required”

should have a cross next to it instead of a tick, and the Header and Body sections

should be greyed out.

The location and format of the JMF should be specified using the “Directory”, “Suffix”,

and “Format” text fields. The “Format” text field allows scripting to be performed on the

outgoing file. It can, for example, allow the Job Id to be including as part of the

filename. If the “Format” text field is empty then a JMF shall be created within the Job

Id and the Suffix only.

AIMS will require full read, write, create, and delete permissions on this directory. If

there is already a file with the same name it shall be overwritten.

The JMF shall be produced once the Job is marked for Complete, and shall show only the

mailpieces that have not been successfully completed, either because they have not

been seen or they caused an error during processing.

Format of Job Missed File

The JMF can optionally contain a Header record on the first line of the file. If there is no

need for a Header record then the selection “Include Header” should have a cross next

to it instead of a tick, and the Header section should be greyed out. The JMF may not

have any Body records if no mailpieces have been successfully completed. Each Body

record line refers to one mailpiece.

The location in the Header record (if required) and in each Body record of required

parameters, such as Mail Piece Id, should be recorded in the available text fields on this

page. Where necessary it is possible to specify rules using VBScript within the “Format”

text field to convert data stored within AIMS such as machine control characters to the

format required by other systems.

The JMF can record data received from the incoming Job Allocation File (JAF) as well as

data received from the processing of mailpieces on the Neopost Folder Inserters. For

more information about the data that can be recorded from the Neopost Folder Inserters

see the Machine Data section of this document.

For the avoidance of doubt, if there is more than one page in the mail piece, the multi-

page mail piece shall still be recorded in this file on one line for the whole mail piece.

General Settings

Configuration Name

A configuration name should be chosen to identify the configuration.

Page 78: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 78 of 137

Type of Import

There are two methods of Job Allocation File (JAF) importation available within job

configuration. These are Automatic Import and Scan First Page Import.

Automatic Import

When Automatic Import is selected in job configuration, all JAF that meet the set-up

parameters are automatically imported into AIMS. During the import process the JAF

shall be removed from the directory.

Scan First Page Import

When Automatic Import is not selected in job configuration, the JAF is not imported into

AIMS until the operator scans the Barcode (or 2D Data Matrix) on the first page of the

job’s printed-paper. To import a job the operator shall log into AIMS browser-based

client, navigate to the Jobs page, and click the “Scan Job” button on the Jobs screen.

They shall then scan the Barcode (or 2D Data Matrix) using a handheld scanner. Once

scanned, AIMS shall filter its list of jobs waiting for import. The operator can then click

the Job found to import it. During the import process the JAF shall be removed from the

directory. It is recommended that a PC running AIMS browser-based client and installed

with an appropriate handheld scanner be situated next to the Neopost Folder Inserter

(Driven By IMOS).

Successful Import Directory

By default, upon a successful import, the JAF shall be moved to the “Imported” directory

directly under file drop directory. If a different directory is required this can be specified

using the “Successful Import Directory”.

Error Import Directory

By default, upon an error during import, the JAF shall be moved to the “Error” directory

directly under file drop directory. If a different directory is required this can be specified

using the “Error Import Directory”.

Check IMOS Job Name

Extra security can be added by selecting the option to Check IMOS Job Name. When

this option is selected, AIMS checks the IMOS Job Name sent when the folder inserter

connects against the IMOS Job Name fields in the JAF file. If this option is selected and

there is a value in the IMOS Job Name field in the JAF file, then they have to match. If

they do not then the Job will not be able to continue and an error will be raised on the

folder inserter. If this option is selected but there is no value in the IMOS Job Name

field in the JAF file then no check is carried out at the Job is allowed to continue.

Close Job

Actions to be carried out once the “Close Job” button has been pressed.

Jobs can be automatically closed by AIMS after a defined period of time if they have

either been fully processed (every Mailpiece has been seen by AIMS) or they are fully

finished (every Mailpiece has gone to its intended destination). This functionality is only

available for Jobs that have been preloaded. It is not available for Audit or Statistics

Jobs.

Reprint Job

Requirements to allow the “Reprint Job” button to be available and actions to be carried

out once the “Reprint” button has been pressed. There is an option to allow the deletion

of a Job database when the Reprint buttion is pressed. This would be unusual operation

as the Closed Loop information about the Job would be lost. There is also the option to

close the Job if there are Zero Reprints. This has the advantage that Operators can just

press the Reprint button whether there are Reprints or not. If there are no Reprints

required then the Job will be automatically closed.

Page 79: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 79 of 137

Document Mark

In order to enable the scanning of Jobs for import or the automatic filtering of Job or

Mailpiece screens on scan, the length of the barcode (or 2D Data Matrix), together with

the position of the Job Id and Mail Piece Id need to be specified.

Cost Centre Accounting

If Cost Centre Accounting is enabled the User can specify one or more Cost Centres to

apply to a Job when it is closed. If more than one Cost Centre is entered they should be

separated with a comma and a proportion of the Job’s Mailpieces will be assigned to

each Cost Centre. For example if there are 100 Mailpieces within the Job and 2 Cost

Centres defined, 50 Mailpieces will be assigned to each of the Cost Centres.

Reprocessing Oversized

When the “Reprocessing Oversized” option is enabled, any Mailpiece that is diverted as

an Oversized Mailpiece can be immediately reprocessed through a folder inserter again

without then need to send it for reprint.

Dispositions

Mailpieces within a Job have a Disposition to show at which stage of the process they

are at. When the “Use Enhanced Dispositions” option is enabled the enhanced (or

extended) list of Dispositions is used during the creation of output files. When this

option is not enabled the basic list of Dispositions is used during the creation of output

files. A list of Dispositions can be found in the Machine Data section of this document.

Dispositions within AIMS are always Enhanced Dispositions.

Trigger Files

AIMS can monitor a directory for Trigger Files. When Trigger Files are seen, an action is

carried out appropriate to the file suffix. Trigger File functionality is available for Closing

a Job, Reprinting a Job, or Late Diverting mailpieces.

The Trigger File filename should contain the Job Id and the suffix required to denote the

action to be triggered. In the case of closing and reprinting triggers the content of the

file is ignored.

Late Divert Trigger File

The Late Diverts trigger file should contain a list of Mailpiece Ids that require reprinting

within the Job. Each Mailpiece Id should be on its own line within the Late Diverts

Trigger File. The success of a Late Diverts Trigger File import is written to the Trigger

Log File (.tlf). This Trigger Log File is written to the same directory as where the

original Trigger File was imported.

Page 80: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 80 of 137

Scripting Neopost’s Automated Insertion Management System (AIMS) allows scripting of data that

is imported or exported. This functionality is not available in AIMS-100 and is

limited in AIMS-500. This can be useful to change data formats, create unique

filenames, or store data between import and export, amongst other things. The

scripting engine using the VB.Net framework. Scripting is accessible within the Job

Configuration Wizard wherever a “Format” textbox is available. An example of scripting

in VB.Net is shown below.

SCRIPT:

Dim strArray() As String

Dim strMyid As String

strArray = Split(AIMS.Value, “_”)

if Ubound(strArray) = 1 then

strMyid = strArray(0)

AIMS.JobId = mid(strArray(1),1,14)

AIMS.UserParameter(“MyId”) = strMyid

end if

return AIMS.Value

Together with the standard VB.Net framework, there are various Methods and Properties

available in the AIMS Namespace.

AIMS Namespace The AIMS Namespace can be accessed using “AIMS.” Prior to the Method or Property

being called. The following Methods and Properties are available in the AIMS

Namespace.

Properties

Name Description UserParameter(String1) Allows data to be stored and

retrieved between import and

export of a Job. Data is stored

and retrieved using a string (1)

as a key. The string must be

enclosed in double quotes and

can include space characters. JobId Gives access during scripting to

the Job Id. Directory Gives access during scripting to

the Directory of the file being

imported or exported. Suffix Gives access during scripting to

the Suffix of the file being

imported or exported. Value Gives access during scripting to

the Value of the data item

mapped by the customer. Line Gives access during scripting to

the whole Line associated with

the data item mapped by the

customer.

Page 81: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 81 of 137

Unread Holds the number of mailpieces

in a Job with a Disposition of

Unread. Only useful for scripting

of output files. Failed Holds the number of mailpieces

in a Job with a Disposition of

Failed. Only useful for scripting

of output files. Oversized Holds the number of mailpieces

in a Job with a Disposition of

Oversized. Only useful for

scripting of output files. Voided Holds the number of mailpieces

in a Job with a Disposition of

Voided. Only useful for scripting

of output files. CommandedDivert Holds the number of mailpieces

in a Job with a Disposition of

Commanded Divert. Only useful

for scripting of output files. LateDivert Holds the number of mailpieces

in a Job with a Disposition of

Late Divert. Only useful for

scripting of output files. Processing Holds the number of mailpieces

in a Job with a Disposition of In

Process. Only useful for scripting

of output files. HandMailedFromUnread Holds the number of mailpieces

in a Job with a Disposition of

Hand Mailed From Unread. Only

useful for scripting of output

files. HandMailedFromFailed Holds the number of mailpieces

in a Job with a Disposition of

Hand Mailed From Failed. Only

useful for scripting of output

files. HandMailedFromOversized Holds the number of mailpieces

in a Job with a Disposition of

Hand Mailed From Oversized.

Only useful for scripting of

output files. HandMailedFromVoided Holds the number of mailpieces

in a Job with a Disposition of

Hand Mailed From Voided. Only

useful for scripting of output

files. FullFormatHandMailedFromUnread Holds the number of mailpieces

in a Job with a Disposition of Full

Format Hand Mailed From

Unread. Only useful for scripting

of output files. FullFormatHandMailedFromFailed Holds the number of mailpieces

in a Job with a Disposition of Full

Format Hand Mailed From Failed.

Only useful for scripting of

output files. FullFormatHandMailedFromOversized Holds the number of mailpieces

in a Job with a Disposition of Full

Page 82: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 82 of 137

Format Hand Mailed From

Oversized. Only useful for

scripting of output files. FullFormatHandMailedFromVoided Holds the number of mailpieces

in a Job with a Disposition of Full

Format Hand Mailed From

Voided. Only useful for scripting

of output files. MachineToBin1 Holds the number of mailpieces

in a Job with a Disposition of

Machine To Output Bin 1. Only

useful for scripting of output

files. MachineToBin2 Holds the number of mailpieces

in a Job with a Disposition of

Machine To Output Bin 2. Only

useful for scripting of output

files. MachineToBin3 Holds the number of mailpieces

in a Job with a Disposition of

Machine To Output Bin 3. Only

useful for scripting of output

files. MachineToStack Holds the number of mailpieces

in a Job with a Disposition of

Machine To Stack. Only useful

for scripting of output files. FullFormatMachineToBin1 Holds the number of mailpieces

in a Job with a Disposition of Full

Format Machine To Output Bin 1.

Only useful for scripting of

output files. FullFormatMachineToBin2 Holds the number of mailpieces

in a Job with a Disposition of

Format Machine To Output Bin 2.

Only useful for scripting of

output files. FullFormatMachineToBin3 Holds the number of mailpieces

in a Job with a Disposition of

Format Machine To Output Bin 3.

Only useful for scripting of

output files. FullFormatMachineToStack Holds the number of mailpieces

in a Job with a Disposition of

Format Machine To Stack. Only

useful for scripting of output

files. Total Holds the number of mailpieces

in a Job. Only useful for

scripting of output files.

Methods

Name Description PadStringLeft(String1, Integer2, Char3)

Takes string (1) and adds

character (3) to the left of string

(1) until the length of the

returned string is a certain

length (2). If the incoming

string (1) is longer or the same

length as the padded length (2),

Page 83: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 83 of 137

no padding or trimming is carried

out. The returned value is a

string. PadStringRight(String1, Integer2, Char3)

Takes string (1) and adds

character (3) to the right of

string (1) until the length of the

returned string is a certain

length (2). If the incoming

string (1) is longer or the same

length as the padded length (2),

no padding or trimming is carried

out. The returned value is a

string. LimitStringLeft(String1, Integer2) Takes string (1) and removes

characters from the left of string

(1) until the length of the

returned string is a certain

length (2). If the incoming

string (1) is shorter or the same

length as the padded length (2),

there is no adding of characters

to the returned value to make it

match length (2). The returned

value is a string. LimitStringRight(String1, Integer2) Takes string (1) and removes

characters from the right of

string (1) until the length of the

returned string is a certain

length (2). If the incoming

string (1) is shorter or the same

length as the padded length (2),

there is no adding of characters

to the returned value to make it

match length (2). The returned

value is a string. ToExternalDate(String1, String2) Takes string (1) which shall be a

date string in ISO format “YYYY-

MM-DD hh:mm:ss” and converts

it to customer date format using

the format described in string (2)

using standard date formats plus

other characters (e.g. “MM-Test-

DDYY”). The returned value is a

string. ToInternalDate(String1, String2)

Takes string (1) which shall be a

date string in customer format

and converts it to ISO date

format (“YYYY-MM-DD

hh:mm:ss”) using the format

described in string (2) using

standard date formats plus other

characters (e.g. “MM-Test-

DDYY”). The returned value is a

string. ConvertDispositionToPBCode(String1) Takes string(1), which is

expected to be an AIMS

Disposition Code, and converts it

to a PB limited Disposition Code.

The returned value is a string.

Page 84: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 84 of 137

ConvertDispositionToPBText(String1) Takes string(1), which is

expected to be an AIMS

Disposition Code, and converts it

to a PB limited Disposition Text

description. The returned value

is a string.

Page 85: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 85 of 137

Machine Data The following data is available from the Neopost Folder Inserters during their processing of mailpieces. This data can be recorded in a

fixed format as originally received from the Neopost Folder Inserter, or it can be modified using VB.Net Scripting within the Job

Configuration Wizard to enable this data to conform to outside systems.

Parameter Description Length Possible Values

Auto End (Result) 1 0 = False

1 = True

Control Mode (Result) 1 0 = Off

1 = Statistics

2 = Verification

3 = File Based (Machine Control)

4 = Reserved

5 = Audit

6 = Hand scan

7 = Reserved

8 = Loss of Communications

Cost Centre (Result) 20 User or Franker Input

Disposition Code (Result) Unprocessed – Mailpiece

has not been seen on

output of the folder

inserter.

Failed – Mailpiece has

been removed as an

error document from the

folder inserter.

Oversized – Mailpiece has

been diverted as it

2 Enhanced Dispositions Standard Dispositions 00 = Unread 00 = Unread

01 = In Process 01 = In Process

10 = Failed

11 = Oversized

12 = Voided

10 = Failed

20 = Commanded Divert

21 = Late Divert

20 = Diverted

30 = Hand Mailed From Unread

31 = Hand Mailed From Failed

32 = Hand Mailed From Oversized 33 = Hand Mailed From Voided

35 = Full Format Hand Mailed From Unread

36 = Full Format Hand Mailed From Failed

37 = Full Format Hand Mailed From Oversized

38 = Full Format Hand Mailed From Voided

30 = Hand Mailed

Page 86: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 86 of 137

exceeds the maximum

number of pages set on

the folder inserter.

Commanded Divert –

Mailpiece has been

diverted due to label

instruction either from

printed page or AIMS

DataStation.

Late Divert – Mailpiece

has been diverted due to

a post printing label

instruction from the AIMS

DataStation.

Hand Mailed From… –

Mailpiece has been made

good by hand. Previously

the mailpiece was in the

state of Unprocessed,

Failed, Oversized, or

Voided.

Completed… – Mailpiece

has been made

enveloped by folder

inserter. The mailpiece

has gone to either the

Stack, Bin 1, Bin 2, or Bin

3.

Full Format… – Mailpiece

has gone into a Full

Format envelope.

40 = Completed Stack

41 = Completed Bin 1

42 = Completed Bin 2

43 = Completed Bin 3 44 = Completed Bin 4

45 = Full Format Completed Stack

46 = Full Format Completed Bin 1

47 = Full Format Completed Bin 2

48 = Full Format Completed Bin 3

49 = Full Format Completed Bin 4

40 = Completed

Page 87: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 87 of 137

Envelope Divert 1 (Result) 1 0 = False

1 = True

Envelope Divert 2 (Result) 1 0 = False

1 = True

Envelope Divert 3 (Result) 1 0 = False

1 = True

Envelope Size (Result) 1 1 = Normal

2 = Full Format

Feeder 1 Count (Result) 2 00 – 99

Feeder 2 Count (Result) 2 00 – 99

Feeder 3 Count (Result) 2 00 – 99

Feeder 4 Count (Result) 2 00 – 99

Feeder 5 Count (Result) 2 00 – 99

Feeder 6 Count (Result) 2 00 – 99

Feeder 7 Count (Result) 2 00 – 99

Feeder 8 Count (Result) 2 00 – 99

Feeder 9 Count (Result) 2 00 – 99

Feeder 10 Count (Result) 2 00 – 99

Feeder 11 Count (Result) 2 00 – 99

Feeder 12 Count (Result) 2 00 – 99

Feeder 13 Count (Result) 2 00 – 99

Feeder 14 Count (Result) 2 00 – 99

Feeder 15 Count (Result) 2 00 – 99

Feeder 16 Count (Result) 2 00 – 99

Feeder 1 Label (Result) 10 Label read from Feeder

Feeder 2 Label (Result) 10 Label read from Feeder

Feeder 3 Label (Result) 10 Label read from Feeder

Feeder 4 Label (Result) 10 Label read from Feeder

Feeder 5 Label (Result) 10 Label read from Feeder

Feeder 6 Label (Result) 10 Label read from Feeder

Feeder 7 Label (Result) 10 Label read from Feeder

Feeder 8 Label (Result) 10 Label read from Feeder

Feeder 9 Label (Result) 10 Label read from Feeder

Feeder 10 Label (Result) 10 Label read from Feeder

Feeder 11 Label (Result) 10 Label read from Feeder

Page 88: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 88 of 137

Feeder 12 Label (Result) 10 Label read from Feeder

Feeder 13 Label (Result) 10 Label read from Feeder

Feeder 14 Label (Result) 10 Label read from Feeder

Feeder 15 Label (Result) 10 Label read from Feeder

Feeder 16 Label (Result) 10 Label read from Feeder

Filled Envelopes (Result) 1 0 = False

1 = True

Form Divert 1 (Result) 1 0 = False

1 = True

Form Divert 2 (Result) 1 0 = False

1 = True

Franked (Result) 1 0 = False

1 = True

Full Format Pack Divert (Result) 1 0 = False

1 = True

Halt (Result) 1 0 = False

1 = True

IMOS Destination (Result) 1 0 = Envelope conveyor/Vertical stacker

1 = Envelope Divert 1

2 = Envelope Divert 2

3 = Envelope Divert 3

4 = Envelope Divert 4

8 = Hand Processed - Mailed

9 = Removal

IMOS Error Code (Result) IMOS error codes 4 0000 - 9999

IMOS General Function (Result) 3 000 – 255

IMOS Job Name (Result) 20 Job Name used on IMOS

IMOS Mailpiece Status (Result) 1 0 = Valid output

1 = Document automatically removed at sheet divert 1

2 = Document automatically removed at sheet divert 2

3 = Document removed after collation

4 = Error to sheet divert 1

5 = Error to sheet divert 2

6 = Envelope Divert

7 = Documents to FFPD (without FFI)

8 = Hand Processed – Removal

Page 89: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 89 of 137

IMOS Mailpiece Weight (Result) To 0.1 grams accuracy 5 00000 – 99999

IMOS Mailpiece Weight Group (Result) 1 0 = None

1 = Group 1 (weight or OMR group)

2 = Group 2 (weight or OMR group)

3 = Group 3 (weight or OMR group)

4 = Group 4 (weight or OMR group)

IMOS Output Function (Result) 3 000 – 255

IMOS Station Removed (Result) 2 00-16

Ink Mark 1 / Jog (Result) 1 0 = False

1 = True

Ink Mark 2 / Pulse Conveyor (Result) 1 0 = False

1 = True

Intermediate Fold (Result) 1 0 = False

1 = True

Job Id (Result) 10 A-Z 0-9

Machine (Result) 20 A-Z 0-9

Machine Operator (Result) 20 A-Z 0-9

Mailpiece Id (Result) 20 Mailpiece Id as recorded within AIMS. Useful for Audit

and Statistic Jobs

No Seal (Result) 1 0 = False

1 = True

Postage Value (Result) 6 00.000 – 99.999

Prime Documents (Result) 3 000 – 999

Removal (Result) 1 0 = False

1 = True

Removal Type (Result) 1 0 = No Error

1 = General Error

2 = No Read

3 = Possible Corrupt Group

4 = Too Many Pages

5 = Too Few Pages

6 = Sequence Error

7 = Late Divert

Status Code (Result) 2 00 = Unread

01 = Bad (Future Bad Input)

02 = Bad (Future Bad Output First)

Page 90: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 90 of 137

03 = Bad (Future Bad Output Second)

04 = Bad (Future Bad General)

05 = Good

Timestamp (Result) 19 YYYY-MM-DD hh:mm:ss

Total Form Count (Result) 3 000 – 999

Page 91: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 91 of 137

Administration Tab

User Accounts Neopost’s Automated Insertion Management System (AIMS) provides user accounts via

its own username and password database, Windows / Active Directory User

authentication, or Windows / Active Directory Group authentication. The decision as to

the type of user accounts that AIMS should allow can be made during installation. This

can be changed once AIMS is running by going to the “System Settings” page under the

“Administration” tab. Only one type of user authentication can be active at any one

time.

AIMS Authentication

During initial installation an account called “Administrator” shall be created. This

account will have administration and login permissions and can be used to create other

AIMS User accounts. On first login you shall be asked to create a password. Once

logged in the administrator should go to the “Administration” tab and select the “User

Accounts” option. Once the User Accounts page has loaded, click the “Add User

Account” button. In the Username text field enter the new username and then select

the permissions that the user should have. A password should then be selected

together with the password rules that must be adhered to. AIMS Users will be able to

change their own passwords at any point once they have logged in, but must also

adhere to these set password rules.

An AIMS User with the permission “Is Administrator” can change any AIMS User’s

permissions at any point in the future.

To prevent an AIMS User from logging into AIMS the permission “Allow Login” should be

changed from a tick (Yes) to a cross (No) and the selection then saved.

It should be noted that usernames and passwords are sent in the clear between

browsers and the AIMS DataStation.

Windows / Active Directory User Authentication

During initial installation an account called “Administrator” shall be created. This

account will have administration and login permissions and can be used to create other

AIMS User accounts with Windows / Active Directory User authentication. The

Administrator account shall only work whilst there are no other accounts registered. On

first login you shall be taken straight into AIMS. Once logged in the administrator

should go to the “Administration” tab and select the “User Accounts” option. Once the

User Accounts page has loaded, click the “Add User Account” button. In the Username

text field enter the new username in the format “Domain\Username” and then select the

permissions that the user should have. The “Domain\Username” should correspond to a

valid Windows / Active Directory user on an accessible domain. A password cannot be

set within AIMS as the authentication of this account will be carried out by Windows /

Active Directory.

An AIMS User with the permission “Is Administrator” can change any AIMS User’s

permissions at any point in the future.

To prevent an AIMS User from logging into AIMS the permission “Allow Login” should be

changed from a tick (Yes) to a cross (No) and the selection then saved.

Page 92: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 92 of 137

Authentication is handled by Windows / Active Directory so usernames and passwords

are not sent in the clear between browsers and the AIMS DataStation.

Windows / Active Directory Group Authentication

Windows / Active Directory Groups are used to control access to AIMS. For a Windows /

Active Directory account to gain access to AIMS they must be a member of specific

groups. During initial installation an account called “Administrator” shall be created.

This account will have administration and login permissions and can be used to assign

the Windows / Active Directory groups used to hold AIMS User accounts with Windows /

Active Directory Group authentication. This Administrator account shall only work whilst

there are no other accounts registered. On first login you shall be taken straight into

AIMS. Once logged in the administrator should go to the “Administration” tab and select

the “System Settings” option. The groups can be set on the “System Settings” page of

the “Administration” tab. The groups directly correspond to permissions within AIMS.

When adding the groups to the “System Settings” page, please ensure that any Domain

or Computer Name information is added in the form “domain\group name”.

Is Administrator

Allow Reprint Job

Allow Complete Job

Allow Delete Job

Allow Reset Job

Allow Create Reports

Allow Create Alerts

Allow Mark Late Diverts

Allow Mark Hand Mailed

Allow Mark Removed

Allow Search

Allow Login

At least one Windows / Active Directory user account must be assigned to the “Is

Administrator” group to allow for future administrative tasks.

In this mode AIMS User’s cannot be added from within AIMS.

To prevent an AIMS User from logging into AIMS the Windows / Active Directory account

should be removed from the “Allow Login” Windows / Active Directory group.

Authentication is handled by Windows / Active Directory so usernames and passwords

are not sent in the clear between browsers and the AIMS DataStation.

Changing Between Authentication Methods

To change between Authentication Methods is to run the AIMS installer from “Control

Panel > Programs and Features” and select to “Modify Available Options”. You will then

be presented with a choice of the Authentication Methods to choose. Continue through

the Installation Wizard until the new settings are installed. You will need to restart the

computer after these changes.

Page 93: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 93 of 137

Machines Neopost’s Automated Insertion Management System (AIMS) provides a list of machines

that are currently or have previously been connected to the AIMS DataStation. This can

be viewed via the AIMS front-end by going to the “Machines” page under the

“Administration” tab. Extra details regarding the machines can be seen or saved by

clicking on the relevant machine name on the list. The Machine Detail page allows the

storage of support details.

Page 94: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 94 of 137

Change Password Neopost’s Automated Insertion Management System (AIMS) allows uses to change their

own password when AIMS Authentication is in use. This can be used by the

Administrator to change their own password in addition to using the “User Accounts”

screen to change either their own or other Users’ passwords.

Page 95: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 95 of 137

Alerts Neopost’s Automated Insertion Management System (AIMS) provides alerts functionality

through the “Alerts” page under the “Administration” tab. To add an alert the AIMS

User clicks on the “Add Alert” button. They are then presented with a number of

options. Each alert should be named and an alert type must be chosen. The visibility of

Alerts can be set so that they are visible to the owner of the alert or visible to all. Alerts

are displayed on the Dashboard page. Only an Alert’s owner or an administrator can

edit an individual Alert.

Alerts can be set to show the following:

Job 100% Finished

Job 100% Processed

Production Output Above

Production Output Below

Connected

Disconnected

Job Imported

Job Import Failure

Job Sent for Reprint

Job Reprint Failure

Job Closed

Job Close Failure

Backup Success

Backup Failure

Restore Success

Restore Failure

Job Reset

Job Deleted

Page 96: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 96 of 137

Command Queue Neopost’s Automated Insertion Management System (AIMS) provides a list of all major

commands that are requested and executed, together with their success status.

Command Queue functionality is available through the “Command Queue” page under

the “Administration” tab. The most recently requested command shall be shown at the

top of the list on the first screen of the Command Queue page. More detail regarding

the command, such as the AIMS User that requested it and its success or error,

including error message, can be found by clicking on the command within the command

queue list.

Page 97: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 97 of 137

Configurations See separate “Configurations” section of this document.

Page 98: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 98 of 137

Backup & Restore Neopost’s Automated Insertion Management System (AIMS) provides Backup & Restore

functionality and this is available by going to the “Backup & Restore” page under the

“Administration” tab. The Administrator can choose to create one or more backup

schedules.

Access to AIMS is restricted during a Backup or a Restore.

Any attempt to connect a folder inserter to AIMS during a Backup or a Restore

will result in a failed connection.

Backup Schedules

To add a backup schedule the AIMS User clicks on the “Add Schedule” button. They are

then presented with a number of options.

Each backup schedule should be named and a backup location must be chosen. The

backup location must be accessible to the Windows / Active Directory account used to

run the AIMS Services. There is an option to automatically expire (delete) backups after

a set number of days. This can be useful to ensure storage is not filled up with to many

backups.

A backup schedule can be set to manual, in which case it has to be run each time by an

AIMS administrator, or the backup schedule can be set to automatically run on a daily,

weekly, or monthly basis. Where the backup schedule is set to automatically run, the

appropriate hour and minute, day or the week, or day of the month needs to also be

set.

The backup schedule will then need to be saved. At any point in the future the backup

schedule’s expiry days, period, and appropriate timings can be changed. The location of

the backup cannot be changed, however a backup schedule can be deleted and a new

backup schedule created.

Once a backup has been saved it can be tested by clicking the “Backup” button. The

first time a backup is run, either through a manual click of the “Backup” button or

through automatic running, may take some time. Subsequent backups run using this

schedule should take less time, as the backups are incremental in nature.

Folders will be created at the backup location to store “Stale”, “Closed”, and “Archived”

Job databases. A folder will also be created for each backup date and time containing

the currently active Jobs and the two controlling databases. Backup files are

compressed to reduce storage requirements.

Database backup files will be removed from the appropriate “Stale”, “Closed”, and

“Archived” folders once they are no longer referenced by any database backup file

stored in the dated folders if an expiry date has been set for all backup schedules.

The progress of an instigated backup can be checked by looking at the Command

Queue. Backups are queued until all folder inserters have disconnected from AIMS.

This may result in the “Backup” or “Scheduled Backup” command staying in the

“Pending” state on the Command Queue for some time. Once all folder inserters have

disconnected the command should change to “Running” and then finally “Complete”.

Page 99: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 99 of 137

Restore Backup

To restore a backup the AIMS User clicks on the “View Backups” button. They are then

presented with list of previous backups.

Each backup that has been carried out will be listed here unless it has been deleted by

an AIMS administrator or through use of the backup schedule’s expiry setting. The

backup will be listed showing the Schedule Name, the Owner, the date and time the

Backup was created, and the Backup Status. Individual backups can be deleted from

this list. This will result in their permanent deletion.

Once the AIMS user chooses the backup that they are interested in restoring, they

should click on the appropriate backup. Details about this backup are then presented

including the backup status, backup location, and the backup log showing which

databases are available from this backup. To restore this backup click the “Restore”

button.

The AIMS user is asked to confirm the action of restoring twice. It is recommended that

the AIMS user carry out a backup prior to doing the restore. In some circumstances

AIMS will carry out an automatic backup however a restore will continue to be run even

if the backup fails.

During the restore process a page is shown detailing the current state of the restore.

These states are Checking Databases, Restore Started, Restore Completed. Once the

restore has completed a page shall be displayed showing whether the restore was

successful or whether the restore failed. A log showing the outcome of the restore is

also displayed.

Page 100: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 100 of 137

Logs Neopost’s Automated Insertion Management System (AIMS) provides easy access to the

log files generating using processing. Logs are available by clicking on the “Logs”

button under the “Administration” tab.

Clicking on the “Logs” button downloads a zip file containing the previous five calendar

days’ worth of logs. If there are less than five calendar days’ worth of logs then only

the available logs will be contained within the zip file.

Page 101: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 101 of 137

System Settings Neopost’s Automated Insertion Management System (AIMS) allows for the modifying of

system wide settings by going to the “System Settings” page under the “Administration”

tab. The AIMS change log, showing development changes between different versions of

AIMS, and licensing information can also be found on the System Settings page.

Settings

Timers

This section of the System Settings page allows the modifying of the Job Progress File,

and the Run Commands timers. Timer values are is seconds. If modifications are made

to these timers then the changes will not be implemented until the Neopost Services are

restarted.

The Job Progress File timer specifies the number of seconds between each write to the

Job Progress File (JPF).

The Run Commands timer specifies the number of seconds between each run of any

outstanding commands. An example of an outstanding command would be the

execution of a “Mark as Hand Mailed” request. Decreasing this timer could increase the

responsiveness of the AIMS front end but could at the same time cause a strain on the

AIMS DataStation hardware.

Display

Allows the customising of the following display options:

Filter by Operator

Show Customer Id

Show SLA

Show Full Format

Sort by Latest Job

Sort by Latest Mailpiece

Show Job Id (Job Name)

Delete Alerts after Days

Login Warning Message

Default Language

Multi-Language

Login Authentication

See the “Windows / Active Directory Group Authentication” section of this document.

Services

A list of the three Windows Services use to control AIMS. A traffic light display is used

to show the current status of each Windows Service.

Licensing

The licensing section of this page shows the modules that are currently licensed on this

installation. Initial installations are received with a trial period. During this trial period

the product activation code will need to be input into the “Activation Key” text field.

Page 102: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 102 of 137

Disaster Recovery Failover Plan Where the operation of the Neopost Folder Inserter is critical to the working operation of

a mailroom it is advised that a Disaster Recovery Failover Plan is available.

Descriptions of the three main Disaster Recovery Failover Plans are detailed on the

following pages. These pages can be amended to show actual configuration data.

Where the Neopost AIMS DataStation is required to load or save ADF files to another

network location these settings can be changed in the Job Configuration module on the

AIMS DataStation. Instructions on changing these settings are below in the section

titled “Job Configuration Change”.

It is advised that currently running or loaded Jobs are trashed

when a Disaster Recover situation is instigated.

Page 103: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 103 of 137

Control Marks on Document Neopost AIMS can operate in a mode where the instructions on how to handle the

mailpiece within the Neopost Inserter are sent from the AIMS DataStation to the

inserter in real-time, as the mailpiece is processed. This has the advantage that these

instructions can be changed, for example to add a late divert, after the printing on the

mailpiece, but before the mailpiece is processed through the inserter. However the

disadvantage of this mode is that the inserter will not know what to do with a mailpiece

if communication with the AIMS DataStation is lost.

To counter this communication loss, control marks with processing instructions should

be added to the mailpiece barcode or 2D Data Matrix. During normal operation the

Neopost Folder Inserter will use the instructions sent from the AIMS DataStation,

however with a simple switch of Job on the IMOS software it can revert to reading the

control marks on the mailpiece.

Is this Disaster Recovery Failover Plan in operation? Yes No

Operation Mode IMOS Job Name

Normal

Disaster Recovery

Page 104: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 104 of 137

Disaster Recovery AIMS DataStation Where the Neopost AIMS DataStation has failed, for example there has been a physical

hardware fault, it can be useful to have a Disaster Recovery AIMS DataStation to

failover to. This Disaster Recovery AIMS DataStation should already be setup with the

same operating system, software installation of Neopost AIMS, and User Permissions as

the Live AIMS DataStation. The Job Configurations loaded onto the Live AIMS

DataStation should also be loaded onto the Disaster Recovery AIMS DataStation

however if these Job Configurations are set to automatically import jobs, this mode

should be switched off. This is to ensure the Disaster Recovery AIMS DataStation does

not automatically import jobs when it is not intended to work as the Live AIMS

DataStation.

The Neopost Folder Inserter can be pointed at the Disaster Recovery AIMS DataStation

instead of the Live AIMS DataStation with a simple change of IP Address on the Network

Devices screen within IMOS.

It is important to remember to change the web address used to view the AIMS

application when switching to the Disaster Recovery AIMS DataStation.

Is this Disaster Recovery Failover Plan in operation? Yes No

IMOS Changes

Operation Mode IP Address (Port)

Normal

Disaster Recovery

Web Browser Changes

Operation Mode AIMS Web Address

Normal

Disaster Recovery

Detailed Instructions

The following instructions should be followed to change the connection details on the

Neopost Folder Inserter from the Live AIMS DataStation to the Disaster Recovery AIMS

DataStation.

Step 1: Within IMOS click on the “Menu” button.

Page 105: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 105 of 137

Page 106: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 106 of 137

Step 2: Click on the “Engineering” button.

Step 3: Click on the “Network Devices” button.

Page 107: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 107 of 137

Step 4: Click on the “IP Address” button and enter the new IP Address. Click

on the “Port Number” button and enter the new Port Number. This needs to be

done for both the Input Channel and the Output Channel. Remember these are

the VLAN / Dedicated LAN IP Address and Port Numbers.

Step 5: Click the “OK” button, click the “Run Screen” button, and close down

IMOS. Reopen IMOS and use as normal.

It is very important to fully close IMOS and then reopen IMOS after changing the

network device settings.

Page 108: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 108 of 137

Job Configuration Change The location of ADF files to be loaded onto or saved from the Neopost AIMS DataStation

may need to be changed in a Disaster Recovery scenario where these locations have

become inaccessible.

To change where Neopost AIMS looks the User recovering the solution needs to log into

Neopost AIMS as an Administrator. They must then click on the “Administration” tab,

click on the “Job Configuration” button, click on the appropriate Job Configuration. Once

loaded the Directories should be changed where necessary.

Is this Disaster Recovery Failover Plan in operation? Yes No

Job Allocation File Directory Changes

Operation Mode Directory

Normal

Disaster Recovery

Job Progress File Directory Changes

Operation Mode Directory

Normal

Disaster Recovery

Job Complete File Directory Changes

Operation Mode Directory

Normal

Disaster Recovery

Job Reprint File Directory Changes

Operation Mode Directory

Normal

Disaster Recovery

Job Good File Directory Changes

Operation Mode Directory

Normal

Disaster Recovery

Job Missed File Directory Changes

Operation Mode Directory

Normal

Disaster Recovery

Successful Import Directory Changes

Operation Mode Directory

Normal

Disaster Recovery

Error Import Directory

Operation Mode Directory

Page 109: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 109 of 137

Normal

Disaster Recovery

Detailed Instructions

The following instructions should be followed to change the locations on the Neopost

AIMS DataStation for retrieving or saving ADF files.

Step 1: Within AIMS click on the “Administration” button.

Page 110: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 110 of 137

Step 2: Click on the “Job Configuration” button.

Step 3: Click on appropriate Job Configuration.

Page 111: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 111 of 137

Step 4: Edit the Directory text box on the Job Allocation File page.

Step 5: Edit the Directory text box on the Job Progress File page.

Page 112: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 112 of 137

Step 6: Edit the Directory text box on the Job Complete File page.

Step 7: Edit the Directory text box on the Job Reprint File page.

Page 113: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 113 of 137

Step 8: Edit the Directory text box on the Job Good File page.

Step 9: Edit the Directory text box on the Job Missed File page.

Step 10: Edit the Successful Import Directory and Error Import Directory text

boxs on the General Settings page. Then click the “Save” button.

Page 114: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 114 of 137

Settings will take effect immediately.

Page 115: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 115 of 137

Diagnosing Issues

Possible Errors

Image (or PDF) fail to display on webpage

Check whether IIS 6.0 is using ISAPI Filter “UrlScan” by opening IIS and right clicking

on “Web Sites”, selecting “Properties”, and then going to the “ISAPI Filters” tab. If

UrlScan is used then it may be allowing some files to be processed or denying some files

from being processed. UrlScan is usually installed at the following location and can be

modified by editing the “urlscan.ini” file.

C:\WINDOWS\system32\inetsrv\urlscan\

Most images are “.png” but there are also some “.gif” and there are also “.pdf” files.

“ASP.NET Ajax client-side framework failed to load.”

Check whether IIS 6.0 is using ISAPI Filter “UrlScan” by opening IIS and right clicking

on “Web Sites”, selecting “Properties”, and then going to the “ISAPI Filters” tab. If

UrlScan is used then it may be allowing some files to be processed or denying some files

from being processed. UrlScan is usually installed at the following location and can be

modified by editing the “urlscan.ini” file.

C:\WINDOWS\system32\inetsrv\urlscan\

The extension “.axd” needs to be allowed.

Cannot login to AIMS with any user account

This can occur if the user instance running the IIS does not have permissions to access

the database. Open IIS and go to “Application Pools > AIMS”. Click on “Advanced

Settings” and check the “Identity” is either “ApplicationPoolIdentity” or

“NetworkService”. If it is not then correct this and then restart the AIMS DataStation.

Username is blank when changed to Windows Authentication

The browser is not sending account credentials to IIS. Check the browser settings.

Installation fails during installation of SQL Server Express 2005 SP4

Page 116: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 116 of 137

This error can occur during setup if the User account used to run the setup does not

have the necessary permissions. The User account must have Local Administrator

rights. There can still be a problem caused by operating systems that use User Access

Control (UAC). UAC may be enabled on Windows 7 and Windows Server 2008 operating

systems. UAC prompts the user, including users running under Local Administrator

rights, when changes are made to the AIMS DataStation. As parts of the AIMS

installation, including the SQL Server Express 2005 SP4 section, are done “silently” the

UAC prompt is not visible. As the UAC prompt is not visible it cannot be accepted by the

User, and is declined instead. This results in a failed installation.

To resolve this issue, UAC can be turned off. Go to “Control Panel > User Accounts >

Change User Account Control Settings” and change the level to the lowest level

described as “Never notify”.

If you are not able to turn off UAC then the SQL Server Express 2005 SP4 installation

can be carried out using non-silent installation by running the SQL Server Express 2005

SP4 installation file (“SQLEXPR.exe” found on the installation CDROM).

Right click on “SQLEXPR.exe” and select “Run as administrator”.

The SQL Server Express 2005 SP4 installer will initially extract its required files. It will

then prompt you to accept the licensing terms and conditions. Tick the box and click

the “Next” button.

Page 117: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 117 of 137

Prerequisite will now be installed. Once complete click the “Next” button.

Page 118: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 118 of 137

The AIMS DataStation will be scanned and the above screen will be displayed. Click the

“Next” button.

Page 119: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 119 of 137

The system is checked for problems. Click the “Next” button.

Page 120: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 120 of 137

Enter your details, then untick the “Hide advanced configuration options”. Click the

“Next” button.

Page 121: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 121 of 137

Ensure “Database Services” are selected and then click the “Next” button.

Page 122: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 122 of 137

Select “Named instance” and enter the text “AIMS”. Then click the “Next” button.

Page 123: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 123 of 137

Select “Use the built-in System account” and then select “Network service”. Ensure

“SQL Server” is ticked under the section called “Start services at the end of setup”.

Click the “Next” button.

Page 124: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 124 of 137

Select “Windows Authentication Mode”. Click the “Next” button.

Page 125: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 125 of 137

Select “Collation designator and sort order:” and select “Latin 1_General”. Click the

“Next” button.

Page 126: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 126 of 137

Tick “Enable User Instances” and tick “Add user to the SQL Server Administrator role”.

Click the “Next” button.

Page 127: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 127 of 137

Ensure options are not ticked. Click the “Next” button.

Page 128: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 128 of 137

Click the “Install” button to start the installation according to your settings.

Page 129: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 129 of 137

Setup will progress. Once the “Next” button becomes available click the “Next” button.

Page 130: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 130 of 137

Setup of SQL Server Express 2005 SP4 is now complete. Click the “Finish” button and

restart the AIMS DataStation. Once the AIMS DataStation has restarted run the AIMS

installation again. This time it will find the “AIMS” instance of SQL Server Express 2005

SP4 and continue with the AIMS installation.

Error installing SQL Server Express 2005 SP4 relating to InprocServer

It is possible that an error will present itself will the following message (or similar).

This error is caused by confusion in the Windows Registry possibly caused by a previous

attempt at installing SQL Server Express 2005 SP4 or an application using its

components. The error can also be found on some systems after the January 2012

Windows Updates have been applied.

Page 131: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 131 of 137

Fixing this error required making changes to the Windows Registry and should only be

attempted by someone who is confident to do this.

Click “Abort” on the error message shown above and ensure that the installer has

closed.

Open the registry editor and right click on “HKEY_LOCAL_MACHINE > SOFTWARE”.

Select “Permissions” and click “Advanced”.

On the “Owners” tab, select the “Administrators” group and then tick the “Replace

owner on subcontainers and objects” check box.

Click “Apply”

An error or warning message may be displayed informing that permissions could not be

applied to all subcontainers and object. This is likely to be ok and the steps should

continue.

On the “Permissions” tab tick the “Replace permission entries on all child objects with

entries shown here that apply to child objects” or “Replace all child object permissions

with inheritable permissions from this object” check box.

Click ok.

Restart the PC.

It should now be possible to install SQL Server Express 2005 SP4 using the SQL Server

Express 2005 SP4 installer.

If the message appears again click the “Ignore” button. This button may need to be

clicked a number of times (approximately 16 times).

Problem Importing or Exporting Files

This may present itself with the inability to see or import a Job, or the Job may import

without its mail pieces, or in another way.

This issue can occur if the permissions on the directory where AIMS is importing a Job

from or exporting a Job to are not correct.

AIMS should have permission to view a listing of the directory. AIMS should also be

able to read the content of files within the directory, delete, move, and write files to the

directory.

Right click on the directory that files with either be imported from or exported to. Select

“Permissions” and click on the “Security” tab. Click the “Edit” button and add the Local

or Domain user that will be used to run the AIMS Services. Ensure this user has “Full

Control”, “Modify”, “Read & Execute”, “List Folder Contents”, “Read”, “Write”

permissions ticked. Then click “Ok”.

Then select the User in the list of “Group or User Names” and click the “Advanced”

button. Now find the User in the list of “Permission Entries” and click the “Change

Permissions” button. Select the User from the new list of “Permission Entries” and click

the “Edit” button. Ensure the “Apply To” option is set for “The Folder, Subfolders, and

Files”. Ensure all the permissions have “Allow” ticked. Click the “Ok” button.

Click “Ok” until all the dialog boxes are closed.

Ensure these permissions are inherited downwards.

Check to make sure that the file to be imported is not marked as Read Only. Files

marked as Read Only will not be imported as AIMS performs a check on the file prior to

importing to make sure that it is not locked to another process.

Page 132: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 132 of 137

IMOS appears to be setup correctly but AIMS will not respond to connections

The NeopostIO and NeopostEnterprise Windows Services may need to be restarted.

Please note that restarting these Windows Services will knock off other Neopost Folder

Inserters that may be successfully connecting to the AIMS DataStation.

The NetworkTestTool (Simulator) does not connect to AIMS DataStation

Check that the Windows User running the NetworkTestTool has full permissions to the

“C:\Program Files (x86)\AIMS\TestTool” directory and “C:\Program Files

(x86)\AIMS\FileDrop” directory (assuming the installation directory as “C:\Program Files

(x86)\AIMS\”. These directories are required for the creation of test files.

Check that the IP Address and Port referenced in the NetworkTestTool match the IP

Address and Port used on the AIMS DataStation.

Check that the FileDrop location matches the location set in the Simulator Configuration

file.

Object reference not set to an instance of an object

If this error occurs during the import or export processes then the permissions of

directories and files should be checked. It is possible that the Windows Account used to

run the NeopostIO Service does not have the correct permissions for the directory or file

in question.

NeopostIO Service Starts and then immediately stops

This could be due to a conflict in the use of TCP Ports on the AIMS DataStation. To

check whether any other process is using the assigned port carry out the following

instructions. By default AIMS uses Ports 2002 and 2003.

Open a command prompt window. From Start / Run enter: cmd

From the command prompt enter: netstat -ano

Note the PID (process identifier) associated with the ports you are concerned about.

(Also note the Local Address, Foreign Address, Protocol and State.)

Then do ctrl-alt-del to bring up the Windows Task Manager.

In Windows Task Manager, select the Processes tab.

Look for the PID you noted when you did the netstat in step (c). Look to left to the

“image name” and that tells you which process has that PID.

- If you don’t see a PID column, click on View / Select Columns. Make sure PID is

selected. Click OK.

- Make sure “Show processes from all users” is selected.

If there is a conflict the port can be changed by going to the NeopostIO.exe.config file

and changing the “PortNumber” or “InternalPortNumber” key. If the

“InternalPortNumber” key is changed then you will also have to go to the “IVSMain”

Page 133: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 133 of 137

database and to the “Settings” table. Change the record with a “SettingName” of

“PortID” to the new “InternalPortNumber”.

Machine Not Connecting to AIMS

This could be due to a network issue or a license issue.

Network Issue

Check that the AIMS DataStation is available on the network by pinging the AIMS

DataStation from the folder inserter.

License Issue

Check the correct number of machines licensed by checking the System Settings page

on the AIMS front-end. If this is wrong then contact IPSS to clarify license installed. If

this is correct then Stop and Start the Services in the following order:

Stop NeopostIO

Stop NeopostEnterprise

Stop NeopostAudit

Start NeopostIO

Wait 5 seconds

Start NeopostEnterprise

Start NeopostAudit

Database Maintenance Maintenance routines are run each night between midnight and 1am. These routines

have been designed to allow continued use of the folder inserter.

It is recommended that regular Backups be taken using the Backup and Restore

module. Folder inserters will not be able to connect to AIMS during a Backup or a

Restore. A Backup will be delayed if there is already a connection in place when a

backup is scheduled to take place. More information about the Backup and Restore

module can be found in the Backup and Restore section of this document.

When a Job is deleted it is automatically added to a temporary archive as a “.arc” file.

The “.arc” file is a standard SQL Server backup file that has also gone through GZIP

compression. The Job will be permanently deleted from this temporary archive after 35

days. The purpose of this temporary archive is to allow for recovery from a mistaken

deletion in extreme circumstances. Recovery of a deleted Job is not a simple process

and will require Support.

Logs Logs showing communication to and from AIMS can be found in the following directory

“C:\Program Files (x86)\AIMS\Services\Logs” where “C:\Program Files (x86)\AIMS\” is

the installation directory.

Log files are automatically deleted after 90 days.

Some other log entries are added to the Windows Application Log and can be viewed

using Event Viewer.

Logs can also be viewed by an Administrator going to the Administrator tab within AIMS

and clicking on the “Logs” button. This will download the last five calendar days’ worth

of log in a zip file.

Page 134: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 134 of 137

The Command Queue, viewable from within AIMS on the Administration tab, shows a list

of commands that have been, or are to be, executed. When an error occurs, the error

text can be viewed.

Page 135: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 135 of 137

Useful Information

Creating a Shared Directory (Workgroup to Domain) When connecting the AIMS PC to the customer network it is important to not join their

domain as this may add a number of automatic software updates on to the AIMS PC

such as Anti-Virus.

If the shared directory is to be on a PC other that the one that AIMS has been installed

on then it is recommended that the AIMS installation be modified using the local account

that will be created in the following instructions. In this case the shared directory

should be created before installing AIMS.

To create a shared directory between a PC on a Workgroup and another PC on a Domain

without the prompting for passwords the following instructions should be carried out.

Create a local user account on both the PC in the Workgroup and the PC in the

domain.

Choose the location for the shared directory. This shared directory can be on

either the PC in the Workgroup on the PC in the domain.

Create the directory and then right click on the directory and select “Properties”.

Click on the “Sharing” tab and then click “Advance Sharing”. This will bring up a

form where you should select to share this folder and enter the share name. You

should then enter the accounts that you wish to have access to this share. Add

the local user account that you created earlier and ensure it has “Full Control”

selected. Apply this.

Go to the “Security” tab and add the local user account that you created earlier

and ensure it has “Full Control” selected. Apply this.

Install AIMS (or modify AIMS installation) using the local account. This enables

the AIMS Services to connect across the network to the other PC using the local

account settings. This works because the local account settings on the AIMS PC

match the local account settings on the remote PC. To modify the AIMS

installation, go to “Control Panel > Programs and Features”, select AIMS from the

list of programs and then click on the “Change” button. This will bring up the

AIMS setup dialogs. Choose “Modify Available Options”. This allows the

changing of the Authentication Type for logging into AIMS and the settings on

AIMS Service Accounts from running AIMS and providing the ability to load files

from and save files to folders other than the default installation folder.

Ensure that the OMS is running under an account that can see, read, write, and

delete from the shared directory.

These instructions will also work the other way (Domain to Workgroup) however it is

much more common for AIMS to be on its own Workgroup and the OMS to be on the

customer’s corporate domain.

Database Utility The AIMS Database Utility should only be used by a competent user. It can be found at

the following location:

C:\Program Files (x86)\AIMS\Utilities\DBUtility.exe

Page 136: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 136 of 137

Removing / Merging Machines or Users from AIMS

The total removal of a Machine or User from AIMS is not encouraged and can cause data

integrity issues. However a database utility has been created to enable certain

operations to be carried out by a competent user of AIMS. Two of these operations are

modifying an AIMS Username and modifying a Machine Name.

The database utility should only be used if a backup of AIMS has been carried out using

the AIMS Backup & Restore functionality.

Both the Modify AIMS Username and Modify Machine Name operations allow for the

merging of one entry with another. This can be used to remove the display of a

Machine Name or Username that is no longer desired on the AIMS screens and reports

whilst retaining their statistics for Analysis later under the Machine Name or Username

that it is changed or merged to.

The database utility should always be “Run As Administrator” and should not be shut

down while it is processing. At the end of each operation a confirmation will be

displayed.

To remove or merge an AIMS Username using the database utility type in the “Current

Username” in the box provided. Then type in the desired “New Username” in the box

provided. Click the “Update” button. If the “New Username” already exists you will be

prompted that the entries will be merged. If the “New Username” is not currently in the

database then the AIMS Username will be changed to this new unique AIMS Username.

To remove or merge a Machine using the database utility type in the “Current Machine

Name” in the box provided. Then type in the desired “New Machine Name” in the box

provided. Click the “Update” button. If the “New Machine Name” already exists you will

be prompted that the entries will be merged. If the “New Machine Name” is not

currently in the database then the Machine Name will be changed to this new unique

Machine Name.

Page 137: AIMS Administrator Manual - Neopost/media/kb_neopost_com/... · Page 5 of 137 Introduction This document is the Administration Manual for Automated Insertion Management System (AIMS).

Page 137 of 137

Delete Unused Jobs

It is recommended that Jobs are deleted from AIMS using the AIMS front end. However

if a large number of Jobs have been added into AIMS by mistake then the database

utility can be used to delete them.

The database utility should only be used if a backup of AIMS has been carried out using

the AIMS Backup & Restore functionality.

The Delete Unused Jobs functionality will delete all Jobs that have had no transations

and have a Packs Complete of “0”. This can be seen on the Jobs screen of AIMS as “0 of

…”

To delete all unused Jobs click on the “Delete” button.