Configuring Letterhead: Difference between revisions

From NEOSYS User Support Wiki
Jump to navigationJump to search
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=== Older method using HEAD.HTM ===
Letterhead using Maintenance mode, F5, DEFINITIONS [[Special:PermanentLink/6482]]
=== Primary Letterhead Requirements ===
=== Primary Letterhead Requirements ===


Line 6: Line 10:
#Address for letterhead
#Address for letterhead


=== Location of images for letterhead ===
Image Format{{Letterhead Logo Format}}<br>


==== Placing letterhead images in the local data folder ====
=== General principles to get excellent letterheads ===


If users don't have access to the world wide web from their computers then the put images is in the data\xyz folder (where xyz is the database code) and then in the HEAD.HTM file you can put src="http://192.168.0.1/neosys/data/xyz/SOMEFILE.JPG". (replace the IP 192.168.0.1 with the real IP and xyz with the dataset name). Do not use just the file name because if a document with such a link goes out over the network then the recipients email program recognizes the mail as a phishing mail and might even block it.
Set the letterhead aesthetically pleasing by following the below points:


==== Placing letterhead images on neosys.com ====
*DONT just cut and paste whatever you have been given with no care and attention to it looking nice.
*DO balance up the lines in some clever way and avoid stretching across the whole page as far as possible
*DO JOIN multiple lines onto one line or SPLIT lines to make full use of the vertical space that the logo height reserves in the letterhead
*DO something nice even if you see other cases and examples done badly
*DONT copy existing letterheads if they dont follow the above principles (unless it is known that the client specifically wants it like that)


Placing letterhead images on neosys.com means that documents properly show the logo regardless of where they are sent or used AS LONG AS there is access to the web.
=== Dynamic letterhead ===


1) Using FTP etc., upload the image file to neosys.com in TWO places.
NEOSYS letterhead is not designed for a specific page size or layout. It has to be highly adaptable to work on many different device types and dimensions, for example browser screen, email screen, printer landscape, printer portrait.
httpdocs/img
httpsdocs/img


2) In the letterhead configuration file, prefix the image file name with //www.neosys.com/img/
NEOSYS media invoices use the "date list" mode by default (instead of "date grid" mode as for schedule printouts) and therefore can fit in portrait mode but, since media schedules and plans usually must be printed in landscape mode, it is common to print media invoices in landscape mode too.


For example:
=== Using Preprinted Letterhead ===


<IMG SRC="//www.neosys.com/img/MEDIALIN.JPG" ALT="MediaLine">
NEOSYS output documents have an option to OMIT letterhead in order to be suitable for printing on paper that has pre-printed letterhead on it.


Note: Do NOT start the src with http: to avoid browser questions when accessing neosys using https. Neither prefix it with https to avoid browser questions when using http.
Usually the user will have to configure a large printer top margin in such a case to ensure that NEOSYS will not start overprinting the pre-printed letterhead. This is because there is currently no option in NEOSYS to configure the printer top margin.


=== Naming logo files ===
=== Setting up letterhead in Company File ===


#It is recommended that logo file names include useful info like company name and not useless info like “logo”.
Basic concepts:
#The objective is that we can look at a directory of files and take a reasonable guess of what each file contains.
#We should be able to keep a lot of logo files in one directory without risk of clashing.


For example: Version 2 of the right hand side logo of company Abracadabra LLC the file name could be ABRA2R.JPG.
*A letterhead consists of 1, 2, 3 or more "cells" of equal width, spread from left to right.


=== General format for image files ===
*Each cell may contain an image, text, or both.


File names for all letterhead logos, Company stamp/signature etc should in simple “8.3” format, i.e.
*The alignment left, center or right, and font-size of each cell can be configured.
  - Max 8 characters plus extension like “.JPG” or “.GIF” etc
  - All capital letters
  - No punctuation, special characters or spaces<br>Otherwise the NEOSYS restore process will corrupt the filename into something like LOGO_M~1.JPG and the logos will not appear on documents.<br>
Naming Convention
  - Rename to only CAPITAL alphanumeric characters i.e. A-Z and 0-9 and underscore _
  - Use all UPPER CASE letters since any lower-case letters will be converted to upper-case on backup/restore.<br>
The above rules apply to all files placed in DATA directory since files there are subject to limitations in the backup/restore process.<br>
Image Format{{Letterhead Logo Format}}<br>


If file names have been used contrary to the instructions above e.g using long names more than 8 characters, then when you restore backups the file names are changed and will no longer appear on any letterhead/footing etc.
*Images, e.g. logos, can be uploaded. Text, e.g. addresses, can be entered.
Note that files uploaded or otherwise placed in the IMAGES directory are not restricted to 8.3 format and will be backed up to USB with their full correct file name.
*Text may contain HTML tags to allow for customisation eg bold or anything else that you can imagine.


In the screenshots below file name is more than 8 characters long, after restore file name changed and the image does not get displayed in the Invoices.
Uses DRY principle - DONT REPEAT YOURSELF - to keep configuration clear, ease maintenance and reduce errors.  Any future changes to logos and addresses will  be automatically replicated everywhere necessary.


[[File:Cligi2.jpg]]
*Logos and addresses can be shared between companies.
*Text may contain various substitution codes like %COMPANY_NAME%, %TAX_REG_NO% etc.


[[File:Cliqimg.jpg]]
=== Using substitution macros in letterhead text ===


=== Customising the letterhead for all printed documents ===
To avoid having to make separate letterhead per company in multi-company databases, various "macros" can be inserted into letterhead text.


Set the letterhead aesthetically pleasing by following the below points:
The macros are replaced with the corresponding values from the Company File at the time of document or report creation.


*DONT just cut and paste whatever you have been given with no care and attention to it looking nice.
NEOSYS Support team MUST always put Tax Reg No/Company Name/Company Reg No in the Company file and NOT directly into HEAD.HTM, as it is unnecessary repetitive work and prone to errors if and when changes are required to be made.
*DO balance up the lines in some clever way and avoid stretching across the whole page as far as possible
*DO JOIN multiple lines onto one line or SPLIT lines to make full use of the vertical space that the logo height reserves in the letterhead
*DO something nice even if you see other cases and examples done badly
*DONT copy existing letterheads if they dont follow the above principles (unless it is known that the client specifically wants it like that)


In Maintenance mode, press F5 and the following command:
*%COMPANY_NAME% from the Company File
*%COMPANY_REG_NO% from the Company File
*%TAX_REG_NO% from the Company File
*%URL% from System Configuration File
*%DATAURL% from System Configuration File. Where NEOSYS documents and reports are created.
*%DATABASECODE% Up to eight characters. Same as login screen.


ED DEFINITIONS HEAD.HTM
*more options can be added on request


Then edit it as how you would do to a HTML file.
==== Example 1: Logo on left, address on right ====


Commands:
[[file:lettereg1.png]]


Ctrl + N New Line
==== Example 2: Using the same image and text as another company ====
Ctrl + D Delete line
F9         Save
Alt + D        Delete the document


==== Example 1 ====
[[file:letterheadeg2.png]]


Logo top left. Address top right.
==== Example 3 - Full Manual letterhead ====


<pre>
Completely manual design of letterhead can be done in a single row/cell by placing the HTML code as Text.
<TABLE width=100%>
<tr>
  <td align=left>
  <img src=http://192.168.0.1/neosys/data/xyz/SOMEFILE.JPG></img>
  </td>
  <td align=right>
  <table style=font-size:80%>
    <tr>
      <td align=left>
      www.websitename.com<br>
      P.O. Box 493, Dubai, U.A.E.<br>
      Tel: +971 4 2222222 <br>
      Fax: +971 4 2222223
    </td>
    </tr>
  </table>
  </td>
</tr>
</table>
</pre>
 
==== Example 2 ====
 
Logo top center.
 
<pre>
<p align=center><img src=http://192.168.0.1/neosys/data/xyz/SOMEFILE.JPG></img></p>
</pre>


==== Checking what file names are actually used for logos ====
[[file:letterheadold.png]]
#Get the document on screen
#Right click the image you want to check
#Choose Properties
#Look at “Address (URL)”. The last bit is the file name.


=== Customising the letterhead for transmission certificates ===
==== Example 4 up a "banner-style" letterhead ====


“Transmission certificate” is an option on the Schedule Printout that formats the schedule printout slightly differently so that it can be used as a transmission certificate i.e. a formal document suitable for certifying that advertising has appeared correctly.
Use a three cell html table to store left, center and right images.


See [http://userwiki.neosys.com/index.php/Schedule_Printout#Certificate Certificate option in Schedule printout]
Make normally sized separate images for the left and right sides.


The letterhead of a transmission certificate can customised per media vehicle so that the agency can issue them on behalf of the media.
Make a single color image that can be resized on the fly by html to fill in the gap.


Media vehicle logo per vehicle can be uploaded on the Vehicle file.
<pre>
<table width=100% cellspacing=0 cellpadding=0 >
<tr>


=== Customising the letterhead for accounting documents ===
  <td align=left width=1%>
  <img src=EXAMPL.PNG />
  </td>


Accounting documents may have a different letterhead from all other documents and the accounting letterhead is often set to blank so that all accounting documents (eg invoices and statements) are printed on real letterheaded stationary for stronger impact and formality.
  <td>
  <img src=EXAMPC.PNG width="100%" height="100" />
  </td>


Stationary option can be set in NEOSYS Configuration file, New invoices page, ledger account page etc.  
  <td align=right width=1%>
  <img src=EXAMPR.PNG />
  </td>


To maintain a different letterhead for accounting documents, go to maintenance mode, press F5 and use the following command to edit the file INVHEAD.htm.
</tr>
</table>
</pre>


ED DEFINITIONS INVHEAD.HTM
=== Converting Old style letterhead ===


Do not create INVHEAD.HTM which is a duplicate of HEAD.HTM because it causes problems in future when only HEAD.HTM is edited and INVHEAD.HTM is not.
Old style letterhead will automatically appear like full manual letterhead.


=== Positioning address at bottom of page ===
It can very easily be converted manually to the new format, as and when convenient, by extracting the company name, address, font size etc from the html tags and placing them in new style letterhead configuration.


This unfortunately cannot be done in NEOSYS due to lack of facility in HTML web pages or at least lack of knowledge of how to do it at the moment.
Existing letterhead logos should be downloaded and re-uploaded in the new configuration style.


Many NEOSYS clients print their invoices on pre-printed letterhead stationary in order to get precise branding and the formality of real letterhead.
Where-ever possible, old hard-coded letterhead text like company name, and company and tax registration numbers MUST be replaced with %% macros to ease future maintenance.


One can set printer margin to adjust the invoice text on a pre-printed letterhead.
Where-ever possible, for companies that share address blocks, the address MUST NOT be entered multiple times. Address blocks MUST only be entered on one main company to ease future maintenance.


=== Deciding to use portrait or landscape pre-printed letterhead ===
Where-ever possible, logos that are shared between companies MUST NOT be uploaded more than once. Logos MUST only be uploaded on one main company to ease future maintenance.


NEOSYS media invoices use the "date list" mode by default (instead of "date grid" mode as for schedule printouts) and therefore can fit in portrait mode but, since media schedules and plans usually must be printed in landscape mode, it is common to print media invoices in landscape mode too.
Conversion of multi-company databases requires conversion of each company individually. Converting one company, does not automatically convert them all. Any unconverted companies will remain as they were.


=== Location of HTML files ===
=== Location and URL of uploaded letterhead images ===


All html documents output by NEOSYS are put in the data\xyz folder (where xyz is the database code) and deleted automatically after about one hour)
The uploaded images are placed in NEOSYS web server /images/ folder with names like logo_XXX_9.jpg where XXX is the company code, and 9 is the letterhead column number.


=== Searching for earlier created letterheads ===
In the HTML document the images are referred to by the FULL URL to the NEOSYS web server


You can search for all earlier created letterheads in the maintenance mode. This is useful when you have several companies and want to see which companies have been configured with letterheads.
The URL is obtained from the first NEOSYS login URL found in the Configuration File


In maintenance mode, press F5
<img src="https://test.hosts.neosys.com:4430/images/DEVDTEST/UPLOAD/COMPANIES/logo_X_1.jpg" />


FIND DEFINITIONS HEAD.HTM
FULL URL is used because, for NEOSYS documents to be converted with their images into other formats like OFFICE/PDF etc, the program doing the conversion must be able to retrieve the image using the URL contained in the HTML.


=== Changing the letterhead for printed documents ===
=== Not seeing images if using alternative NEOSYS login URLs ===


The letterhead is edited using the below command in maintenance mode.
Anybody using secondary NEOSYS login URLs will NOT be able to see uploaded letterhead logos in their documents.


ED DEFINITIONS HEAD.HTM
=== Using other images ===
      or
ED DEFINITIONS X_HEAD.HTM
(where X is the company code followed by an underscore)


MUST follow the below steps to ensure proper setup of letterhead:
Since any img tag can be placed in the text of letterhead, any image can be included in letterhead configuration.
#Ensure that all HEAD.HTM files are edited including INVHEAD.HTM else reports will have different logos. Also delete duplicate invhead.htm files
#[[Configuring_Letterhead#Primary_Letterhead_Requirements| Primary Letterhead Requirements]]
#[[Configuring_Letterhead#Location_of_images_for_letterhead |Location of images for letterhead]]
#[[Configuring_Letterhead#Naming_logo_files | Naming logo files]]
#[[Configuring_Letterhead#General_format_for_image_files | General format for image files]]
#[[Configuring_Letterhead#Customising_the_letterhead_for_all_printed_documents | Customising the letterhead for all printed documents]]
#[[Configuring_Letterhead#Customising_the_letterhead_for_transmission_certificates | Checking what file names are actually used for logos]]


=== Copying and Deleting letterheads ===
Such images could be placed on a public web site and the FULL url (omitting http: and https:) placed in the letterhead.


We can manage letterheads by using the following commands:
Note: Do NOT start the src with http: or https: to avoid browser questions when accessing neosys using https/http


COPY DEFINITIONS X_HEAD.HTM TO: (DEFINITIONS Y_HEAD.HTM)
=== Checking what file names are actually used for logos ===
DELETE DEFINITIONS X_HEAD.HTM
#Get the document on screen
#Right click the image you want to check
#Choose Properties
#Look at “Address (URL)”. The last bit is the file name.


(where X is the division whose letterhead you want to delete, or copy into letterhead for division Y)
=== Location of NEOSYS HTML files ===


=== Using substitution macros in HEAD.HTM ===
All html documents output by NEOSYS are put in the data\xxxxxxxx folder where xxxxxxxx is the database code


To avoid having to make separate HEAD.HTM entries per company in multi-company databases, various "macros" can be inserted into HEAD.HTM.
They are deleted automatically after about one hour


The macros used in HEAD.HTM file are replaced with the corresponding values from the Company File at the time of document or report creation.
=== Customising the letterhead for transmission certificates ===


NEOSYS Support team MUST always put Tax Reg No/Company Name/Company Reg No in the Company file and NOT directly into HEAD.HTM, as it is unnecessary repetitive work and prone to errors if and when changes are required to be made.
“Transmission certificate” is an option on the Schedule Printout that formats the schedule printout slightly differently so that it can be used as a transmission certificate i.e. a formal document suitable for certifying that advertising has appeared correctly.


