DocStarter - Creating a Guideline from EDI Data

DocStarter - Creating a Guideline from EDI Data
TIBCO Foresight® EDISIM®
DocStarter: Creating a Guideline from EDI Data
Software Release 6.15.0
July 2015
Two-Second Advantage®
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR
BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON
FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT
LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE
AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE
IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS
DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE
LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER
LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS
DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE
ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No
part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.
TIBCO, Two-Second Advantage, and TIBCO Foresight EDISIM are either registered trademarks or trademarks of TIBCO
Software Inc. in the United States and/or other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition (J2EE), and
all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation in the U.S. and other
countries.
All other product and company names and marks mentioned in this document are the property of their respective owners
and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING
SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE
README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM
PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE
PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW
EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE
PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY
OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY
RELEASE NOTES AND "READ ME" FILES.
Copyright © 2010-2015 TIBCO Software Inc. ALL RIGHTS RESERVED.
General Contact Information
TIBCO Software Inc., Foresight Group
655 Metro Place South
Suite 900
Dublin OH 43017
Phone: (614) 791-1600
Fax: (614) 791-1609
Technical Support
E-mail: [email protected]
Web: https://support.tibco.com
(Note: Entry to this site requires a username and password. If you do not have one, you can request one. You must have
a valid maintenance or support contract to use this site.)
Contents
Capabilities ................................................................................................................................................ 3
Two Versions of DocStarter....................................................................................................................... 3
Skills Required ........................................................................................................................................... 3
Input and Output ........................................................................................................................................ 4
DocStarter Steps ....................................................................................................................................... 4
Analyze the EDI File .................................................................................................................................. 5
Create a Collection File ............................................................................................................................. 6
Import the Collection into Standards Editor ............................................................................................... 8
Edit a DocStarter Guideline ....................................................................................................................... 9
Use the Guideline .................................................................................................................................... 10
DocStarter
1
7/28/2015
DocStarter
2
7/28/2015
Capabilities
Customized guidelines (also called MIGs in EDIFACT) are typically created with TIBCO Foresight®
EDISIM®’s Standards Editor using an existing guideline as a base. EDISIM® also provides the capability
to create a custom guideline from EDI data. This tool is called DocStarter.
A guideline created with DocStarter can be used with any EDISIM module, just as if you had created it
manually with Standards Editor. This includes:

printing formatted documentation

viewing guideline information on-screen

analyzing data

creating test data

using it with other Foresight products like TIBCO Foresight® Community Manager® or any of the
specialty HIPAA products.
Two Versions of DocStarter
EDISIM currently supports two versions of DocStarter:

DocStarter for X12, EDIFACT, and HL7, which uses the Validator component

Legacy DocStarter for X12 or EDIFACT, which uses the Analyzer component and will be deprecated
over time.
Both versions work the same way, but the resulting collection files are incompatible. You cannot add data
to a collection file using Validator if the collection file was originally created by Analyzer and vice-versa.
Skills Required
DocStarter requires that you:

use EDISIM’s Validator or Analyzer

perform simple operations in EDISIM’s Standards Editor.
DocStarter
3
7/28/2015
Input and Output
An EDI file can contain one or more transactions or messages. Within each file, you can use any or all
transactions or messages to build the guideline.
The resulting guideline will contain one or more transaction sets or messages, with segments, elements,
and codes that are customized to match the data in the EDI file.
850
EDI850
EDI850
EDI850
DocStarter
810 Guideline
in EDISIM DB
(Validator/Analyzer +
Standards Editor)
EDI
Use with any EDISIM
module (print guideline,
analyze EDI, create Test
Data, etc.)
Use with any other
TIBCO Foresight product
The guideline will be as complete and accurate as possible, based on the EDI data files. However, you
will probably want to refine it by editing it with Standards Editor, or by using DocStarter with more EDI files
as you get them.
Tips
The more data files you have, the better your guideline will be.
In general, you will want to use only error-free EDI data to create your guideline.
DocStarter Steps
To create a guideline from EDI data, you will use:

Validator or Analyzer - to check the data before using it.

Standards Editor - to import and modify the new guideline.

