Maintain Stylesheets (GMNT-14) 


The iComms facility allow users to send formatted letters and documents to persons or entities, like students, personnel members or debtors.  This screen is used to set up letters or documents that are produced by the different iComms options in each subsystem.  The letters or documents may contain tags that is replaced with data related to students or entities.

NOTE : A user may only update their own Stylesheet.

After being uploaded to the ITS System, documents may be merged with a specific set of data using the individual iComms programs in the subsystems to generate final / merged documents.
Fields in the option:

Block 1:  iComms Style sheets

Use for both stylesheets from XML reports and iComms.

Records created by System (user ITS), cannot be deleted/updated.


Field Type
&
Length
Description
Code A8 This code will name your Group e.g. RES01GRP - Residence Master Group.  For each different documentation entity a new master group will be created.  If currently using for qualification X and qualification Y different codes, this will become QUALXGRP and QUALYGRP.  End all your master groups with -GRP.  All Master Groups must be linked to the applicable menu and option at {USERS-1}, TAB - Report Output Formats.  Save your letter as RTF in the word processing package with the same letter code that you will create on the ITS back office system.  
Description A80 The description of your documentation entity.  No spaces are allowed in the description field as this description is often utilised as a tag.
Document Classification A8 When creating a new record the user can select from a LOV the type of Document Classification e.g.
  • MST - Master Group which is required to link the following features to it,
    • LET - Letter per individual
    • SMS - SMS per individual
    • INC - Paragraph Include,
    • LST - Bulk/Summary list of students/entities for who letters were created,
    • LOG - Bulk/Summary Log file displaying number of students/entities that were created
    • XML - Bulk/Summary XML List to be used.  
    • ASC - Bulk/Summary student/entity data in Ascii file,
    • LAB - Bulk/Summary Labels on envelopes,
This field is mandatory and once committed the record cannot be updated.
Start Date DD-MON-YYYY The date this record was first created.
Store to Client Button Click on this button to store the document to your PC.  This document will be saved to C:\ITSTEMP by default.  The user can then move this file to a more specific area on the network.
Retrieve from Client Button Click on this button to upload and convert the RTF document into ITS Back Office System from the PC or a specific area on the network.
Show A1 Y/N .  This show indicator defines if a stylesheet is active or not.  Inactive stylesheets will not be presented to the user when running reports.  Inactive Groups cannot be linked on {USERS-1}.
User A8 The User ID of the person that initially created this record.
Show on iEnabler A1 Y/N.  If Y is indicated on letter, the letter will be displayed on the iEnabler {S00004-35} View Correspondence option.  This applies only to LET document classification.

When creating a record above and on commit the following will be updated programmatically in the background from a fixed set of data as defined by ITS.
(Users cannot see or update this fields / data.)

Field Description
Output Format The output defines the make-up of the file that will be loaded, e.g. is this a comma separated or text or binary file.  Currently this is a fixed set as defined by ITS.
Output Type This defines the type of output generated by this file, e.g. SMS or letter or list.  Currently this is a fixed set as defined by ITS.
Mime Type Currently this is a fixed set as defined by W3C.  This defines the content of this entity.

Example:

 Example of ...

 

Block 2:  Document Groups       

The group block is only used for iComms to set up your group of document outcomes for a specific menu option.  This defines any letters, lists, labels and SMS's that a specific option will generate.  Multiple groups can be set up for a specific menu where different output combination is needed.


Field Type
&
Length
Description
Sequence N4 The sequence in which this document classification item is linked to the Master (MST) iComms Style sheet. Start at 10 and use an increment of 10.
Document Classification   The type of document, the following document classifications are available i.e.:
  • XML List 
  • Letter
  • Label
  • List
  • Log File which will indicate to you the number of records created
  • SMS
  • ASCII
Description A128 The name / description that you want to be printed on the report of the log file.  
English Document A8 The English Document Code of the letter or SMS.  List and Label will be the same code for English and Alternate.  Use list of values to populate Output Format and Output Type for this document. 
Alternate Document A8 The Alternate Document Code of the letter or SMS.  List and Label will be the same code for English and Alternate.  Use list of values to populate Output Format and Output Type for this document. 
Display at runtime A1 Typically this will be No for letters and SMS as you will generate a different PDF document for each record returned and the PC might not be able to handle so many documents.  If set to (Y)es then, when viewing the output, the system will check the number of outputs generated and compare this to the number allowed for System Operational Definition MO, Subsystem GC.  If there are more outputs than allowed by the SOD, the system will prompt the user asking if all the outputs should be viewed.
Send Mail A1 If Yes, documents will be mailed directly to the students / personnel according to the e-mail addresses on the biographical information.  This functionality will only work if a mail server has been set up for outgoing mail.
Mail Destination A128 This is an override facility and should be left blank.  If a value is entered here, documents will be sent to this address. 
Default Printer Destination A128 When iComms letters are generated, the printer entered here will be used as default printer, but the user will have the option to select another printer where required, provided that the user is linked to the printer in the "User Printer Access" - tab of the "User Access Definitions" {USERS-5}
Active A1 Is the document active? Yes or No.  If No, this document will not print nor be mailed, irrespective of what end-user answered in the first five questions, e.g. Print Letter, Print List, Print Label, Print ASCII, and  Print SMS.
Number of Test Records N2 The number of rows that must be included in a test run.
Label Profile Code A8 This field only works when Document Classification is Label. The LOV setup is done on {GCS2-20}

When creating a record on block 2, on commit the following will be updated programmatically in the background from a fixed set of data as defined by ITS.
(Users cannot see or update this fields / data.)

Field Type
&
Length
Description
Level A1 This define the time / level that this stylesheet runs against the XML.  If (I)ndividual this will run each time per individual row and will generate a separate document. If (B)atch this stylesheet will run once on the full XML file and generate a single document.  Documents, such as a letter and SMS that goes to different students / persons must be run on (I)ndividual level.  Lists, labels and the log file that contains all records must be run on Batch level.
Output Format A8 The output defines the make-up of the file that will be loaded, e.g. is this a comma separated or text or binary file.  Currently this is a fixed set as defined by ITS.
Output Type A8 This defines the type of output generated by this file, e.g. SMS or letter or list.  Currently this is a fixed set as defined by ITS.
Mime Type A128 Currently this is a fixed set as defined by W3C.  This defines the content of this entity.
File Extension A3 This will be the extension against which the generated / final document will be stored against.

 Example of ...



Block 3:  Letter Objects

Each iComms option will have at least one pre-existing letter containing all the available letter object (tags).  The available tags are generally listed in the help file of the SCOM option that will be used to generate the letter.

Only tags that are linked on this block may be used in the letter.  When creating new letters, the Copy Letter Objects section can be used to copy tags from pre-existing letters to the current letter.


Field Type
&
Length
Description
Letter Stylesheet A8 This is the actual converted RTF document containing the letter, as defined in block 1. Only documents of type RTF, INC, text / rtf are allowed.
Description   Display Letter description as entered on iComms style sheet.
Letter Object A8 Predefined tags.  Defining the contents of a specific field, (or fields), (old D Parameter content) to be printed.  Only documents of type XSL, INC, application / xml are allowed.
Description   Display Letter object (tag) description as entered on iComms style sheet.


Example:
 Example of ...



its_man_img/gmnt-14b5i1.jpg

 



Block 4:  Copy Letter Objects

Use the Standard letter of the menu option you use to create the letter, and copy to the new letter.

Field Type
&
Length
Description
Copy from A8 The old letter code from which tags must be copied.
Copy to A8 The new letter code will be populated from block 1.   
Copy Letter Object Button After pressing the button the actual copying of the objects will be done.  


Example:

its_man_img/gmnt-14b5i1.jpg

 

Block 5:  Conditional Letter Objects

This tab may be used to specify the inclusion of paragraphs in individual letters based on a value of a tag.


