SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each...

129
Excellence Series User Guide SouthWare ® WorkFlow Revision 15

Transcript of SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each...

Page 1: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Excellence SeriesUser Guide

SouthWare®

WorkFlow

Revision 15

Page 2: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

NOTICE

The information in this document is subject to change without notice. SouthWareInnovations, Inc. assumes no responsibility for any errors that may appear in thisdocumentation.

COPYRIGHT NOTICE

Copyright © 1983 - 2009 by SouthWare Innovations, Inc. All rights reserved. Printed in the United States of America. No part of this publication may be reproduced ortransmitted in any form or by any means without the written permission of SouthWareInnovations, Inc. Auburn, Alabama. Violations of the copyright law may result insubstantial civil and criminal damages and penalties.

TRADEMARK NOTICE

SouthWare® , SalesMark® and TaskWise® are registered trademarks of SouthWareInnovations, Inc. SouthWare Excellence Series™, DocTransfer™, ExcelAssist™,ExcelReport™, ExecuMate II™, Extended Data™, ImportMate II™, InternationalTransactions™, ReportMate™, SwiftGen™, SwiftMate™, SouthWare Forms™,SouthWare NetLink™, SouthWare WorkFlow™, StopCheck™, and AnswerReady™ aretrademarks of SouthWare Innovations, Inc.

Other products and company names used in this publication are for identificationpurposes only and may be trademarks or registered trademarks of their respective owners.

Page 3: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

SouthWare Excellence Series™ (Revision 15) 3

SouthWare WorkFlow™ - Table of Contents

SouthWare WorkFlow™ - Overview and Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . 5

WorkFlow Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

WorkFlow Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Process Flow Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Program Definition Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

WorkFlow FlowPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

FlowMod Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Applicable Entry Routines for Literals/Constants . . . . . . . . . . . . . . . . . . . . . . 32

FlowMod Listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

WorkFlow Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Work Flow Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Create SouthWare/Internet Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Create SouthWare Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Create SouthWare Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Create Scheduled Action/Reminder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Modify G/L Account Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Extract Records from WorkFlow Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Load Records to WorkFlow Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Create SouthWare Forms Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Appendix A - SouthWare WorkFlow™ Security Notes . . . . . . . . . . . . . . . . . . . . . . . 107

Appendix B - Developer Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Appendix C - FlowMod Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Page 4: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Table of Contents SouthWare WorkFlow™

4 SouthWare Excellence Series™ (Revision 15)

NOTES:

Page 5: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Introduction SouthWare WorkFlow™

SouthWare Excellence Series™ (Revision 15) 5

SouthWare WorkFlow™ - Overview and Introduction

One of the major strengths of the SouthWare Excellence Series™ isthat its processes and built-in business rules/procedures have beenproven successful by thousands of businesses over many years. Whenyou use the Excellence Series in your business you know that thefeatures are already in place to handle all your standard businessfunctions.

But what do you do when "standard" functions aren’t enough to handleyour needs or desires in a particular area? What if you need tocustomize a process in an area where there is not a built-in option?

Certainly one option is to make custom programming changes. Thismakes your system non-standard and not readily upgradeable, but itdoes give you the functions you need. But wouldn’t it be great if youcould add the functions and keep your system standard?

That’s where SouthWare WorkFlow™ comes in. With its unique

WorkFlow Controller technology you have the ability to "insert" new

functions at many different points in a process. In many cases thesefunctions, called FlowMods, will eliminate the need for any custom

Page 6: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

SouthWare WorkFlow™ Introduction

6 SouthWare Excellence Series™ (Revision 15)

programming. Or if custom programming is still required you may beable to use a FlowMod to call the custom program at the right time andstill keep your system standard!

The two major benefits of SouthWare WorkFlow™ are:

1. You can see how information flows through a process and betterunderstand each standard step.

2. You can add supplemental steps that modify the standard flow.

How Does It Work?

Let’s look at how you get these two benefits:

Seeing the Information Flow

SouthWare WorkFlow™ accesses files that contain records for eachprocess, program, and FlowPoint within a program. With theWorkFlow Controller you can zoom between these levels ofinformation to see how the pieces fit together. Each record can containcomments that explain its use and other information such as aboutoptions that affect its use. By reviewing a process, program, or field

Page 7: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Introduction SouthWare WorkFlow™

SouthWare Excellence Series™ (Revision 15) 7

with the WorkFlow Controller you can learn more about its function inyour system.

Adding FlowMods

With SouthWare WorkFlow™ you can add one or more FlowMods toa particular FlowPoint (field, question, or other processing point in aprogram). When the related program gets to that particular point, itcalls WorkFlow to take whatever FlowMod step(s) you have specified.

You can use a FlowMod to:

! Test for one or more conditions of the data! Conditionally decide to take a subsequent step! Conditionally skip to another FlowMod! Display a message and evaluate the response given to a message! Replace the data in a field with other data! Execute a SouthWare Object to launch a program, play keystrokes,

or do other functions! Stop the normal flow from continuing

FlowMods really serve as a programming language that is simple to use

and understand. You get the flexibility of custom programming

within standard programs!

L Note to Developers - With SouthWare WorkFlow™ you have aterrific object-oriented development environment. When you needto add extra functionality beyond WorkFlow’s features, you cancreate stand-alone routines called from WorkFlow. This ensuresfuture compatibility and "hides" the complexity and functions ofyour routine from the programs that use it.

Page 8: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

SouthWare WorkFlow™ Introduction

8 SouthWare Excellence Series™ (Revision 15)

NOTES:

Page 9: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WorkFlow Controller WF-01

SouthWare Excellence Series™ (Revision 15) 9

Control a Process Via FlowMod Steps

WF-01 WorkFlow Controller

When you access this program you must enter:

Process ID

Enter a Process ID for review or press <Enter> for ALL processes. You may use the Lookup feature to list Process Ids.

NOTE: The Controller program builds a sort file before display. Ifyou are interested in only one process you should enter it heresince the sort file may build quicker than if you include AllProcesses.

Program ID

Enter a Program ID for review or press <Enter> for ALLprograms. If you entered a Process ID above then "ALL" ProgramIDs will include only programs within the process. If you enter aProgram ID then only that program will display in the Controller.

Page 10: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-01 WorkFlow Controller

10 SouthWare Excellence Series™ (Revision 15)

Sample WorkFlow Controller View

Extract ID

You may specify an Extract ID or press <Enter> to include ALLExtract IDs. This allows you to limit the FlowMods you see tothose that match the Extract ID or don’t have an Extract ID. Thisis helpful when you are reviewing FlowMods on a system thatcontains multiple sets (Extract IDs) of changes.

After you specify the IDs the program builds a sort file containinginformation from the process, program, flowpoint, and flowmodrecords. The Controller screen then displays:

Here is the information shown:

Mod? Shows a "Y" if the related record has any FlowModsdefined for it - otherwise is blank.

Process ID Shows the Process ID if different than the previousrecord (this will be blank if you entered a specificprogram ID).

Seq Shows the sequence of a program within a process(this will be blank if you entered a specific programID).

Program ID Shows the Program ID.

Page 11: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WorkFlow Controller WF-01

SouthWare Excellence Series™ (Revision 15) 11

FP ID Shows the FlowPoint ID.

Mod Shows "x99" where "x" is the Before/After timingand "99" is the FlowMod sequence number.

Description Shows the description of the process, program,FlowPoint, or FlowMod.

On? For a FlowMod record, shows whether the FlowModis Active.

Mode For a FlowMod record, shows the mode (Add,Change, Both) for the FlowMod.

F/C? For a FlowPoint record, shows "Y" if the FlowPointhas Fail/Continue logic.

Extract ID Shows the Extract ID of the record.

The Controller initially shows information for all levels of records:1 - Process Records2 - Program Records3 - FlowPoint Records4 - FlowMod Records

You may change the level shown by using the Options feature shownin the prompt:

Options (<F4>) Select this feature to change the detail shown in theController View. You may then select to:

1 Show All Levels Shows all 4 levels of detail(this is the default)

2 Remove a Level of Detail Show one less level thancurrently displayed

3 Add a Level of Detail Show one more level thancurrently displayed

4 Show Processes Only Show only the Process level

5 Show Programs Only Show only the Program level

6 Show FlowPoints Only Show only the FlowPoint level

7 Show FlowMods Only Show only FlowMods

8 Rebuild View File for ChangesRebuild the View File to reflectany FlowMod changes you’ve

Page 12: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-01 WorkFlow Controller

12 SouthWare Excellence Series™ (Revision 15)

made via the Controller

9 Restart View File at BeginningRestart the View at the beginningof the View File

To Zoom or Edit the Records Shown

To zoom on or edit the information shown you simply click on a recordor highlight it with the arrow keys and press <Enter>.

! For Process, Program, and FlowMod records this will access therelated maintenance program.

! For FlowPoint records a question will first ask if you want to Adda FlowMod or View the FlowPoint (or display the FlowPointLevel if there are existing FlowMods and they are not displayed).- If you choose to add a FlowMod the FlowMod maintenance

screen will appear and will fill in the FlowPoint info so youmay add the new record.

- If you choose to Edit the FlowPoint the related maintenancewill appear.

- If you choose to Display the FlowMod Level then the viewwill redisplay to show FlowMods

Rebuilding the Display File

The View file is a temporary file built from existing WorkFlow-relatedinformation. When you make changes to FlowMods the View file willnot reflect the changes unless you rebuild it. There are three ways todo this:! Exit the scrolling list and enter the same parameters again! Choose the "Options" function (<F4>) and select to Rebuild the

View File! When you access the FlowMod maintenance program from the

Controller and then return to the Controller, a question asks if youwant to rebuild the View file for any changes - enter "Y" to rebuild

Page 13: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WorkFlow Database WF-02

SouthWare Excellence Series™ (Revision 15) 13

WF-02 WorkFlow Database

The options in this section let you define or change the standard filesused by SouthWare WorkFlow™.

Page 14: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-01 Process Flow Records

14 SouthWare Excellence Series™ (Revision 15)

Process Flow Records

WF-02-01 Process Flow Records

This program lets you define the process records that serve as anoverview of the programs involved in a process. You do not changethe flow with these records, but you use these records to outline theinter-relationship between the programs.

Note: The standard process database contains records for majorprocesses. There are other processes that may not be definedin this database.

1. Process ID:

Enter up to ten characters to identify this process.

2. Sequence:

Enter the relative 3-digit sequence of this record in the entireprocess. Press <Enter> to assign the next sequence number. Theprogram assigns numbers in increments of 10 to leave room forlater additions.

Page 15: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Process Flow Records WF-02-01

SouthWare Excellence Series™ (Revision 15) 15

If this is the first record for this process this field willautomatically be zero. The zero sequence record is used to containthe description for the entire process.

3. Program ID:

Enter the Program ID of the program for this record. The fieldallows up to 12 characters to provide for the unique switchesneeded for some records (such as RSBILPRT/M/A).

This field is skipped for the zero sequence record.

4. Description:

If this is the zero sequence record, here you enter the overalldescription of the process (up to 30 characters).

For other records you may leave this field blank to have theprocess description be the description as defined for the ProgramID record. You may also enter a description here to override theProgram ID description if the use of the program in this process isdifferent.

5. Comments:

Enter up to five 60-character lines to more completely describe thisrecord. When you highlight this record at the Process Level of theWork Flow Controller window the comments will appear in a box.

6. Extract ID:

If this record is part of group of related records that need to bemoved to another system enter an Extract ID for the group. TheExtract ID packager (XX-08-06-03) can be used to extract andimport records that are part of a group.

Page 16: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-02 Program Definition Records

16 SouthWare Excellence Series™ (Revision 15)

Program Definition Records

WF-02-02 Program Definition Records

Here you may maintain the program documentation that describes theuse of a program. These records display in the WorkFlow Controllerlist at the Program Level to help document what programs are involvedin a process. They also provide the descriptions for relating togetherall the FlowPoints in each program.

You may also find some of the program switches documented in theWorkFlow Program database. This is not an exhaustive link ofswitches but includes some of the common ones that might be useful todealers/users.

The WorkFlow Program Database includes a record for each standardSouthWare program. This database serves as the input for themanagement of programs in the SouthWare Environment Managerprogram XX-05-01). You may define a FlowMod for any FlowPoint inthe program (see the discussion "To Find a FlowPoint ID" inWF-02-03).

Security Note: Special Maintenance programs will not be available.

Page 17: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Program Definition Records WF-02-02

SouthWare Excellence Series™ (Revision 15) 17

1. Program ID:

Enter the program ID for this program. You may enter up tofifteen characters to allow for program switches (such as the "Q"switch in "RSBILENT/Q").

2. Description:

Enter a 30-character description of this program. This is thedescription that will appear in the Work Flow Controller list.

3. Comments:

Enter a 30-character description of this program. This is thedescription that will appear in the Work Flow Controller list.

Fields 4 and 5 are used only for Maintenance and Entry type programs. They are used for the "90 series" standard FlowPoints that are availablefor all Maintenance/Entry Programs. See the "Primary File" discussionin the WF-02-04 section.

4. Master File:

Enter the Data Dictionary File name for the master file maintainedby this program. Do not enter a file ID here unless you know the

program makes the primary record information available to

WorkFlow, which is normally only in maintenance/entry programs.

5. Secondary File:

Enter the Data Dictionary File name for the secondary file (if any)maintained by this program. Do not enter a file ID here unless you

know the program makes the secondary record information

available to WorkFlow, which is normally only inmaintenance/entry programs.

6. Program Type:

Here you may specify the type program/format that this recorddocuments:

C Conversion - this is an upgrade conversion programF File Maint/Entry - this is a normal maintenance or entry

programI Import Update - this is an update program used by

ImportMate II technologyO Other - this program doesn’t fall into any of the other

categoriesP Print - this is a normal print programQ Inquiry - this is an inquiry program

Page 18: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-02 Program Definition Records

18 SouthWare Excellence Series™ (Revision 15)

R ReportMate - this is a ReportMate format (this recorddefines the Primary File so that you may use the 8701FlowPoint to launch a FlowMod from the running of thereport

S Search Utility - this is a search/lookup programT TaskWise Alert Driver - this record defines the primary

file for a TaskWise Alert Driver recordW WorkFlow Only - this record defines a record that is set

up to define the primary file for special proceduralFlowPoints

7. Extract ID:

If this record is part of group of related records that need to bemoved to another system enter an Extract ID for the group. TheExtract ID packager (XX-08-06-03) can be used to extract andimport records that are part of a group.

8. Special Handling:

This field contains some special indicators used by SouthWaretechnology. Normally you should not edit these values:

(blank) No special handlingX Extended Data maintenance or import of XD values - the

program name varies based on the XD type and themaster file may be determined at runtime

O Override number is required for one or more fields

9. Override ON Log FM:

(This applies only to records that have “F” Program Type and thathave a Primary File; requires security level of 7 for SwiftMate)

This field allows you to selectively turn on data maintenanceauditing for records Added, Changed, or Deleted in thePrimary file for this record. This enables the audit logging forchanges made with this program regardless of whetherauditing is enabled for the file. This can be useful for specialmaintenance programs when you want to audit overridechanges to files without auditing all changes to the files.

This field displays a window of Data Maintenance AuditingOverride Flags that you may set for a program (these flagsapply only to the Primary File for the program):

Add Records Flag

Turn this on (“Y”) to create an audit record for each

Page 19: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Program Definition Records WF-02-02

SouthWare Excellence Series™ (Revision 15) 19

record added to the Primary File by this program.

Delete Records Flag

Turn this on (“Y”) to create an audit record for eachrecord deleted from the Primary File by this program.

Field Changes Flag

Turn this on (“Y”) to create an audit record for eachfield changed in the Primary File by this program.

See "Data Maintenance Auditing System"( XX-02-04) formore information.

Page 20: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-03 WorkFlow FlowPoints

20 SouthWare Excellence Series™ (Revision 15)

Special FlowPoint Records

WF-02-03 WorkFlow FlowPoints

This program maintains the definition information for each FlowPointavailable in the system. All the fields here except for the Commentsare actually stored in the SouthWare Data Dictionary also used byReportMate™, ImportMate II™, and other products. The Commentsare stored in the Help file.

Note: This database does not include all SouthWare FlowPoints. Itincludes FlowPoints for the programs that you typicallymodify (the entry and maintenance programs). Even if aFlowPoint is not in this database you may still define aFlowMod for any FlowPoint in the program. See thediscussion "To Find a FlowPoint ID" later in this section.

1. Program ID:

Enter the Program ID for this record (up to fifteen characters toallow for switches).

2. FlowPoint ID:

Enter the FlowPoint ID assigned within the program. This is a six-character field and is the change number and sub-change numberfor an entry program.

Page 21: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WorkFlow FlowPoints WF-02-03

SouthWare Excellence Series™ (Revision 15) 21

Fields 3 and 4 are entered only if this is a new FlowPoint. If theFlowPoint already exists the record will be displayed after you enterthe FlowPoint ID.

3. DD File:

Enter the Data Dictionary File number for this FlowPoint. Youmay use the Lookup feature.

4. DD Field:

Enter the Data Dictionary Field number for this FlowPoint. Youmay use the Lookup feature.

5. Description:

Enter a 20-character description of this FlowPoint. This is thedescription that will appear in the Work Flow Controller list.

6. Comments:

Enter up to five 60-character lines to more completely describe thisrecord. When you zoom to this record from the WorkFlowController window you can review the comments.

7. Has Fail/Continue Logic?:

Enter “Y” if this FlowPoint has special logic coded into theprogram to handle Fail and Continue steps in WorkFlowFlowMods. This will allow you to define a Fail or Continue stepin a WorkFlow FlowMod for this FlowPoint.

Press <Enter> to default to “N” if this field does not have specialFail/Continue logic.

8. Primary File Name:

This field applies only to special WorkFlow FlowPoints that arenot data entry fields. Here you must enter the Data Dictionary FileName for the Primary File being updated at the time of thisFlowPoint. WorkFlow uses this file to determine the Primary Filefor a FlowMod, which determines which Data Dictionary fieldsare available in the FlowMod.

The next two fields allow you to specify that this FlowPoint should bepresented in the WorkFlow Controller as being part of a differentprogram. This might be needed for a subroutine or other program thatappears to run as part of another process.

Page 22: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-03 WorkFlow FlowPoints

22 SouthWare Excellence Series™ (Revision 15)

9. Doc O/R Program:

Leave this field blank to use the program ID in field 1 above as thedocumented program for this FlowPoint. If necessary you mayenter an override program ID to use when documenting thisFlowPoint in the Controller.

10. Doc O/R FlowPoint ID:

Leave this field blank if you are using the FlowPoint ID in field 2above as the documented program for this FlowPoint. If necessaryyou may enter an override FlowPoint ID to use when documentingthis FlowPoint in the Controller.

General FlowPoints

Here are some standard FlowPoints available:FlowPoint Description

Available in All Programs (File ID of "ZF00")

0001 Start of a program before any security checking is done

(available in all programs) - Has Fail/Continue logic

0002 Start of a program just prior to the display of a screen(available in all programs). In entry/maintenanceprograms this is the point where Screen Overrides areexamined and implemented if applicable.

9999 Exit of program after all processing.

Available in Entry/Maintenance Programs (File ID of "ZF90")

8898 Delete question for master record889802 Delete question for secondary record8899 Abandon question for master record889902 Abandon question for secondary record90 Start of FM Logic (entry logic)9001 After the Screen Format is displayed

9099 Before the Data is displayed for a record - Has

Fail/Continue logic

91 Display of Master record92 The accept at the Enter Change Number prompt for a

master record92CHG# Occurs when you are accessing a change number for an

existing record in change mode. The Current Field valueat this FlowPoint will contain the field number of thefield about to be accessed. This can be either a primarytwo-digit FlowPoint number or a primary field in a PlusBox window (see Limitation for field groups below).

Page 23: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WorkFlow FlowPoints WF-02-03

SouthWare Excellence Series™ (Revision 15) 23

This procedural FlowPoint contains FAIL logic - if yourFlowMod specifies to FAIL then this will abort the accessof the change number. If you are trying to access thefield from the Change Number prompt this abort willreturn to the change number field. If you are accessingthe field in another way the abort will be similar to a skipfield and will go to the next field.

Notes and Limitations! This FlowPoint does not apply to adding a record or

to accessing a record in inquiry mode.! If you define a FlowMod for this FlowPoint it will be

executed at every field in the program that you accessin change mode. If you only need the FlowMod to beexecuted at one or two fields it will be more efficientto use the individual field FlowPoint(s) instead ofthis global FlowPoint.

! This FlowPoint is a procedural FlowPoint, not anaccept FlowPoint. If you want to test for a functionkey pressed or other entry then you should do this atthe normal “92" or “96" FlowPoints or at a specificfield FlowPoint.

! This FlowPoint is only executed at the first field ofany special field “groups”. For example, inCustomer Maintenance the Credit Limit and CreditRating fields are part of a group - the FlowPoint isexecuted only at the Credit Limit field.

! Timing 1 and Timing 2 FlowMods will not beexecuted at the Change # field. Timing 3 FlowModswill be executed at the Change # field since this is aprocedural FlowPoint.

ExampleLet’s say that when operator JSMITH accesses customermaintenance you only want him to be able to change theaddress info (fields 2 through 7). This FlowPointprovides a simple way to do this via a FlowMod:

Program: ARCUSTMNFlowPoint: 92CHG#Steps:

IF XX990001 (operator) = ‘JSMITH’AND Current Field LT 8

Page 24: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-03 WorkFlow FlowPoints

24 SouthWare Excellence Series™ (Revision 15)

EXITELSE FAILEND

9202 Second character of the Change # prompt. At thisFlowPoint you can test Current Field, which will be thesecond character entered. However, the primary purposeof this field is to record the value for all entries whenrecording RCF Packets.

9299 After you have specified to write a record but before the

record is actually written - Has Fail/Continue logic thatreturns to 92 on the Fail

93 After the I/O (read/write) of a master record94 End of FM Logic (entry logic)

9401 After the Secondary Screen (e.g. line item) Format isdisplayed

9499 Before the Data is displayed for a Secondary record - Has

Fail/Continue logic

95 Display of Secondary (e.g. line item) record96 The accept at the Enter Change Number prompt for a

secondary record9602 Second character of the Change # prompt for a secondary

record. At this FlowPoint you can test Current Field,which will be the second character entered. However, theprimary purpose of this field is to record the value for allentries when recording RCF Packets.

9699 After you have specified to write a secondary record but

before the record is actually written - Has Fail/Continue

logic that returns to 96 on the Fail97 After the I/O (read/write) of a secondary record

Available in Print Programs (File ID of "ZF91")

8601 At the Accept of the Output Option8602 At the Accept of the Spool File Name8603 At the Accept of the Spool Format Name8604 At the Accept of the Alternate Printer Name

Page 25: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WorkFlow FlowPoints WF-02-03

SouthWare Excellence Series™ (Revision 15) 25

FlowPoint for Printing

You now have a FlowPoint in the SWPRTOVR program that isexecuted on each print job before the default names such as spool filenames are established. This can be helpful if you need to establish aglobal FlowMod for print jobs.

This FlowPoint is defined as follows: Program ID: SWPRTOVR FlowPoint: 8703PTDD File: ZF23DD Field: 9Primary File: XX99Has Fail Logic: N

Example:Let’s say you want to change the default spool file name foreach print job. In the spool format record you can define avariable that utilizes an XX99 field. Then via this newFlowPoint you can modify the XX99 field for each print job.

To Find a FlowPoint ID

The FlowPoint database documents the commonly used FlowPointsand the FlowPoints that you would not be able to find out on your own(such as general FlowPoints and FlowPoints in update programs). There are hundreds of other FlowPoints that are not documented herebut are easy to find.

If you are in a field, message, question, etc., you may use the Modifyfunction to display the FlowPoint ID for that point in the process. TheModify screen displays the FlowPoint ID in the lower middle of thescreen. In some instances there may not be a FlowPoint, in which casethe screen displays "FlowPoint not available".

For example, if you want to call a special routine at the sequenceselection field in AR Inquiry (AR-04), go to that accept and accessModify (the button or <Ctrl R><Ctrl R>). The middle of the screenshows you that the program is AROPENIN and that the FlowPoint is"8907". This would also work at Report selection parameter fields,questions, etc.

Page 26: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

26 SouthWare Excellence Series™ (Revision 15)

Define FlowMods

WF-02-04 FlowMod Maintenance

In this program you define FlowMods for particular FlowPoints. TheFlowMod is essentially custom programming that you create withsimple-to-use but powerful commands. It is automatically incorporatedinto the standard program and is evaluated/executed at the appropriateFlowPoint.

With SouthWare WorkFlow you can add one or more FlowMods to aparticular SouthWare FlowPoint (field, question, or other processingpoint in a program). When the related program gets to that particularpoint, it turns control over to WorkFlow to take whatever FlowModstep(s) you have specified. From your standpoint your FlowMod hasthe same effect as if you had changed the standard program.

When the standard program turns control over to WorkFlow it makesavailable the current record information. Your FlowMod can thenwork with the current record information (read it or change it) just as ifthe standard program was doing the work.

Page 27: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 27

FlowMods really serve as a programming language that is simple to useand understand. You get the flexibility of custom programming withinstandard programs!

In the SouthWare Environment Manager (XX-05-01) you may identifyand view the FlowMods set up on your system. There are two levels ofreview:

- All FlowMods - from the main list of selections in theEnvironment Manager you may select “CustomizationFeatures” and then “WorkFlow FlowMods”. This will list allof the FlowMods defined on your system. As you highlighteach record the preview pane shows the steps for theFlowMod. You may also zoom to the FlowMod for editingvia the Edit function.

- FlowMods per Program - from the main list of selectionschoose Programs, choose an application, and expand aprogram. You may then expand the “Program FlowPoints”selection to see all the FlowPoints. Any FlowPoint that has anexisting FlowMod will display a “Y” in the description andwill display a different icon on Windows workstations. Youmay expand the FlowPoint to see the FlowMod(s). As youhighlight each FlowMod record the preview pane shows thesteps for the FlowMod. You may also zoom to the FlowModfor editing via the Edit function.

1. Program ID:

Enter the program ID for this FlowMod. If you use the Lookup ofWork FlowPoints this will be filled in.

The ID is validated against the Program ID file (WF-02-02), butyou may use a Program ID that does not exist in that file.

2. FlowPoint ID:

Enter the FlowPoint ID assigned within the program. This is a six-character field and is the change number and sub-change numberfor an entry program. If you use the Lookup of FlowPoints thiswill be filled in.

The FlowPoint ID is validated against the Data Dictionary, but youare not limited to FlowPoints that exist in the Data Dictionary. Seethe "To Find a FlowPoint ID" discussion in WF-02-03.

Page 28: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

28 SouthWare Excellence Series™ (Revision 15)

Primary FileAfter you specify the FlowPoint the program determines thePrimary File for the FlowPoint and displays it to the right of thescreen. This is the Data Dictionary file it uses to screen whichfields are available for reference in this FlowMod. The programfirst looks at the Data Dictionary to see if a record exists for thisFlowPoint:- If a Data Dictionary record exists the program checks to see if

the record contains a Primary File:- if there is a Primary File, this file is used- If a record does not exist or does not contain a Primary

File, the program looks at the Program ID record if itexists and uses the appropriate file indicated there- if there is not a Program ID record or not a file

indicated then the Primary File is set to be "XX99". This allows you to access system data such asoperator, company ID, link values, security levels,and other non-application data.

Note: The WorkFlow functions that reference the DataDictionary (e.g. IF and REPL) utilize the same utilities asReportMate™. If you try to call a ReportMate™ reportin the same FlowMod as you’re referencing the DataDictionary in other steps the results are unpredictable. For this reason you should always do a call to aReportMate™ format in a separate FlowMod record thatdoesn’t have any other references to the Data Dictionary. If the call to ReportMate™ is an integral part of amodification you can use the GOTO step to call to theseparate FlowMod containing the ReportMate™ call.

3. Execute Timing:

This field controls whether the FlowMod occurs before or after thenormal processing at this FlowPoint. ! Enter "1" if the FlowMod should be processed before the

FlowPoint- this is always the timing for non-entry FlowPoints- for entry FlowPoints this is before you have entered any

data! Enter "2" if the FlowMod should be processed after the

FlowPoint (after you have entered data) - this applies only to a

field in which you enter data.! Enter "3" if the FlowMod should be processed at the exit of

Page 29: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 29

the FlowPoint - this applies only to a data field in an

entry/maintenance program. This is after the processing forthe field is completed. If the FlowPoint lets you enter data,the Exit is after the field data is written to the record and afterany display of the data. The situations that require this timinginclude:

- when you want to change the value of the data entered (atthe After timing the data is not yet placed in the record -at Exit timing the data is now in the record area for you tochange)

- you want to execute a FlowMod at the end of a field thatis automatically skipped (thus the "2" timing is notavailable)

4. FlowMod #:

Enter a two-digit number to indicate the relative sequence of thisFlowMod to other FlowMods defined for this FlowPoint. Thisallows you to have up to 99 FlowMods for each of the threetimings for a Work FlowPoint. With this number you also controlthe sequence in which they are processed. Press <Enter> to assignthe next sequence number. The system assigns new numbers inincrements of five to allow room to insert FlowMods later.

5. Description:

Enter a 30-character description of this FlowMod. This willdisplay in the Work Flow Controller window to help you identifythe FlowMod.

6. Comments:

Enter up to five 60-character lines to describe the purpose of thisFlowMod. You should think of this as the “documentation” foryour programming change. When you zoom to this FlowModfrom the Work Flow Controller window you can review thesecomments.

7. Mode:

If this FlowMod is related to an entry or maintenance program,indicate whether the FlowMod applies when you are <A>dding arecord, <C>hanging a record, or <B>oth. Press <Enter> to defaultto <B>oth.

NOTE: If you specify <B>oth you may also define a conditionaltest for Add or Change mode within a FlowMod step so

Page 30: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

30 SouthWare Excellence Series™ (Revision 15)

you don’t have to create different FlowMods for Add andChange mode.

8. Special Options:

This field contains options that you may set when needed:

Extract ID

If this FlowMod is part of a set of related FlowMods (such as foran applet) you may enter a ten-character code to identify the set(such as the applet ID). The FlowMod Export utility (WF-03-06)lets you export FlowMods to a file for transfer to another system,and you may select a group of FlowMods for export via theExtract ID. This Extract ID also lets you activate or deactivate agroup of FlowMods (see "To Turn On/Off a Group of FlowMods"later in this section). Defaults to blank during add of a record.

Repeat if Validation Error?

This flag is functional only on validated data entry FlowPoints.

This flag controls what will happen in WorkFlow when the relateddata entry point determines that an entry is not valid and thenreturns to accept the entry again. Enter "Y" if you want WorkFlowto execute this FlowMod each time the program loops back toaccept data after an invalid entry. Enter "N" to have WorkFlowexecute this FlowMod only the first time data is accepted and noton subsequent accepts because of invalid data. This defaults to

"N" during add of a record.

Here are some considerations when programming this flag:

- Normally this flag should be "N" since the FlowMod mayhave been responsible for putting the invalid data into the field(from a Replace, keystroke object, etc.). If you say "Y" in thissituation you have created a programming loop! Thevalidation of the field won’t let you continue on past the fieldwith an invalid value, but the FlowMod will continually putthe invalid value into the field. If this happens you will haveto "kill" the runtime session, come back up, fix yourprogramming problem, and enter the record again.

- One example where this should be "Y" is when the FlowModinvokes a Field Filter for the field. If the filter passes aninvalid value to the data entry field, you normally want theprogram to call back to the Filter.

Page 31: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 31

9. Active?:

Press <Enter> to default to "Y" to make this an active FlowMod. You may enter "N" to deactivate this FlowMod. Deactivating aFlowMod can be particularly helpful when you are debugging aseries of FlowMods and want to turn off a FlowMod withoutdeleting it. This defaults to "Y" during add of a record.

See "To Turn On/Off a Group of FlowMods" later in this section.

10.-19. Steps:

In these fields you may define up to ten individual steps for thisFlowMod. For each step you first indicate its Type as shown inthe pop up selection box.

The remaining info for the step is dependent on the Type asexplained in the table below. Valid types are:

IFEXECENDFILTREPLRETNINSDISPGOTOMESGUTILCALCANDORELSEFAILCONTEXITCALLSCRNLFMTSFFOACRE

NOTES:

! Not all of these types are available at all FlowPoints or timingsituations. See the table below for more details.

Page 32: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

32 SouthWare Excellence Series™ (Revision 15)

! While you may execute multiple FlowMods at a FlowPoint, ENDand MESG Steps may only refer to other Steps in the sameFlowMod. An IF must have its END or a MESG must have itsMESSAGE in the same FlowMod, not in another FlowMod.

! Applicable Entry Routines for Literals/Constants

When you define a FlowMod step that replaces a field with aliteral or constant the program uses any applicable entry routinewhen accepting the literal or constant. For example, if you arereplacing a data dictionary field that is a customer number with a"literal" the program will accept the literal via the customernumber entry routine and format the value appropriately (such asinserting leading spaces). This eliminates the need to format theliteral or constant for data such as customer numbers, vendornumbers, dates, etc.

Special Notes on Current FieldCurrent Field is a special WorkFlow data field that contains thevalue of the current FlowPoint field. If the current FlowPoint isunknown or undefined then the format of "Current Field" isunknown to the program. If you specify to enter or test aliteral/constant the program will ask you the following informationabout the literal/constant value:

Type of field - Alphanumeric, numeric, or dateSize of fieldNumber of decimals (if numeric)

This will let the program automatically format the value you enterfor a literal/constant.

Date ExceptionOne exception to the standard of using entry routines is when youare replacing a fixed date into the "Current" field at Timing 1when the Current field is a date. In this situation the program doesnot use the date routine since the constant to be entered in theCurrent field is the unformatted (typically MMDDYY) value youwould normally enter in a date field instead of the formatted(CCYYMMDD) value that is actually stored for each date. If youare not using Current field but are replacing a Data Dictionary datefield the program will use the date routine to format the constant.

Page 33: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 33

Type Related Information Entered Examples

ACREAccept andReplace

Accept data from the user and replace thevalue in a field with the accepted data.

See “Create Your Own EntryField with ACRE” below.

AND Additional test condition following an IF thatmust also be true in order for the remainingsteps before END-IF to be taken. Test allowsthe same operands and operations as the IFType.

AND (operand 1) (operation) (operand 2)

If the Order has a backorderand it has not been reviewed,display a message and don’tcontinue:

IF (Ord B/O Status) NE 0

AND (XD Rvw Flag) NEY

MESSAGE B/O-REVIEW FAILEND-IF

Page 34: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

Type Related Information Entered Examples

34 SouthWare Excellence Series™ (Revision 15)

CALCCalculate

This type lets you define a calculation andthen name the result for reference in anotherstep.

CALC (op 1) (operation) (op 2) (result)

operand 1 can be: !Data Dictionary field!CALC* (from a previouscalculation)!DATE* (from a prior step)

operation can be: !+ (add)!- (subtract)!* (multiply)! / (divide)! % (percentage)

NOTE: If operand 1 is a date, the only

valid operations are add and

subtract.

operand 2 can be: !Data Dictionary field!Constant!CALC* (from a prior step)!DATE* (from a prior step)

NOTE: If operand 1 is a date you may

subtract another date (for a date

difference) or add/subtract a

constant (to increment/decrement

the date).

result can be: !CALC* (to name the resultfor future reference) where"*" is a number from 1 to 9

!DATE* (if you add/subtract aconstant from a date) where "*" isa number from 1 to 9 - this lets yourefer to the computed date in alater step

To test to see if a ShippingDate is more than 30 daysafter an Order Date:

CALC (Ord Dt) - (ship Dt) (= CACL1)IF CALC1 > 30..etc...

CALLCall aCustomProgram

This Type calls a COBOL program. Itspurpose is to use the FlowMod to passinformation and control to an externalprogram at a FlowPoint. When you select thisType of Step you must enter the CustomProgram Name. You may also select whetheryou want the program to be canceled after thecall or left resident in memory until the callingprogram is exited.

CALL myprogram

Page 35: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

Type Related Information Entered Examples

SouthWare Excellence Series™ (Revision 15) 35

CONTContinue

At certain FlowPoints you may specify thisType. If a “CONTINUE” step is encounteredby Work Flow Control, it tells the relatedprogram to CONTINUE and returns control tothe program (any following steps orFlowMods are ignored). How the programhandles this condition is coded specifically foreach FlowPoint, but it generally means thatthe program will execute the standard actiontaken at this point.

(See OR example)

Page 36: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

Type Related Information Entered Examples

36 SouthWare Excellence Series™ (Revision 15)

DISPDo a specialDisplay

With the DISP step you may use WorkFlow todisplay text or data on your screen. This isuseful for situations such as:! when you want to display statusinformation! when you want to conditionally place a textliteral on the screen (such as to warn about asituation)! when you want to display a related piece ofdata from another file! when you want to display screen formattingsuch as lines or bitmap images! when you want to display a floatingwindow on the screen

Remember that a DISP step:! puts data on the screen but does not take itoff - you will have to display spaces to removeit! is in addition to any normal displays, notinstead of them

To create a DISP step:! Enter any preceding steps in the FlowModsuch as for conditional tests.! Enter DISP as the step type.! Indicate what you want to display:

Data fieldMessage responseCalculation resultDateCurrent FieldLiteral/ConstantLine Draw (a graphic line)Bitmap

! Indicate the needed info for what you wantto display such as the field ID, label text,calculation ID, etc.! For data or labels indicate the Display type- whether to display as a label, entry field,prompt, framed label, or non-fonted text! Indicate the beginning Line and Column forthe display.! Indicate the size of the display.! Specify any display attributes to use.

IF customer balance over10000 DISP (Balance is) DISP (cust balance)END

(when no longer needed)DISP (spaces)

See “To Dispaly a Floating

Window” for more details on

Floating Windows

Page 37: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

Type Related Information Entered Examples

SouthWare Excellence Series™ (Revision 15) 37

ELSEElse

This Type indicates that the steps followingthe ELSE are to be taken only if the preceding

IF test(s) in this FlowMod are not true. Forease of understanding the program does notallow you to put any other test steps (IF,AND, OR) in a FlowMod after an ELSE Typestep. However, you can do further testing in asubsequent FlowMod.

(see OR example)

ENDEnd-If

This Type simply indicates that all the stepsfor an IF test have been entered. To reduceconfusion the program requires you to enteran END-IF step if you have specified an IFstep. Any steps after an END-IF are notconditional on the IF test(s).

(see previous examples)

EXECExecute

With this Type you execute a SouthWare®object:

EXEC (Object ID)

Enter the ID of an object or use the Lookup tocreate a new object. This could call aprogram, execute keystrokes, etc. In Rev 6 ofthe SouthWare Excellence Series™ this wasthe result of a Field-Level Object.

(See 1st IF example)

EXITExit

This Type step tells WorkFlow Control toreturn control to the program and ignore anyfollowing steps or FlowMods for thisFlowPoint. This is useful in conjunction witha series of IF tests where you want to skipother tests once you get a true test. This issimilar to a CONTINUE except that it is notdependent on any special coding in the relatedprogram.

You have defined threedifferent FlowMods for aFlowPoint, but if a conditionis true at the end of the firstFlowMod you don’t want togo on to the last twoFlowMods:

FlowMod 1(steps)IF (test for condition to betrue) EXITEND-IFFlowMod 2(steps)FlowMod 3(steps)

Page 38: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

Type Related Information Entered Examples

38 SouthWare Excellence Series™ (Revision 15)

FAILFail

At certain FlowPoints you may specify thisType. If a “FAIL” step is encountered byWork Flow Control, it tells the relatedprogram to FAIL and returns control to theprogram (any following steps or FlowModsare ignored). How the program handles thiscondition is coded specifically for eachFlowPoint, but it generally means that thestandard action at this point will NOT beexecuted.

(See examples above)

FILTFilter

This Type of step launches a Field Filter (seeXX-09-07-01). You may use it at an entryfield to provide additional validation orediting of the data entered. When you use thisstep type you must enter the Filter Number touse.

(at the Class/Size field)FILT (# of Class/Size filter)

GOTOGo To

With this Type you direct WorkFlow to go toa specific FlowMod number for processing:

GOTO (FlowMod #)

This skips any subsequent steps in the currentFlowMod and goes directly to the FlowModnumber specified.

IF (condition is true)GOTO 10ELSEGOTO 20END-IF

Page 39: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

Type Related Information Entered Examples

SouthWare Excellence Series™ (Revision 15) 39

IF This Type tests a condition to see if the nextsteps until END-IF should be taken:

IF (operand 1) (operation) (operand 2)

operand 1 can be:!Data Dictionary field!Work Flow Message Response (if aprior step was a MESSAGE)!CALC* from a prior step!DATE* from a prior step

Special: !If the FlowMod Mode is <B>othadd and change, you may selectADD-MODE or CHG-MODE asthe condition for the test. Nofurther info is needed for the step.

!If the FlowMod Timing is Before orAfter, you may select "Current Field" asthe condition for the test. "CurrentField" is the value the operator entersinto the field. You may also test for anyvalid function key that is not a globalfunction key (e.g. you may test for <F5>but not for <F9> since <F9> invokes aglobal function). Exit Timing should testData Dictionary field.

operation can be:!LT - Less Than!GT - Greater Than!EQ - Equal To!NE - Not Equal To!GE - GT or EQ!LE - LT or EQ!MM - Mask Matching (alpha only)!NM - Mask No Matching (alpha only)

operand 2 can be:!Data Dictionary field !Work Flow Message Response (if aprior step was a MESSAGE)!CALC* from a prior step!DATE* from a prior step!Literal or Constant!Function key value (see TestingFunction Keys notes later)

Launch an object if the 6thXD field for the Order Headeris not Y, then put a Y in thefield:

IF XK03 0006 NE Y EXEC (Object) REPL XK03 0006 with YEND-IF

If the user’s response to amessage is N, don’t continue:

IF MESG-RESP = N FAILEND-IF

IF Current Field EQ <F5> EXEC (Object)

Page 40: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

Type Related Information Entered Examples

40 SouthWare Excellence Series™ (Revision 15)

INSInsert

This Type lets you insert keystrokes into thekeystroke buffer - these will be "played" at thenext accept of data. For this Type of step yousimply indicate the keystrokes to be "played":

INS (keystrokes)

(keystrokes) can be any valid keyboardcharacters. For function keys you may entervariables as described in the prompt.

If you are using Insert at a data entry field andthe Execute Timing is Before, the keystrokeswill be played into the field. If the Timing isAfter, the keystrokes will be played at the nextaccept after this field.

If you use INS at a non-accept FlowPoint thekeystrokes will stay in the buffer until youreach an accept field. This can be helpful in asituation such as when you use WorkFlow tocall out to a ReportMate™ report from a non-accept point and want to automatically answerall the questions (via keystrokes) when youget to the report.

Note: This is equivalent to launching akeystroke object. If the keystrokesare unique to this situation, theINS step is the best approach. Ifthe keystroke combination will beuseful in other FlowMods thendefining a keystroke object is thebest approach.

When a user changes field 12in a record you want toautomatically take them tofield 25:

Define a change modeFlowMod for field 12 that isexecuted After the field:

INS 23<CR>

Whenever the user exits field12 in change mode theFlowMod will enter thekeystrokes necessary to go tofield 25.

LFMTList FormatforSearch/Inq

Allows you to use WorkFlow in conjunctionwith ReportMate to customize the format ofsearch lists and inquiries. The step type is"LFMT" for List Format and allows you tospecify a ReportMate format to use for the listformat.

See “Variable List Feature forSearches and Inquiries” in theRM-02 ReportMatedocumentation.

Page 41: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

Type Related Information Entered Examples

SouthWare Excellence Series™ (Revision 15) 41

MESGMessage

This Type displays a Work Flow Message. When you specify this Type of step you mustenter the Message ID or use the Lookup tocreate a Message ID (see Work FlowMessages for more info).

MESG (ID)

ID is the ten-character identifier you assignedto a particular message you defined.

Ask a question at a specialFlowPoint, and if the userdoesn’t answer Y then don’tcontinue:

MESG ASKQUESTIF MESG-RESP NE Y FAILEND-IF

OR Alternative test condition following an IF. Either the IF or the OR (but not both) must betrue in order for the remaining steps beforeEND-IF to be taken. Test allows the sameoperands and operations as the IF Type.

OR (operand 1) (operation) (operand 2)

At a credit check point,continue only if CustomerUser Field 1 is not Y or ifCustomer Credit Field is notREVW:

IF (Cust User 1) NE YOR (Cust Credit) NE REVW CONTINUEELSE MESG CREDITSTOP FAILEND

Page 42: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

Type Related Information Entered Examples

42 SouthWare Excellence Series™ (Revision 15)

REPLReplace

With this Type you replace the contents of adata field related to this FlowPoint with a newvalue. This is in the format of:

REPL (datafield) WITH (newvalue)

“datafield” is the Data Dictionary referencefor a field. The data fields available at aparticular FlowPoint will depend upon therecord(s) being updated. You may alsospecify a “temporary” field to access the listof ULink fields.

“newvalue” is the value you want to place inthe field:!You may enter a literal or constant - theformat will depend upon the format of thefield you’re replacing. !You may specify a Data Dictionaryreference if the new value should come fromanother field (including a temporary ULinkfield).!You may specify a CALC* or DATE* fieldfrom a prior step.

Note: If you are using this function toreplace the value in another file,you should normally do this only atthe write/rewrite of the currentrecord. If you do this prior towriting the current record and thenabandon the current record entrythe changes you made to anotherfile will not be "undone".

See also the “Option to REPL Data withLiterals Longer Than 30 Characters”discussion below.

(See 1st IF example)

Page 43: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

Type Related Information Entered Examples

SouthWare Excellence Series™ (Revision 15) 43

RETNRe-Accept

With this Type you tell the system to re-acceptthe field just entered. It is valid only for aFlowPoint which accepts a value from theuser and only for the "After" or "Exit"timings. A typical use of this field is to testthe "Current Field" value and then "RETN" ifyou want to force the user to enter a differentvalue. No other information needs to beentered for this type of Step.

Notes:

!Make sure your FlowMod allows the user toget out of this "loop" with any function keysthat you consider valid. The <F8> key willget you out of a RETN condition, but anyother key must be valid in your FlowMod testin order to exit the field. See the secondexample to the right.!A difference between the "After" and "Exit"timings for a return is that the "Exit" point isexecuted even if a field is auto-skipped in thestandard program while the "After" occursonly if the field is actually accepted (even ifyou are "skipping" it via WorkFlow).

(if you want to force a non-zero answer in a numeric field)IF Current Field Not GT 0 RETNEND

(to do a RETN only on dataentered, not on any functionkey pressed - unless the fieldis terminated normally the testwill not apply)IF Current Field NE FKey<NL> EXITENDIF Current Field NE (testvalue) RETNEND

(note that the <NL> keytested above includes any keythat normally exits a fieldincluding <Tab>, <ShftTab>,and Up/Dn arrows)

SCRNScreenOverride

This Type allows you to add a special ScreenOverride to a program via a FlowMod. Thistype is available only at the FlowPoint of"0002" in entry programs. You may enter aFlowMod step type of "SCRN" and then enterthe Screen Override number. For example,you could create a FlowMod step that tests theoperator security level and calls particularoverrides based on the security level.

Note that any Screen Overrides that you callvia WorkFlow will be in addition to theoverrides in the records numbered 1 thru 9. The standard table is overridden by processingeach applicable Screen Override record usingthe Screen Override number sequence. If youare creating several different versions of ascreen you should be careful not to includeany overrides in records 1 thru 9 unless youwant them to apply to all situations or unless ahigher numbered override will supersede alower-numbered override.

(set up a screen override 50that hides certain fields)IF (operator sec level < 7) SCRN 50END

SFFOSF FormsTemplate

Used to call a WorkFlow Forms Template thatexecutes a particular forms program andSouthWare Forms record.

See “Create Your Own Formsas versions of StandardForms” later in this section.

Page 44: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

Type Related Information Entered Examples

44 SouthWare Excellence Series™ (Revision 15)

UTILLaunch aWorkFlowUtility

This Type allows you to launch one of thevarious WorkFlow utilities from a FlowMod. These utilize templates to automatically createSouthWare records. A selection menu allowsyou to choose:! Mail (WF-03-02)! Event (WF-03-03)! Note (WF-03-04)! Scheduled Action (WF-03-05)! Modify G/L Account Parts (WF-03-06)

After you select the type of utility you mustenter the appropriate template ID.

(create a mail template to sendmail to the salesperson for anorder that is shipped so thatthe salesperson can notify thecustomer)

(at FlowPoint that occurswhen an order is shipped)UTIL (mail, template ID)

After you have defined all the steps you need in a FlowMod simplyskip the remaining steps.

Insert/Delete/Cut/Paste Steps Options

You have several editing functions to help you with the creation ofFlowMods.

To Insert a StepYou may insert a step between existing steps as long as there areempty steps at the bottom of the FlowMod record. Go to the stepthat should follow the new step, press <F1> as shown in theprompt, and space for the new step will appear. All other stepsafter the new step will be moved down in the FlowMod.

To Remove/Delete a StepYou may remove a step by:- spacing out the step type field, or- by pressing <F2> at the field

To "Cut" a Step for Later InsertionIf you want to remove a step and then insert it elsewhere yousimply use the <F2> option to remove the step. The program savesthe last step you deleted so that you may "paste" it as describedbelow.

Page 45: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 45

To "Paste" a Step Previously DeletedOnce you have deleted a step with the <F2> Remove function youmay insert or "paste" it by going to the step slot you want to useand pressing <F4> as shown in the prompt. This inserts thepreviously-deleted step and moves subsequent steps down.

User Link Fields for Temporary Storage

There are fields in XX-99 (numbers over 900) that you may read andupdate with WorkFlow. These are "linkage" fields which contain noinitial data when you log on but may be used to store and access datathat is retained for an entire logon session. These are for advancedusers who need the equivalent of programming working storage fields. (These fields are in addition to the "Link User Passing" field already

available in Rev 7.0 which can be used for the same purpose.)

For example:L From one program you want to call to another program, find

the record you want, save some data about the record, andhave the saved data available when you return to the originalprogram.

L You are doing some complex calculations and want to storecertain results so that are available to other FlowPoints.

You may use these linkage fields as temporary storage fields for aFlowMod under the following conditions:

! You may not use these fields if you use a custom program thatalready uses ACU-SPECIAL-USER-LINKAGE.

! These fields are not cleared by any standard process during alogon session, so if you want to use a field as if it is emptyyou must use WorkFlow to clear any data out of the field(REPL it with zero or spaces).

! If you access a program via the Breakout or Link functionsand change these fields, the changes will not be reflectedwhen you return from the Breakout or Link. (You may use anobject, button, or RapidKey if you do want to retain thechanges when you return).

Note: Remember that these new fields are an alternate use of theACU-SPECIAL-USER-LINKAGE field available toSouthWare Developers. If you use custom programs then youmay not use these special fields and use the ACU-SPECIAL-USER-LINKAGE field without probable conflicts.

Page 46: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

46 SouthWare Excellence Series™ (Revision 15)

Testing Function Keys

When you choose to test a Function key in a step you may select one ofthe following function keys:

<F1> Function key 1<F2> Function key 2<F3> Function key 3<F4> Function key 4<F5> Function key 5<F6> Function key 6<F7> Function key 7<F8> Function key 8<UP> Up arrow<DN> Down arrow<ESC> Escape key<NL> New Line or Enter key - this includes all keys that

normally exit a field including <Tab>, <ShftTab>, andUp/Dn arrows

To Turn On/Off a Group of FlowMods

You may turn off/on a group of FlowMods by using the "UpdateActive Flags" option (<F4>). This lets you turn the Active flags on oroff for one or all Extract IDs.

! Press <F4> when you do not have a FlowMod record on thescreen.

! A pop-up window will ask you whether you want to set ActiveFlags to Yes or No. Select an option.

! You must then enter the Extract ID for the group. You may alsoleave the Extract ID blank to specify ALL FlowMods if you wantto activate or deactivate ALL FlowMods.

This feature is particularly helpful when debugging FlowMods. Youmay easily turn off all other FlowMods and then turn on only aparticular Extract ID. Or you could turn off only a particular ExtractID to test its impact.

Page 47: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 47

FlowMod Tips

To make a FlowMod apply to only one operator

Enter a step that tests the operator before continuing:IF XX99 01 EQ (operator) (whatever is to happen)END

To make a FlowMod apply to only one company

Enter a step that tests the company before continuing:IF XX99 05 EQ (Company ID) (whatever is to happen)END

Create Your Own Entry Field with ACRE

You have the ability to use WorkFlow to create your own “accept” ofdata via a filter at any FlowPoint. This feature is available via the“ACRE” (Accept/Replace) step type that uses the flexible features offilters (XX-09-07) for the actual accept of the data. If you want to askthe user to enter a number, code, value, etc. you can do this in aFlowMod by using an ACRE step that displays a filter to accept thedata and then places it in a temporary or permanent field for use insubsequent steps. This is similar to what you can do with an ExtendedData field, but with this feature you can:

1. accept data at any time (not just after all the normal fields andnot just through the Extended Data entry program) and

2. accept data even if you’re not going to store the data in a file.

Defining the filter for an ACRE stepWhen you define a filter for a WorkFlow accept you must specify theData Dictionary field (XX-09-07-01, field 3). The Data Dictionaryfield is the field that will be replaced with the value entered via thefilter. For example:- If you want to accept a value for temporary use and don’t need to

store it permanently you may press <F4> Temporary Field toaccess a list of the ULink fields (900 series) available in fileXX99. These fields are stored in memory but not stored in a file. If you use temporary fields you must be sure to keep track ofwhich ones you use so that you don’t have conflicting uses of thesame field.

Page 48: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

48 SouthWare Excellence Series™ (Revision 15)

- If you want to store the accepted value in a file simply use the DataDictionary lookup to specify the file/field identifiers.

Note: If you use an Extended Data field make sure theExtended Data record exists at the time you plan toreplace the field. When you add a new record itsExtended Data record is typically not created untilafter the normal record is written. See the examplebelow for a creative way to save an Extended Datafield value as a temporary field until the record canbe created.

Defining the ACRE stepWhen you define a FlowMod to use the Accept/Replace filter you mayenter the following information for an ACRE step:a. Filter number(the following are accepted only if the filter uses an Overlay Entry

Look)

b. Field label (the label the user will see that describes the field toenter)

c. Label Line/Column (the position for the display of the label)d. Accept Line/Column (the position for the filter accept field)

When the FlowMod executes the ACRE step, it will display the fieldlabel at the “Field Label” position and execute the filter you specifiedwith instructions to accept the data at the “Accept” position. Remember that your accept can use all the normal features of filterssuch as prompts, defaults, supplemental lookups, etc.

Note: The Floating Window feature described below is a great wayto accept a new field on an already-full screen.

Example:Let’s say you want to accept an “Order Source” field after youenter the customer number for an order and then save it in anOrder Header Extended Data field. Because Extended Data is notcreated until after the Order Header is written, you may notAccept/Replace directly to the Extended Data field. But you mayaccomplish the same result with the following steps:a. Set up your Order Header Extended Data field for the Order

Source as an AutoImport field. Define the Source for the dataas one of the User Link (Ulink) fields available in XX99 (the900 series). This tells Extended Data to automatically createthe Extended Data record when the Order Header is written

Page 49: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 49

and to get the value from the Ulink field and put it in theExtended Data field.

b. Define your ACRE step at the appropriate FlowPoint. In therelated filter Data Dictionary field use the same Ulink fieldyou referenced in the Extended Data setup. This will causethe value the user enters to be placed into Ulink so that it willbe available when Extended Data needs it.

The result of this setup will be:- The user is asked to enter the Order Source after entering the

customer number in the Order Header. - The program saves the entered value in the Ulink field.- When the user completes the Order Header the Extended Data

program will create the Extended Data record for the OrderHeader and will insert the Ulink value into the Extended Datafield.

Create a Floating Window

With WorkFlow you may display a floating window on the screen and:- Display data in the window- Accept data in the window- Leave the window on the screen when you move on to other

FlowPoints- Close the window to remove it from the screen

These features are implemented in the DISP step type. When youchoose this type you have the following additional options:

Create Floating WindowThis function will open a Floating Window for use bysubsequent steps. You may specify:

Starting Line Enter the line for the upper left corner of thewindow.

Starting Column Enter the column for the upper leftcorner of the window.

Lines Enter the total number of lines for thewindow. This must include the top andbottom window lines as well as the linewithin the window for displaying/acceptingdata.

Size Enter the total number of column positions forthe window. This must include the left and right

Page 50: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

50 SouthWare Excellence Series™ (Revision 15)

window line positions.Attribute You may optionally enter an attribute such

as color for the entire window area.

Note: There is only one Floating Window at a time. If youcreate a Floating Window when you already have aFloating Window on the screen the previous windowwill be closed when the new one is created.

Close Floating WindowThis function removes the floating window from the screen. Any displays or accepts that appeared in the window will alsobe removed. After the close the window that was currentwhen you created the floating window will become the currentwindow again.

De-activate Floating WindowThis function leaves the floating window displayed on thescreen but switches the program focus back to the windowthat was current when you created the floating window. Thisallows you to leave the window displayed for reference butcontinue with normal processing in the program. At a laterFlowPoint you may close the window if you no longer need itfor reference.

IMPORTANT NOTES! - When you create a floating window all subsequent steps in

the program will take place in that window until you close orde-activate the window. Make sure you close or de-activate

the window when you are through using it. WorkFlow doesnot automatically de-activate or remove a floating windowuntil you exit the program.

- When a floating window is active all line and columnpositions are relative to the window, not to the screen. Line 1and column 1 become the first available positions in the activewindow not counting the window border. If you display afloating window beginning at column 40 and then display afield at column 2, the column 2 will be relative to the windowand will actually appear on column 42 of the screen (screencolumn 40 will be the window border).- If you attempt to display at a line/column that exceeds the

window size then the display will not appear.- If you attempt to accept at a line/column that exceeds the

window size then the accept will occur but you will not

Page 51: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 51

see it.- Normally you may not display any values outside of the

current window. An exception is when you havespecified to display a prompt on line 23 or line 24 - thiswill be displayed outside of the window.

Example:Let’s say you want to display some information about acustomer during the entry of line items in Order Entry. Here’san overview of the steps for the FlowMod(s):- Create the Floating Window (DISP step, Create Floating

Window) with the position and size you want.- Display each literal or data field to appear in the window.

Make sure your line/column positions are relative to thewindow, not to the screen.

- When you are through with the window (which may be inanother FlowMod) close the window (DISP step, CloseFloating Window).

Create Your Own Forms as versions of Standard Forms

You may use WorkFlow to create and call a template that executes aparticular forms program and SouthWare Forms record. This meansthat at any FlowPoint you could write a FlowMod that prints a specialversion of the form(s) available for the program you’re using. Forexample, you could create your own special bill of lading by creating acustom version of the Picking Ticket form and then printing yourspecial form via WorkFlow in addition to the normal Picking Ticket.

To call a forms program from WorkFlow and specify the template youmust:

1. Create the Forms Override text file for the custom form2. Create a Forms Override record in SF-01. 3. Create a WorkFlow Forms Template record (WF-03-09) for

the Forms Override. You may optionally specify a particularprinter or Fax ID to use.

4. Create a FlowMod at the FlowPoint at which you want toprint the form (this must be in a program that normally printsthe form you are using). In the FlowMod include the step type"SFFO" and reference the Template you created in step 3.

Note: You may also call a specific form/template via anObject. Create an Object (XX-09-02) that calls theprogram "WFSFOMNT/W [templateID]" where

Page 52: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

52 SouthWare Excellence Series™ (Revision 15)

templateID is the ID to the record you created in step3 above.

Selectively Override Format for Standard Forms

You may use WorkFlow Forms Templates (WF-03-09) to specify theoverride format to use for a standard form. This feature will overridethe normal "Find" feature used to determine the format to use.

In the XX99 list of available fields there are five fields that you canupdate via WorkFlow. These fields are:

Nbr Description14 WF SFFORM Override 115 WF SFFORM Override 216 WF SFFORM Override 317 WF SFFORM Override 418 WF SFFORM Override 5

There are special flowpoints for RSBILENT and SVSOHENT that are

launched at the time these programs use the Find feature for what formto use. This flowpoint is ISFORM for RSBILENT and SVFORM forSVSOHENT.

The SouthWare Form Find process will review the contents of thesefive fields each time a form is printed. If any of these fields contains aForms Template name that applies to the current form then the formatfor that Template will be used instead of the format the Find wouldhave otherwise used. If these fields don’t contain an applicableTemplate then the Find will use the normal hierarchy.

This gives you great flexibility in controlling what format is used. InWorkFlow you simply REPL any one of these WF SFFORM Overridefields with the Forms Template name to use. Until you clear oroverwrite that WF SFFORM Override value the forms print programwill use that Forms Template any time you print the related form.

For example, let’s say you want to vary the format of both yourinteractive picking tickets and your invoices based on Customer Type. Each time you bring up an order you could execute a WorkFlowFlowMod that:- tests the Customer Type for the customer on the order

Page 53: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 53

- inserts a WorkFlow Forms Template name for the pickingticket in WF SFFORM Override 1 (or insert spaces if nospecial format applies)

- inserts a WorkFlow Forms Template name for the invoiceform in WF SFFORM Override 2 (or insert spaces if nospecial format applies)

When you print an interactive picking ticket the Form Find feature willfind a picking ticket related Forms Template in WF SFFORM Override1 and will use it. When you print an interactive invoice the Form Findfeature will skip the Template in WF SFFORM Override 1 (since it isnot related to invoices) but will use the Template in WF SFFORMOverride 2.

Note: The system uses the first applicable Template it finds so itdoes not matter which slot you use or in what sequence youdefine your overrides.

Using a FlowMod to Limit Records Shown in Search Lists

If you want to limit the records that appear in a search/lookup list, youmay use WorkFlow to test each record before displaying it (this appliesto searches only, not to inquiries). There is a FlowPoint for each fileyou can search that uses the format "83xxxx" where "xxxx" is theSouthWare data dictionary file name (you may go into WF-02-03 foreach search program to determine the FlowPoint for each file). ThisFlowPoint occurs prior to the display of a record in the search list. You may define a FlowMod at this FlowPoint for a particular file thattests the record and does a "FAIL" if the record should not bedisplayed in the list.

For example, let’s say that you have used one of the UserFields in the customer record to indicate whether a customer isconsidered active, and you want to omit the inactive customersfrom the search list for customers. A FlowMod to do thiscould be:

Program ID: ARSEARCHFlowPoint: 83AR01Timing: BeforeSteps:

IF AR01 field 36 = N FAILEND

Page 54: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

54 SouthWare Excellence Series™ (Revision 15)

Each time the customer search list displays, it tests the UserFlag 1 (field 36) and does not include the customer in thesearch list if the flag is "N".

Do WorkFlow Processing for Each Record Read in aReportMate Run

You may launch WorkFlow FlowMods from a ReportMate report! Foreach record that a ReportMate report selects for printing/processingyou can launch FlowMods related to that record. With the versatilityof WorkFlow you can use this capability in a wide variety of situations:

Examples:- Update values in the stock file via a ReportMate report- Run a ReportMate report for the sales order file and generate

Mail for exception conditions- Run a ReportMate report for the customer file and update an

Extended Data field for customers that meet certain criteria

Here’s how to use this feature:1. Create your ReportMate format.2. Create a WorkFlow Program record (WF-02-02) that has the

format name as the program name and defines the primary file forthe report.

3. Create a FlowMod for the Program record (format name) that youcreated in step 2.

- Use the FlowPoint of “8701"- Enter the steps to be executed

When you run the ReportMate report each time a record qualifies forthe report (based on ranges and selection criteria in the report) theprogram will pass the current record to WorkFlow and launch theFlowMod.

When you create a ReportMate report the system automatically createsa WorkFlow program record (program type of “R” for ReportMate) forthe ReportMate format. This enables the 8701 FlowPoint for the reportformat so that you don’t need to add the FlowPoint to the DataDictionary.

Page 55: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 55

Modify Incoming Data in ImportMate II via WorkFlow

Use WorkFlow to clean up and enhance your imported data. You mayuse WorkFlow during importing to test, convert, or translate theincoming data. This lets you handle complicated data conversionissues with simple FlowMods. A FlowPoint is executed for eachimported record at the point when ImportMate II is ready to validatethe new or changed record. At that FlowPoint you can create aFlowMod that will test and/or change the data.

The program for the FlowPoint is the import format name.

Update FlowPoints8701IW Primary record - for single file imports this will be the

only FlowPoint. For header/detail type imports this willthe import of the header record.

8702IW Secondary record - for header/detail type imports this willbe the import of the detail record.

8703IW Tracking record - this will be the import of the tracking orthird file for the import format.

8704IW This will be the import of the fourth file for the format (asof this release this is only used for the payments on salesorders).

For example, let’s say you are importing stock records from anoutside source using an import format "STOCKIN". There is afield in the incoming data that is equivalent to your productcategory, but the codes in that field are not the same as yourSouthWare product categories. With WorkFlow you could createa FlowMod at FlowPoint 8701 in program "STOCKIN" to test theincoming field and replace it with its equivalent product category.

Import Error FlowPointsThere are additional separate flowpoints for fatal import errors(errors that prevent the record from being imported). The last two

Page 56: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

56 SouthWare Excellence Series™ (Revision 15)

characters of the FlowPoint will be changed from IW to IF.

8701IF8702IF8703IF8704IF

These FlowPoints are helpful if you want to create log file ofrecords not imported or sent out an email to notify the appropriatepeople of the problem.

Creating Necessary FlowPoint RecordsRemember that you must have a FlowPoint record in theWorkFlow database in order for the system to know what primaryfile is related to the FlowPoint. You must add individualFlowPoints (via WF-02-03) for each import format that needsFlowMods.

Example:For example, if you want to add workflow to the order headerimport and the format is ORDER, there has to be a recordadded to WF0203

Program ID: ORDERFlowpoint 8701IW (because it's the order header)Primary file: RS07No Fail Logic

For order detail it's Program ID: ORDERFlowpoint 8702IW (secondary transaction file)Primary File RS08No Fail Logic

If you also want to create a log record of fatal order, give awarning message or send an email if an import has a fatalerror:

Program ID: ORDERFlowpoint 8701IFPrimary File RS07No Fail Logic

Page 57: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 57

For order detail records:Program ID: ORDERFlowpoint 8702IF (secondary transaction File)Primary File RS08No fail logic

Keys for Records Created are available for use in other programsWhen you add a record to a file via SouthWare import technologythe key to the created record is available as an environmentvariable. The variable name is SWENV-NEW-IM-KEY. Youmay set this up as a Special Environment Variable via XX-09-15so that you can access its current value via ReportMate andWorkFlow.

For example, let’s say you are using a SouthWare data packet tocreate a new customer record. Each time you launch the datapacket via WorkFlow the value of SWENV-NEW-IM-KEY willbe the assigned customer number. You could then display the newcustomer number or store this key for future reference if needed.

Note on Multi-Part Keys

This feature is most useful for files that have a single-part key. The key available in this environment variable includes all parts ofthe key to the created record. This means that if you are creating asingle-part key such as a customer record then the environmentvariable will contain the customer number. But if you create amulti-part key such as a stock record then the environment variablewill contain both the stock number and location as a single value.

There are other special environment variables for sales orders andservice orders so that you may identify just the header portion ofthe key:

SWENV-NEW-IM-ORD-NO This is the value of the lastsales order number assigned.

SWENV-NEW-IM-SO-NO This is the value of the lastservice order number assigned.

Limitations

- WorkFlow is not applicable to imports done via NetLink.- Only the fields in the primary record are available at these

FlowPoints. Extended Data is updated differently than normal

Page 58: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

58 SouthWare Excellence Series™ (Revision 15)

fields and this feature does not apply to Extended Data fields.

Option to REPL Data with Literals Longer Than 30 CharactersYou may use the REPL function in a FlowMod to replace data with along literal. This feature is primarily targeted to users who need toreplace the value of Environment Variables via WorkFlow when thevalue of the variable is larger than 30 characters. It is implemented viadelimited text within the FlowMod Comment field to provideflexibility and self-documentation for the FlowMod.

This feature is implemented by a“Replace With” option for the REPLstep in a FlowMod:

10 - Delimited Text from Comment (field 6)

This option will replace the field with text you have insertedwithin a delimited text literal in the Comment field of theFlowMod. If you choose this option you must then specifythe delimiters:

Delimiter Characters

Enter the starting and ending delimiters that surround thetext literal in the Comment field. For example, enter“<>” if your literal is “<mynewliteralvalue>” within theComment field. The program will verify that theComment contains text with those delimiter charactersand will warn you if the Comment does not containdelimited text.

Example:Let’s say you want to replace the value of an environmentvariable MY-ENV-VARIABLE with the value “This ismy new long value for this variable”. In the Comment forthe FlowMod you could enter the following text:

This FlowMod replaces the value of MY-ENV-VARIABLE with <This is my new long value forthis variable>.

Page 59: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 59

In the FlowMod step you would then specify to REPL theData Dictionary field for the environment variable withDelimited Text and enter the <> characters as thedelimiter characters. When the FlowMod step is executedit will replace the value with the delimited text:

Variable New ValueMY-ENV-VARIABLE This is my new long value for

this variable

Using a FlowMod to Control Which Programs DisplayWarning Notes

You have the ability to use WorkFlow to control whether SouthWarewarning notes will display in certain programs. This can be useful insituations such as when you add a stock item warning note for yoursales operators but don’t want that warning note to appear in yourpurchasing and receivings programs.

Here are the components of this feature:1. FlowPoint in SWNOTMNT

There is a FlowPoint "8701" in SWNOTMNT that occurs at thetime a warning note is about to display. You can use thisFlowPoint in a FlowMod to test the new fields below or other dataand optionally "FAIL" on the display of the warning note. See theexample below.

2. New DD field for Notes Record TypeIn file XX99 you have a field 13 "Notes record type". This willcontain the current note record type (such as "103" for OrderHeader or "5" for Stock Item) when you are displaying (or about todisplay) a SouthWare note. The Notes Record Type is the same asthe XD Record Type (XD-03-01) but here is one Notes Type thatdoesn’t have corresponding XD:

113 ExcelReport Events

3. New DD field for Called By ProgramIn file XX99 you have a field 12 "Notes Calledby Prog". This will

Page 60: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-04 FlowMod Maintenance

60 SouthWare Excellence Series™ (Revision 15)

contain the name of the program that called for Notes.

Here’s how you can use these components in a FlowMod to address thesituation described above by restricting Stock Warning Notes (Type"5") to RSBILENT:

Program SWNOTMNTFlowPoint 8701IF XX99 0013 EQ "5" (If Note Record Type is 5) AND XX99 0012 NE "RSBILENT (and Called Program is not

RSBILENT) FAIL (Don’t display the warning note)END-IF

This single FlowMod would eliminate the display of stock recordwarning notes except for users of RSBILENT.

See Appendix C for a table of other WorkFlow examples.

Special FlowMod Debugger Trace Option

To help you debug a FlowMod that is not working as you intended youhave the ability to turn on a “debug” mode for WorkFlow that logs theprocessing of each FlowMod step into a text file. You may thenreview this file to see each FlowMod, each step, and the variablevalues for each step to help you debug any problems you are havingwith a FlowMod.

To use this tool:1. Turn on debug mode - to activate the WorkFlow debug mode

you execute the main WorkFlow driver program,WFTRAFIC, with special switches. At the menu Selectprompt key in one of the following:- 'WFTRAFIC/D/Y/D' to create a new results file. Calling

the program with the 'Y' switch causes the file to becreated each Workflow session. In other words, eachtime you execute a menu selection (a program call) fromSWMENU a new debug file will be created containing allflowmods that execute until you return to the SWMENUprogram.

- 'WFTRAFIC/D/A/D' to append results to the existingaudit file. Calling the program with the 'A' switch

Page 61: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Maintenance WF-02-04

SouthWare Excellence Series™ (Revision 15) 61

appends the debugging results to any existing file, even ifit was from another menu selection.

2. Run the program containing the flowmods.3. Turn off debugging - at the menu prompt enter

'WFTRAFIC/D/N/D' to deactivate debug mode. Debug modeis also automatically turned off when you log off (exit theruntime).

4. Review the debug log file. The results of running Workflowin debug mode are stored in a file in the run directory with thefollowing name:

ZnnnWF.TXT where nnn is the line number of yourworkstation

Page 62: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-02-05 FlowMod Listing

62 SouthWare Excellence Series™ (Revision 15)

WF-02-05 FlowMod Listing

With this program you may print a listing of FlowMods to help youmanage your FlowMod database. When you select this option you maychoose a range of process IDs, a range of program IDs, one or allExtract IDs, and specify whether to include inactive FlowMods. Theprogram lists the FlowMods (including their steps) that match yourcriteria, and the listing is sorted by FlowMod number withinFlowPoint.

Page 63: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WorkFlow Utilities WF-03

SouthWare Excellence Series™ (Revision 15) 63

NOTES:

WF-03 WorkFlow Utilities

The options in this section are special-purpose WorkFlow-relatedutilities.

Page 64: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-01 WorkFlow Messages

64 SouthWare Excellence Series™ (Revision 15)

WorkFlow Messages

WF-03-01 Work Flow Messages

With this program you may create messages that appear at a FlowPointand accept a response from the user. In a “MESSAGE” type FlowModStep you must have a valid Message ID defined in this program.

1. Message ID:

Enter a unique identifier (up to ten characters) for this message.

2. Message:

Enter up to ten 60-character lines of text. This is the informationthat will appear in the message box. In this text (typically at thebottom) you should include the prompt for the user’s options(valid responses) in responding to the message. You may entervariables in the text (see "To Define a Variable" below).

3. Valid Responses:

Here you may enter up to ten valid responses to this message. Each response may be a single character (any letters you enter willbe converted to upper case since all responses to a message willalso be converted). The user will not be able to exit the messagebox until he enters one of the valid characters you define here

Page 65: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WorkFlow Messages WF-03-01

SouthWare Excellence Series™ (Revision 15) 65

followed by the <Enter> key. In your Work Flow FlowMod youcan then evaluate the response you received ( MESG-RESP) andspecify what to do based on the response.

Here are two special-purpose values you may define as responses:

& Enter an ampersand if the <Enter> key (without any othercharacter) should exit the box.

* Enter an asterisk if Any Key the user presses should exitthe box. This serves as a wild card Valid Responsecharacter.

4. Box Center Line:

Indicate the Line number for the center of the message box. Thiswill default to line 11.

5. Box Center Column:

Indicate the Column number for the center of the message box. This will default to column 40.

6. Top Title:

Here you may specify the title that will appear at the top of themessage window. The Top Title may contain up to 60 characters. Each time the message displays this title will appear at the top ofthe message.

Example:Let’s say you’ve defined a FlowMod at the point of printing aninteractive picking ticket that tests for a Review Flag. If theReview Flag is not "Y" then you want to display a message andaccept any key as a response to clear the message.

Message ID: PCKTCKRVW

Text:Order #<@DD=RS070001> has not been reviewed. You maynot print the picking ticket until the Review Flag is "Y". Please contact Bill or Sharon if you need immediate review ofthis order.

Press any key to return to the sales order.Valid Responses: *

Page 66: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-01 WorkFlow Messages

66 SouthWare Excellence Series™ (Revision 15)

To Define a Variable

Variables

Within certain text fields you may place variables that are dependent onthe data available when you use the template. You specify a variable

by entering <@DD=XXNNnnnn> where "XXNN" is the DataDictionary file number and "nnnn" is the field number. The programwill replace the variable name with the actual data for the currentrecord. The key to the file you specify must be available when you use

this template.

You may use the <F3> Specify Variable feature to automaticallyappend a variable parameter at the end of the field. When you accessthis function you must first specify the Launch Point:

Program Name

- You must first enter the program name of the program that

will launch this template. This first question is not the

variable, but helps determine which fields are available

for the variable.

FlowPoint ID (if applicable)- If the program has multiple primary files you must enter the

FlowPoint ID you will use so the feature can determine whichfile is primary at the time of launch.

The function will then display a list of files available so you may selectthe file for the variable. After you select a file the function displays alist of the fields available. After you select the field for the variable thefunction will append the variable syntax at the end of the text you’veentered.

Example:You plan to use a message template in a FlowMod that occurswhen you finish an order line item. You want to include thecustomer contact name in the message.

Program Name enter RSBILENTFlowPoint ID enter 97

The utility will then know that the line item file is primary and willlet you select data fields available at that point. You may selectthe customer file (AR01), then select the contact field (field 8). The utility will insert <@DD=AR010008> at the end of your text. When you use this template from a FlowMod, each message willshow the Contact name for the current customer instead of the

Page 67: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WorkFlow Messages WF-03-01

SouthWare Excellence Series™ (Revision 15) 67

variable indicator.

Note: When variables are replaced in a line the wrapping of text willNOT be changed. If the data from a variable is larger than theroom available on the line then the rightmost characters on theline will be truncated.

Page 68: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-02 Create SouthWare/Internet Mail

68 SouthWare Excellence Series™ (Revision 15)

Sample WorkFlow Mail Template

WF-03-02 Create SouthWare/Internet Mail

This utility will create a SouthWare Mail Message or an Internet e-mailmessage from a template. This lets you use WorkFlow to automaticallycreate a mail message.

1. Mail Template ID:

Enter a unique identifier (up to ten characters) for this mailtemplate.

2. Description:

Enter a description of the output of this template so that you canrecognize the template in a search list.

3. thru 6. Send To (1 thru 4):

These fields allow you to specify each of the four possible mailrecipient ID fields. For each field enter the following information:

Address Type

S SouthWare Mail - Enter “S” to specify a SouthWare Mailoperator address.

I Internet E-Mail - Enter “I” to specify an Internet E-Mailaddress.

Leave the type blank on an address line to skip.

Page 69: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare/Internet Mail WF-03-02

SouthWare Excellence Series™ (Revision 15) 69

Source

Select the source of information for the field:T Template - the value for this field will be provided from the

template. In the "Value" field you may specify the pre-defined value.

D Data Variable - the value for this field will be assigneddepending on the data of the current record. If you select thissource type you may then reference the Data Dictionaryfile/field in the Value field. Example:

When you select an order for invoicing you want to notifythe responsible salesperson. One option is to set up eachsalesperson code as a Mail List that cross-references tothe salesperson's Mail Operator (typically the securityoperator). Then Assign the "Send To" value for thetemplate from the Salesperson on the sales order (RMDDfile RS07, field 10).

Value

- If the Source is a Data Variable, you specify a variable by

entering <@DD=XXNNnnnn> where "XXNN" is the DataDictionary file number and "nnnn" is the field number. The

key to the file you specify must be available when you use this

template.

- If the Source is Template, enter the value to use when creatingmail messages from this template. For SouthWare Mail youmay enter a mail operator. For Internet E-Mail you may entera 50 character e-mail address.

7. From:

This applies only to SouthWare mail, not to Internet e-mail.This allows you to specify the mail sender ID field.- If the Source is Template, you may enter an ID or leave this

blank to have the sender default to the current logon operatorwhen the template is used.

- If the Source is Data Variable specify the variable by entering

<@DD=XXNNnnnn> where "XXNN" is the Data Dictionaryfile number and "nnnn" is the field number. The key to the file

you specify must be available when you use this template.

8. SouthWare Mail Options:

This field displays a plus box of other options for SouthWareMail:

Page 70: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-02 Create SouthWare/Internet Mail

70 SouthWare Excellence Series™ (Revision 15)

Priority

This allows you to specify the SouthWare Mail priority for thistemplate.

Review After Create?

Enter "Y" if you want to access the mail maintenance programwhenever you generate a message from this template. This wouldlet you see and edit the message before it is sent. Enter "N" if themessage should be created automatically without any operatorreview.

9. Internet Mail Options:

This field displays a plus box of other options for Internet Mail:

Mail Interface ID

Enter the Mail Interface ID (XX-05-12) to use to send Internet e-mail from this template. If you leave the field blank the programwill use the default E-Send Interface ID for your workstation (XX-05-02, field 11).

Attachment Option:

Here you may choose whether e-mail messages created from thistemplate should have a file attachment for the message. Thisfeature works only when using an Outlook mail interface or acommand-line mail interface that supports the sending ofattachment files.

(blank) Leave blank or select “None” to skip the attachmentfeature for this template

T Template - the name of the attachment file will beprovided from the template. In the "Filename" field youmay specify the pre-defined file name. You may useenvironment variables (<@ENV=varname>) to referencea file name controlled by the value of the environmentvariable specified.

D Data Variable - the name of the attachment file will beassigned depending on the data of the current record. Ifyou select this source type you may then reference theData Dictionary file/field in the Filename field.

R RCF Packet - the name of the attachment file will be a filecreated by running an RCF packet print job (such asoutputting a report to a PDF file). You may then specify

Page 71: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare/Internet Mail WF-03-02

SouthWare Excellence Series™ (Revision 15) 71

the RCF Packet to run.

O OfficeLink - the name of the attachment file will be a filecreated by an OfficeLink job. You may then specify theOfficeLink ID to run.

How Attachments WorkWhen WorkFlow launches a Mail Template here is how it obtains theattachment file:

! For “T” type attachment - the program obtains the file name fromthe template and uses that as the attachment file

! For “D” type attachment - the program obtains the value of thevariable and uses that as the attachment file

! For “R” type attachment - the program launches the object for theRCF Packet (which prints the report), obtains the file name usedfrom an environment variable, and uses that file name for theattachment file

! For “O” type attachment - the program launches OfficeLink in“silent mode”, obtains the file name from the OfficeLink, and usesthat file name for the attachment file

After obtaining the attachment file name the program creates the e-mailmessage and attaches the file:! For Outlook-type interfaces the program references the attachment

file name in the ActiveX interface to Outlook! For command-line interfaces the program uses the file name for

the attachment file. This replaces the <@FILE> command in theAttachment command line of the send ID (field 5 of XX-05-12),which replaces the “ATTACHMENT” variable in the commandline.

Subject and Text

In fields 10 and 11 you may specify the text of the message. Withinthe text you may place variables that are dependent on the data of thecurrent record.

VariablesWithin the text you may place variables that are dependent on the dataof the current record. You specify a variable by entering

<@DD=XXNNnnnn> where "XXNN" is the ReportMate™ filenumber and "nnnn" is the field number. The program will replace the

Page 72: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-02 Create SouthWare/Internet Mail

72 SouthWare Excellence Series™ (Revision 15)

variable name with the actual data for the current record. The key to

the file you specify must be available when you use this template.

You may use the <F3> Specify Variable feature to automaticallyappend a variable parameter at the end of the field. When you accessthis function:- You must enter the program name of the program that will launch

this template.- If the program has multiple primary files you must enter the

FlowPoint ID you will use.- The function will then display a list of files available so you may

select the file for the variable.- After you select a file the function displays a list of the fields

available.After you select the field for the variable the function will append thevariable syntax at the end of the text you’ve entered.

10. Subject:

This is the 30-character brief description of the message (usuallythe topic).

11. Text:

Here you define the contents of the mail message:

Text Source:

! Enter “T” if you want to enter the mail message in thetemplate. You may then define up to ten 60-character linesfor the message.

! Enter “F” if you want the mail message to come from a textfile. Using a text file gives you more flexibility in editing andhandling more/longer lines.

When you create e-mail messages via WorkFlow to send viaMicrosoft Outlook you have the option to use an HTML-format file for the template of the e-mail message. This givesyou full control over the “look” of the message since you canuse rich text html features such as images, fonts, and colors.

Text Filename

You may then enter the name of the text file (the default pathis your SouthWare run directory). When you access thistemplate you may use the “Display Input File” (<F4>) todisplay the contents of the text file.

Page 73: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare/Internet Mail WF-03-02

SouthWare Excellence Series™ (Revision 15) 73

If creating e-mail messages via WorkFlow to send via MicrosoftOutlook choose Text Source of “F” for Filename, then enter thename of the html template as the text filename. You may insertvariables in the html text just like a non-html text file template.When WorkFlow creates e-mail from the template it will replacethe variables in the html template, then send the result as the bodyof the e-mail message. When the template filename ends in “.htm”or “.html” WorkFlow will instruct Outlook to use the Rich TextHTML format for the body of the e-mail message. Note: Thisfeature is limited to E-Send interface records that interface toMicrosoft Outlook (XX-05-12, field 2 = “O”) since it involvesActiveX communication with Outlook.

Example:In our example above you might have the following:Subject

Order <@DD=RS070001> Shipped

Text (from template or from text file)

Order <@DD=RS070001> for <DD=RS070051> wasselected for billing. The customer PO number is<@DD=RS070009>.

When this mail template is used for Order 1234 the resultingmessage might be:

Subject: Order 1234 ShippedText Order 1234 for Amalgamated Industries was selected

for billing. The customer PO number is AI125467.

Note: When variables are replaced in a line the wrapping of textwill NOT be changed. If the data from a variable is largerthan the room available on the line then the rightmostcharacters on the line will be truncated.

To Create/Edit E-Mail body in a separate fileIf the Body Text source (in field 11) is “F” for file and you enter afile name (instead of a variable), you have the option to create/editthe file name you entered.

! If the file name ends in “.htm” or “.html” the program willuse a web editor screen to display the web page file forediting.

Page 74: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-02 Create SouthWare/Internet Mail

74 SouthWare Excellence Series™ (Revision 15)

! For other file name extensions the program will use a texteditor control to display the file for editing.

In both editing options a prompt explains how you can insert aSouthWare variable to be replaced with data at runtime.

As you display a record that uses a file name the program willdisplay the contents of the file if possible. An Edit button allowsyou to access the file in the appropriate editor.

Note: If you use variables in the body file name you may onlyuse variables available from XX99, XX88, or the primaryfile for the FlowMod.

Generating SouthWare Mail

When you generate a SouthWare Mail message from this template themessage will be created as follows:

1. To Operator(s): (as specified in template)

2. From Operator: (as specified in template)

3. Mail Type: (as specified in template)

4. Subject: (as specified in template)

5. Priority: (as specified in template)

6. Purge Date: (Defaults as specified in Mail SystemControl Record)

7. Alarm Date/Time: (Current system date/time)

Text of Mail Message: (as specified in template)

If you selected the "Review" option the utility will call the mailprogram for the created message before it is sent.

Generating Internet e-mail

When you generate an Internet e-mail message from this template themessage will be created as follows:To Address(es): (as specified in template)

From Address: (Defined in e-mail server software)Subject: (as specified in template)

Text of Mail Message: (as specified in template)

Example:Let’s say you want to send an e-mail notification to a customer

Page 75: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare/Internet Mail WF-03-02

SouthWare Excellence Series™ (Revision 15) 75

when you create a service order (flowpoint 9299 inSVSOHENT). In the template you could:- specify the variable for the Internet E-Mail address of the

customer (AR01field 69) as the Send To address- put "Service Order Confirmation" as the subject of the

message- put text with variables as the message:

Service Order number (variable for S/O number) hasbeen initiated for your account. The schedule startdate is (variable for start date) at (variable for starttime).

Then you could create a FlowMod at flowpoint 9299 inSVSOHENT that uses this template to send an e-mail messagewhen you create a service order.

Page 76: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-02 Create SouthWare/Internet Mail

76 SouthWare Excellence Series™ (Revision 15)

The following chart illustrates how you can utilize SouthWaretechnologies to address some common e-mail scenarios:

Sample E-Mail

Application

How to Address

Create a blank e-mail message for asingle customer

There are many ways to create a blank e-mailmessage for a customer. Some examples are:

! From Customer Zoom View, click on e-mail link.

! From TaskWise Client Info tab, click one-mail link.

! From TaskWise task, click on "SendEmail" button from toolbar.

! Define an object that does a Windows call"mailto:<@AR010069>" and execute itwith WorkFlow wherever AR01 isprimary.

Create an e-mail message for acustomer that utilizes a pre-definedtemplate for the contents of themessage

You can pre-define a template for an e-mailby using WF E-mail templates. When usingthe Outlook interface, this can be HTML orregular text and you can define it to auto-sendthe message or wait for possible changes andallow the user to send it. For command-linee-mail software, regular text is supported andit is sent automatically.

Page 77: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare/Internet Mail WF-03-02

SouthWare Excellence Series™ (Revision 15) 77

Quickly create a report file and e-mail it to someone

There are a few ways to accomplish e-mailinga report to someone. If you want the report tobe the body of the e-mail, you could chooseto send the report via E-mail from the printparameters for the report.

After being prompted for the e-mail addressand pressing send, the report contents will bein the body of the e-mail. If you would ratherattach the report to the e-mail and have adifferent body, you can use WF E-mailtemplates and the following technologies toaccomplish this:

! RCF Packet that creates output file forreport (Spool, HTML, PDF)

! E-mail Send ID! WF E-mail Template (referencing RCF

Packet as attachment)

Then, this WorkFlow could be used as ascheduled item, ToDone, or a hotkey fromsome place in SouthWare.

Automatically create PDF versionsof customer statements and e-mailthem to the customers as a batchjob

Statements can be sent to customers in batchmode without user intervention using thefollowing technologies:

! RCF Packet! E-mail Send ID! WF E-mail Template! TW Alert Processor! Action Scheduler! SouthWare Server

See the discussion below "How It Works:

Sending Statements to Customers Using

SouthWare Server”

Identify customers who needcollection letters and automaticallycreate/e-mail customized collectionletters

You can send collection letters with a simpleclick of a button using the followingtechnologies:

- OfficeLink ID- E-mail Send ID- WF E-mail Template- ToDone ID- FYI Report

See the discussion below “How It Works:

Sending Collection Letter to Customers in

FYI”

Page 78: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-02 Create SouthWare/Internet Mail

78 SouthWare Excellence Series™ (Revision 15)

Create and send a summary OrderConfirmation as an HTML-formate-mail

Similar to customer statement exampleabove, but use HTML body and Outlook forWF Template.

Create and send a summary ServiceOrder as an HTML-format e-mail

You can create a WF E-mail template thatuses information from “SV04” and includeany variables you’d like available from“SV04”. You can define a flowmod that willautomatically launch this E-mail template viahotkey or question in any place that you’dlike. Refer to WF E-mail template“SERVICWORK” for an example.

Tips on Mail Interfaces

Here is a comparison of sending e-mail via Microsoft Outlook versus acommand-line software (such as Blat):

Interface

Type

Advantages Disadvantages

Microsoft Outlook ! Can use HTML body! Sent copies saved in Sent

folder! Option to AutoSend

(review or not)

! Windows only! Must have Outlook (not

Outlook Express)! Feature-set is limited to

SouthWare’s interface toOutlook

Command-Line ! Uses less systemresources

! Multi-platformavailability

! Runs invisible! Feature-set determined by

product

! Cannot review beforesending

! Text-only body! Sent copies not

automatically saved in afolder ! If you would like to

receive copies of thesent statements, youcan use a "Bcc"(Blind Carbon Copy)option of thecommand-line e-mailsoftware to send acopy to yourself orsome e-mail addressdefined for thispurpose.

Page 79: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare/Internet Mail WF-03-02

SouthWare Excellence Series™ (Revision 15) 79

Other Tips on Using E-Mail ! If you want to send PDF attachments, you must run on a

Windows system. SouthWare does not create PDF files onnon-Windows systems. This will work with the Windowsruntime or thin client. For example, if you are running thinclient with a Linux server, and you want to automate sendingof e-mail with PDF attachments via SouthWare Server, youshould execute SouthWare Server via thin client, NOT fromthe UNIX server.

! If you are using the Form PDF Archive feature of Rev 12, youcannot send PDF attachments for archive-enabled forms. APDF output cannot be archived, therefore is not allowed.

! If you are using the Form PDF Archive feature of Rev 12 andyou send batch e-mails from a non-Windows computer, noarchiving is done. This is because archiving of forms requiresa Windows system. So, if you want to send e-mail statementsusing SouthWare Server and have them archived, you shouldbe running the SouthWare Server from a Windows system viathe Windows runtime or thin client.

! Command-line option - BLAT - Blat is a Win32 commandline utility that sends e-mail using SMTP or post to Usenetusing NNTP. It is a product that can be used free of chargeand is included with Rev 12 in a “Blat” directory off the mainSouthWare directory. There is a complete readme file in“Blat/docs” directory that explains how Blat works. A“BLAT” sample E-mail Send ID has been included with Rev12 and will work after Blat is installed. To install blat,execute the following command line:

SouthWare Dir\Blat\full\blat -install smtpserver senderemail

Where:smtpserver = SMTP Server address (ex. mail.yahoo.com)senderemail = Sender’s E-mail address ([email protected])

---------------

How It Works: Sending Statements to Customers using

SouthWare Server

Statements can be sent to customers in batch mode without user interventionusing the following technologies:

- RCF Packet

Page 80: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-02 Create SouthWare/Internet Mail

80 SouthWare Excellence Series™ (Revision 15)

- E-mail Send ID- WF E-mail Template- TW Alert Processor- Action Scheduler- SouthWare Server

RCF Packet (XX-09-14-01)Example ID: CUSTSTMT

Setup an RCF Packet to print an individual statement. You may choose theoutput option that you would like attached to the e-mail (spool/plain text,HTML, PDF). Use variables for parameters as necessary - specifically thecustomer number range. For all variables, the primary file should be "AR01".

E-Mail Send ID (XX-05-12)Example ID: BLAT

Setup an E-Mail Send ID of type "E" for Command Line E-mail. This way,no user interface will be involved and the process can be run on theSouthWare Server.

WF E-mail Template (WF-03-02)Example ID: CUSTSTMT

Setup a WorkFlow E-mail Template for the customer statement. The "To"address should be a data dictionary value referring to the customer's e-mailaddress. The body of the e-mail should mention that the statement isattached. The attached file should be the RCF Packet previously defined. The Send ID used should be the command line e-mail ID previously defined. For all variables, the primary file should be "AR01".

TW Alert Processor (TW-04-11-02)Example ID: CUSTSTMT

Setup an Alert Driver for customer statements. Make the primary file "AR01"and use a custom schedule of whatever you desire. The Alert DriverMaintenance program will automatically take you to the Scheduled Actionrecord related to it. The program will also take you automatically to theFlowmod maintenance so you can define what steps should be taken. Theflowmod should execute the mail template previously defined with anyconditions you want.

Action Scheduler (XX-09-08-01)Example ID: TWCUSTSTMT

When defining the Alert Driver, the Action Scheduler item was defined aswell. You can test the action with some sort of test data at XX-09-08-02. The scheduled action should be setup to execute with the operator ID used bythe SouthWare Server (SERVER, for example).

Page 81: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare/Internet Mail WF-03-02

SouthWare Excellence Series™ (Revision 15) 81

SouthWare Server Start SouthWare Server and a workstation or server that is capable of sendingthese e-mails. The computer would have to have proper access to theSouthWare files and have access to the command line e-mail product you areusing.

---------

How It Works: Sending Collection Letter to Customers in FYI

Collection letters can be sent to customers with a simple click of a buttonusing the following technologies:

- OfficeLink ID- E-mail Send ID- WF E-mail Template- ToDone ID- FYI Report

RCF Packet (XX-09-11)Example ID: ZZCOLLECT1

Setup an OfficeLink ID related to the customer file that can be your collectionletter. An example one is released with SouthWare. Field 4 "Extract Data"should be "Y".

E-Mail Send ID (XX-05-12)Example ID: OUTLOOK

Setup an E-Mail Send ID of type "E" for Command Line E-mail or "O" forOutlook. Since this is an interactive send of an e-mail, Outlook might be thebest e-mail software to use. However, you may choose a command-line e-mail as well.

WF E-mail Template (WF-03-02)Example ID: CUSTLTR

Setup a WorkFlow E-mail Template for the customer letter. The "To" addressshould be a data dictionary value referring to the customer's e-mail address. The body of the e-mail should mention that the letter is attached. Theattached file should be the OfficeLink ID previously defined. The Send IDused should be the E-mail ID previously defined. For all variables, theprimary file should be "AR01".

ToDone ID (RM-05-03)Example ID: CUSTLTR

Setup a ToDone ID to send the customer letter. The primary file should be"AR01". The related flowmod should execute the WF E-mail templatedefined previously. The "To" address should be a data dictionary value

Page 82: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-02 Create SouthWare/Internet Mail

82 SouthWare Excellence Series™ (Revision 15)

referring to the customer's e-mail address. The body of the e-mail shouldmention that the letter is attached. The attached file should be the OfficeLinkID previously defined. The Send ID used should be the E-mail ID previouslydefined. For all variables, the primary file should be "AR01".

FYI Report (RM-06)Example ID: CUSTBAL

Setup a new FYI Report for "AR01". Select the previously created ToDoneID to be on the report. You may want to put the past due balance on thereport and add a range or some selection criteria related to the past duebalance to limit the records shown in the FYI grid. Then, access theGridView tab and click the "Edit" button. Now you can click on the ToDoneID and send collection letters to customers!

Page 83: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare Event WF-03-03

SouthWare Excellence Series™ (Revision 15) 83

WorkFlow Event Templates

WF-03-03 Create SouthWare Event

This utility creates a SouthWare Event from a template. You may use aFlowMod to automatically create an event.

1. Event Template ID:

Enter a unique ID (up to ten characters) for this template.

2. Description:

Enter a description of the output of this template so that youcan recognize the template in a search list. You may usevariables. See "To Define a Variable" in WF-03-01.

3. Type:

Enter the type of event to create from this template. This mustbe a valid type defined in XL-04-02.

4. Cross-References:

Your entries in this field depend upon the type of event you’recreating. Within the event type you defined which cross-references applied:

Page 84: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-03 Create SouthWare Event

84 SouthWare Excellence Series™ (Revision 15)

CustomerStock/LocationServiceVendorEmployee

For each one that applies (entry is Required or Optional) youmay enter the source of the cross-reference when the templatecreates an event:

Source

Select the source of information for the field:L Link - the value for this field will come from

the current Link value (usually from thecurrent record). This is the normal defaultduring event entry.

D Data Variable - the value for this field willbe provided from a data field. You maythen enter the Data Dictionary reference forthe field. You specify a variable by entering

<@DD=XXNNnnnn> where "XXNN" isthe Data Dictionary file number and "nnnn"is the field number. The key to the file you

specify must be available when you use this

template. See "To Define a Variable" inWF-03-01.

5. Points:

Enter the default Excel points for the template only if youwant to override the default points defined in the event type. Otherwise leave this field blank.

6. Dollars

Enter the default dollars for the template only if you want tooverride the default dollars defined in the event type. Otherwise leave this field blank.

7. Score

If the event type allows a score instead of points, enter thedefault score if you want to override the default.

In fields 8 and 9 you may specify the text that goes into the event. Within the text you may place variables that are dependent on the dataof the current record. You specify a variable by entering

<@DD=XXNNnnnn> where "XXNN" is the data dictionary filenumber and "nnnn" is the field number. When you create a mail

Page 85: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare Event WF-03-03

SouthWare Excellence Series™ (Revision 15) 85

message the program will replace the variable name with the actualdata for the current record. The key to the file you specify must be

available when you use this template. See "To Define a Variable" inWF-03-01.

8. Description:

Enter the value to insert into the Event Description field forevents created from this template.

9. Notes:

Here you may define up to five 60-character lines to place in aNote attached to events created from this template. You mayuse variables (see "To Define a Variable" in WF-03-01).

10. Review After Create?:

Enter "Y" if you want to access the event maintenanceprogram whenever you generate an event from this template. This would let you see and edit the created event. Enter "N" ifthe event should be created automatically without any operatorreview.

Page 86: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-04 Create SouthWare Notes

86 SouthWare Excellence Series™ (Revision 15)

WorkFlow Notes Templates

WF-03-04 Create SouthWare Notes

This utility creates a SouthWare Note from a template. You may use aFlowMod to automatically create a note.

1. Note Template ID:

Enter a unique ID for this notes template (up to tencharacters).

2. Description:

Enter a description of this template that will make it easy torecognize in a search list.

3. Record Type:

Select the category of note to create or use the Lookup.

4. Key Source:

Select the source of information for the related key field(Customer Number for customer note, Vendor Number forvendor note, etc.):

L Link - the value for this field will come fromthe current Link value (usually from the

Page 87: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare Notes WF-03-04

SouthWare Excellence Series™ (Revision 15) 87

current record). You should only use thisoption on notes types that have a related linkvalue.

D Data Variable - the value for this field willbe provided from a data field. You maythen enter the Data Dictionary reference forthe field. You specify a variable by entering

<@DD=XXNNnnnn> where "XXNN" isthe Data Dictionary file number and "nnnn"is the field number. The key to the file you

specify must be available when you use this

template. See "To Define a Variable" inWF-03-01.

5. Note Category / Attachment Type:

Enter the note category and attachment type to use in Notescreated from this template.

In fields 6 and 7 you may specify the text that goes into the Note. Within the text you may place variables that are dependent on the dataof the current record. See "To Define a Variable" in WF-03-01.

6. Note Purpose:

Enter the brief purpose of the Note that appears in the Notessearch list. You may use variables. See "To Define aVariable" in WF-03-01.

7. Note Text:

Enter up to five 60-character lines of text to place in the NoteText. You may use variables. See "To Define a Variable" inWF-03-01.

8. Review After Create?:

Enter "Y" if you want to access the Note maintenanceprogram whenever you generate an event from this template. This would let you see and edit the created note. Enter "N" ifthe note should be created automatically without any operatorreview.

9. Attachment Filename:

If you specified an Attachment Type that has a related file youmay enter the filename to use for Notes created from this

Page 88: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-04 Create SouthWare Notes

88 SouthWare Excellence Series™ (Revision 15)

template. You may use variables in the filename. See "ToDefine a Variable" in WF-03-01.

10. Access Oper/Group:

Enter a valid operator or operator group if you want to limitaccess to notes created via this template to a specificoperator/group.

NOTE: When you are defining templates related to notes (i.e.import formats, WorkFlow templates, OfficeLinkattachments) you may specify an operator/group thatyou may not access. The program will warn you thatyou won’t be able to see the resulting note.

Page 89: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create Scheduled Action/Reminder WF-03-05

SouthWare Excellence Series™ (Revision 15) 89

WorkFlow Scheduled Action/Reminder Templates

WF-03-05 Create Scheduled Action/Reminder

With this program you may create a template for a non-recurringAction/Reminder. See the Action Scheduler documentation (XX-09-08) for more information on these fields and features.

NOTE: You may NOT create a recurring Action/Reminder with atemplate. The date increment info is used for initialscheduling.

1. Action Template ID:

Enter a unique ID for this Action template (up to fivecharacters). The key to any actions created from this templatewill be WFxxxxx99999 where xxxxx is the template ID and99999 is a sequence number.

2. Description:

Enter a description of this template that will make it easy torecognize in a search list. You may use variables. See "ToDefine a Variable" in WF-03-01.

Page 90: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-05 Create Scheduled Action/Reminder

90 SouthWare Excellence Series™ (Revision 15)

3. Type of Action:

Select the type of action from the list shown.

Related ID

Unless the type is a Reminder Only you will also need tospecify the Related Object, Menu, or Macro name.

4. Scheduling Calculation:

Here you must indicate how the template should calculate thescheduled date/time for the template:

Reference Date

Normally you should press <Enter> here to indicatethat the scheduled date will be based on the currentsystem date (plus the increment) each time thistemplate is used.

You may also refer to a stored date in a record byspecifying a Data Dictionary reference in the format<@DD=XXNNnnnn> where XXNN is the filenumber and nnnn is the field number. The key to the

file you specify must be available when you use this

template.

Reference Time

You may press <Enter> here to indicate that thescheduled time be based on the current system timeeach time this template is used.

You may also enter a time in the format HHMM ifthis action should be scheduled for a specific time(such as 1500 for a 3:00 PM time).

(Increment Info)

Here you enter the fields that you normally enter fora Recurring Action. See the Action Schedulerdocumentation for information on these options.

The template calculates the scheduled date/time by

starting with the Reference Date/Time and then

"rescheduling" using the units increment, prox day, fixed

time, and OK days.

Page 91: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create Scheduled Action/Reminder WF-03-05

SouthWare Excellence Series™ (Revision 15) 91

Examples:a. You want the template to create a reminder for the

next day:- Press <Enter> at the Reference Date and

enter "0800" for the Reference Time.- Select Units Type of <D>ays, Increment of

1, no Prox Day, and fill in the other fieldsappropriately.

b. You want to create a reminder for 7 days after aservice call so that you can follow up with thecustomer:- Use <@DD=SV040032> as the Reference

Date (this is the data dictionary reference tothe Service Order Closed Date) and "0800"as the Reference Time.

- Select Units Type of <D>ays and incrementof 7.

5. Use Run Company?:

Enter “Y” if the template should insert the current companyID in a created action.

Enter “N” to specify the Company ID for the created action:- Enter a Company ID if the Action is for only one

Company.- Leave this field blank if the created Action should

apply to all Company IDs.

6. Source of Run Operator:

Select the source of information for the field:A Assign from Logon Operator - the value for this field

should be the current operator.T Template - the value for this field will be provided

from the template. In the "Value" field you mayspecify the pre-defined value.

D Data Dictionary Variable - the value for this fieldwill be assigned depending on the data of the currentrecord. If you select this source type you may thenreference the Data Dictionary file/field in the Valuefield.

Page 92: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-05 Create Scheduled Action/Reminder

92 SouthWare Excellence Series™ (Revision 15)

Value

- If the Source is a Data Variable, you specify a

variable by entering <@DD=XXNNnnnn> where"XXNN" is the Data Dictionary file number and"nnnn" is the field number. The key to the file you

specify must be available when you use this template.

- If the Source is Template, enter the value to use. You may enter spaces if the created action should beapplicable to All operators.

7. Security:

Enter a specific additional security system/level for the createdaction or leave this blank as described in the Action Schedulerdocumentation.

8. Comments:

Here you specify the text that goes into the Action Comments. You may use variables. See "To Define a Variable" in WF-03-01.

9. Auto Launch/Late:

Indicate whether the created Action should be subject tolaunching by StopCheck™ or manually launched.

10. Late Warning?:

Enter Yes if Late Warning should be activated if this processis late. Enter No if no Late Warning is desired after thescheduled time has passed.

Late Warning is displayed in the StopCheck box and in theMenu Banner.

11. Review After Create?:

Enter "Y" if you want to access the Action maintenanceprogram whenever you generate an event from this template. This would let you see and edit the created action. Enter "N"if the action should be created automatically without anyoperator review.

Page 93: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Modify G/L Accounts Parts WF-03-06

SouthWare Excellence Series™ (Revision 15) 93

WorkFlow Modify G/L Account Templates

WF-03-06 Modify G/L Account Parts

With this program you may create templates that change a G/L accountvalue using a FlowMod. In the "REPL" step type you can replace aG/L Account field with the results of a template. In the template youcan conditionally override parts of an account to help with specialdepartmentalization or related accounting needs.

1. G/L Acct Template ID:

Enter a unique ID for this template (up to 10 characters). Thisis the key to the template that you will refer to in theFlowMod.

2. Description:

Enter a brief description of the purpose of this template. Thisdescription will appear in the search list to help you choosethe right template for a FlowMod.

3. thru 6. Replace (Account Parts):

These fields allow you to specify how each part of the accountnumber should be modified by the template. For each part ofthe G/L account structure that you use you may specify thefollowing:

Page 94: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-06 Modify G/L Accounts Parts

94 SouthWare Excellence Series™ (Revision 15)

Replace Part Code:

Select how this part should be modified by thetemplate:

N - Part should Not be modified by the template(e.g. to leave the Code portion of theaccount unchanged)

F - Part should be replaced by the value of

another Field (field should be numeric) -(e.g. to insert the value from a customerExtended Data "Dept #" field into theDepartment portion of the account)

A - Part should be replaced by thecorresponding value from another G/L

Account (e.g. to replace the Departmentportion of the revenue account with theDepartment from the Dept/Operatorsoverride revenue account)

C - Part should be replaced by a Constant (e.g.to insert "003" as the Division portion of anaccount)

Source File:

(Valid only for "F" and "A" replacements.)Enter the SouthWare Data Dictionary file ID for the

source field. The file you specify must be available

at the FlowPoint you plan to use! See the "PrimaryFile" discussion in WF-02-04.

Source Field:

(Valid only for "F" and "A" replacements.)Enter the SouthWare Data Dictionary field for thesource field. The field must be defined as numeric inthe Data Dictionary. If this is an "A" typereplacement the field you specify must be defined inthe Data Dictionary as a G/L Account.

Constant:

(Valid only for "C" replacements.)Enter the value of the constant you want to replaceinto the account number for this part.

Page 95: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Modify G/L Accounts Parts WF-03-06

SouthWare Excellence Series™ (Revision 15) 95

How the Template Works

Let’s say you want to do the example listed above under the "A" typereplacement. In Order Entry you want to replace the Departmentportion of the revenue account with only the Department from theDept/Operator’s override revenue account (instead of the entireoverride account). We’ll do our FlowMod at the very end of a lineitem so we can use the Dept/Operator override sales account after it hasbeen overridden into the line item.! Create a Template of "OE-SALES"

- Choose to Replace the Department portion of youraccount with an "A" type replacement - select theLine Item Sales Account (RS08, 46) as the sourcesince you will be modifying the account after theDept/Operator override has already been placed intothe Sales Account

- Choose to Replace the Code portion of your accountwith an "A" type replacement from the ProductCategory (IV03, 4)

! At the FlowPoint "96" in RSBILENT (write of a line item)you create a FlowMod.- create a step with the "REPL" type- indicate to replace the Line Item Sales Account

(RS08, 46)- choose to replace it with a "G/L Acct Template"- specify the "OE-SALES" template ID

When RSBILENT writes a line item, WorkFlow will:- call the OE-SALES template- create an account number from the Code portion of the

Product category revenue account and the Department portionof the Line Item Sales account

- replace the new account number value into the Line Item Salesaccount.

Page 96: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-07 Extract Records from WorkFlow Files

96 SouthWare Excellence Series™ (Revision 15)

WF-03-07 Extract Records from WorkFlow Files

The options in this menu allow you to dump records from selectedWorkFlow files to a sequential file for merging into another system.

Export WorkFlow FlowMods

This utility lets you dump FlowMods to a sequential file for merginginto another system.

When you select this program you must enter the following parameters:

WorkFlow Flow Mod Data File:

This defaults to the WFMOD file in your data directory.

Sequential File Name

Enter the name of the sequential file to create or default to thename "WFMOD.SEQ".

Range of Programs

Enter a range of Program IDs or press <Enter> for ALL.

FlowMod Extract ID

Enter a single Extract ID or press <Enter> for ALL. TheExtract ID lets you easily extract selected FlowMods that arescattered throughout different programs.

Export WorkFlow Process Records

This utility lets you dump WorkFlow Process Records to a sequentialfile for merging into another system.

Output File Name

Enter the name of the sequential file to create or default to thename "ALWFPRO.SEQ".

Range of Processes

Enter a range of Process IDs or press <Enter> for ALL.

Extract ID

Enter a single Extract ID or press <Enter> for ALL.

Page 97: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Extract Records from WorkFlow Files WF-03-07

SouthWare Excellence Series™ (Revision 15) 97

Export WorkFlow Program Records

This utility lets you dump WorkFlow Program Records to a sequentialfile for merging into another system.

Output File Name

Enter the name of the sequential file to create or default to thename "ALWFPRG.SEQ".

Range of Programs

Enter a range of Programs or press <Enter> for ALL.

Extract ID

Enter a single Extract ID or press <Enter> for ALL.

Page 98: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-08 Load Records to WorkFlow Files

98 SouthWare Excellence Series™ (Revision 15)

WF-03-08 Load Records to WorkFlow Files

The options in this menu allow you to create WorkFlow records from asequential file created on another system.

Import WorkFlow FlowMods

With this program you may create new FlowMod records from animport file created on another system.

Sequential File Name

Enter the name of the sequential file to import or default to thestandard name "WFMOD.SEQ".

WorkFlow Flow Mod Data File:

This defaults to the WFMOD file in your data directory.

Merge or Overwrite

Indicate whether you want to <M>erge or <O>verwriteexisting FlowMods that have the same FlowMod # as one inthe import file:

- Select <M>erge to have the system change theFlowMod # of the incoming record to the nextavailable FlowMod # for the FlowMod Point. This isuseful when you want to add FlowMods to existingFlowMods.

- Select <O>verwrite to have the system replace theexisting FlowMod with the new FlowMod in theimport file. This is useful when you want to update aset of existing FlowMods.

Import WorkFlow Process Records

With this program you may create new Process records from an importfile created on another system.

Sequential File Name

Enter the name of the sequential file to import or default to thestandard name "ALWFPRO.SEQ".

Overwrite Existing Records

Indicate whether you want to overwrite process records thatalready exist.

Page 99: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Load Records to WorkFlow Files WF-03-08

SouthWare Excellence Series™ (Revision 15) 99

Import WorkFlow Program Records

With this program you may create new Program records from an importfile created on another system.

Sequential File Name

Enter the name of the sequential file to import or default to thestandard name "ALWFPRG.SEQ".

Overwrite Existing Records

Indicate whether you want to overwrite program records thatalready exist.

Page 100: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-09 Modify G/L Accounts Parts

100 SouthWare Excellence Series™ (Revision 15)

WF-03-09 Create SouthWare Forms Template

With this program you may create a record that cross references to aparticular Forms Override record in SF-01. You may then useSouthWare WorkFlowJ to call the template that executes a particularforms program and SouthWare Forms record. This means that at anyFlowPoint you could write a FlowMod that prints a special version ofthe form(s) available for the program you’re using. For example, youcould create your own special bill of lading by creating a customversion of the Picking Ticket form and then printing your special formvia WorkFlow in addition to the normal Picking Ticket.

To call a forms program from WorkFlow and specify the template youmust:

1. Create the Forms Override text file for the custom form2. Create a Forms Override record in SF-01. 3. Create a WorkFlow Forms Template record (WF-03-09) for

the Forms Override. You may optionally specify a particularprinter or Fax ID to use.

4. Create a FlowMod at the FlowPoint at which you want toprint the form (this must be in a program that normally printsthe form you are using). In the FlowMod include the step type"SFFO" and reference the Template you created in step 3.

Note: You may also call a specific form/template via anObject. Create an Object (XX-09-02) that calls theprogram "WFSFOMNT/W [templateID]" wheretemplateID is the ID to the record you created in step3 above.

Here are the fields in the template file:

1. Template ID:

Enter a unique ID for this template (up to 10 characters). Whenyou use this template for the SFFO or LABL utilities you mustreference this ID.

2. Description:

Enter a description of the purpose of this template to help youidentify it in a search list.

3. Record Type:

Specify what type of template you are defining:

Page 101: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare Forms Template WF-03-09

SouthWare Excellence Series™ (Revision 15) 101

1 Standard Interactive Label - to print a standard formatlabel using the LABL utility

2 Custom Interactive Label - to print a custom format label(modified via SouthWare Forms) using the LABL utility

3 Custom Form - to print any of the other custom forms(modified via SouthWare Forms) that are supported bythe SFFO utility

Note: The IV01 label is still supported by the SFFOutility but we recommend you use the LABLutility since it provides more capability.

4. Key to SF Override:

If you are defining a template for a custom format usingSouthWare Forms you must select the custom format record asdefined in SF-01. Use the Lookup feature to select the record andthis field will be filled in.

5. Automatic Printer ID:

Here you may enter a specific printer ID (XX-05-05-01) to use oryou may leave this field blank. If you leave it blank the programwill use the printer in the related Forms Override record (ifapplicable) or ask you for the printer at runtime.

6. Automatic Send ID:

Here you may enter a specific Send ID (XX-05-12) to use for afaxed form or you may leave this field blank. This does not applyto labels.

7. Label Controls:

If you are printing interactive labels (record type 1 or 2) you areable to specify the following parameters:

Primary File at FlowPoint:

Select one of the available primary files for interactive labels:

IV01 Inventory Item FileIV20 Physical Inventory TransactionIV21 Inventory TransactionIV22 Receivings TransactionRS08 Sales Order Line ItemSV06 Service Order Line Item

Page 102: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-09 Modify G/L Accounts Parts

102 SouthWare Excellence Series™ (Revision 15)

Number of labels per stock #:

For certain primary files you have an option for the quantity touse in printing labels:

For IV01choose one of the following:- QOH - use Quantity on Hand in the stock file- AVL - use Quantity Available in the stock file

For RS08 choose one of the following:- SHP - use Quantity to Ship on the line item- ORD - use Quantity Ordered on the line item

For other primary files there is only one available quantityto use.

Confirm?:

Specify whether you want to be asked to confirm the numberof labels to print each time this template is used. Enter “Y” tohave the print program display the default number of labels toprint and allow you to override. Enter “N” to automaticallyprint label(s) without confirming the quantity.

Print Tracking/Serial# Line:

Enter “Y” if you want labels for serialized items to print a linewith serial number info on the label and print a label per serialnumber. (You must answer “Y” to the serial line question in

order to have an option per tracking type below).

Per Lot?

Enter “N” if you want labels for lot-tracked items to printa line with lot number info on the label and print a labelper lot number. Enter “Y” to print a label per unit (e.g.10 units in a Lot will result in 10 labels).

Per Size?

Enter “N” if you want labels for size-tracked items toprint a line with size info on the label and print a label persize. Enter “Y” to print a label per unit.

Per Color?

Enter “N” if you want labels for color-tracked items toprint a line with color info on the label and print a labelper color. Enter “Y” to print a label per unit.

Per Bin?

Page 103: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare Forms Template WF-03-09

SouthWare Excellence Series™ (Revision 15) 103

Enter “N” if you want labels for bin-tracked items to printa line with bin number info on the label and print a labelper bin number. Enter “Y” to print a label per unit.

Print if Missing Tracking?

If you specified above to print labels with tracking numberinfo you may specify whether the program should print labelswith blank tracking info for any missing tracking numbers. Enter “Y” to print labels for all tracking numbers availableand needed, or enter “N” to print labels only for definedtracking numbers.

For example, let’s say you’re printing labels for items to bepicked for a sales order. You may not have known all theserial numbers that would be used when you entered the order,but you want to be able to put a label on all items picked. Youcould enter “Y” here. If the quantity to print for a serializeditem is “15" and you have only defined 10 of the serialnumbers to use, the label print will print the 10 labels withtheir tracking info and will print 5 more labels with blanktracking info.

Number of Print Lines Per Label

Enter the total number of print lines from the start of one labelto the start of the next label. The default value is 6 for astandard label.

Number of Labels Across

Enter "1", "2", or "3" to designate whether you are usingsingle, double, or triple wide continuous form labels. Bar

coded labels must be one-wide. Since this feature involvesinteractive labels you should typically use one-up labels.

Note: Each item’s interactive label(s) is a separate print joband will close the printer. Make sure you don’tprogram extra form feeds in your printer parametersif your printer does automatic form feeds at the startor end of a job.

Print Stock Number in Bar Code

Enter "N" to print standard labels. Enter "Y" if you want thestock number printed in Bar Code Format on the label (andyou have Bar Code software and/or hardware).

Page 104: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-09 Modify G/L Accounts Parts

104 SouthWare Excellence Series™ (Revision 15)

If you enter "Y" you will also be asked:! to enter the number of times to print the bar code.

Normally this would be "1", but if the bar code producedon your printer is narrow you may want to print itmultiple times to make it easier to scan.

! to specify the number of print lines used in printing theBar Code (how many label lines does it use?)

! whether you want to print the stock number in normalalphanumeric characters under the bar code

! whether you want to print trailing spaces in the stocknumber bar code

- if you answer “Y” to print trailing spaces anotherquestion asks the maximum size of stock number(default of 15) to limit the bar code printing oftrailing spaces.

For Bar Code the program will use the special Bar Codecharacters defined in the Printer Record Info (see SwiftMatedocumentation). The Initialization characters (to turn on barcode print) will be sent before the stock number and the Resetcharacters (to turn off bar code print) will be sent after thestock number.

There are many bar code options which vary the height andwidth of the bar code, and some options will not fit on astandard label. You must have a special printer or otherhardware/software device which produces bar codes fromthese characters. The program assumes that a line feed will bedone after the bar code, and if this is not the case you shouldput a line feed in your Reset character string.

Print Bin ID/Sell Price Line?

(Applies only to shelf labels, not to labels printed from line

items.)

Enter "Y" if you want to print the standard Bin ID and Priceline on the label. Enter "N" to skip printing of this line. If youenter "Y" you must then specify which price to print on thelabels. Enter "L" to print the list price on the labels, "N" toprint no price on the labels, or enter the number of the pricelevel to print on the labels.

Print Interactive Item Labels via WorkFlow

Page 105: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Create SouthWare Forms Template WF-03-09

SouthWare Excellence Series™ (Revision 15) 105

You may use WorkFlow to print interactive item labels based on datain various item-related files. This gives you tremendous flexibility inproducing item labels as needed to track the movement of inventory inyour business. With the WorkFlow utility of "LABL" you can printlabels from the following primary files:

RS08 Sales order line item file - this is a label option that printsfrom data in the sales order line item file and usesinformation from RS09 (line item tracking) for trackingitem labels

SV06 Service order line item file - this is a label option thatprints from data in the service order line item file

IV01 Stock file - this is the batch stock label format and usesinformation from IV04 (tracking file) for tracking itemlabels

IV22 Receivings detail - this is the batch label format and usesinformation from IV23 (receiving tracking numbers ) fortracking item labels

IV20 Physical inventory - this is a label option that prints fromdata in the physical count file and uses information fromIV04 (tracking file) for tracking item labels

IV21 Inventory transactions - this is a label option that printsfrom data in the inventory transaction file

Example uses include:- Interactively printing Pick/ship labels as you print picking

tickets (implemented as a standard WorkFlow-driven example

solution in Inventory/Sales)

- Interactively printing Received item labels for each receivingtransaction (implemented as a standard WorkFlow-driven

example solution in Inventory/Sales)

- Interactively printing a service label to place on an itementered on a service order

- Interactively printing Labels for each item listed on aReportMate report (using the special FlowPoint inReportMate reports)

This feature is implemented via the following components:

UTIL option of “LABL” for a WorkFlow FlowModWhen you choose the UTIL option for a step type the optionLABL is available:

Page 106: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

WF-03-09 Modify G/L Accounts Parts

106 SouthWare Excellence Series™ (Revision 15)

LABL Choose this type to indicate that you want to print aninteractive item label. You must then specify theForm Template record to use (WF-03-09).

When the FlowMod executes a UTIL-LABL step the programuses the information in the template to print one or morelabels for a stock item.

Corresponding Launch Points for the Different Label PrimaryFiles

Here are some appropriate launch points for each of the labelprimary files:IV01 Launch when stock file is primary such as to print an

interactive label from the stock maintenance orinquiry.

IV20 Launch when Physical Inventory Transaction file isprimary such as to print labels from the PhysicalCount entry program.

IV21 Launch when Inventory Transaction file is primarysuch as from the Inventory Transaction entryprogram.

IV22 Launch when Receivings Transaction line file isprimary such as from the Receivings entry program. There is an example WorkFlow solution for

receivings labels that is based on a receivings

operator option - activating this option automatically

creates the necessary FlowMod.

RS08 Launch when Sales Order Line Item is primary suchas from Sales Order line item entry screen. There is

an example WorkFlow solution for item labels that

interactively print for items on a picking ticket. This

example is based on a sales operator option -

activating this option automatically creates the

necessary FlowMod.

SV06 Launch when Service Order Line Item is primarysuch as from Service Order line item entry screen.

Page 107: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Security Notes Appendix A

SouthWare Excellence Series™ (Revision 15) 107

NOTES:

Appendix A - SouthWare WorkFlow™ Security Notes

WorkFlow is a separately licensed product (system number 1280). When called from XX-09-03, WorkFlow allows the same options asthe field-level object functionality in Rev 6.

FlowMods that contain any functions not allowed in XX-09-03 willwork only if you have a valid license for WorkFlow. They will beignored with no message if you do not have a valid license.- If WorkFlow is licensed, all FlowMods apply- If WorkFlow is NOT licensed, only the FlowMods that don’t

require WorkFlow licensing will apply

Page 108: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Appendix A Security Notes

108 SouthWare Excellence Series™ (Revision 15)

NOTES:

Page 109: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Developer Notes Appendix B

SouthWare Excellence Series™ (Revision 15) 109

Appendix B - Developer Notes

Designing routines to be called by WorkFlow

The general recommendation for designing code interfaced toWorkFlow is that you use small, modular, stand-alone programs. Instead of changing standard SouthWare code in a program you need tocreate a program that accomplishes the same task external to thestandard code. Special considerations include:1. Any manipulation of the current record in use by the standard

program must be done via the Current Record Area Interface (seenext section). This gives you access to the data in the record thatis locked and would otherwise not be accessible.

2. Any other file I/O must be handled by your program. Thisinvolves opening, using, and closing the files you need to read. For example, if your code needs to update a related file you mustopen, read, write, and close the file within your program. (Notethat any secondary records that are locked by the SouthWareprogram will not be accessible for updating by a Developerprogram.)

Otherwise the logic you need to code will be the same.

Note: Your program called from WorkFlow will always be canceledwhen it returns to WorkFlow.

Entry-Type Programs

For entry (FM Logic) programs there are FlowPoints at eachchange number, sub-change number, and other special FM Logicpoints. See the database under the ZF FlowPoints.

! If you update the current record area make sure theSouthWare program will later write or rewrite the record. Justremember that your changes must be written, and the standardSouthWare program is the only one that can write the recordin the current record area.

Update-Type Programs

In these programs you will only have intermediate FlowPoints ifthey have been coded into the program. The database shoulddocument FlowPoints we have added, but you can check thesource to make sure we haven’t added one since the last update ofthe FlowPoint database.

Page 110: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Appendix B Developer Notes

110 SouthWare Excellence Series™ (Revision 15)

! If you need a FlowPoint for your application please send usyour request. We’ll try to help you use WorkFlow to avoidrev-locked custom code in SouthWare standard programs.

Other Programs

In other programs you may use the Modify function to display theFlowPoint for individual fields. For example, if you want to call aspecial routine at the sequence selection field in AR Inquiry (AR-04), go to that accept and access Modify (the button or <CtrlR><Ctrl R>). The middle of the screen shows you that theprogram is AROPENIN and that the FlowPoint is "8907". Thiswould also work at Report selection parameter fields.

Receiving/Updating Current Record Area

LINKAGE SECTION.01 LNK-WORKFLOW-PASSING PIC X(2700)

PROCEDURE DIVISION USING RM-LINKAGE-AREA, LNK-WORKFLOW-PASSING.

MOVE LNK-WORKFLOW-PASSING TO SW-WORKFLOW-PASSING.* when you are ready for the record areaMOVE EXTRACT-REC TO IO-TYPEPERFORM IO-filename

.

.

.* when you are finished with the record areaMOVE REPLACE-REC to IO-TYPEPERFORM IO-filename

MOVE SW-WORKFLOW-PASSING to LNK-WORKFLOW-PASSING

NOTE: You can look at SW-WORKFLOW-PASSING inSWMESG.PL to see the other information that is available toyou. For example, the FlowPoint gives you info such as thechange # and sub change #, the value of the current entryfield, the NEW flag, and the ADD flag.

Page 111: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Developer Notes Appendix B

SouthWare Excellence Series™ (Revision 15) 111

Special Utility for Updating Copied FlowMods

If you create FlowMods under one company ID and then copy them toanother company any company-specific fields such as Extended Datawill not work properly. The FlowMod contains the company ID forthese types of fields, and the FlowMods will not be able to use thesefields under another company.

If the company ID you have copied to has the same user-defined fields(such as Extended Data) as the one you used to create the FlowMod,you may run a program that will update the Company ID informationwithin the FlowMod records. This program runs automatically at theend of FlowMod build or Extended Data Data Dictionary update, butyou may also run it at any time. From the SouthWare menu you mayenter the program name “WFMODFIX” to run the utility. The utilitydoes the following:

- rebuilds the data dictionary for Extended Data andSalesMark™

- changes the FlowMods to change any company ID specificfields to match the current company

- rebuilds the data dictionary pathing in the FlowMods

Note: If you run this utility within a company that does not havethe same user-defined fields then the resulting FlowModswill not work.

Page 112: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Appendix B Developer Notes

112 SouthWare Excellence Series™ (Revision 15)

NOTES:

Page 113: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Examples Appendix C

SouthWare Excellence Series™ (Revision 15) 113

Appendix C - FlowMod Examples

The following table contains several examples of FlowMods to helpyou understand the power of WorkFlow and see how easy it is toutilize that power to solve real problems. These situations wereselected from user enhancement requests.

NOTES:

! Some of these enhancements may later be incorporated as standardproduct features, but would still be good examples of WorkFlow'spower.

! These examples are subject to change and may contain errors. Donot assume a similar situation will work until you have tried it.

Example Situation FlowPoint FlowMod Steps

The system asks a question and thedefault is "Y". You want the defaultto be "N".

(any program)ID: (use Modifyto find)Timing: Before

INS "N"

(this inserts an "N" in thefield)

You want to limit the entry of A/Paccounts in A/P transactions to twovalid accounts.

APTRXMNTID: 12Timing: Exit

(create a messageexplaining which accountsare valid)IF (A/P acct) not = (account1)AND (A/P acct) not =(account 2) MESG (message ID)RETNEND

You want to auto-default some fieldswhen using stock inquiry.

RSSTKINQID: Various - useModify to findFlowPoint IDsTiming: Before

INS (keystrokes)

(you could also make thekeystrokes be conditionalon the operator)

You want to display the locationnumber on the order header screen.

(Other requests include customerpayment terms, fax number,customer type, etc. - these should bedisplayed after specifying thecustomer number and optionally atthe display of master record)

RSBILENTID: 91Timing: After

DISP "Loc: " (somewhere on screen)DISP (order header loc) (to the right of Loc:)

At No Change Master(FlowPoint 92) you shoulddisplay spaces to the rightof the "Loc:" to clear thevalue of the record youcleared.

Page 114: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Appendix C FlowMod Examples

Example Situation FlowPoint FlowMod Steps

114 SouthWare Excellence Series™ (Revision 15)

You want to force in flat amountswhen you enter certain miscellaneouscharges.

RSBILENTID: (each of thefour M/C codefields)Timing: After

Let’s say that we have an"HC" Handling charge thatshould be $10 and an "EF"Expedite Fee that should be$15.For each of the M/Camount fieldsIF (misc chg code) = HC INS "10<CR>"ENDIF (misc chg code) = EF INS "15<CR>"END

You want to store the dept/operatorcode per line item of the last personwho changed the record.

RSBILENTID: 97(when the lineitem is written)Timing: Before

(Use Extended Data tocreate a "Last Chg By" fieldrelated to the order lineitem record)

REPL (Last Chg By) with (Curr Dept/Operator)

You want the discount account usedon a sale to be the same as theincome account (instead of going toa separate account).

RSBILENTID: 97Timing: After

(In this case this is a simpleReplace - if you wanted tomodify only a portion ofthe G/L account you coulduse a GL Account ModifyTemplate defined in WF-03-06)

REPL (disc acct) with(sales acct)

If you close a service order more than5 days after you start it you want toautomatically create an event torecord this. You can then reviewthese events to research why theservice orders weren’t closed sooner.

SVSOHENTID: 8701Timing: Before

(create an event template inWF-03-03 with serviceorder info as variables inthe Notes)CALC (close date) - (startdate) = CALC1IF CALC1 > 5 UTIL EVENT (template ID)END

Page 115: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Examples Appendix C

Example Situation FlowPoint FlowMod Steps

SouthWare Excellence Series™ (Revision 15) 115

You want to keep operators fromaccessing stock file maintenancebetween 4:30 and 5:00 PM while yourun some lengthy reports.

RSSTKMNTID: 0001Timing: Before

(The 0001FlowPoint hasFail/Continuelogic to make thispossible at thestart of aprogram)

(create a message templateexplaining situation)IF (system time) > 163000AND (system time <170000 MESG (message ID) FAILEND

(You could also ask aquestion in the messageand give the operator achoice of continuinganyway.)

When you service a piece ofequipment that is under warranty,you want to automatically extend thewarranty for 90 days.

SVINVGENID: 8701Timing: Before

IF (curr date) < (equippart warr dt)AND (equip part warr dt)NE 0 CALC (curr date) + 90= CALC1 REPL (equip part warrdt) with CALC1ENDIF (curr date) < (laborwarr dt)AND (labor warr dt) NE 0 CALC (curr date) + 90= CALC1 REPL (labor warr dt)with CALC1END

You want to secure the pay-relatedfields in employee maintenance byallowing only one operator to see andchange their values.

PREMPMN1ID: 0002Timing: Before

(Set up a screen override 40to secure or hide the pay-related fields.)IF (operator ID) NE (oneoperator) SCRN 40END

Page 116: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Appendix C FlowMod Examples

Example Situation FlowPoint FlowMod Steps

116 SouthWare Excellence Series™ (Revision 15)

You want to prevent an operatorfrom changing a stock record that isnot in his location.

This is an example where you needto be "creative" to find a solution. Since you don’t enter a transactionoperator for stock maintenance thereis not a normal way to identify whichlocation applies to the current logonoperator. Here are two creativeworkarounds that will work:1)This will work for a limitednumber of locations:- Use one of the user-defined

system numbers (such as "37")in the logon operator todesignate location. Then usesecurity level "1" for location 1,security level "2" for location 2,etc. This lets you "specify" thelocation for a logon operator.

2)This will work for any number oflocations:- Add a user-defined Extended

Data record type and relate it tothe Logon Operator file (XX-88). Then add an ExtendedData field for location and testthe location.

RSSTKMNTID: 9099Timing: Before

(the FlowPoint9099 hasFail/Continuelogic to preventdisplay)

(note in thisexample that weuse "EXIT" whenwe haveidentified theproper location -this prevents usfrom testing theother IFs)

Option 1IF (operator security levelfor user-defined system) =1AND (stock location) NE"001" FAIL EXITENDIF (operator security levelfor user-defined system) =2AND (stock location) NE"002" FAIL EXITENDIF (operator security levelfor user-defined system) =3AND (stock location) NE"003" FAIL EXITEND(etc. as needed)

Option 2IF (xd field for operator)NE (stock location) FAILEND

You want to set up an order reviewprocess. You need to:- Add a "Review Code" to each

order- Allow a secured way to change

this Review Code- Prevent an order from being

selected for invoicing unlessthe Review Code is "R"indicating that it has beenreviewed

(You could also test a standard fieldsuch as Picking Ticket date to notallow invoicing unless the pickingticket has been printed.)

RSBILENT/BID: 8830Timing: Before

(this point is atthe question thatasks if you wantto select the orderfor billing)

(add an Extended Datafield to the order header for"Review Code" and addSecurity to the Entry in theXD options - this wouldallow only an operator withproper security to changethe review code)

IF (xd field) NE "R" INS "N<CR>"END

Page 117: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Examples Appendix C

Example Situation FlowPoint FlowMod Steps

SouthWare Excellence Series™ (Revision 15) 117

Would like a new ship to address inorder entry to default each line’svalue to the customer address. Thisway they only have to change what isdifferent.

Note: This is an example ofusing WorkFlow tochange the value of fieldsyou haven’t yet entered

for a new record. Thenwhen you get to the fieldsthe values you specifiedbecome the defaults.

RSBILENTID: 09Timing: After

(a ship to numberof 99 indicatesthat you areentering a newship to address)

IF (change mode) EXITENDIF (Current Field) = 99 REPL (ship to name) with (bill to name) REPL (ship to address 1) with (bill to address 1) (etc.....)END

You want to allow any A/R operatorto change a customer’s address orphone number type info. But if theoperator has a security level less than7 you want to remove all other fieldsfrom the screen.

ARCUSTMNID: 0002Timing: Before

(Set up multiple ScreenOverrides in XX-09-09 toremove all other fields)IF (oper sec level) < 7 SCRN (screen #) SCRN (screen #) etc.END

When you access a customer in orderentry you want to display the date oftheir last sale and how many yearsthey’ve been a customer.

RSBILENTID: 04Timing: After

DISP (date of last sale)(position)CALC (curr date) - (date added) = CALC 1CALC CALC1 / 365 = CALC2DISP CALC2 (position)

(if you need to remove thisinfo from the screen youmay display spaces at thesame position)

Page 118: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Appendix C FlowMod Examples

Example Situation FlowPoint FlowMod Steps

118 SouthWare Excellence Series™ (Revision 15)

If a customer’s balance is greaterthan $10,000 you want to display amessage in Order Entry when a newsale is made to this customer. Themessage should ask the operator toget approval from the credit managerand to enter "Y" if approved and "N"if not approved. You want to createan event for each "Y" answer tomake sure the operators are actuallygetting approval.

RSBILENTID: 04Timing: Exit

(create a WorkFlowmessage to explain thesituation to the operator -include a variable in themessage for the customerbalance - make validanswers "Y" and "N")(create an event templatethat includes variables ofthe operator, order number,customer number, and anyother info you want tocapture)

IF (cust curr bal) > 10000 MESG (message ID)ENDIF (message answer) = Y UTIL (event) (templateID)ELSE INS (F8 key)END

Page 119: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Examples Appendix C

Example Situation FlowPoint FlowMod Steps

SouthWare Excellence Series™ (Revision 15) 119

If the cost was overridden on a salesorder line item you want the price tobe optionally calculated as 10%,20%, or 30% higher than the costentered.

RSBILENTID: 26 (unitcost)Timing: Exit

(set up a WorkFlowmessage that asks whatpercentage to use for theoverride price - 1=10%,2=20%, 3=30%, N=Nooverride)FlowMod 1IF (cost o/r flag) = Y MESG (message ID)ENDIF (message answer) = N EXITIF (message answer) = 1 GOTO (FlowMod 20)END

FlowMod 2IF (message answer) = 2 GOTO (FlowMod 30)ENDIF (message answer) = 3 GOTO (FlowMod 40)END FlowMod 20CALC (Current field) * 1.1 = CALC1REPL (unit price) withCALC1EXIT FlowMod 30CALC (Current field) * 1.2 = CALC1REPL (unit price) withCALC1EXIT FlowMod 40CALC (Current field) * 1.3 = CALC1REPL (unit price) withCALC1EXIT

Page 120: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Appendix C FlowMod Examples

Example Situation FlowPoint FlowMod Steps

120 SouthWare Excellence Series™ (Revision 15)

You want the sales account numberfor a line item to use the code portionfrom the product category accountand the department portion from thedept/operator record.

RSBILENTID: 9699Timing: Before

(create a template to modifyG/L accounts in WF-03-06! Choose to Replace theDepartment portion of youraccount with an "A" typereplacement - select theDept/Operator overridesales account! Choose to Replace theCode portion of youraccount with an "A" typereplacement from theProduct Category (IV03, 4)

IF (dept/oper override salesacct) NE 0REPL (sales acct, RS08,46) with (GL template, ID)

You want to save the last credit-cardnumber used by a customer and useit as the default on the next credit-card payment.

Saving itRSBILENTID: 3701Timing: AfterDefaulting itRSBILENTID: 37Timing: After

(set up a customerExtended Data field forsaving credit card number -you could also use the usercomment field)Saving itREPL (cust XD field) with(Current Field) Defaulting itREPL (credit card number)with (cust XD field)

Page 121: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Examples Appendix C

Example Situation FlowPoint FlowMod Steps

SouthWare Excellence Series™ (Revision 15) 121

You want to restrict the use of theBilling Adjustment order type toparticular operators.

Note: Here we’ll explore anadvanced capability - theuse of user-definedExtended Data to addnew fields to standardtransaction operators

How to set up Extended Data to addfields to the Dept/Operator- Add a user-defined master file

type such as "87"- Choose a key type of <A>lpha-

numeric- Enter "RS88" as the related

R/M file in field 4- Enter the fields you want to add

- in our example we’ll add a"Allow Billing Adj?" flag

RSBILENTID: 02Timing: After

(set up a user-defined XDmaster file type asdescribed in the leftcolumn)

IF (order type) NE B EXITENDIF (XD field for AllowBilling Adj) NE "Y" (you could do a message) RETNEND

You want to prevent an order lineitem from being selected for billing ifthere are tracking/serial numbers notyet entered.

RSBILENT/BID: 8750Timing: Before

(this point is rightafter the programhas changed theline item status to"S" for Selected)

IF (qty to ship, RS08 8)NE (tracking qty entered,RS08 29) (you might do a messagehere) REPL (select status,RS08 111) with (space)END

You want to see the order total whenentering a box in UPS/Shipping. This will help let you know howmuch to declare for insured value.

S2UPSLABID: 8701Timing: Before

DISP (order total)(somewhere)

(you may want to display aliteral and also clear thetotal later in the flow)

Page 122: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Appendix C FlowMod Examples

Example Situation FlowPoint FlowMod Steps

122 SouthWare Excellence Series™ (Revision 15)

You want PO entry to check yourcredit limit with the vendor and letyou know if you exceed it.

POENTRYID: 17Timing: After

(this will do thetest each time wemake an entry inthe PO linenumber field)

(create a WorkFlowmessage that explains youare over the credit limit)

IF (Current Field) = <F8> CALC (vendor credit limit) - (vendor curr balance) = CALC1 CALC CALC1 - (PO total amt) = CALC2ENDIF CALC2 < 0 MESG (message ID)END(you could also DISP thecalculated amount over thelimit on line 23)

You want to allow an operator toselect orders for invoicing but not beable to print the invoice.

You could test the operator code, testanother dept/operator option, or adda new dept/operator option - we'lladd a new option in this example.- Add a user-defined Extended

Data type and relate it to RMfile RS88 - see the previousexample about restricting theuse of Billing Adjustments

- Add a new option "AllowInvoice Printing?"

RSBILENTID: 8879Timing: Before

(this point is atthe invoice printquestion - if theoperator isn'tallowed to printwe'llautomaticallyanswer "N" to thequestion)

IF (new XD field "AllowInvoice Print") = "N" INS "N<CR>"END

You want to display the IC-Verifypre-authorization date on the billingpayment screen and have the systemgive a warning if the date is morethan 10 days old (or whenever thepre-auth expires).

(We'll also display "Expired" in theAUTH field for the credit card info.)

RSBILENTID: 8780Timing: Before

(this point is atthe display ofdata for thepayment screen -it is only valid inChange Mode)

(create a WorkFlowmessage explaining thesituation)IF (credit card amount) Not> 0 OR (ICVerify Date) = 0 EXITENDCALC (Current Date) - (ICVerify Date)=CALC1IF CALC1 > 10 MESG (message ID) DISP "Expired" (next to AUTH)END

Page 123: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Examples Appendix C

Example Situation FlowPoint FlowMod Steps

SouthWare Excellence Series™ (Revision 15) 123

You want to display the PO unit costas a reference in receivings cost entryfor items received without cost.

RSRCCENTID: 91Timing: Before

IF costed with quantity (IV12:45 ) = "N" DISP unit cost ( IV06:9) (somewhere on screen) ELSE DISP 0 (same position as above display) END

You want the PO expected date todefault from the Requested Date plusthe vendor lead time.

POENTRYID: 24Timing: Exit

(we’re setting upthe default at theexit of the fieldsince the fieldmay be auto-skipped - thismeans we need todo our owndisplay of thenew value sincethe display hasalready occurred)

IF (add mode) CALC (Current Field + lead time) = CALC1 REPL (expected date) w/ CALC1 DISP (expected date) line 21 pos 68END

When creating a stock item from thevendor catalog, you want to carrycertain Extended Data fields from thevendor catalog Extended Data to thestock item Extended Data.

RSBILENT (or POENTRY)ID: 8740Timing: Before

(this point is afterthe new stockrecord has beencreated by theroutine)

REPL (stock XD field) with (catalog XD field)REPL (stock XD field) with (catalog XD field)etc.

You want to prevent orders frombeing selected for invoicing if thecustomer is on credit hold.

RSBILENTID: 8830Timing: Before

(this point occursat the select forbilling questionfor the order)

IF (cust credit rating) ="HOLD" (you might display amessage) INS "N<CR>"END

Page 124: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Appendix C FlowMod Examples

Example Situation FlowPoint FlowMod Steps

124 SouthWare Excellence Series™ (Revision 15)

You have a requirement that depositson an order be equal to 50% or moreof the remaining amount to ship. You want the system to help yourequire additional payments asneeded.

Note: In our example we don'tallow the operator tocontinue if the Deposit isinsufficient. You couldalso ask a question in themessage in order todecide whether to "FAIL"and return to the paymentscreen.

RSBILENTID: 8781Timing: Before

(this point iswhen you start toexit the paymentscreen but beforethe order headerrecord is written -there is "FAIL"logic that returnsto the EnterChange prompt)

(create a messageindicating that you mustreceive additional payment)CALC (Total Price) * .50 = CALC1IF (Deposits Balance) < CALC1 CALC CALC1 - (Deposits Bal)=CALC2 DISP "Add'l Deposit Required:" Line 23 Pos 1 DISP CALC2 Line 23 Pos 25 MESG (message ID) FAILEND

You want to add an extra warning ata particular question since youroperators don’t seem to understandthe implications of the question.

(you can use theModify functionto find out theFlowPoint - useAfter timing totest their answer)

(An alternate wayto do this is to doBefore timing,display theMessage, andthen use theanswer to themessage to INSthe properkeystrokes intothe question’sanswer field)

(let’s assume that youroperators often enter "Y"when they should enter "N"- you want them to confirmthe Y - you create aWorkFlow message thatexplains the question andasks them to enter Y toconfirm or N to answer thequestion again)

IF Current Field EQ Y MESG (message ID)ENDIF (Message answer) EQ Y EXITELSE RETNEND

You want to be able to attach awarning to Ship Via records (or otherrecords that don’t have the notesoption).

(You can use WorkFlow messages todo this - let’s say you want to displaya warning for types UPA and FEX inOrder Entry)

RSBILENTID: 10Timing: After

(create WorkFlow messagesof "WARNUPA" and"WARNFEX")

IF Current Field = UPA MESG WARNUPAENDIF Current Field = FEX MESG WARNFEXEND

Page 125: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

FlowMod Examples Appendix C

Example Situation FlowPoint FlowMod Steps

SouthWare Excellence Series™ (Revision 15) 125

When an item flagged as "sell but donot purchase" reaches zero quantity,you want to give a warning to theoperator and automatically changethe stock file status to "do not sell orpurchase" so that no one elsebackorders it.

RSBILENTID: 9799Timing: Before

(this point is afteryou finish a lineitem)

(create a WorkFlowmessage that explains thesituation)IF (stock item avail qty)Not > 0AND (stock handling code)= "Y" MESG (message ID) REPL ( handling code) with "X"END

You primarily sell non-stock items. You want the line item type todefault to non-stock, default toPurchase For handling, and want thepurchase for vendor to default fromthe miscellaneous stock record.

RSBILENTLine item typeID: 18Timing: After

Purchase forvendorID: 20Timing: After(this allows youto set up thedefault vendorafter you identifythe stock number)

Line item typeINS "<ESC>N<CR>P<CR>"(since the type auto-defaults to "I" this set ofkeystrokes backs up andchanges the type to "N" fornon-stock)

Purchase for vendorIF (add mode)AND (item type) = "N" REPL (Purch Vendor) with (Vendor from stock record)END

You want to update the bin locationfor a sales order line item to reflectthe current bin ID at invoicing time.

RSBILENT/BID: 8750Timing: Before

(this point is rightafter the programhas changed theline item status to"S" for Selected)

REPL (line item bin ID) with (stock item bin ID)

Page 126: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Appendix C FlowMod Examples

Example Situation FlowPoint FlowMod Steps

126 SouthWare Excellence Series™ (Revision 15)

When you select an order for billingyou want to automatically notify theresponsible salesperson so they cancontact the customer to let him knowthe order has shipped.

Note: To notify the SouthWaresalesperson we need toknow his mail operator. We set up the mailoperator to be thesalesperson ID and matchthis to the logon operator.

RSBILENT/BID: 8830Timing: After

(This is at theorder headerquestion aboutselecting forbilling)

(create a SouthWare mailtemplate to notify thesalesperson - include dataabout the order)

IF (current field) = "Y" UTIL Mail (template ID)END

You want to display the quantity onhand and available for a stock itemyou are adjusting in InventoryTransactions. If the quantityavailable after this transaction will benegative, give a warning message.

To displayquantitiesRSTRXMNTID: 09Timing: Before

To clearquantities andcheck fornegativeRSTRXMNTID: 09Timing: After

(create a WorkFlowmessage "NEGSTOCK"that warns that the quantityavailable will go negative)

To display quantitiesDISP "Qty On Hand:" (lin20 col 37)DISP (qty on hand) (lin 20col 50)DISP "Qty Avail:" (lin 21col 37)DISP (qty avail) (lin 21 col50)

To clear qtys and check fornegativeCALC (qty avail - qtyentered) = CALC1IF CALC1 < 0 MESG NEGSTOCKENDDISP LABEL " " (lin 20 col37 size 30)DISP LABEL " " (line 21col 37 size 30)

You want your operators to be ableto add a new customer bill-to addresson the fly, but you don’t want to givethem a security of 7 in A/R.

N/A This situation doesn’trequire a FlowMod. UseOverride Security (XX-03-04) to lower the security ofthe ARBILMNT program.

Page 127: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

SouthWare WorkFlow™ Index

Example Situation FlowPoint FlowMod Steps

SouthWare Excellence Series™ (Revision 15) 127

You have written a custom pricingprogram and want to call yourprogram from order entry to calculatethe unit price for a line item.

Note:

This example illustrates how you canuse WorkFlow to incorporate customprograms without revising thestandard programs. The power ofWorkFlow for programmers is seenin the fact that the current recordarea (which is only in memory) isavailable for use and updating bycustom programs just as if thecustom logic was part of the standardprogram.

RSBILENTID: Timing: After

(in this examplewe're calculatingthe price after theuser enters thequantity)

CALL (your programname)

Your program then:! receives the line itemrecord area from WorkFlow! does whatever processingyou've written to determinethe unit price! replaces the unit price inthe line item record area! exits

WorkFlow receives backthe record area andprovides it to RSBILENT.

Page 128: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

Index SouthWare WorkFlow™

128 SouthWare Excellence Series™ (Revision 15)

SouthWare WorkFlow™ Index

Bar Code LabelsPrinting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Developer Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Execute Timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Extract ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30, 46Fail/Continue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11, 21FlowMod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7, 26

Active Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Repeat Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

FlowPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7, 20, 27Table of General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22To Find the ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Master File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Mode - Add/Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Primary File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21, 28Process ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Program ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15, 17Secondary File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Step Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

AND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33CALC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34CALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34CONT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35DISP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36ELSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37END . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37EXEC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37EXIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37FAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38FILT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38GOTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38IF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39INS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40MESG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41OR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Page 129: SouthWareSeeing the Information Flow SouthWare WorkFlow accesses files that contain records for each process, program, and FlowPoint within a program. With the WorkFlow Controller

SouthWare WorkFlow™ Index

SouthWare Excellence Series™ (Revision 15) 129

REPL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42RETN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43SCRN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43UTIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66WorkFlow Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Action/Reminder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Modify G/L Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93, 100Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86