Document Builder or other EDISIM module - to use the guideline.
The steps are described in the next sections:
1. Analyze the EDI File .................................................................................................................. 5
2. Create a Collection File ............................................................................................................. 6
3. Import the Collection into Standards Editor ............................................................................... 8
4. Edit a DocStarter Guideline ...................................................................................................... 9
5. Use the Guideline ................................................................................................................... 10
DocStarter
4
7/28/2015
Analyze the EDI File
The first step in creating a guideline from EDI data is to analyze the file – usually against a published
standard.
1. From within Validator or Analyzer, choose File | Open and select the file that contains EDI data. Click
Open in the File Open dialog box.
2. From the Select Standard dialog box, choose a published X12, EDIFACT, or HL7 standard or an
industry guideline that ships with EDISIM. This will be the base standard for the guideline that you are
creating. Normally, this would be the standard specified within the EDI files. Select the check box for
Use for all Occurrences of xxxx.
3. Click OK to start the analysis.
4. When the analysis completes, view the diagnostics. If they appear to be what you want, create a
collection file as described below. Generally, you only want to use good EDI data to start a guideline.
DocStarter
5
7/28/2015
Create a Collection File
The next step in creating a guideline from EDI data is to create a collection file for import into Standards
Editor.
A collection consists of either:
One file (.COLX) when using Validator
or
Three files (.COL, .IDX, and .TXN) when using Analyzer.
You might wish to save them to EDISIM’s TEMP folder or another location where they will be easy to find
and delete.
1. Review the DocStarter collection options below. Validator DocStarter only supports the Entire Input
File option. If you are using Analyzer DocStarter and are using only part of the EDI file to create the
guideline, click on an appropriate segment in Analyzer’s bottom pane: interchange header, group
header, or transaction set or message header.
2. Choose File | DocStarter Collection.
3. From the DocStarter Collection dialog box, choose one of the options listed and click OK.
DocStarter
6
7/28/2015
Options
Entire Input File: Collect information from all interchanges. This is the default if you do not select a
specific interchange header, functional group header, or transaction set or message header segment.
Default: On.
Interchange: (Analyzer DocStarter only) Collect information from the current interchange only. You
must have clicked on a segment in that interchange in Analyzer's Segment pane. Default: Off.
Functional Group: (Analyzer DocStarter only) Collect information from the current functional
group, which can contain one or more transactions. You must have clicked on a segment in
that functional group in Analyzer's Segment pane. This option is faded if the currently
selected segment is not part of a functional group (for example, for EDIFACT files with no
UNG). Default: Off.
Transaction Set or Message: (Analyzer DocStarter only) Collect information from the current
transaction set or message. You must have clicked on a segment in that transaction set or
message in Analyzer's Segment pane. Default: Off.
4. Choose a file name and folder. To start a new collection, enter a filename with file type .col.
To add to an existing collection, select the SAME .COL/.COLX file and click Save. Data from this
analysis will be added to the existing file.
Note that:

Collection files are specific to the tool you are using (Validator or Analyzer). For example, you
cannot add to a collection file that was originally created by Analyzer DocStarter with new data
created by Validator DocStarter.

A collection can only have one guideline. You cannot mix guidelines within a collection file.
5. Wait until you see Collection Complete and then click Close.
Adding to your collection
It is to your advantage to collect from many data files. This gives EDISIM more data from which to build a
better guideline.
To add another file, repeat the process outlined above, analyzing other EDI files against the same
published standard, and adding the results to the same collection file.
Important: Be sure to add the results to the same .COL/.COLX file.
When finished collecting data from the EDI files, import the collection into Standards Editor.
DocStarter
7
7/28/2015
Import the Collection into Standards Editor
The next step in creating a guideline from EDI data is to import the collection into Standards Editor.
1. Open Standards Editor.
2. Choose File | Import | Import DocStarter File.
3. Locate and select the collection (.col/.colx) file created by Validator/Analyzer and click Open.
4. Choose the appropriate DocStarter options from the dialog box.
Validator DocStarter options:
Analyzer DocStarter options:
DocStarter
8
7/28/2015
Options
Guideline name (Required) (Analyzer DocStarter Only)
Overwrite existing guideline? (Analyzer DocStarter Only)
Retain Local CodeValues – When selected, any codes that are not recognized by the underlying
standard are stored as local codes in the transaction set or message. If this option is not selected,
such codes are ignored. Default: Off.
Mark Segments as Required if used everytime – When selected, DocStarter marks segments as
required if the EDI file always includes them. This is most useful if the COL/COLX file contains data
from many EDI files. Default: Off.
Mark Composites as Required if used everytime (Validator DocStarter Only) – When selected,
DocStarter marks composites required if the EDI file always includes them. This is most useful if the
COL/COLX file contains data from many EDI files. Default: Off.
Mark Elements as Required if used everytime – When selected, DocStarter marks elements
required if the EDI file always includes them. This is most useful if the COL/COLX file contains data
from many EDI files. Default: Off.
Remove Unused Transactions or Messages – When selected, DocStarter only includes
Transactions or Messages that it finds in the EDI data. We recommend selecting this option if you are
analyzing against a published standard. For example, if the EDI data contains a purchase order and
an invoice, and you compare to a published standard version that contains hundreds of documents,
only a purchase order and an invoice are included in the resulting guideline. Default: On.
5. Use File | Save As to save the new guideline.
6. Enter a standard name, make changes to the description if desired, choose your envelope options
from the Properties button, and click OK.
After importing, you can delete the COL/COLX, IDX, and TXT files unless you will be
acquiring more EDI files for the collection.
Edit a DocStarter Guideline
After you have created and saved a new guideline from EDI data, you may receive more EDI files that
can help you fine-tune the guideline. You can add to the original collection file, using the same published
standard for analysis, and then re-import it into Standards Editor, creating a new guideline. You can then
delete the first guideline, if desired.
If you no longer have the collection file, or if you have invested substantial time in modifying the guideline,
this may not be practical. In that case, you may wish to make a new collection and create a second
guideline, then use EDISIM’s Comparator component to merge the code sets and determine which
additional segments and elements have been used.
DocStarter
9
7/28/2015
Use the Guideline
Now that you have cleaned up the guideline, you can use it in any other EDISIM module, as well as with
other TIBCO Foresight products.
For example, to print a formatted document:
1. Open DocBuilder and choose File | Open Standard.
2. Choose the guideline that you created from the EDI data.
3. Select the transaction set/message and click “OK”.
4. After DocBuilder generates the documentation, you can print it.
For additional information see Fsdocbld.pdf, FSValidator, FSanalyz.pdf, and FSeditor.pdf located in
EDISIM’s Documentation directory.
DocStarter
10
7/28/2015
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement