tie business integration smartstart administrator's guide · · 2014-12-23iii 1.0...

TIE Business Integration SmartStart 1.0

Administrator’s Guide 1.0

iii

1.0 Introduction to TIE Business Integration SmartStart ......... 1

1.1 Glossary of Common Terms and Concepts .................................. 2

2.0 TIE Kinetix BI SmartStart Overview .................................... 3

2.1 System Requirements .............................................................. 4 2.2 TIE Business Integration SmartStart: How it Works...................... 5 2.3 TIE BI SmartStart System Architecture ...................................... 6 2.4 TIE BI SmartStart System Scenarios ........................................ 12

3.0 Getting Started with TIE BI SmartStart ............................ 19

4.0 Reviewing System Statistics ............................................. 21

4.1 Communication Sessions ........................................................ 22 4.2 Current Queue State ............................................................. 27 4.3 Document Statistics .............................................................. 28 4.4 Getting Support .................................................................... 30 4.5 Initiating Communication Sessions .......................................... 34

5.0 Configuring TIE BI SmartStart .......................................... 35

5.1 Communication Modules ........................................................ 36 5.1.1 File System Communication Module ........................................ 38 5.2 Addresses ............................................................................ 40 5.3 Document Structures ............................................................. 49 5.4 Workflows ............................................................................ 56 5.4.1 Operating TIE BI Smart Start Workflow Designer ...................... 56 5.4.2 Available Workflow Activities .................................................. 76 5.4.3 Configuring Workflow Activities .............................................. 77 5.5 Processes............................................................................. 93 5.6 Scheduling ........................................................................... 98 5.6.1 Daily Scheduling ................................................................. 100 5.6.2 Weekly Scheduling .............................................................. 103 5.6.3 Periodic Scheduling ............................................................. 106 5.6.4 Modifying Schedules ............................................................ 109 5.7 Service Control .................................................................... 110 5.8 Application Settings .............................................................. 112 5.8.1 General Settings ................................................................. 113 5.8.2 Notifications Settings ........................................................... 114 5.8.3 Outgoing Email Settings ....................................................... 115 5.8.4 Licensing Info ..................................................................... 116 5.8.5 Archiving ........................................................................... 118

Table of Contents

iv

6.0 TIE BI SmartStart Documents ......................................... 119

6.1 Reviewing Documents ........................................................... 120 6.1.1 Document Screen Selections ................................................. 121 6.1.2 Filtering Documents ............................................................. 123 6.1.3 Searching Documents .......................................................... 124 6.1.4 Document Details ................................................................ 127 6.1.5 Reprocessing Documents ...................................................... 135

7.0 Monitoring TIE BI SmartStart ......................................... 137

7.1 Viewing System Logs ............................................................ 138 7.2 Monitoring Internal Messages ................................................ 143 7.3 Monitoring Workflows ........................................................... 147

Index .................................................................................... 151

TIE Business Integration SmartStart 1.0 Administrator’s Guide

© 2009 Tie Holding 1

1.0 Introduction to TIE Kinetix BI SmartStart The TIE Kinetix Business Integrator SmartStart system is a new business integration tool enabling you to deliver documents to partners in a timely, efficient manner.

An upgraded version of the former TIE Kinetix QuickStart (TQS) product, this service utilizes the latest technologies available, allowing its various components to communicate through a series of system messages.

As part of these enhancements, the TIE BI SmartStart system will offer several new features, including:

• Delivering notification emails to users whenever system errors occur

• Allowing quick and easy access to support assistance

• Supporting XML documents

• Providing increased scalability and flexibility in document processing workflows

• Providing graphic designs of document process workflows

• Displaying valuable statistics regarding your system operations

This document contains details of the following topics:

• TIE BI SmartStart Overview

• Getting Started with TIE BI SmartStart

• Reviewing System Statistics

• Configuring TIE BI SmartStart

• Monitoring TIE BI SmartStart


© 2009 TIE Kinetix 2

1.1 Glossary of Common Terms & Concepts The following is a list of common terms that are associated with the TIE Kinetix Business Integration SmartStart system. Before you begin utilizing this product, it may be important to familiarize yourself with these important TIE BI SmartStart concepts.

Term/Concept Definition

Document The body of content being delivered from one partner to another. A document may appear in the form of an EDI, XML, binary or Flat file.

Note: It is important to note that a document was formally referred to as a “message” in the TIE QuickStart (TQS) system.

Message The means in which components of the TIE Kinetix Business Integration SmartStart system communicate with one another. Messages may be either Data messages or Command/Control messages.

A document (described above) is delivered to processing modules through a series of data messages received by various system components.

Note: It is important to note that the definition of a message has changed from the former TIE QuickStart (TQS) system. Messages from TQS are now referred to as “documents” in the TIE BI SmartStart system.

TIE BI SmartStart The acronym used to identify the TIE Kinetix Business Integration SmartStart system.

VAN The acronym used to identify the Value Added Network, a hosted service acting as an intermediary between partners. A VAN transmits data in EDI, XML, and binary format and hosts various integration services for a process or industry.

Message header The part of the message containing its general information (i.e. message ID and subject). This data allows the TIE BI SmartStart infrastructure to deliver messages to the specific components capable of processing them.

Message payload The part of the message containing general information about the data being processed by the component receiving the message. In most cases, the payload represents the document being processed.



2.0 TIE Kintetix BI SmartStart Overview This section provides you with a clear overview of the TIE Kinetix TIE BI SmartStart system and encapsulates the following topics:

• System Requirements

• How TIE BI SmartStart Works

• TIE BI SmartStart System Architecture

• TIE BI SmartStart System Scenarios



2.1 System Requirements Before getting started on the TIE Business Integration SmartStart Solutions application, it is important to ensure that your computer meets the system requirements listed below.

The requirements listed below are essentially the same for Windows Vista operating systems.

Minimum Recommended

Processor 1 GHz 32-bit (x86) or 64-bit (x64) processor.

2 GHz 32-bit (x86) or 64-bit (x64) processor.

Internal Memory 1 GB 2 GB

Disk space 40 GB disk with 2 GB available space

80 GB disk with 5 GB available space.

Display Please refer to the MS-Vista System Requirements at http://www.microsoft.com/windows/windows-vista/get/system-requirements.aspx.

Network Internet access, depending on the communication modules.

Supported Operating System

MS XP Home/Professional

MS Vista Home/Home Premium/Business/Ultimate.

Database Engine MS SQL Server 2005/2008 (Express Editions also supported)

Prerequisites MS. Net Framework 3.5

Other Access to an SMTP server needed for sending email notifications.

In addition, it is important to obtain both a required serial number for installing TIE BI SmartStart as well as installation keys for its Communication Modules.



2.2 TIE Business Integration Smart Start System: How it Works The TIE Business Integration SmartStart system consists of a collection of components, or services, performing a multi-step process in which a document is received from its original source, adapted, and delivered to its various recipients.

A document may need to undergo a series of phases before being validated, translated, and ultimately sent to the intended recipients or ERP system. Each phase is executed by a specialized component of TIE BI SmartStart. These components communicate to one another through messages maintained on the TIE BI SmartStart internal messaging system, which primarily consists of two main components, the Message Bus and Command Bus.

The following diagram illustrates the architecture of the TIE Business Integration SmartStart system:

Command Bus(CB)

Document ProcessorWorkflow Processing

Aggregator (grouper)

Document Analyzer

Document Processing Dispatcher

Purger Invalid Messages Queue(IMQ)

Mes

sage

Bus

(M

B)

Dead Letter Queue(DLQ)

Log & Audit Message History

System Management Console(SMC)

LoggerMessage Storage System

Document Out

Dispatcher

CM-In Activator

Addresses

Workflow Definitions

Document Type

Definitions

Splitter(EDS)

Aggregation Queue

Scheduler

Schedules

Process Activator

Send Queue CM-Out Activator

Message Archive

Archiving System Notifier

Email Notification

Utility Services

Batch ProcessFile SystemTranslator

(ETC)

CM - In

CM - Out

Licenses Storage

Licensing

Post Message

Document Repository

Documents

Document Archive

Documents Archive

Directory Watcher

Ack. Processor



2.3 TIE Kinetix TIE BI SmartStart System Architecture The TIE Kinetix TIE BI SmartStart system is built around an internal messaging system which primarily consists of a Message Bus and Command Bus, triggering all functions performed on the application.

Message Bus – This unit manages all messages that are waiting to be processed by the various system components. The Message Bus may receive and distribute data containing payloads that representing the documents to be processed as well as additional information used for routing the message to the component processing its payload.

Command Bus – This unit is used for transmitting command messages to various system components of the system, triggering specific system functions. Each system component is connected to the Command Bus and may receive commands from either the System Management Console or another system component.

The TIE BI SmartStart system also features an important component called the System Management Console.

System Management Console – This application, which is accessible to administrators, provides system health information through logs, audit trails, and message history charts, while allowing you to control the execution of system modules. The System Management Console (SMC) also provides detailed screens for each system component that requires configuration. The SMC triggers specific functionalities by posting control messages on the Command Bus, while directly accessing the databases in the system for retrieving and storing configuration data.

The TIE BI SmartStart system uses a collection of system components, which perform specific tasks according to various messages received from the system’s buses. Listed below are the components configured in the TIE BI SmartStart system.

Communication Modules – The components through which documents are sent or received are called Communication Modules. In order to preserve compatibility with the existing TQS communication modules, a device called the Communication Module Wrapper ensures that TIE communication modules are compatible within the TIE BI SmartStart system.

CM-In Activator and CM-Out Activator – These components control the execution of the Communication Modules, triggering the execution of communication sessions when specific command messages are received from the Command Bus. The content files that are received are stored in a designated system, thereby allowing documents to be created. For each of the received documents, a corresponding message is created and posted on the Message Bus, allowing the remaining system components to process the documents. The documents that need to be sent are retrieved from payloads of the messages waiting in the Send Queue. The documents’ content is then forwarded to the Communication Module sending it on the specific VAN.

Directory Watcher – This component monitors the content of a configured directory on the system, creating a document and the corresponding message for each of its files.



Acknowledgement Processor – Since some communication modules may receive acknowledgement messages from VAN, this component is able to match the acknowledgements with previously-sent documents. The document’s information is updated in order to reflect that its content was acknowledged by the network.

Document Analyzer – This component’s primary function is to determine document information such as format, type, subtype, sender, recipient, etc., based upon the folder from which the document content was retrieved by TIE BI SmartStart (in-house/flat-file documents) or based on information extracted by parsing the document content (EDI and XML). The information determined for the document content is used to update the corresponding entry in the Document Storage. A new document state entry is then created, allowing the history of the document processing to be tracked.

Document Processing Dispatcher – Once a document’s information has been determined by the Document Analyzer, the Document Processing Dispatcher can identify the specific process, or workflow, which should e used to process the document. The dispatcher uses a list of registered processes with an associated set of activation criteria. If the document properties fulfill the activation criteria, it will be presented to the associated process.

Process Activator – This component represents a specific process that was previously registered to the TIE BI SmartStart system. Once the Process Activator receives a message, it extracts the document from the payload and forwards it to the process it is representing, thereby marking the registration as busy. Once this process is completed, the Process Activator clears the busy flag in the registration record and allows other documents to be presented to the process.

Splitter – This component’s primary function is to extract individual documents from a single composed document. For each of the resulting documents, messages are posted to the Message Bus to enable further processing.

Document Processor – This component processes documents that are using a specific workflow composed from a sequence of activities, including translations, file system actions, batch processes, email notifications, and utility services. Specific workflow activities are used for determining when a document can be posted back to the Message Bus for delivery to its intended recipient.

Purger – This component is responsible for extracting from the Message Bus the messages marked as being in error. In addition, the Purger extracts each message that hasn’t been processed within a specific timeframe. Once extracted, these messages will then be moved to the Invalid Message Queue (IMQ). Note that the administrator, after resetting the error status flag, may repost messages from the IMQ into the Message Bus to allow the document processing to continue with the step that previously failed.

Aggregator – This component receives messages containing documents that need to be grouped, or aggregated, before being sent to their intended recipients. Therefore, these documents are stored in the Aggregation Queue until the next communication session is initiated. Once the components are extracted from the Aggregation Queue, one by one, the component attempts to group them based upon various criteria, such as recipient, type, communication module, etc. For each composed document that was created during the aggregation process, a message is created and posted to the



Message Bus, allowing the Document Out Dispatcher to receive them. When the aggregation process has completed, a command message is posted to the Command Bus, triggering the execution of the communication session for the outgoing documents.

Document Out Dispatcher – The role of this component is to enrich the received documents with valid address information, while placing them into the Send Queue. If the document cannot be linked to an address, it is placed into the Dead Letter Queue (DLQ), and a notification will be sent to the administrator. Note that the administrator may move messages from the DLQ to the Message Bus once the address database has been updated, allowing the Document Out Dispatcher to re-attempt assigning an address to the carried document.

Document Storage – This component acts as a repository for documents processed by the TIE BI SmartStart system. Each document entry contains a specific set of status entries that correspond to each process step in which the document has passed.

Document Archive – When the system performs a periodical cleanup of the Document Storage component, all documents older than a specific number of days will be moved into the Document Archive. The content of the Document Archive will also be occasionally purged, removing outdated documents from its contents. The archive and cleanup processes will be activated through control messages placed on the Command Bus by the Scheduler.

Scheduler – This component is capable of triggering specific activities in the system by generating command messages of various types at specific times and intervals. Once generated, these control messages are posted to the Command Bus.

Logger – This component allows all other components of the system to write log and audit entries to the files and database.

Notifier – This component receives specific messages from the Command Bus and delivers important notification emails, regarding documents being sent to the Dead Letter Queue (DLQ) or Invalid Message Queue (IMQ), to the system administrator.

Licensing – This component determines if the complete TIE BI SmartStart system, or a specific component within it, is permitted to run. In addition, each system component may request the value of a set of licensing parameters, if interested.

Message Storing System – This component is responsible for storing the history of messages received by various TIE BI SmartStart system components. Based on the content of the Message History storage, the System Management Console (SMC) is able to provide the administrator with a complete history of all messages that passed through the system while processing documents.

Archiving System – The role of this component is to transport outdated message history entries into the Message Archive, once they’ve been stored in Message History for more than a specific number of days. In addition, the Archiving System is responsible for its cleanup process, which deletes all archived messages that have aged past a determined number of days. The archival and cleanup processes will be activated through control messages placed on the Command Bus by the Scheduler.



The TIE BI SmartStart system also utilizes a set of queues containing messages with specific statuses.

Invalid Message Queue (IMQ) – This queue stores two types of messages: 1) messages posted to the Message Bus that couldn’t be properly processed by any of the system components; 2) messages that were found within the Message Bus with an error status.

Dead Letter Queue (DLQ) – This queue contains messages transporting documents that could not be properly delivered to its designated recipient due to invalid or insufficient address information or communication errors.

Aggregation Queue – This queue stores messages transporting documents that are waiting to be grouped during the aggregation process.

Send Queue – This queue contains messages that are being prepared for delivery to the designated recipient, waiting to be delivered during the next communication session.


Message Types

The aforementioned components of the TIE BI SmartStart system communicate through a series of messages, thereby triggering specific functions performed by each module or component.

The messages used within the system consist of the following types:

• Data Messages – The role of these messages is to transport specific data from one system component to another. Data messages always include a valid header as well as a payload, which either contains the actual data or a reference to the data storage.

• Command Message – The role of these messages is to request or instruct a specific system component to execute a particular operation. In situations where an operation is not fulfilled by the specified component, the incident will be reported as an exception. Command messages always contain a header, and in some cases, a valid payload. For instance, the command message for message history storage must contain information regarding the associated documents within the payload, thereby allowing the history to be complete.

Note: In the TIE BI SmartStart system, the term “message” refers to the object of communication that is internally exchanged between system components, requesting specific functions to be executed. Previously, in the TIE QuickStart system, the definition of the term “message” was what will now be referred to as a “document” in the TIE BI SmartStart system. Therefore, the document sender, recipient, format, type, and subtype are not included in the message header. Rather, this data is included in the message payload along with the reference to the entry in the document storage.



Message Headers and Payloads

Depending on its specific type, each messages being delivered may contain both a header and a payload.

In the TIE BI SmartStart system, a message header generally includes the following data:

• Classification of the message (i.e. data or command).

• Subject, which indicates the nature of the message (i.e. “Received document” or “Document ready to process”).

• A code indicating the status of the message.

• The amount of time a message will remain on the Message Bus before it expires and is extracted to the IMQ (by the Purger).

• The command in which the message must execute or carry out (optional).

• An identifier for the component receiving the message (optional).

• The number of times the message attempted a specific operation and failed (optional).

• The number of times a message is permitted to retry a failed operation (optional).

Message payloads may contain information about the document to which it is associated. Besides the document identifier, it also contains document characteristics, allowing the message to be routed in a timelier fashion.

Message payloads carrying documents typically contain the following information:

• The format of the document (i.e. XML, EDI, or flat file).

• The type of document (g. Invoice, ORDERS).

• The subtype of the document (g. D96A).

• The identifier of the party sending the document.

• The identifier of the party receiving the document.

• The status of the document (g. received, parsed, or sent).



2.4 TIE BI SmartStart System Scenarios Demonstrated in this section are two scenarios in which either incoming or outgoing documents are processed within the TIE BI SmartStart system.

The diagrams presented in this section are used to illustrate the process flow associated with each function.

Scenario A – Incoming Documents

In the example below (Figure 1a), and Order document, in EDI format, is received from Partner X. This item must be imported into the ERP system as an XML document.

Partner X VAN/Internet ERP SystemBISS System

Sends Order (EDI format)

Sends Order (XML format)

Figure 1a

The above process flow entails the following steps:

• Partner X begins the transaction by sending out the document, an order in EDI format, through either VAN or the internet (FTP/SMTP).

• The TIE BI SmartStart system retrieves the EDI document during a communication session through the communication module.

• TIE BI SmartStart will then convert the document into XML format and store the results within a specific folder.

• TIE BI SmartStart will then execute a command batch, triggering the ERP system to import the document.

Note that Partner X may also be sending a batch of multiple documents, a scenario in which the system’s Splitter component will be required to extract the documents individually.



Scenario A – Process Flow

The diagram below (Figure 1b) further illustrates the scenario presented above (Figure 1a) by detailing the step-by-step process flow of the document as it is passes through the various system components.

Note that each numbered step in the following diagram corresponds to its description below.

Figure 1b

Scenario A:

0. Before the TIE BI SmartStart system is enacted, this process actually begins when Partner X delivers an order document to the VAN mailbox.

1. The system’s administrator, or user, initiates the communication session by clicking the appropriate button on the System Management Console (SMC).

1a. In situations in which the system is operating on a schedule, the communication session will be initiated by the Scheduler component.

2. The SMC posts a message on the Command Bus, requesting it to begin the session.

Command Bus(CB)



Document Analyzer



Mes

sage

Bus

(M

B)





Document Out

Dispatcher

CM-In Activator

Addresses


Document Type

Definitions

Splitter(EDS)

Aggregation Queue

Scheduler

Schedules

Process Activator


Message Archive


Email Notification

Utility Services


(ETC)

CM - In

CM - Out

Licenses Storage

Licensing

Post Message

Document Repository

Documents

Document Archive

Documents Archive

Directory Watcher

Ack. Processor

VAN Partner X

Administrator

0

1

2

3

4

5

6

7

8

9 1011

12 13 14

1a

2a



2a. In situations in which the system is operating on a schedule, the Scheduler component will place the message on the Command Bus, preparing it for the outgoing communication session.

3. The CM-In Activator component receives the command message.

4. The communication session is then initiated within the CM-In component.

5. The Communication Module component retrieves the document from the VAN mailbox.

6. A new message is created (carrying in its payload the incoming document) and posted to the Message Bus with a subject of “New Document.”

7. Since the Document Analyzer is subscribed to the Message Bus for messages with the “New Document” subject, it receives the message carrying the new document and extracts necessary information from it, identifying it as an EDI Order coming from Partner X.

8. The Document Analyzer then posts a message to the Message Bus with a subject of “Known Document,” indicating that the document is ready to be processed.

9. Since the Document Processing Dispatcher is subscribed to the Message Bus for messages containing the “Known Document,” it receives the message carrying the recognized document.

10. The Document Processing Dispatcher determines the process configured to run for the document, according to its type and sender (in this example, an EDI order from Partner X).

11. After being initiated by the Process Activator, the Document Processor starts the processing of the document by using a predefined workflow.

12. The workflow activates that Translator (ETC) in order to convert the document into XML format.

13. The XML file is then placed into a configured folder.

14. A command batch is executed to begin the ERP import process.



Scenario B – Outgoing Documents

In the example below (Figure 2a), the ERP system is attempting to transport grouped invoice documents, appearing in XML format, to Partner X.

Figure 2a

The above process flow entails the following steps:

• The ERP system begins the transaction by generating invoices for Partner X and placing these XML documents into a specific folder.

• The TIE BI SmartStart system monitors the folder and retrieves each XML individually.

• TIE BI SmartStart will then convert each invoice document into EDI format and groups them into one EDI interchange.

• Finally, when the user initiates a communication session, TIE BI SmartStart builds the EDI interchange and delivers it to Partner X through the configured communication module.



Scenario B – Process Flow

The diagram below (Figure 2b) further illustrates the scenario presented above (Figure 2a) by detailing the step-by-step process flow of the document as it is passes through the various system components.

Note that each step numbered in the following diagram corresponds to its description below.

Figure 2b

Scenario B:

0. Before the TIE BI SmartStart system is enacted, the ERP system delivers an XML invoice document to a designated folder.

1. The Directory Watcher retrieves the document from the folder.

2. The Directory Watcher creates a new message carrying the newly-retrieved document and posts it to the Message Bus with a subject of “New Document.”

3. Since the Document Analyzer is subscribed to the Message Bus for messages with the subject “New Document,” it receives the message carrying the new document and extracts the necessary information, identifying it as an XML Invoice to be received by Partner X.

Command Bus(CB)



Document Analyzer



Mes

sage

Bus

(M

B)





Document Out

Dispatcher

CM-In Activator

Addresses


Document Type

Definitions

Splitter(EDS)

Aggregation Queue

Scheduler

Schedules

Process Activator


Message Archive


Email Notification

Utility Services


(ETC)

CM - In

CM - Out

Licenses Storage

Licensing

Post Message

Document Repository

Documents

Document Archive

Documents Archive

Directory Watcher

Ack. Processor

Invoice folder ERP

Administrator

12

3

4

0

67

8 910

11 12

13

14

13a

VAN

5

151617

18

19

20

21

22

23 24

14a



4. The Document Analyzer then posts a message to the Message Bus with a subject of “Known Document,” indicating that the document is ready to be processed.

5. Since the Document Processing Dispatcher is subscribed to the Message Bus for messages with the subject of “Known Document,” it receives the message carrying the recognized document.

6. The Document Processing Dispatcher determines the process configured to run for the document, according to its format, type, and recipient (in this example, an XML invoice to be received by Partner X).

7. After being initiated by the Process Activator, the Document Processor starts the processing of the document by using a predefined workflow.

8. The Translator (ETC) converts the XML document into EDI format.

9. It is requested that the document is grouped and then sent to Partner X.

10. A message carrying the translated document is posted to the Message Bus with a subject of “Group and Sent,” indicating that the document is ready to be grouped.

11. Since the Aggregator (grouper) is subscribed to the Message Bus for messages with the subject “Group and Send,” it receives the document.

12. The message carrying the document is then delivered to the Aggregation Queue, where it awaits the remaining documents to which it will be grouped, until a communication session is requested.

13. The administrator, or user, will then initiate the communication session.

13a. In situations in which the system is operating on a schedule, the communication session will be initiated by the Scheduler component.

14. The System Management Console (SMC) posts a message on the Command Bus, requesting it to prepare for the outgoing communication session.



14a. In situations in which the system is operating on a schedule, the Scheduler component will place the message on the Command Bus, preparing it for the outgoing communication session.

15. The Aggregator (grouper) receives the command message.

16. The Aggregator creates interchange documents by the document already storied in the Aggregation Queue.

17. The grouped documents (interchanges) are then delivered to the Message Bus as payloads of messages with the subject “Send,” indicating that they are ready to be sent.

18. Since the Document Out Dispatcher is subscribed to the Message Bus for messages with the “Send” subject, it receives the grouped documents.

19. Each of the grouped documents is then assigned a valid address by the Document Out Dispatcher, based upon the existing recipient ID associated with the document characteristics.

20. The messages carrying documents are then moved to the Send Queue, where they wait to be sent.

21. The Aggregator (grouper) posts a message to the Command Bus, requesting it to start communication session.

22. The CM-Out Activator receives the command message from the Command Bus.

23. The documents being stored in the Send Queue are then delivered to the Communication Module component.

24. The Communication Module component delivers the documents to Partner X via the configured VAN/internet.



3.0 Getting Started with TIE BI SmartStart Once you have started TIE Kinetix TIE BI SmartStart system, you will be automatically directed to its Home tab, which consists of a series of widgets.

The Home page will also contain a Get Support feature, allowing you to contact the Support Department with any outstanding issues you may encounter. However, requests should only be performed when previous attempts to rectify issues through the use of logs and status information have thereby failed.

You’ll also notice a menu of existing tabs at the top portion of the screen, which include Home, Documents, Monitoring, and Configuration.

Clicking each tab will direct you to its respective screen. For example, if you select the Documents tab, you will be directed to the Documents screen.



Each tab in the TIE BI SmartStart system corresponds to a phase of the product’s functionality, including the following:

Field/Option Description

Home Select this tab to access a compiled summary of statistics from your previous communication sessions. These statistics include:

• Document statistics

• Current queue figures

• Session log, document, and message statistics

Starting from this page, you may also contact the system’s technical support team with support requests.

However, requests should only be performed when previous attempts to rectify issues through the use of logs and status information have thereby failed.

Documents Select this tab to view a summary of all existing documents within the database, allowing you to filter them by various classifications, such as active or archived.

You may also view documents according to a specific queue in which they’ve been stored, such as the Dead Letter Queue (DLQ) or Invalid Document Queue (IDQ).

Monitoring Select this tab to monitor the progress of active workflows, system messages, and communication logs.

Configuration Select this tab to perform a variety of system configurations, which determine the nature in which your system operates.



4.0 Reviewing System Statistics When starting the TIE BI SmartStart System Management Console, the application defaults to its Home tab, which features a series of widgets containing various statistics associated with your communication sessions.

The statistics appearing on this page correspond to specific transactions performed within each session, including detailed document and message information and component-created logs.

This page also contains an overview of current queue data as well as a timeline of documents being sent, received, or declared invalid.

In addition to displaying these statistics, this tab provides a means for requesting technical support, whenever such service is necessary.

The Home page consists of the following four sections:

• Communication Sessions

• Get Support

• Current Queue State

• Document Statistics



4.1 Communication Sessions The Communication Sessions section of the Home page allows you to review details of the recent activity on the TIE BI SmartStart system.

The top portion of the section will display a carousel containing a series of widgets, each one representing one of the recent communication sessions.

Each session appears with its respective timestamp and number of documents that have been sent, received, or declared in error.

You may rotate between communication sessions by clicking their respective widgets.



Once a communication session has been selected, its associated statistics will appear in the Sessions Statistics area at the bottom of the section.

Each statistical overview contains a summary of documents that were sent, received, placed in error, unable to be sent, or waiting to be sent. A corresponding bar graph also illustrates the statistical breakdown of your session.

You may click on the section’s Logs tab in order to access an overview of all logs that were created during the specified communication session.

Each log appears with its respective Creator, FileName, and Creation Time.



Selecting the Documents tab at the bottom of the section will direct you to an overview of the specific documents included in the session.

Each document in the grid will be displayed with the following information:


Indicates when a document has been declared in a state of error.

In/Out Indicates whether the specified document is an incoming or outgoing document. Valid values include:

• In – The document is an incoming document.

• Out – The document is an outgoing document.

Id Indicates the ID number assigned to the specified document.

Date created Indicates the date and time in which the document was created.

Date processed Indicates the date and time in which the document was processed.

Sender Indicates the name of the party sending the document.

Recipient Indicates the name of the party receiving the document.

Status Indicates the current status, or phase, of the specified document. For example, if the document is in the process of being analyzed, this field will display “Analyze.”




Subject Indicates the name of the document’s file.

Comm. Module Indicates the name of the TIE BI SmartStart communication module associated with the document.

You may click on a specific row to access additional information pertaining to its corresponding document. For more information, proceed to the chapter entitled TIE BI SmartStart Documents.

Selecting the Internal Messages tab will direct you to an overview of internal messages exchanged by TIE BI SmartStart components while processing documents associated with the communication session.

Each message in the grid will be displayed with the following information:


Id Indicates the ID number assigned to the specified message.

Created Indicates the date and time in which the message was created.

Creator Indicates the name of the component that created the internal message.

Subject Indicates the subject of the internal message.




Status Indicates the status of the specified message. For example, if the message has been successfully processed, this field will display “Processed.”

Error Code If the message has encountered an error, this field displays the code of the error.

Error Indicates a description of the error that the message has encountered.

You may select a row to view additional details associated with its corresponding internal message. For more information, refer to the chapter entitled Monitoring TIE BI SmartStart.



4.2 Current Queue State The Current Queue State widget, which appears to the far left side of the Home page, contains a summary of documents that have been stored within the various queues of the TIE BI SmartStart system, providing notification of potential errors in your system’s configuration.

This widget reflects the documents that have been stored within the following system queues:

• Unable to Send Queue

• Invalid Document Queue

• Send Queue


Unable to Send Queue

This queue contains all documents that the system was unable to send to its intended recipients. Various conditions may determine when the system is unable to send a specific document, such as a missing or invalid address.

Invalid Document Queue

This queue contains all documents that have been deemed invalid within the system. A series of conditions may determine when a document is considered invalid, such as insufficient data, translation errors during document processing, etc.

Send Queue This queue contains all documents that are waiting to be sent to the desired recipients. A high volume of documents in this queue indicates that either a communication session was not executed for sending documents or that it is repeatedly failing.



4.3 Document Statistics The Document Statistics widget, which appears in the bottom, left corner of the Home page, contains a summary of all documents that have been sent, received, deemed invalid, or declared dead-letters. The statistics displayed in this widget are demonstrated on a bar graph.

When the Home page is accessed, this widget defaults to the document statistics from the current day.

At the bottom of the widget, you may click the This Week tab to access the statistics of all documents from the current week.



You may also click the This Month tab to access the statistics of all documents from the current month.



4.4 Getting Support As part of the featured enhancements included in the TIE BI SmartStart system, you may now request technical support directly from the Home page of your application. When this feature is enacted, a package (which may include the affected content files) is delivered to the Support Department. However, requests should only be performed when previous attempts to rectify issues through the use of logs and status information have thereby failed.

The Get Support widget appears in the top left-hand corner of the Home page. You may click the Get support now! button in order to request technical support service.

If you are permitted to request support (your application is licensed and your maintenance subscription is up to date) and your system is connected to the internet with access to the support server, you will then be prompted with a window, providing instructions for reporting your technical issues.



Click Next to proceed to the ensuing window, where you may select the communication session for which you are seeking customer support.

Note that each session appears in the grid with its respective identifier, date of occurrence, and checkmark to indicate whether or not it resulted in system errors.

You may select a session by clicking on its corresponding row. Pressing down on the CTRL or SHIFT key will allow you to select multiple sessions.

Once you have selected the proper communication session, click Next to proceed to the ensuing window, where you may describe the nature of your issue.

It is highly recommended that you describe the intricate details of the issue in order to enable a timely response from the support department. These details must include the latest changes performed to the system configuration as well as steps taken to reproduce the reported problem.



Click Next to proceed to the ensuing window, where you will be asked if you wish to send the affected document with your support request. Simply check the box provided in order to deliver the associated files to the support department.

You must also provide a password in the Package password field in order to ensure additional security for your support package. Once this password has been established, it will be sent to the support department in a separate message.

Click Next to proceed to the ensuing window, where it is indicated that all information pertaining to your communication session is being gathered, compressed, and sent to the support department.



Click Send in order to deliver the support request to the appropriate department.

Once initiated, the progress bar will indicate the current status of the process. When it has concluded, the window will confirm the successful delivery of the support request.

You may also click the Back button to return to any step in the process.

After uploading the respective data on the support server, TIE BI SmartStart will deliver an email containing the request description and password of the uploaded package to the Support Department’s email address, as configured in the licensing file. An entry in the TIE Support system is automatically created, allowing you to personally inquire about the request’s status on TIE Customer Portal.

Once the support department has reviewed the request, the user will be contacted via email or telephone with valuable feedback for rectifying the issue.



4.5 Initiating Communication Sessions The Home page also allows you to initiate a communication session through its toolbox at the top of the page.

This toolbox consists of four buttons, allowing you to initiate communication sessions and refresh the statistics:

• Send & Receive – Initiates a communication session, allowing you to both send and receive documents.

• Send – Initiates a communication session, allowing you to send documents.

• Receive – Initiates a communication session, allowing you to receive documents.

• Refresh – Performs a refresh of the data and displays the most current statistics from the communication session.

Click the button that corresponds to the nature of your communication session. The System Management Console will then place the appropriate command messages in the TIE BI SmartStart bus. The background-running service will then activate the appropriate modules to initiate and execute the requested type of communication session.

A pop-up window will then appear, indicating that the communication session has been activated and may take a few moments to complete. You are encouraged to continue working on the TIE BI SmartStart system until the documents have been processed.

Click OK to remove the pop-up window from the screen.

Click the Refresh button to update the page with the most current communication statistics.

You may also refer to the Documents tab in order to monitor the activity of your document transactions.



5.0 Configuring TIE BI SmartStart Before you send and receive documents via the TIE BI SmartStart product, it is important to properly configure the system to support the desired document processing functions.

Configuring TIE BI SmartStart requires the application of specific parameters on various tabs and screens throughout the system. Without a proper configuration, TIE BI SmartStart will be unable to transmit a document’s messages through the proper streamline of components.

Therefore, it is recommended that users configure the TIE BI SmartStart system in the following order:

1. Communication Modules

2. Addresses

3. Document Structures (Document Analyzer)

4. Workflows (Workflow Designing)

5. Processes (Document Processor)

6. Scheduling (if necessary)

7. Application Settings

Note that workflows are maintained in a separate application referred to as Workflow Designer.



5.1 Communication Modules The first step in configuring your TIE BI SmartStart system is to establish the specific communication modules through which documents are sent and received.

Note that the TIE BI SmartStart installation includes the File System communication module as well as SMI communication.

In order to use additional communication modules, they must be individually installed on your system, which generally requires an additional licensing fee.

Once you’ve selected the Configuration tab at the top of the screen, you must click on the Communication Modules button within its menu.

The Configuration – Communication Modules screen will then be displayed.



You will notice along the left-hand pane a list of communication modules installed on the system. Each communication module appears with the icon directly above it.

When you select a communication module in the left-hand pane, the screen will display its respective fields, reflecting its specific properties and values.

The name associated with each communication module includes its type and location type, as determined by the licensing module. The lone exception is the File System communication module, which is not associated to one specific license.

Within the fields provided, you may figure configure each communication module accordingly.



5.1.1 File System Communication Module The File System communication module may be used for both send and receiving documents. With this module, you may configure multiple paths from which the document may be received. Note that when sending documents via File System, the address folder is used as a subfolder.

From the Configuration – Communication Modules screen, select the File System option from the left-hand menu in order to access its configuration fields.

In the fields provided, enter the appropriate values.


Module enabled Indicates whether or not the communication module is to be enabled within the system. Valid values include:

• Checked – The communication module has been enabled on the system.

• Unchecked - The communication module is disabled on the system.

Outgoing documents folder

Enter the path of the folder at which the content of the outgoing documents will be placed.

The partner address value will be used as its respective subfolder.




Incoming documents storage folder

Enter the folder path of where the content of the received documents will be stored in the system, allowing them to be accessed for further processing. The system regularly empties the folders where the document files were originally received, allowing additional document files to be received in the ensuing sessions.

Watched Locations (section)

Indicates the list of folders where the system is to receive document files.

Recursive Determines whether or not the files will be retrieved by the specified folders as well as its respective subfolders. Valid values include:

• Checked – The files will be retrieved by the specified folders and subfolders.

• Unchecked – The files are not to be retrieved by the specified folders and subfolders.

One document per folder

Indicates whether or not TIE BI SmartStart will create only one document for which the folder’s files will be used. Valid values include:

• Checked – The system will create only one document for which the files received from the specified folder will be used as its multiple contents.

• Unchecked – The system will create multiple documents, one for each of the files retrieved by from the specified folder.

For configuration details on the remaining communication modules, refer to the TIE Communication Modules for BI Smart Start Administrator’s Guide.



5.2 Addresses In order to configure the remainder of the TIE BI SmartStart system, it is important to establish a database of partner addresses.

Without valid address information, the system cannot retrieve the sender of incoming documents, whereas outgoing documents cannot be sent to the intended recipients. Therefore, such documents are dropped into the Dead Letter Queue (DLQ).

In addition to simple partner addresses, you may also create distribution lists, which are comprised of partner addresses to which documents may be sent.

Once you’ve selected the Configuration tab at the top of the screen, you must click on the Addresses button within its menu.

The Configuration - Addresses screen will then be generated.



You may also add a new address or distribution list to the system by clicking the icon beside the row at the bottom of the grid. A pop-up window will then be

displayed, allowing you to specify the type of item you wish to create.

To create a new database, click . The New Address details screen will then be displayed.

In the fields provided, enter the appropriate information for the address you are adding. Note that all fields appearing with red borders are required.


Name Enter the name of the partner associated with the address you are adding to the database.

ShortName Enter a unique short name for the partner address you are adding to the database. The short name may be an abbreviated version of the entry appearing in the Name field.

Partner Code Enter the unique code used for identifying the partner associated with the address you are adding. This value may include either an EAN or GLN code, or perhaps a mutually-agreed code.

Partner Code Qualifier

Enter the qualifier, or identifier, of the agency issuing the partner code specified in the Partner Code field (i.e. EAN, 14, ZZ, own).

Note that the partner code and code qualifier must match the values used in the documents you receive from the partner. Otherwise, the system cannot recognize the document sender of recipient.

Description Enter a description for the address you are adding to the database.




Communication via From the drop-down list box, select the communication module through which the documents sent to the address will be delivered. These options will only include the communication modules registered into the system based upon license information.

Address Enter the address to which documents are to be delivered. It is important to be careful when entering the address in this field.

Send copy to If necessary, select from the drop-down list box the address to which a copy of the document or item should be sent.

When you have finished configuring the address, click to save it to the configuration database.

Your new entry will then appear in the grid with its respective Short Name, Type, VAN (communication module), Name, and Address.



You may also modify an existing address record by selecting it within the grid and generating the Address pop-up window.

When finished, you may also click one of the following buttons in order to perform its respective function.

Button Description

Click this button to save the address you are adding to the database.

Click this button to remove any modifications you have performed to the address.

Click this button to delete the address from the existing database.



To create a distribution list:

1. Click the icon beside the row at the bottom of the grid.

2. When the pop-up menu appears, click the button.



The Distribution List pop-up screen will then be generated.

3. In the fields provided, enter the appropriate information for the distribution list you are adding. Note that all fields appearing with red borders are required.


Name Enter the name of the partner associated with the distribution list you are adding to the database.

ShortName Enter a unique short name for the partner distribution list you are adding to the database. The short name may be an abbreviated version of the entry appearing in the Name field.

Description Enter a description for the distribution list you are adding to the database.



4. From the Available addresses window, select the existing email address you wish to add to the distribution list.

5. Click to add the address into the Member addresses window, which represents the entries that will be included in the distribution list.

You may repeat this process until you have added all email addresses you wish to include in your distribution list.



You may also select an address in the Member addresses window and click to remove it from the distribution list. You’ll notice that the email

address will then return to the Available addresses window.

6. When you have finished configuring the distribution list, click . The distribution list will then appear in the grid.



You may also modify an existing distribution list record by selecting it within the grid and generating the Distribution List pop-up window.

When finished, you may also click one of the following buttons in order to perform its respective function.

Button Description

Click this button to save the distribution list you are adding to the database.

Click this button to remove any modifications you have performed to the distribution list.

Click this button to delete the distribution list from the existing database.



5.3 Document Structures An integral step in configuring TIE BI SmartStart system is to set up your document structures, allowing the Document Analyzer component to recognize documents and populate its metadata based upon:

• information extracted from its respective content (when possible)

• information provided directly from the administrator

EDI documents following EDIFACT or ANSI X12 standards will be analyzed by the Document Analyzer (be default), thereby not requiring the administrator to establish specific structures for them.

However, the administrator will need to define the method in which in-house files are recognized as well the structures used for analyzing XML documents.

Once you’ve selected the Configuration tab at the top of the screen, you must click on the Document Structures button within its menu.

The Configuration - Document Structures screen will then be generated.



You may click on the icon at the far left-hand side of the grid to access a pop-up menu, in which you may select whether the item is an XML or EDI document.

Once you have selected the document’s file type (by clicking either the Create new XML structure or Create new Inhouse structure buttons), the Attributes pop-up screen will appear, allowing you to configure the document attributes.

This screen will vary, depending upon whether you’ve selected an XML or Inhouse document structure.



XML Document Attributes Configure your XML document-analyzing structure in the fields provided on the Attributes pop-up window. Note that the Description field, which appears in red borders, is a required field, as is at least one of the Recognition Attributes fields.


General Attributes

Type Indicates that the document is of the XML structure type.

Description Enter a description for the XML structure type being created.

Recognition Attributes (at least one field must be populated)

Namespace Enter a namespace, or identifier, for the XML structure type being created. If the namespace is used within the document’s content, the document will be recognized as belonging to the specified type.

Schema Enter the schema associated with the XML structure type being created. The document will be recognized as belonging to the specified type if its content is declared as implementing the XML schema.

DTD Enter the document type definition (DTD) associated with the XML structure type being created. The document will be recognized as belonging to the specified type if its content is declared as implementing the DTD.




General Attributes

XPath Enter the XPath being used with the XML structure type being created. The document will be recognized as belonging to the specified type if the evaluation of this XPath expression returns a non-null XML node.

In the Attributes section of the pop-up window, you may establish values of the document attributes and determine whether or not an XPath is used to extract the value for each of the existing attributes.

In the grid provided, you may select the attribute you wish to establish.



To activate the XPath for the specified attribute, select Yes from the drop-down list box and enter a valid XPath query string in its Value field. For detailed instructions on writing a valid XPath query, refer to the XPath documentation at http://www.w3schools.com/XPath/default.asp.

Values that are not marked as an XPath will be copied to the document attribute.

At the bottom of the screen, you may click one of the three buttons in order to perform its respective function.

Button Description

Click this button to save the document structure you are adding to the database.

Click this button to remove any modifications you have performed to the document structure.

Click this button top remove the specified document structure from the database of existing items.



Inhouse Document Attributes As previously mentioned, the Document Analyzer can only search for data in the standard EDI and XML documents. In all other cases, the Inhouse structure may be defined by the administrator, allowing a document to be properly identified. This feature also allows document attributes to be properly established, based upon the folder from which the document was retrieved.

With its distinct functionality, Inhouse structures are only utilized for documents received via the Default File System Communication Module. For more details on configuring this communication module, refer to the section entitled Communication Modules.


General Attributes

Type Indicates that the document is of the Inhouse structure type.

Description Enter a unique description of the Inhouse document structure.

Recognition Attributes

File Location Enter the absolute path of the folder from which this type of document is to be read.

Filename Enter the name of the file for the specified type of document. This field is optional.

Type Enter the type of Inhouse document attribute (i.e. Sender) that you are creating.



In the Inhouse Document Attributes section, you may enter the appropriate data in the fields provided.

At the bottom of the screen, you may click one of the three buttons in order to perform its respective function.

Button Description

Click this button to save the document structure you are adding to the database.

Click this button to remove any modifications you have performed to the document structure.

Click this button top remove the specified document structure from the database of existing items.



5.4 Workflows Once the appropriate addresses and document structures have been established within the TIE BI SmartStart system, it is recommended that you properly configure your workflows.

Workflows that are necessary for document processing may be created and maintained through the TIE BI SmartStart Workflow Designer.

The Workflow functionality allows you to process your documents through a specified sequence of activities. Activities perform specific actions, such as translating, sending, grouping documents, etc.

5.4.1 Operating the TIE BI SmartStart Workflow Designer You may begin the process of generating workflows by accessing the TIE BI SmartStart Workflow Designer application.

In the top, right-hand pane will appear a list of available workflow activities.



The toolbar at the top of the TIE BI SmartStart Workflow Designer allows you to perform each available workflow function.

These functions include:

• Creating new workflows

• Editing existing workflows

• Compiling workflows

To create a new workflow:

1. Click the icon at the top left-hand corner of the screen. You may also click on the File menu and select New.



2. Once the New Kinetix Workflow pop-up appears, enter a unique name for the workflow you are creating in its Workflow name field.

Note that a workflow name must begin with an alpha character and cannot contain spaces or special characters (i.e. “@”). You may use an underscore (_) in lieu of a blank space.

3. Click OK to generate all three sections of the TIE BI SmartStart Workflow Designer.



In the left portion of the screen, the Sequential Workflow pane allows you to assemble the workflow while determining the order of its associated activities.

The top right-hand corner of the screen contains a list of existing workflow activities.



The bottom right-hand corner of the screen contains a list of properties for each workflow activity.

4. From the list of existing workflow activities, select the item you wish to add to the workflow order. Drag the activity item into the Sequential Workflow pane and drop it on the green plus icon at the location to which it should be added.

Each activity will appear at the appropriate location within the sequential workflow. You notice that the order of workflow activities is listed downward on the screen, beginning with the green arrow icon and ending at the red stop icon.



When you select an activity in the Sequential Workflow pane, its respective properties will appear in the section at the bottom, right-hand corner of the screen.

5. In the fields provided, you may configure the properties for each activity. Refer to the forthcoming Configuring Workflow Activities section for definitions and values of each property.



6. When you have finished adding and configuring each activity, click to save the new workflow.



To open an existing workflow:

TIE BI SmartStart also allows you to open existing workflows and perform any necessary modifications.

1. Click the icon at the top left corner of the screen.

2. Once the Open Kinetix Workflow pop-up appears, select the workflow item you wish to open from the Workflow name drop-down list box.



3. Click OK to access the existing workflow item.

You’ll notice that disabled workflow activities, like etcTranslation1 in the below example, will appear as “grayed out” in the Sequential Workflow section.



In order to enable the workflow activity, the Enabled field in the Activity Properties section must be set to True.

4. Perform any necessary modifications to the workflow, including the addition of workflow activities and changes to their respective properties.

5. When finished, click to store your changes.



To cut, copy, and paste activities:

It may be necessary to rearrange the order of activities within the workflow. The Workflow Designer allows two methods for relocating an activity within a workflow:

1. Perform a drop and drag to the appropriate location

2. Perform a standard cut/paste or copy/paste

In the Sequential Workflow section, you may drag and drop an activity to a new location within the workflow order, placing it on the green plus icon ( ).

Assume in the following example that you wish to move the copyContent1 activity to the third position in the workflow order.

Click the on the copyContent1 activity and drag it to the green plus icon above the desired location.



The activity will then appear in the new location in the Sequential Workflow pane.

You may also utilize the toolbar to perform standard copy/paste and cut/paste operations.

In the Sequential Workflow section, select the workflow activity you wish to either

cut or copy and click the appropriate icon in the toolbar ( to cut, to copy).



You may click the arrow pointing to the desired location and click the paste icon in the toolbar.

The activity will then appear in its new location within the workflow.



To delete an activity from a workflow:

There are three ways in which you may delete an activity from a workflow.

1. In the Sequential Workflow section, select the activity you wish to delete, and from the Edit menu, select Delete.

2. You may also right-click the activity in the Sequential Workflow section and select Delete.

3. Select the activity in the Sequential Workflow section and press the DELETE key on your keyboard.



The activity will then be removed from the workflow.

To compile a workflow:

Before a workflow can be utilized on the TIE BI SmartStart system, it must first be compiled.

It is important that the System Management Console is not in use when workflows are being compiled. Otherwise, you’re the compilation of the workflow could result in errors.

1. From the workflow you’ve created, select the icon in the toolbar.



2. Once the Workflow Compiler Form pop-up is generated, click .

The Workflow Compiler Form will then perform the compilation process on your workflow.



The “Service started” line at the bottom of the dialog indicates that the workflow has finished compiling.

The workflow is then placed in a folder, where it will be accessible to the rest of the TIE BI SmartStart system.

3. You may click to close the Workflow Compile Form pop-up and return to the Workflow Designer.

If the workflow unexpectedly terminates, you may restart processing by

clicking the Restart Service icon in the toolbar.



To perform additional functions:

You may perform additional functions on the Workflow Designer, including expanding/collapsing activities, printing workflow data, or enlarging/minimizing the Sequential Workflow section.

In the event that your workflow contains an ifElse activity, you may either expand or collapse its contents within the Sequential Workflow section.

Select the ifElse activity in the Sequential Workflow section and click the icon in the toolbar to expand its contents.

You may also click the icon to collapse the activity in the Sequential Workflow section.



You may also print a workflow by clicking the icon in the toolbar, thereby generating the Print dialog.

When you’re finished applying your print options, click OK to print the workflow data.

You may also enlarge or minimize the display of the Sequential Workflow section by selecting the appropriate percentage from the toolbar’s drop down menu.



The Sequential Workflow section will then appear in the Workflow Designer under its selected size.



5.4.2 Available Workflow Activities The standard workflow activities included in TIE BI SmartStart include the following:


ETCTranslation Instructs TIE BI SmartStart to translate a document using the TIE Translator ETC.

XSLTranslation Instructs TIE BI SmartStart to translate a document using an XSL file.

This activity is to be used when the document consists of the XML format.

SendDocument Instructs TIE BI SmartStart to send a document to its intended recipient once the next communication session begins.

GroupAndSendDocument Instructs TIE BI SmartStart to send the document to its intended recipient once it’s been grouped with similar documents. The documents will then be sent once the ensuing communication session begins.

ExecuteBatch Instructs TIE BI SmartStart to perform the execution of a command line batch, which is an external process that may be applied to the document’s content.

AnalyzeDocument Instructs TIE BI SmartStart to analyze the document content based on defined document structures and to set the document properties according to the current document content.

This activity is to be used only with standard EDI and XML documents.

CopyContent Instructs TIE BI SmartStart to create a copy of the processed document content and place it in a specified folder.

PutDocumentToFolder Instructs TIE BI SmartStart to place (relocate) the processed document content into the specified destination folder.

ExposeDocument Instructs TIE BI SmartStart to expose a document’s properties in order for it to be utilized in additional workflow activities.

EmailNotification Instructs TIE BI SmartStart to deliver email notifications to intended recipients.




RepostAsNewDocument Instructs TIE BI SmartStart to place a document back onto the system as a new item, allowing it to be processed as any other item, beginning with document analyzing.

Note that this activity should only be used by experienced implementers.

ReprocessDocument Instructs TIE BI SmartStart to reattempt processing of the document by reposting it to the system bus as a known document. It will then be dispatched to another process configured in the system.

Note that this activity should only be used by experienced implementers.



5.4.3 Configuring Workflow Activities

When creating workflows, you must first configure the properties of each activity.

The workflow activity properties are grouped in the system according to its category type. (i.e. Document properties, Options, etc.)

Depending on the specific activity, some properties may be commonly used.

The following table lists groups that are common within specific activities. In addition to these listed properties, several activities contain a series of specific properties.

Property group/Activity

Act

ivit

y

Act

ivit

y+

Do

cum

en

t P

rop

ert

ies

Do

cum

en

t P

rop

ert

ies

Op

tio

ns

Han

dle

rs

Po

st

Co

py

Op

tio

n

File

Fo

lder

Op

tio

ns

Mo

re

Sp

eci

fic

Pro

pert

ies

ETCTranslation X X X X

XSLTranslation X X X X

ExecuteBatch X X X X

CopyContent X X

PutDocumentToFolder X X

SendFolder X X X X X X

GroupAndSendDocument X X X X X X

RepostAsNewDocument X X X X X X

ReprocessDocument X X X X X X

EmailNotification X X

AnalyzeDocument X

ExposeDocument X X



The following tables detail the parameters for each associated properties group. Each customized TIE activity will appear with a description of its respective parameters.

“Activity” Properties Group The property fields listed below will also appear for the Activity group.

Activity Property Description Mandatory

(Name) Displays the unique name used to identify the activity.

Yes

Description Displays a description of the activity. No

Enabled Select from the drop-down list box the value indicating whether or not the activity has been enabled within the system. Valid values include:

• True – The activity has been enabled within the system.

• False – The activity has not been enabled within the system.

Note that disabled activities cannot participate in execution and validation processes.

Yes

“Activity+” Properties Group The following properties are displayed on screen as part of the “Activity” properties group, but appear only for a reduced set of activities:

• SendDocument

• GroupAndSendDocument

• RepostAsNewDocument

• ReprocessDocument



The following properties are determined by the system and should not be altered.

WF Activity Property Description Mandatory

InterfaceType This value is determined by the system and should not be altered.

Yes

MethodName This value is determined by the system and should not be altered.

Yes

“Document Properties” Property Group The “Document Properties” group is common to the activities that allow you to determine the attributes of the document that result from the execution of the activity:

• ETCTranslation

• XSLTranslation

• ExecuteBatch

In this situation, you may specify the attributes of the translated document. For example, if the document consisted of EDI format prior to an ETCTranslation, you may set the value of the DocumentFormat property to “XML” in order to notify the system that the result of the ETCTranslation is an XML document.

The same group of parameters also appears for activities posting the document back to the system message bus for additional processing:

• SendDocument




In this situation, you may set the attributes of the document being posted to the bus. For example, if you wish to send the document to a specific recipient, you must set the value of the RecipientShortName to the desired value in the SendDocument activity.

Finally, the same set of parameters is available for the activity exposing the document attributes for workflow activities not considered TIE custom activities:

• ExposeDocument

In this situation, the associated properties are read-only.

Note that for all cases in which property values can be changed, the manner in which the system uses them is defined by values of the properties in the “Document Properties Options” group.




DocumentFormat Enter the new value defining the document format (i.e. EDIFACT or XML).

No

DocumentType Enter the new value defining the document’s type (i.e. INVOIC or ORDERS).

No

DocumentSubType Enter the new value defining the document’s subtype (i.e. D96A).

No

RecipientShortName Enter the short name of the document’s recipient.

Note that an address must exist with a specified short name. Addresses are defined on the Configuration – Addresses screen.

No

SenderShortName Enter the short name of the document’s sender.

Note that an address must exist with a specified short name. Addresses are defined on the Configuration – Addresses screen.

No

“Document Properties Options” Property Group The properties within this group define the manner in which the system uses document attributes specified in the “Document Properties” group.

These properties are specific for the following TIE custom activities:

• ETCTranslation

• XSLTranslation

• ExecuteBatch

• SendDocument







ChangeDocumentProperties Select from the drop-down list box whether or not the document attributes should be set once the activity has been executed. Valid values include:

• True – Values should be assigned to the document attributes.

• False – The document properties should remain unchanged.

Note that when the field is set to True, you may configure the Document Properties field accordingly.

Yes

UseNullValues Indicates how a null value on a document property should be interpreted when setting new document attributes. Valid values include:

• True – The document attribute corresponding to a null-specified Document Properties field will be set to an empty value.

• False – The document attribute corresponding to a null-specified Document Properties field will remain unchanged. The system preserves the value before executing the activity.

The value of this property is only used if ChangeDocumentProperties is set to True.

Yes



“Handlers” Property Group For the Handlers property group, which appears in a series of TIE custom activities, you should not attempt to change existing values.

• SendDocument





MethodInvoking This is a default property added by the Engine for various types of activities, not currently used in TIE BI SmartStart.

Important: Do not attempt to set a value for this property!

No

“Post a Copy Option” Property Group This property is displayed as part of the “Options” group for a set of TIE custom activities that post the document back to the system message bus for additional processing:

• SendDocument





PostCopy Select from the drop-down list box whether or not a copy of the document (as opposed to the original) should be posted to the Message Bus for addition processing. Valid values include:

• True – A copy of the document is posted to the Message Bus for additional processing.

• False – The original document is posted to the Message Bus for additional processing.

Yes



“File Folder Options” Property Group This property group is used by activities that are copying or moving the document content to a specified folder:

• CopyContent

• PutDocumentToFolder


Destination Folder Enter the destination folder (in absolute path) to which the document copy should be copied or moved.

Yes

Create Folder Select from the drop-down list box whether or not the system is to create the destination folder, provided it doesn’t already exist. Valid values include:

• True – The system is to automatically create the destination folder when it does not already exist.

• False – The system generates an error if the destination folder doesn’t exist.

ExistingFileAction Select from the drop-down list box the action to be performed by the system when the destination file already exists. Valid values include:

• Make Unique – The file name will be changed by adding a counter at the end of it until it becomes unique.

• Append – The content of the document is to be appended to the content of the existing file.

• Overwrite – The existing destination file content will be replaced with the content of the document.

Yes



Specific Properties As previously mentioned, many TIE activities contain specific properties that are not described in the aforementioned groups.

“ExecutiveBatch” Activity The property fields listed below will also appear for the ExecuteBatch activity.

Field/Option Description Mandatory

Command Line (category)

ExecutableFileName Enter the complete, absolute path of the file being executed.

Yes

Arguments Enter the appropriate command line arguments to be used when starting the executable.

You may use the $CONTENT$ macro to specify the location in the command line where the content file’s name will be inserted.

You may also use the $FOLDERS$ macro for specifying the location in the command line where the unique folder path will be inserted.

No

Options (category) Options (category)

ExitCodeOK Enter the code returned by the executed process when it is successfully executed.

Note that in most cases (default), this value should be “0”.

Yes

NeedsUniqueFolder Select from the drop-down list box whether or not the system should create a unique folder to use in the command line. Valid values include:

• True – The system should create a new folder.

• False – A unique folder does not need to be created.

Yes




ResultPath Enter the path from which the results should be retrieved.

This field is only mandatory if UseResultsAsDocumentContent is set to True and UseUniqueFolderAsResult is set to False.

Conditioned (see description)

Timeout Enter the number of seconds allowed before the executed process will be terminated with a timeout error report

Yes

UseResults AsDocumentContent

Select from the drop-down list box whether or not the document content should be replaced with the resulting file(s). Valid values include:

• True – The resulting file(s) will be used as new content of the processed document.

• False – The document content will remain unchanged.

Yes

UseUniqueFolder AsResult

Select from the drop-down list box whether or not the execution results should be retrieved from the unique folder generated by the system. Valid values include:

• True – The execution results should be retrieved from the unique folder.

• False – The execution results should be retrieved from the folder defined by UseResultsAsDocumentContent.

Yes

“EmailNotification” Activity The property fields listed below will also appear for the EmailNotification activity.


Addresses (category)

From Enter the reply address that is to be used for email being sent once an activity is executed.

Yes




To Enter the email address of the intended recipient for emails being sent out when an activity is executed.

Yes

SendAsHTML Select from the drop-down list box whether the body of the email should be sent in either HTML format or plain text. Valid values include:

• True – The body of the email is to be sent in HTML format.

• False – The body of the email is to be sent as plain text.

Yes

Body Enter the body of the email being sent.

Note that the following macros may be used for inserting document properties in the subject text:

• $DOCNUMBER$

• $DOCSENDER$

• $DOCRECIPIENT$

• $DOCTYPE$

Yes

Subject Enter the subject of the email being sent.

Note that the following macros may be used for inserting document properties in the subject text:

• $DOCNUMBER$

• $DOCSENDER$

• $DOCRECIPIENT$

• $DOCTYPE$

Yes

“XSLTranslation” Activity The property fields listen below will also appear for the XSLTranslation activity.


XSLT Settings (category)

XSLTFileName Enter the name of the XSLT file used for processing the document content.

Yes




OutputFileName Enter the name of the file where the system is to store the results of the XSL transformation.

If the value is not an absolute path, the system will create a unique folder for storing the result. The system will then use the file name from the specified folder.

Yes

EnableDocument Function

Select from the drop-down list box whether or not the “document” function should be enabled in the XSLT. This function is used if an external XML file is accessed from the XSL code. Valid values include:

• True – The “document” function is enabled in the XSLT.

• False – The “document” function is disabled.

Yes

EnableScripting Select from the drop-down list box whether or not scripting should be enabled during the XSL transformation. Valid values include:

• True – Scripting is enabled in the XSLT.

• False – Scripting is disabled.

If the XSLT is not from a trusted source, it is recommended that you disabled the scripting.

Yes



“ETCTranslation” Activity The property fields listen below will also appear for the ETCTranslation activity.

Note: For more details on most ETC Translation options, refer to the TIE Translator Reference Manual.


Map Definition Files (category)

EID File Enter the EDI file name, including its extension (i.e. invoice.eid).

Yes

Map Options (category)

Direction Select from the drop-down list box the direction of the translation. Valid values include:

• Translate – The mapping is used for translating EDI to either Inhouse or another format.

• Construct – The mapping is used for constructing an EDI file from either Inhouse or another format.

Yes

EDIFileName Select the name of the EDI file being generated.

Note that this value consists of only the file name and extension, not the file’s absolute path.

This field is considered mandatory when the Direction field is set to Construct.

Conditioned

HeaderFileType Select from the drop-down list box if header files are generated during the translation and the manner in which they are recognized. Valid values include:

• None – No header files are generated.

• Prefixed – The generated header file names begin with special character “~”.

• HDR Extension – The Generated header files contain an .HDR extension.

Yes




IsCSeg Select from the drop-down list box whether or not the CSeg option is active. Valid values include:

• True – The CSeg is active and the EDI content will be constructed with one segment per line.

• False – The CSeg option is inactive.

Yes

OutLineLength Enter the length (number of characters) of existing lines in the constructed EDI file.

Yes

DelimitedTilde Select from the drop-down list box whether or not tilde (~) should be designated for empty text fields in delimited files as opposed to two quotation marks (“”). Valid values include:

• True – Tilde should be designated for empty text fields.

• False – Two double quotation marks should be designated for empty text fields.

Yes

DoNotVerifyCodes Select from the drop-down list box whether or not the code verification for coded elements should be suppressed. Valid values include:

• True – The code validation process is to be suppressed.

• False – The code validation processed is to be performed.

Yes

RemoveEmpty Inhouse

Select from the drop-down list box whether or not the empty generated inhouse files should be deleted at the end of the process. Valid values include:

• True – The empty inhouse files are to be deleted.

• False – The empty inhouse files are not to be deleted.

Yes




Version Select from the drop-down list box whether or not the version information should be printed. Valid values include:

• True – The version information is to be printed.

• False – The version information is not to be printed.

Yes

Trace file generation options (category)

DebugMode Select from the drop-down list box whether or not the debug mode should be activated within the ETC Translator. Valid values include:

• True – The dubug mode is active.

• False – Debug information is not generated.

Yes

TechnicalTrace Select from the drop-down list box whether or not the trace file should include technical information (for helpdesk usage). Valid values include:

• True – Technical information is to be included in the trace file.

• False – Technical information should not be included in the trace file.

Yes

TraceDef Select from the drop-down list box whether or not the tracing feature should be activated for the definition file. Valid values include:

• True – The tracing feature should be activated for the definition file.

• False – The tracing feature should not be activated for the definition file.

Yes




TraceEDIProc Select from the drop-down list box whether or not the tracing feature should be activated for the EDI construction process. Valid values include:

• True – The tracing feature should be activated for the EDI construction process.

• False – The tracing feature should not be activated for the EDI construction process.

Yes

TraceInhouseProc Select from the drop-down list box whether or not the tracing feature should be activated for the inhouse generation process. Valid values include:

• True – The tracing feature should be activated for the inhouse generation process.

• False – The tracing feature should not be activated for the inhouse generation process.

Yes

TraceLinkProc Select from the drop-down list box whether or not the tracing feature should be activated for the link process. Valid values include:

• True – The tracing feature should be activated for the link process.

• False – The tracing feature should not be activated for the link process.

Yes



5.5 Processes Your TIE BI SmartStart system processes documents only when you’ve registered the specific processes necessary for running them. For example, these processes may include workflows that you created and compiled via the Workflow Designer application or perhaps a splitting process provided by the system for EDI documents.

A process will be executied for a specific document when its attributes match the criteria established when registering the process into the system. This criteria includes format, type, subtype, sender, and recipient.

Note: It is important that you register for the same type of dicument both a splitting process and a workflow. In this situation, splitting will only be performed on documents not previously split.

For example, if you wish to process an EDI document containing mutliple invoices, the original document’s type and split document type may both be INVOIC. The split documents will be presented to the Document Processing Dispatcher and no longer forwarded to the Splitter. However, the system will attempt to find another process (workflow) registered for INVOIC documents.

Once you’ve selected the Configuration tab at the top of the screen, you must click on the Processes button within its menu.

The Configuration - Processes screen will then be displayed.



You may add a new process to the system by clicking the icon at the bottom of the grid.

The Process Detail pop-up screen will then be displayed, allowing you to configure the process you are adding.



In the fields provided, enter the appropriate values for the process you are adding. Note that all fields appearing with red borders are required.


Name Enter a unique name for the process you are adding. This entry will be displayed in the list of processes, allowing you to swiftly identify the process.

Priority Select from the drop-down list box the priority level of the process you are adding.

Process Type Select from the drop-down list box the type of process you are adding to the database. Valid values include:

• Split Document – The process extracts individual documents from a single composed EDI document, as performed by the system’s Splitter component.

• Process Document – Registers a compiled workflow to be used for processing documents.

Timeout (seconds) Enter the number of seconds in which the specified process must complete before it times out. If the process has not been completed in the provided number of seconds, the process (workflow) will be aborted and the document will be placed in an error state.

Workflow Type If the Process Type field (mentioned above) has been set to Process Document, you must enter the name of the workflow type being run.

Select from the drop-down list box the workflow type for which the process registration is being added.

Note that the select box will display only the names of the workflows that were previously created and compiled via the Workflow Designer application.



In the Activation Criteria section of the pop-up screen, you may change data on the empty line. These data items determine the criteria in which the process is activated within the workflow.

In each off the criteria fields, you may specifiy the desired value that must be matched precisely by the value of the corresponding document attribute. Otherwise, select one of the special values:

• Any – Indicates the the document attribute corresponding to this field must not be used in the document selection criteria.

• Empty – Indicates that the document attribute must be empty in order to match the document selection criteria.

In the fields provided, enter the criteria through which the process is determined for the document being processed.


DocFormat Indicates the format of the document that may be processed through the process currently registered. (i.e. XML, EDIFACT, INHOUSE).

DocType Indicates the type of document that can be processed through the process currently registered (i.e. D96A).

DocSubType Indicates the subtype of the document that can be processed through the process currently registered (i.e. D96A, abc).

SenderId Select from the drop-down list box the sender (short name) of the document that can be processed through the process currently registered.

RecipientId Select from the drop-down list box the recipient (short name) of the document that can be processed through the process currently registered.



Once a process registration has been added to the configuration database, you may perform modifications by selecting it within the grid. Once the Process Details pop-up screen is displayed, you may apply any necessary changes in the fields provided, as described above.

At the bottom of the screen, you may click one of the following buttons in order to perform its respective function.

Button Description

Click this button to save the process registration you are adding or modifying.

Click this button to remove any modifications you have performed to the process registration.

Click this button to delete the process from the existing database.



5.6 Scheduling In some cases, it may be necessary to initiate various TIE BI SmartStart communication activities, such as communication sessions or document archiving, at specific times. For example, you may wish to send a document to an intended recipient every Tuesday at noontime. In order to determine a specific period in which these functions are performed, you must configure a list of schedules within the system.

TIE BI SmartStart allows you to create schedules based on the following time intervals:

• Daily – The scheduled function will be executed every day at a specific time.

• Weekly – The scheduled function will be executed on a day of the week at a specific time.

• Periodic – The scheduled function will be executed at a defined time interval.

At the time configured in the system, the Scheduler will deliver a command message to the TIE BI SmartStart processing service, requesting the execution of the desired function.

The functions to be executed are specified by setting the message subject to a specific value.

When scheduling a communication session, you may also specify additional information, such as the direction of communication (in the Command field) and the modules to be initiated during the scheduled session.

Once you’ve selected the Configuration tab at the top of the screen, you must click on the Scheduling button within its menu.



The Configuration – Scheduling screen will then be displayed.

You may begin creating your schedules by clicking on the tab that corresponds to the schedule type. For example, if you wish to create a weekly schedule, click on the Weekly tab at the top, left-hand side of the screen.



5.6.1 Daily Scheduling Select the Daily tab to begin creating a list of daily schedules for your TIE BI SmartStart functions.

You may add a new daily schedule to the system by clicking the icon at the bottom of the grid, generating the Daily Schedule pop-up screen.



In the fields provided, you may configure the daily schedule you are adding to the system.


Name Enter a unique name for the daily schedule you are adding to the database.

Description Enter a description for the daily schedule you are adding to the database.

Time to run Enter the precise time of each day, in hh:mm format, at which the scheduled function is to be initiated.

Schedule is active Check this box to activate the daily schedule within the TIE BI SmartStart system. Valid values include:

• Checked – The daily schedule has been activated within the system.

• Unchecked – The daily schedule is deactivated within the system.

Message Subject Select from the drop-down list box the subject of the message associated with the daily schedule you are creating. Valid values include:

• Archive messages – The scheduled operation is to archive the history of internal messages.

• Archive documents – The scheduled operation is to archive documents.

• Start communication – The scheduled operation is to start a communication session.

Command When scheduling a communication session, you may determine the direction of the communication by selecting from the drop-down list box the command code used for launching the scheduled function. Valid values include:

• Send Only – The scheduled communication is strictly to send documents.

• Receive Only – The scheduled communication session is strictly to receive documents.

• Send and receive – The scheduled communication session is to both send and receive documents.

Communication Modules to Activate

When scheduling a communication session, you may check the box beside each communication module being utilized. This section will display a list of communication modules installed on the system.



When finished, you may click one of the following buttons in order to perform its respective function.

Button Description

Click this button to save the daily schedule you are adding to the database.

Click this button to remove any new data you have added to the daily schedule.

Click this button to delete the schedule from the database.



5.6.2 Weekly Scheduling Select the Weekly tab to begin creating a list of weekly schedules for your SmartStart functions.

A weekly schedule determines the precise day and time of the week in which the desired function is to be initiated.

You may add a new weekly schedule to the system by clicking the icon at the bottom of the grid, generating the Weekly Schedule pop-up screen.



In the fields provided, you may configure the weekly schedule you are adding to the system.


Name Enter a unique name for the weekly schedule you are adding to the database.

Description Enter a description for the weekly schedule you are adding to the database.

Day Select from the drop-down list box the day of the week in which the communication session is to be initiated.

Time to run Enter the precise time of day, in hh:mm format, at which the communication session is to be initiated.

Enabled Check this box to activate the weekly schedule within the TIE BI SmartStart system. Valid values include:

• Checked – The weekly schedule has been enabled within the system.

• Unchecked – The weekly schedule has been disabled within the system.

Message Subject Select from the drop-down list box the subject of the message associated with the weekly schedule you are creating. Valid values include:

• Archive messages – The scheduled operation is to archive messages.



Command Select from the drop-down list box the command code used for launching the weekly schedule. Valid values include:

• Send Only – The scheduled operation is strictly to send documents.

• Receive Only – The scheduled operation is strictly to receive documents.