Field Type
&
Length
Description
Letter A8 It is mandatory to first query a Letter in block 3 and then next block to block 5.  The Letter Code will then default from block 3 into the letter field.  Users not allowed to update or insert a record in this field.
Condition Code A8 This is the Condition Code that can be linked to a paragraph.  Users create their own Condition Codes.
Description A80 The Description of the condition code.  Remember that the description may not contain any spaces.
Output Format A8 This defines the type of Output generated by this file, e.g. SMS or letter or list.  Currently this is a fixed set as defined by ITS.
Description A80 Display the Description of output format code.  
Output Type A8 This defines the Type of Output generated by this file, e.g. SMS or letter or list.
Currently this is a fixed set as defined by ITS.
Description A80 Display the Description of output type code.
Mime Type A128 Currently this is a fixed set.  This defines the content of this entity.
User A8 The system will default the User ID of the person whom initially created this record. 
Start Date DD-MON-YYYY The date this record was first created.
Show (Y / N) A1 This show indicator defines if a stylesheet must be shown when generating a Letter.
Test Object A8 Letter Object that must be valuated. 
Condition A10 Select if the condition is Equal to or not Equal to.
Test Value A80 The value of the Letter Object (tag) that must be validated.  
Paragraph A8 Name of the paragraph that was created by the user and linked to block 1.  



Example:

Example of ...

 
The set-up of a letter with paragraphs to be included in individual letters based on the value of a tag
  1. Create a letter document in the "Maintain System Letters" tab.
  2. Create a paragraph exactly the same way as for a letter in the "Maintain System Letters" tab.  The only differences between the two are:
  3. If the paragraph should only be included for certain letters 
  4. Select the test object (tag) on which the condition is based. The List Of Values will only contain tags available for the queried letter.
  5. Select "Equal To" or "Not Equal To" and enter the value that the tag will be compared to (e.g. Y, N, 200800145, etc)
  6. Select a paragraph to be included in the letter if the test is true from the list of values.  The list will contain all the "PINC - iComms Paragraph Include" objects.
  7. When the record is saved, a conditional object will be created and added to the list of "Letter Objects" for the document.
  8. The conditional tag may now be appear in the rtf - document in the same way as any other letter object (tag).
  9. Load and convert the letter.
  10. Print the letter using the relevant iComms program

The use of printer escape sequences with iComms:

  1. Create printer set-ups and printer escape codes in the system to handle tray printing. Tray selection is handled using “Printer Escape Sequences” as entered in "Maintain Printers" {GPRT-1}
     
  2. Create printer escape sequence codes for the tags to be used in the iComms documents and enter it in the "Printer Escape Sequence Description" tab of "Maintain Printers" {GPRT-1}
    Escape Code Description
    Tray1 Print on tray 1
    Tray2 Print on tray 2
  3. Enter the escape sequences for the relevant printers in the "Printer Escape Sequences" tab of "Maintain Printers" {GPRT-1}
    Printer Code Escape Code Description Escape Sequence
    ICF1 Tray1 Print on tray 1 \027&I4H
    ICF1 Tray2 Print on tray 2 \027&I1H
  4. Specify the printer tray to be used with a tag in the rtf - document. The tag name should be the escape code, for example <Tray1>.  Everything after the tag will print on paper from the specified tray.
  5. Load the document in the standard way through "Maintain Stylesheets" {GMNT-5}.
    Note that the "tray" tags should not exist in "Maintain Stylesheets" {GMNT-5}.

See Also:  


History of Changes
Date System Version By Whom Job Description
07-April-2009 v01.0.0.0 Magda van der Westhuizen T154868 New manual.
10-Sep-2009 v01.0.0.1 Charlene van der schyff T161550 Insert link to Operational Manual
16-Jul-2010 v01.0.0.2 Sarah Seeletse F168345 Update for SMS documents
10-Aug-2012 v03.0.0.0 Frans Pelser T181811 Change to a big screen
10-Oct-2013 v03.0.0.1 Sakhile Nyoni T192689 Applied changes done on t186251
03-FEB-2014 v03.0.0.1 Alucia Sabela T192689 Change images URL to the correct one to make images visible.
30-Jun-2014
v03.0.0.2
Alucia Sabela
F200202
Change images to show the images of the current screen.
05-Nov-2014
v03.0.0.3
Sarah Seeletse
F198938
Add description for Label Profile Code
08-Jan-2015
v01.0.0.4
Sarah Seeletse
T205119
Fix Opertional Manual iComms link
19-Nov-2020 v04.1.0.0 Sister Legwabe F247482 Remove GMNT-5 link on the copy-to field as it is now done on GMNT-14 block 1
19-Nov-2020v04.1.0.1Sister LegwabeF247482Remove GMNT-5 link on the copy-to field as it is now done on GMNT-14 block 1
13-Feb-2023 v04.1.0.2 Esther Nel T259419 Add indicator to display document on iEnabler