*%COMPANY_NAME% from the Company File
See [http://userwiki.neosys.com/index.php/Schedule_Printout#Certificate Certificate option in Schedule printout]
*%COMPANY_REG_NO% from the Company File
*%TAX_REG_NO% from the Company File
*more options can be added on request


=== Multiple letterheads in single user version of NEOSYS ===
The letterhead of a transmission certificate can customised per media vehicle so that the agency can issue them on behalf of the media.


Multiple letterheads are provided by using different company codes.
Media vehicle logo per vehicle can be uploaded on the Vehicle file.


Normally NEOSYS does not provide multicompany system for single user price so if the client is only doing the occasional document in other company then perhaps they can edit the document to remove/change the letter head. Editing should be easy enough in Word from the Edit button in Internet Explorer tool bar although after editing they probably have to save it somewhere (anywhere really) in order to print/email it.
=== Positioning address at bottom of page ===


If they are just emailing documents then they can edit the email before sending it.
This unfortunately cannot be done in NEOSYS due to lack of facility in HTML web pages or at least lack of knowledge of how to do it at the moment.


Although it is often not practical, another possible way, is to make the letterhead blank (put just &nbsp;) and they could print all documents on real letterhead depending on which company they want. This would still leave the main company name just above the body of the document though.
Some NEOSYS clients print their invoices on pre-printed letterhead stationary in order to get precise branding and the formality of real letterhead.

Latest revision as of 13:35, 18 April 2018

Older method using HEAD.HTM

Letterhead using Maintenance mode, F5, DEFINITIONS Special:PermanentLink/6482

Primary Letterhead Requirements

While setting up the letterhead for any company, NEOSYS requires the following:

  1. Exact company name to appear on invoices etc
  2. Company logo
  3. Address for letterhead
Image Format
     - Must be a *.JPG or *.GIF or *.PNG file 
     - Must be about 100 pixels high and proportionally wide with NO MARGINS or WHITE SPACES inside the file.
    ** LOGO WILL NOT BE ACCEPTED IF IT DOES NOT FOLLOW THE ABOVE FORMAT **
     - A correctly sized image MUST be created from the ORIGINAL graphic design file (eg. Photoshop PSD).
   Crude resizing of image files using image editing programs is unacceptable. This is because random
   re-pixelation of the edges and (especially) the text from an already pixelated image leads to an
   unacceptable loss of quality. 
  (Click here to see why NOT to resize images for letterheads: http://userwiki.neosys.com/index.php/General_FAQ#Is_it_okay_to_resize_images_for_use_in_letterhead_for_NEOSYS_documents.3F )

General principles to get excellent letterheads

Set the letterhead aesthetically pleasing by following the below points:

  • DONT just cut and paste whatever you have been given with no care and attention to it looking nice.
  • DO balance up the lines in some clever way and avoid stretching across the whole page as far as possible
  • DO JOIN multiple lines onto one line or SPLIT lines to make full use of the vertical space that the logo height reserves in the letterhead
  • DO something nice even if you see other cases and examples done badly
  • DONT copy existing letterheads if they dont follow the above principles (unless it is known that the client specifically wants it like that)

Dynamic letterhead

NEOSYS letterhead is not designed for a specific page size or layout. It has to be highly adaptable to work on many different device types and dimensions, for example browser screen, email screen, printer landscape, printer portrait.

NEOSYS media invoices use the "date list" mode by default (instead of "date grid" mode as for schedule printouts) and therefore can fit in portrait mode but, since media schedules and plans usually must be printed in landscape mode, it is common to print media invoices in landscape mode too.

Using Preprinted Letterhead

NEOSYS output documents have an option to OMIT letterhead in order to be suitable for printing on paper that has pre-printed letterhead on it.

Usually the user will have to configure a large printer top margin in such a case to ensure that NEOSYS will not start overprinting the pre-printed letterhead. This is because there is currently no option in NEOSYS to configure the printer top margin.

Setting up letterhead in Company File

Basic concepts:

  • A letterhead consists of 1, 2, 3 or more "cells" of equal width, spread from left to right.
  • Each cell may contain an image, text, or both.
  • The alignment left, center or right, and font-size of each cell can be configured.
  • Images, e.g. logos, can be uploaded. Text, e.g. addresses, can be entered.
  • Text may contain HTML tags to allow for customisation eg bold or anything else that you can imagine.

Uses DRY principle - DONT REPEAT YOURSELF - to keep configuration clear, ease maintenance and reduce errors. Any future changes to logos and addresses will be automatically replicated everywhere necessary.

  • Logos and addresses can be shared between companies.
  • Text may contain various substitution codes like %COMPANY_NAME%, %TAX_REG_NO% etc.

Using substitution macros in letterhead text

To avoid having to make separate letterhead per company in multi-company databases, various "macros" can be inserted into letterhead text.

The macros are replaced with the corresponding values from the Company File at the time of document or report creation.

NEOSYS Support team MUST always put Tax Reg No/Company Name/Company Reg No in the Company file and NOT directly into HEAD.HTM, as it is unnecessary repetitive work and prone to errors if and when changes are required to be made.

  • %COMPANY_NAME% from the Company File
  • %COMPANY_REG_NO% from the Company File
  • %TAX_REG_NO% from the Company File
  • %URL% from System Configuration File
  • %DATAURL% from System Configuration File. Where NEOSYS documents and reports are created.
  • %DATABASECODE% Up to eight characters. Same as login screen.
  • more options can be added on request

Example 1: Logo on left, address on right

Lettereg1.png

Example 2: Using the same image and text as another company

Letterheadeg2.png

Example 3 - Full Manual letterhead

Completely manual design of letterhead can be done in a single row/cell by placing the HTML code as Text.

Letterheadold.png

Example 4 up a "banner-style" letterhead

Use a three cell html table to store left, center and right images.

Make normally sized separate images for the left and right sides.

Make a single color image that can be resized on the fly by html to fill in the gap. 

<table width=100% cellspacing=0 cellpadding=0 >
 <tr>

  <td align=left width=1%>
   <img src=EXAMPL.PNG />
  </td>

  <td>
   <img src=EXAMPC.PNG width="100%" height="100" />
  </td>

  <td align=right width=1%>
   <img src=EXAMPR.PNG />
  </td>

 </tr>
</table>

Converting Old style letterhead

Old style letterhead will automatically appear like full manual letterhead.

It can very easily be converted manually to the new format, as and when convenient, by extracting the company name, address, font size etc from the html tags and placing them in new style letterhead configuration.

Existing letterhead logos should be downloaded and re-uploaded in the new configuration style.

Where-ever possible, old hard-coded letterhead text like company name, and company and tax registration numbers MUST be replaced with %% macros to ease future maintenance.

Where-ever possible, for companies that share address blocks, the address MUST NOT be entered multiple times. Address blocks MUST only be entered on one main company to ease future maintenance.

Where-ever possible, logos that are shared between companies MUST NOT be uploaded more than once. Logos MUST only be uploaded on one main company to ease future maintenance.

Conversion of multi-company databases requires conversion of each company individually. Converting one company, does not automatically convert them all. Any unconverted companies will remain as they were.

Location and URL of uploaded letterhead images

The uploaded images are placed in NEOSYS web server /images/ folder with names like logo_XXX_9.jpg where XXX is the company code, and 9 is the letterhead column number.

In the HTML document the images are referred to by the FULL URL to the NEOSYS web server

The URL is obtained from the first NEOSYS login URL found in the Configuration File 

<img src="https://test.hosts.neosys.com:4430/images/DEVDTEST/UPLOAD/COMPANIES/logo_X_1.jpg" />

FULL URL is used because, for NEOSYS documents to be converted with their images into other formats like OFFICE/PDF etc, the program doing the conversion must be able to retrieve the image using the URL contained in the HTML.

Not seeing images if using alternative NEOSYS login URLs

Anybody using secondary NEOSYS login URLs will NOT be able to see uploaded letterhead logos in their documents.

Using other images

Since any img tag can be placed in the text of letterhead, any image can be included in letterhead configuration.

Such images could be placed on a public web site and the FULL url (omitting http: and https:) placed in the letterhead.

Note: Do NOT start the src with http: or https: to avoid browser questions when accessing neosys using https/http

Checking what file names are actually used for logos

  1. Get the document on screen
  2. Right click the image you want to check
  3. Choose Properties
  4. Look at “Address (URL)”. The last bit is the file name.

Location of NEOSYS HTML files

All html documents output by NEOSYS are put in the data\xxxxxxxx folder where xxxxxxxx is the database code

They are deleted automatically after about one hour

Customising the letterhead for transmission certificates

“Transmission certificate” is an option on the Schedule Printout that formats the schedule printout slightly differently so that it can be used as a transmission certificate i.e. a formal document suitable for certifying that advertising has appeared correctly.

See Certificate option in Schedule printout

The letterhead of a transmission certificate can customised per media vehicle so that the agency can issue them on behalf of the media.

Media vehicle logo per vehicle can be uploaded on the Vehicle file.

Positioning address at bottom of page

This unfortunately cannot be done in NEOSYS due to lack of facility in HTML web pages or at least lack of knowledge of how to do it at the moment.

Some NEOSYS clients print their invoices on pre-printed letterhead stationary in order to get precise branding and the formality of real letterhead.

Retrieved from "https://userwiki.neosys.com/index.php?title=Configuring_Letterhead&oldid=6701"