• Send and receive – The scheduled operation is to both send and receive documents.




Button Description

Click this button to save the weekly schedule you are adding to the database.

Click this button to remove any new data you have added to the weekly schedule.



5.6.3 Periodic Scheduling Select the Periodic tab to begin creating a list of periodic schedules for your TIE BI SmartStart functions.

A periodic schedule allows you to determine the execution of the desired function at specific intervals of times. For instance, you can configure a periodic schedule to initiate a communication session every 30 minutes.

You may add a new periodic schedule to the system by clicking the icon at the bottom of the grid, generating the Interval Schedule pop-up screen.



In the fields provided, you may configure the periodic schedule you are adding to the system.


Name Enter a unique name for the periodic schedule you are adding to the database.

Description Enter a description for the periodic schedule you are adding to the database.

Interval Enter the interval, in hh:mm format, between communication sessions.

Enabled Check this box to activate the periodic schedule within the TIE BI SmartStart system. Valid values include:

• Checked – The periodic schedule has been activated within the system.

• Unchecked – The periodic schedule is deactivated within the system.

Message Subject Select from the drop-down list box the subject of the message associated with the periodic schedule you are creating. Valid values include:

• Archive messages – The scheduled operation is to archive messages.



Command Select from the drop-down list box the command code used for launching the periodic schedule. Valid values include:

• Send Only – The scheduled operation is strictly to send documents.

• Receive Only – The scheduled operation is strictly to receive documents.

• Send and receive – The scheduled operation is to both send and receive documents.

Communication Modules to Activate

From this window, check the box beside each communication module you wish to activate when the communication session has been started.

This field is only enabled for schedules in which Start communication is selected in the Message Subject field.




Button Description

Click this button to save the periodic schedule you are adding to the database.

Click this button to remove any new data you have added to the periodic schedule.

Click this button to delete the schedule from the database.



5.6.4 Modifying Schedules You may modify any existing schedule within the TIE BI SmartStart database by navigating to its respective tab.

In the grid, click the schedule you wish to modify, generating its respective pop-up screen.

When finished performing the necessary modifications, click to store your changes.



5.7 Service Control Various configuration settings that you have established will not be active until the TIE BI SmartStart service has been restarted.

It is recommended that you perform configuration modifications in “batch" before proceeding to restart the service. Hence, the Service Control feature allows you to manage the status of the processing service.

From the Configuration tab, you’ll notice the Service Control menu in the toolbar at the top of the screen, consisting of three buttons.

Click the appropriate button for the function you wish to initiate.


Start Service Instructs your system to start the TIE BI SmartStart Windows service.

Stop Service Instructs your system to stop the TIE BI SmartStart Windows service.

Restart Service Instructs your system to restart the TIE BI SmartStart Windows service.

It is important to click this button when you have performed additions/changes to the data on the remaining Configuration screens. Once the Restart Service button has been selected, the TIE BI SmartStart Windows service will be initiated with your designated changes.



Once you have selected the appropriate Service Control option, a status bar will indicate that the process is underway.

When the process has completed, you may click OK to return to the current Configuration screen.

However, in the event that the process was unsuccessful, you may be required to contact the TIE Kinetix Support Department. In these cases, you may continue to operate TIE BI SmartStart, but your current communication session may fail.



5.8 Application Settings The TIE BI SmartStart system also allows you to configure your application settings for meeting specific parameters.

This feature allows you to determine localization settings, recipients for system notifications, server settings for outgoing emails, and archived configurations.

Once you’ve selected the Configuration tab at the top of the screen, you must click the Application Settings button within its menu.

A pop-up screen will then appear, containing five tabs:

• General – Allows you to configure basic parameters associated with your system.

• Notifications – Allows you to determine the specific parties receiving important notifications.

• Outgoing Email – Allows you to determine the server settings through which outgoing email is sent.

• Licensing Info – Displays data pertaining to your TIE BI SmartStart licensing agreement.

• Archiving – Allows you to determine the parameters for document and message archiving.



5.8.1 General Settings When the Application Settings pop-up window is displayed, it automatically defaults to its General tab, allowing you to specify basic application configuration data.



Number of sessions to display

Enter the number of recent sessions you would like to be reflected throughout the system. For example, the Home page will reflect statistics from the number of sessions entered in this field.

Language Select the language to be applied to the User Interface (if available).

Locale You may select a different language in the drop-down list box to determine the manner in which numbers, dates, and times will appear on the User Interface. Such changes will only take effect once the application has been restarted.

When finished, click to store your settings.

You may also click to remove the pop-up window.



5.8.2 Notifications Settings The Notifications tab of the pop-up window allows you to determine specific recipients of important system notifications.

At the top of the pop-up window, click on the Notifications tab to access its respective fields.



From Enter the email address being used as “reply to” value when sending system notifications.

To Enter the email address of the recipient of the system notifications. This typically consists of the email address of the system administrator.

CC Enter the address of the party you wish to receive an exact copy of the system notifications.





5.8.3 Outgoing Email Settings The Outgoing Email tab of the pop-up window allows you to configure the server settings through which outgoing email is sent by the TIE BI SmartStart system.

At the top of the pop-up window, click on the Outgoing Email tab to access its respective fields.


SMTP Server Enter the name or IP address of the SMTP server through which outgoing emails are sent.

Port Enter the number of the port on which the SMTP server is running. (The default/standard port number is 25.)

Username Enter the username being used for connecting to the SMTP server.

If the SMTP server is not configured to request authentication, you may leave this field empty.

Password Enter the password being used for connecting to the SMTP server.

If the SMTP server is not configured to request authentication, you may leave this field empty.





5.8.4 Licensing Info The Licensing Info tab allows you to view information pertaining to your TIE BI SmartStart licensing agreement.

At the top of the pop-up window, click on the Licensing Info tab to access its respective fields.


Serial number Displays the serial number that appears on your TIE BI SmartStart license.

Status Displays the status of your TIE BI SmartStart system.

When installing TIE BI SmartStart, you will be granted a temporary license that will permit you to use the system until a permanent license can be requested and obtained. During the interim, the license status will reflect “Installed,” which will prohibit you from performing support requests.

Once the permanent license is granted, the status will reflect “Licensed.”

Expires Displays the date in which your TIE BI SmartStart license is due to expire.

Licensed to Displays the party to which the TIE BI SmartStart system is licensed.

Customer number Displays the code you received when the license was registered in the system.

Helpdesk Name Displays the name of the helpdesk associated with your TIE BI SmartStart license.




Helpdesk Email Displays the email address to which the TIE BI SmartStart system delivers support request emails generated by the “Get Support” wizard.

Note that this email address is typically connected to an automated system generating support incidents in TIE’s internal system. Please do not send emails to this address. The only emails to be processed are the ones sent by the system.





5.8.5 Archiving The Archiving tab allows you to determine the number of days that must expire before documents and internal messages must remain in the system before delivered to the archive database, and subsequently, how long they will remain archived before permanently deleted.

At the top of the pop-up, click on the Archiving tab to access its respective fields.


Days until documents are archived

Enter the number of days that documents must remain in the system database before being moved to the archive database.

Days until documents are deleted from archive

Enter the number of days documents must remain in the archive before being permanently deleted from the system.

Days until messages are archived

Enter the number of days that internal messages must remain in the system database before being moved to the archive database.

Days until messages are archived

Enter the number of days internal messages must remain in the archive before being permanently deleted from the system.

You may click to store your settings.




6.0 TIE BI SmartStart Documents Once you have begun utilizing TIE BI SmartStart for sending and receiving documents, you may review transaction details through the system’s Documents functionality.

The feature contains a summary of both incoming and outgoing documents, including items that are archived, invalid, active, or considered dead letters.

For each document that appears in the database, TIE BI SmartStart displays an abundance of detailed history information, including:

• Status of the document

• Document content data

• Sender and recipient data

• Time of processing

• Error messages (if any)



6.1 Reviewing Documents In order to access the Documents functionality on TIE BI SmartStart, you must select the Documents tab at the top of the screen.

The system will then default to the Documents – Inbox screen, which displays a list of all incoming document.



6.1.1 Documents Screen Selections In the Documents toolbar at the top of the screen, the Documents Group allows you to select a specific database of documents you wish to review.

Menu Option Description

Inbox Click this button to access the Documents – Inbox screen, where you can review your incoming documents.

Outbox Click this button to access the Documents – Outbox screen, where you can review your outgoing documents.

Dead Letter Queue Click this button to access the Documents – Dead Letter Queue screen, where you can review all documents placed in the DLQ, which occurs when a document cannot be delivered to its intended recipient.

Invalid Doc. Queue Click this button to access the Documents – Invalid Doc. Queue screen, where you can review all documents placed that have been linked to processing errors.

All Documents Click this button to access the entire inventory of existing documents within the database. The documents that were moved to the archive do not appear in this list. Therefore, you must select the Archived Documents option to access these documents.

Active Documents Click this button the access the Documents – Active Documents screen, where you can review all documents that are currently active within the TIE BI SmartStart system. These include documents that remain in processing or are due to be grouped or delivered.

Archived Documents

Click this button access the Documents – Archived Documents screen, where you can review all documents that have been previously processed and moved into the archive.



Once you have selected an option from the toolbar menu, the Documents screen will display the respective list of items.

Note that the seven Document screens are identical in appearance, with the exception of the All Documents and Archived Documents screens. These screens contain an addition column to indicate whether or not a document is currently in a state of error.


In/Out Indicates whether the item is an incoming or outgoing document. Valid values include:

• In – The item is an incoming document.

• Out – The item is an outgoing document.

Id Indicates the ID number of the document.

Format Indicates the document format (i.e. EDIFACT, XML).

Type Indicates the document type (i.e. INVOICE, Order).

Date created Indicates the date and time in which the document was created.

Date processed Indicates the date and time in which the document was processed.




Sender Indicates the name of the party sending the document.

Recipient Indicates the name of the party receiving the document.

Status Indicates the current status, or phase, of the specified document. For example, it the document is in the process of being analyzed, this field will display “Analyze.”


Comm. Module Indicates the name of the TIE BI SmartStart communication module associated with the document.

6.1.2 Filtering Documents In the top, right-hand corner of each Documents screen, you may filter documents according to when they were processed by the system.

Select from the Filter drop-down list box the time period of the documents you wish to display on the Documents screen.

Once a selection has been made, the results will automatically appear on the Documents screen.



6.1.3 Searching Documents In the top, right-hand corner of each Documents screen, you may search for specific documents from the existing database.

You may click the icon to access the Search dialog.

In the fields provided, enter the criteria for the documents you wish to search.


Doc. ID Enter the ID number of the document(s) you wish to search.

Subject Enter the subject of the document(s) you wish to search.

Sender Select from the drop-down list box the name of the sender associated with the document(s) you are searching.

Recipient Select from the drop-down list box the name of the recipient associated with the document(s) you are searching.

Format Select from the drop-down list box the format of the document(s) you wish to search (i.e. XML, EDIFACT).

Type Enter the type of document(s) (i.e. INVOIC, ORDERS) you are searching.




Subtype Enter the subtype of the document(s) you are searching.

Start Date Enter the start date associated with the document(s) you are searching.

End Date Enter the end date associated with the document(s) you are searching.

Period Enter the period (“last 12 days”) associated with the document(s) you are searching.

You may click the Advanced button to expand the dialog and display additional fields for which you may base your search criteria.



In the fields provided, enter the additional criteria for which to conduct your search.


Sending Com. Module

Select from the drop-down list box the communication module responsible for sending the document(s) you wish to search.

Receiving Com. Module

Select from the drop-down list box the communication module receiving the document(s) you wish to search..

In Error Select whether or not you wish to include in your search documents that are of the “in error” status. Value values include:

• Checked – Include in the search only the documents that have been placed in error.

• Unchecked – Include all documents in the search, regardless of whether or not they have been placed in error.

Encrypted Select whether or not you wish to include in your search documents that are encrypted. Value values include:

• Checked – Include in the search only the documents that have been encrypted.

• Unchecked – Include all documents in the search, regardless of whether or not they have been encrypted.

Signed Select whether or not you wish to include in your search documents that are signed. Value values include:

• Checked – Include in the search only the documents that have been signed.

• Unchecked – Include all documents in the search, regardless of whether or not they have been signed.

When you are finished entering the search criteria, click to begin your document search.

You may also click to remove all data from the search criteria fields.



6.1.4 Document Details Once you’ve navigated to the appropriate Documents screen, you may click on any of the documents appearing in the grid.

The Document Details pop-up window will then appear, displaying specific document details. You may also reprocess the document depending upon its current stage.



You may review also click to expand the screen.


Document Id Indicates the internal ID of the document.

Document Format Indicates the format (i.e. XML, EDIFACT, INHOUSE) of the document.

Document Type Indicates the type of the document (i.e. DESADV).

Document Subtype Indicates the subtype of the document (i.e. D96A).

Encrypted Indicates whether or not the document is encrypted for security purposes. Valid values include:

• Checked – The document is encrypted for security purposes.

• Unchecked –The document is not encrypted.




Signed Indicates whether or not the document has been signed with a digital certificate. Valid values include:

• Checked – The document is signed.

• Unchecked –The document is not signed.


Sender Address Indicates the address of the party sending the document, as retrieved by the communication module (if available).

Recipient Address Indicates the email address of the party receiving the document, as retrieved by the communication module (if available).

Sender Comm Module

Indicates the name of the communication module through which the sender delivered the document.

Receive Comm Module

Indicates the name of the communication module through which the recipient received the document.

Moment Entered Indicates the date and time in which the document was created in the system.

Moment Processed Indicates the date and time in which the document was processed by the system.

Error Description Indicates a description of the error encountered within the system (if the document remains in an error state).



At the bottom of the pop-up window, you’ll notice a table of Document History records associated with the specified document. Each entry appearing in the table represents a status or stage through which the document passed during processing.

Each record appears in the table with the following fields:


Id Indicates the internal ID associated with the specified document status.

Moment Entered Indicates the date and time in which the document entered the status corresponding to the list entry.

Moment Processed Indicates the date and time in which the document being processed determined the status corresponding to the list entry.

Status Indicates the name of the document processing stage (i.e. Received, Analyze, CopyContent, etc.).

SubStatus Indicates the sub-status of the document’s processing status (i.e. InProcess, Processed, Error).



You may click on an item in the table to generate the Document Status pop-up window, which displays details regarding the selected document status. These details include the content of the document within the processing stage that corresponds to the selected document status.

This pop-up window displays information relating to the document’s status.


Id Indicates the internal ID of the document status record.

Status Indicates the name of the document processing stage (i.e. Received, Analyze, CopyContent, etc.)

Substatus Indicates the sub-status of the document’s processing status (i.e. InProcess, Processed, Error).

Moment Entered Indicates the date and time in which the document entered the status corresponding to the list entry.

Moment Processed Indicates the date and time in when the document being processed determined the status corresponding to the list entry.

Error Type Indicates the type of error, if any, the document has encountered during the processing stage corresponding to the selected document status.




Error Message Indicates the error message in the event an error occurs within the selected document status.

At the bottom of the pop-up window, you’ll notice a table of Document Contents records associated with the specified document. Note that a document may contain multiple associated content files.

Each Document Contents record appears in the table with the following fields:


File Name Indicates the file name of the document.

Transm. Key Indicates the transmission key for the document file as received by the communication module from the VAN (when available).

Content Type Indicates the type of content associated with the document file (which, when possible, will be detected by the communication module).

SubStatus Indicates the sub-status of the document file.

Error Type Indicates the type of error, if any, the document file has encountered during processing.

Error Code Indicates the code of the error associated with the document’s file.



Click on an item in the table to generate the Document Content pop-up window, which displays various details pertaining to the document content entry as well as the associated acknowledgements received from the VAN (if the VAN supports this functionality). The user may also view the content of the document file.

Each Document Contents record appears in the table with the following fields:


Original File Name Indicates the original file name of the document, as reported by the communication module.

File Path Indicates the path at which the document file is located.

Content Type Indicates the type of content associated with the document file (which, when possible, is to be detected by the communication module).

Transm. Key Indicates the transmission key for the document file, as received by the communication module from the VAN (when possible).




Size Indicates the size, in bytes, of the document file.

Error Type Indicates the type of error, if any, the document file has encountered during processing.

Error Code Indicates the code of the error associated with the document’s file.

Error Message Indicates the error message associated with the document file.

At the bottom of the pop-up window, you may also click to access the Content File Viewer, which displays the text of the file.



6.1.5 Reprocessing Documents TIE BI SmartStart will allow you to reprocess a document that has been categorized as “in error.” In these cases, the button will appear at the bottom of the Document Details screen.

With the functionality, the system can resume the reprocessing of the document at the previous stage in which it was successfully executed.

Note that such a stage implies that the document was placed in the internal message bus. Therefore, if an error occurs during the execution of a workflow activity, the document will be rolled back the state prior to the entire workflow process being initiated. In this situation, the workflow will be re-executed from its beginning stages.

Once you have clicked , the Document Details pop-up will be removed and the document will be reprocessed accordingly.



As part of the document reprocessing feature, you may perform the following functions:

• Re-receive document – You may click from the bottom of the Document Details pop-up on the Documents – Inbox screen in order to reprocess a document in the manner in which it was received. The document will then be passed through the various components of the system in order for you to re-receive the document.

• Resend document – You may click from the bottom of the Document Details pop-up on the Documents – Outbox screen in order to reprocess a document in the manner in which it was sent. In these cases, the document will be delivered once again to the Document Out Dispatcher module, which in turn assigns the recipient address to the document (based on the recipient ID). The document will then be placed into the Send queue, where it will be sent out during the next communication session that performs such functions.



7.0 Monitoring TIE BI SmartStart The TIE BI SmartStart system allows you to monitor an overview of transactions being conducted through your communication sessions.

With these features, the system allows you to perform the following functions:

• View system logs

• Monitor the progress of internal messages

• Monitor system workflows

In order to access the Monitoring functionality on TIE BI SmartStart, you must select the Monitoring tab at the top of the screen.



7.1 Viewing System Logs The Monitoring functionality on TIE BI SmartStart allows you to view logs of the activity from previous communication sessions.

This feature allows you to view data for communication logs, component logs, system logs, and file names.

Once you’ve selected the Configuration tab at the top of the screen, you must click the View Logs button within its menu.

The Monitoring - View Logs screen will then be generated, displaying its four sections:

• Communication Logs

• Component Logs

• System Logs

• File Name



The Communication Logs section displays a series of logs generated by the communication modules during various communication sessions.


Creator Indicates the name of the communication module that created the log.

FileName Indicates the name of the file containing the log.

Creation Time Indicates the date and time the log was created.

Selecting an entry in the grid will display its corresponding log in the File Content section at the right side of the screen.



In most cases, a content tab will appear for each communication log or internal file.

The Component Logs section displays various data associated with your components’ activity.


Creator Indicates the name of the component that created the log.


Creation Time Indicates the date and time in which the component log was created.

Selecting one of the entries in the Component Logs table will display the content of the log in its File Content section.



The System Logs section displays a series of logs generated by the TIE BI SmartStart engine and System Management Console.


Creator This column will always contain the value “SYSTEM”.


Creation Time Indicates the date and time in which the system log was created.



Selecting one of the entries in the System Logs table will display its respective content in the File Content section.

Once you’ve selected an existing system log file, its contents will appear in the File Name pane to the right.



7.2 Monitoring Internal Messages The TIE BI SmartStart system allows you to monitor the internal messages associated with the stages through which a document is being processed. This functionality allows you to track the progress of each function within the TIE BI SmartStart system as a document progresses through the various system components.

You may view the current list of system internal messages by selecting the Internal Messages button in the Logs Group menu.

The Monitoring - Messages screen will then be generated, displaying a list of existing internal messages from your recent communication sessions which have yet to be archived.

Each message appears in the grid with its respective information.


ID Indicates the internal ID used to identify the message.

Date created Indicates the date and time in which the message was created.




Creator Indicates the name of the component that created the message.

Subject Indicates the subject of the message. Based on the message subject, the bus controller will direct the message to various system components for further processing.

Status Indicates the status (i.e. “InProcess”, “Processed”) of the message.

Error Code Indicates the code of the error that the message has encountered.

Error Indicates a description of the error that the message has encountered.

You may click on a message in the grid to generate the Message Details pop-up screen.



The Message Details pop-up dialog displays additional details for the message you selected, allowing you to view details pertaining to the associated document (if available).


ID Indicates the code used to identify the internal message.

Bus Id Indicates the ID of system’s bus (Command Bus or Message Bus) through which the message has been transmitted.

Status Indicates the status (i.e. “InProcess”, “Processed”) of the message.

Subject Indicates the subject of the message. Based on the message subject, the bus controller will direct the message to various system components for further processing.

Created by Indicates the name of the component that created the message.

Created at Indicates the date and time in which the internal message was created.

Expires at Indicates the date and time in which the internal message is due to expire. Once a message expires, it is transported to the Invalid Message Queue (IMQ).




Retries Indicates the number of attempts in which the system has tried to process the message.

Max Retries Indicates the maximum number of attempts in which the system is allowed to process the message before placing it in the Invalid Message Queue (IMQ).

Error Code Indicates the code used for indentifying the error that the message has encountered.

Error Message Indicates a description of the error that the message has encountered.

You may click to view the details associated with the internal message.

This functionality includes the same detail screens described in the previous chapter, TIE BI SmartStart Documents.



7.3 Monitoring Workflows The TIE BI SmartStart system allows you to view the existing workflows that were executed by the system while processing documents. Each workflow may be graphically viewed by the administrator to indicate where a process was interrupted or is currently waiting for an execution to complete.

You may view the current activity of system workflows by selecting the Workflow Monitor button in the Logs Group menu.

The Monitoring – Workflow Monitor screen will then be generated, displaying in the left-hand panel that list of workflows that were executed.

Each workflow in the grid displays the following data.


Workflow Displays the name of the workflow.




Status Indicates the current status of the workflow. Valid values include:

• Completed – Indicates the workflow has been successfully executed.

• Running – Indicates that either the workflow remains in execution or that it has returned an error. You may find additional details in the Events column once the workflow is selected.

When you select a workflow from the grid, the middle and right-hand panels will then be activated.



the screen’s middle panel, consisting of the Event and Activity columns, will display the events details as they were tracked while the workflow was being executed.

These details include the time the event occurred, the type of event, and the name of the workflow or activity that generated the event.

In some cases (as detailed below), the events for a workflow with a “Running” status may contain “Exception” or “Running” statuses. Such events indicate that the workflow terminated in error. In these cases, the previous state being indicated in the graph as executed is determined as the state generating the fatal error.



The right-hand pane will display the Sequential Workflow, which indicates the specific activities that were completed within the workflow.



Index

A

Addresses ......................................... 40

Architecture of TIE BI SmartStart .......... 6

C

Communication Modules ..................... 36

Communication Sessions ..................... 22

Communication Sessions (Initiating) ..... 34

Configuraing TIE BI SmartStart ............ 35

Current Queue State .......................... 27

D

Document Details ............................ 132

Documents ..................................... 119

Documents (Reviewing) .................... 120

Document Screen Selections .............. 121

Document Statistics ........................... 28

Document Structures .......................... 49

I

Inhouse Document Attributes .............. 54

M

Messages (Monitoring) ...................... 143

Message Headers and Payloads ............ 11

Messages Types ................................. 10

Monitoring (tab) .............................. 137

P

Processes ......................................... 93

S

Scenarios ......................................... 12

Schedules (Modifying) ...................... 109

Scheduling ....................................... 98

Scheduling (Daily) ............................ 100

Scheduling (Periodic) ........................ 106

Scheduling (Weekly) ......................... 103

Settings (General) ............................ 113

Settings (Licensing Info) ................... 116

Settings (Notifications) ..................... 114

Settings (Outgoing Email) ................. 115

System Requirements .......................... 4

System Statistics .............................. 21

T

Technical Support ............................. 30

V

Viewing System Logs ........................ 138

W

Workflows (Configuring) ..................... 56

Workflows (Monitoring) ..................... 147

X

XML Document Attributes ................... 51