Flat File Decoding DELMIA Apriso 2017 Technical Guide 2016 Dassault Systèmes. Apriso, 3DEXPERIENCE, the Compass logo and the 3DS logo, CATIA, SOLIDWORKS, ENOVIA, DELMIA, SIMULIA, GEOVIA, EXALEAD, 3D VIA, BIOVIA, NETVIBES, and 3DXCITE are commercial trademarks or registered trademarks of Dassault Systèmes or its subsidiaries in the U.S. and/or other countries. All other trademarks are owned by their respective owners. Use of any Dassault Systèmes or its subsidiaries trademarks is subject to their express written approval.
Flat File Decoding DELMIA Apriso 2017 Technical Guide 2 Contents 1 Introduction 3 1.1 Abstract 3 1.2 Product Overview 3 1.2.1 Sample Usage 3 1.3 Vocabulary 4 2 Flat File Decoding Maintenance Screen 5 2.1 Flat File Definition Browser 5 2.2 Flat File Definition and Entities Detail 6 2.2.1 Flat File Definition Detail Tab 6 2.2.2 Flat File Entity Tab 7 2.3 Flat File Entity and Fields Detail 8 2.3.1 Flat File Entity Detail Tab 8 2.3.2 Flat File Field Tab 10 2.4 Flat File Field and Field Translation Detail 10 3 Revision Status and Cascade Copy 13 3.1 Revision Status 13 3.2 Cascade Copy 13 4 References 15 Figures Figure 1 Flat File Definitions browser 5 Figure 2 Flat File Definition and Entities Detail screen Flat File Definition Detail tab 6 Figure 3 Flat File Definition and Entities Detail screen Flat File Entity tab 7 Figure 4 Flat File Entity and Fields Detail screen Flat File Entity Detail tab 8 Figure 5 Flat File Entity and Fields Detail screen Flat File Field tab 10 Figure 6 Flat File Field Detail tab with the Field Mask editor 11 Figure 7 Flat File Field Detail tab with the Flat File Field Translation grid 12 Figure 8 Status transitions diagram 13 Figure 9 Cascade Copy dialog (Flat File Definition example) 14
Flat File Decoding DELMIA Apriso 2017 Technical Guide 3 1 Introduction 1.1 Abstract This Technical Guide gives an overview of the Flat File Decoding, provides you with the background information you need to be able to use it, and describes how to carry out common tasks. This document is intended for people who administer and train on usage of DELMIA Apriso Flat File Decoding in order to perform basic procedures every day. The scope of the document includes the Flat File Decoding usage. 1.2 Product Overview The Flat File Decoding process is created for DELMIA Apriso to be able to decode external system Flat File Messages and extract the values required to process the DELMIA Apriso WIP Orders based on them. The most important property that must be decoded from a flat file is the ProductID. This is because the primary use for a Flat File Message is for Sequencing (as described in the Sequencing Technical Guide), in which the product is the primary item that needs to be sequenced. Other properties such as quantity, UOM, and dates may be required in different cases. Typically, a Flat File Definition describes a single file that can then be decoded into multiple entities. Each entity can have multiple field attributes. For example, the same flat file may be decoded for Carpet and Radio entities. Each Carpet entity can have multiple field properties such as color and thickness. In this case, there would be one definition for the flat file, then one entity record for Carpets and one for Radios with multiple field records describing these entities. 1.2.1 Sample Usage A message is received with 1020 characters. The message is decoded as follows: The first 20 characters are the serial number The next 5 characters are the Sequence number Characters 34 and 35 read BA, specifying that the Carpet color is black, which is decoded to a product ID A WIP Order is created for a black Carpet with the specified Sequence number Characters 30, 32, and 33 read LAX, specifying the model of the exhaust system to be used, which is also translated to a product ID A WIP Order is created for the correct model and Sequence number
Flat File Decoding DELMIA Apriso 2017 Technical Guide 4 1.3 Vocabulary Flat File Message a continuous text string that contains fields that are either separated by a specific delimiter or in a fixed length structure. These fields are to be used to identify the properties of the WIP Order in DELMIA Apriso.
Flat File Decoding DELMIA Apriso 2017 Technical Guide 5 2 Flat File Decoding Maintenance Screen The Flat File Decoding Monitoring and Maintenance screens are accessible in DELMIA Apriso Desktop Client. Flat File Decoding screens are a set of screens that navigate and drill down in the following way: Flat File Definition Flat File Entity Flat File Field Field Translation. These screens allow the user to create new and maintain existing Flat File Definitions. 2.1 Flat File Definition Browser The Flat File Definitions browser is the first of a series of screens that displays a list of all the Flat File Definitions currently in the system. On this screen, it is possible to add a new Flat File Definition, delete an existing one (but only if its revision status is not Active), view the properties of the flat file definitions, and create a duplicate Flat File Definition. The following commands are available: Command Add Delete Property Cascade Copy Figure 1 Flat File Definitions browser Icon Description Opens an empty Flat File Definition and Entities Detail screen where a new Flat File Definition can be added. Deletes the selected Flat File Definition if it is not in the Active status. Opens a Flat File Definition and Entities Detail screen for the selected record where the Flat File Definition can be modified and a child Flat File Entity can be maintained. Creates a new instance of a Flat File Definition and a related child Flat File Entity, Field, and Field Translation by copying from the selected Flat File Definition. When clicked, the Cascade Copy dialog is displayed, which allows the user to modify the basic target definition properties (Figure 9). For details of the Cascade Copy operation, see 3.2 Cascade Copy.
Flat File Decoding DELMIA Apriso 2017 Technical Guide 6 2.2 Flat File Definition and Entities Detail The Flat File Definition and Entities Detail screen displays the properties of the Flat File Definitions and all the child Flat File Entities from the user-selected Flat File Definition from the previous screen. There are two tabs on this screen: Flat File Definition Detail and Flat File Entity. 2.2.1 Flat File Definition Detail Tab On the Flat File Definition Detail tab, it is possible to modify the Flat File Definition properties and activate or cancel a Flat File Definition. Figure 2 Flat File Definition and Entities Detail screen Flat File Definition Detail tab The following actions can be performed on the Flat File Definition and Entities Detail screen: Command Activate Cancel Save Refresh Discard Close Icon Description Changes the revision status from Design in Progress to Active. Changes the revision status from Active to Cancelled. Saves and persists the changes for the Flat File Definition properties to the database. Reloads data from the database. Discards changes made to the screen and reloads data from the database. Closes the current screen and returns to the Flat File Definitions browser. The following properties are available on the tab: Property Flat File Definition ID Description The unique identifier of the Flat File Definition in the database.
Flat File Decoding DELMIA Apriso 2017 Technical Guide 7 Name Revision Revision Status Delimited Fixed Length Field Delimiter Line Length Line Count Description Sample Text Message Resource Partner Effective Date Discontinue Date The name of the Flat File Definition. The revision for the Flat File Definition name. The status of the current revision. Three statuses are available: Design in Progress Active Cancelled The status is advanced using the Activate and Cancel command buttons (as described in the previous table). For more details on Revision Status, refer to 3.1 Revision Status. Specifies that the message decoding is based on the delimiter character. This enables the Field Delimiter field (see below). Specifies that the message decoding is based on the substring lengths. This enables the Line Length and Line Count fields (see below). A character or a series of characters that splits the Flat File Message into substrings. The number of characters per line for a fixed length file. The total number of lines for a fixed length file. The text description of the Flat File Definition. The Flat File Message used for testing purposes. The internal resource linked to the definition. The partner that is sending or receiving messages for the definition. The date from which the definition is applicable. The date at which the definition ceases to be applicable. 2.2.2 Flat File Entity Tab On the Flat File Entity tab, the browser displays a list of all the Flat File Entities defined for the Flat File Definition properties that are viewed. It is possible to add a new Flat File Entity, delete an existing one (only if the revision status is not Active ), view the properties of a Flat File Entity, and create a Flat File Entity by duplicating an existing one. A Flat File Entity is intended for use by Process Authors to group and identify one or more field attributes that are to be extracted from a Flat File Message. For example, a single flat file may be decoded for Carpet entities and again for Radio entities. Each entity can have one or more field attributes such as product groups (e.g., Radio and Carpets), resources, partners, etc. Figure 3 Flat File Definition and Entities Detail screen Flat File Entity tab
Flat File Decoding DELMIA Apriso 2017 Technical Guide 8 The following commands are available: Command Add Delete Property Cascade Copy Icon Description Opens the Flat File Field and Field Translation Detail screen where a new Flat File Field can be added. Deletes the selected Flat File Entity if it is not in the Active status. Opens the Flat File Field and Field Translation Detail screen where the selected Flat File Entity can be modified and child Flat File Fields can be maintained. Creates a new instance of a Flat File Entity and a related child Flat File Field and Field Translation by copying the selected Flat File Entity. When clicked, the Cascade Copy dialog is displayed, enabling the modification of basic target entity properties (Figure 9). For more details on the Cascade Copy Operation, see 3.2 Cascade Copy. 2.3 Flat File Entity and Fields Detail The Flat File Entity and Fields Detail screen displays the properties as well as all the child Flat File Fields of the Flat File Entity selected from the previous screen. There are two tabs on this screen: Flat File Entity Detail and Flat File Field. 2.3.1 Flat File Entity Detail Tab On the Flat File Entity Detail tab, it is possible to modify Flat File Entity properties as well as activate and cancel a Flat File Entity. Figure 4 Flat File Entity and Fields Detail screen Flat File Entity Detail tab The following actions can be performed on the Flat File Entity and Fields Detail screen:
Flat File Decoding DELMIA Apriso 2017 Technical Guide 9 Command Activate Cancel Save Refresh Discard Close Icon Description Changes the revision status from Design in Progress to Active. Changes the revision status from Active to Cancelled. Saves and persists the changes in the Flat File Entity properties to the database. Reloads the data from the database. Discards the changes made to the screen and reloads the data from the database. Closes the current screen and returns to the Flat File Definition browser screen. The following properties are available on the tab: Property Description Flat File Definition ID These fields are properties of the parent Flat File Definition and are Definition Name described in 2.2.1 Flat File Definition Detail Tab. Definition Revision Definition Revision Status Flat File Entity ID The unique identifier of the Flat File Entity in the database. Name The name of the Flat File Entity. Revision The revision for the Flat File Entity name. Revision Status The status of the current revision. Three statuses are available: Design in Progress Active Cancelled The status is advanced using the Activate and Cancel command buttons (as described in the previous table). For more details on Revision Status, refer to 3.1 Revision Status. Description The text description of the Flat File Entity. Group Description The text description for the group. Group An internal group represented in the combination of Group, Group Group Type Type, and Group Class ID. Group Class ID Partner The partner sending or receiving messages for the entity. Resource The internal resource responsible or otherwise linked to the entity. Facility The Facility sending or receiving messages for the entity. Warehouse The Warehouse sending or receiving messages for the entity. Effective Date The date from which the entity is applicable. Discontinue Date The date at which the entity ceases to be applicable.
Flat File Decoding DELMIA Apriso 2017 Technical Guide 10 2.3.2 Flat File Field Tab On Flat File Field tab, the browser displays a list of all the Flat File Fields defined for the Flat File Entity selected on the previous screen. On this screen, it is possible to add a new Flat File Field, delete an existing Flat File Field, and view or edit the properties of the selected Flat File Field. A Flat File Field is a field that can be decoded for a specific Flat File Entity in a message file such as a product number field. The following commands are available: Command Add Delete Property Figure 5 Flat File Entity and Fields Detail screen Flat File Field tab Icon Description Opens the Flat File Field and Field Translation Detail screen where a new Flat File Field and new Field Translations can be added. Deletes the selected Flat File Field if the parent Flat File Entity is not Active. Opens the Flat File Field and Field Translation Detail screen where the selected Flat File Field and Field Translations can be maintained. 2.4 Flat File Field and Field Translation Detail The Flat File Field and Field Translation Detail screen displays Flat File Field properties and all the Flat File Field Translations from the Flat File Field selected from the previous screen. The following properties are available on the tab: Property Description Flat File Definition ID These fields are properties of the parent Flat File Definition and are described in 2.2.1 Flat File Definition Detail Tab. Definition Name Definition Revision Definition Revision Status Flat File Entity ID Entity Name Entity Revision Entity Revision Status These fields are properties of the parent Flat File Definition and are described in 2.3.1 Flat File Entity Detail Tab.
Flat File Decoding DELMIA Apriso 2017 Technical Guide 11 Flat File Field ID Name Description Field Number Is Translated Field Mask Editor Flat File Fields Translation The unique identifier of the Flat File Field in the database. The name of the Flat File Field. The text description of the Flat File Field. This is enabled when the Flat File Definition parent of the Flat File Field is Delimited (for details, see 2.2.1 Flat File Definition Detail Tab). It allows for a 0-based position of the decoded value. Enables translations to be done for the Flat File Field. Translations are defined in the Flat File Fields Translation section (described below). This section is enabled when the Flat File Definition parent to the Flat File Field is of Fixed Length. The Field Mask Editor displays a grid with the dimensions of Line Length and Line Count defined in the parent Flat File Definition (see 2.2.1 Flat File Definition Detail Tab).It allows for selecting a position of the mask that will be used to retrieve the decoded value (see Figure 6). This section is enabled when the Is Translated check box is selected (as described above). It allows Field Translations for the Flat File Field (see Figure 7). Figure 6 Flat File Field Detail tab with the Field Mask editor
Flat File Decoding DELMIA Apriso 2017 Technical Guide 12 Figure 7 Flat File Field Detail tab with the Flat File Field Translation grid
Flat File Decoding DELMIA Apriso 2017 Technical Guide 13 3 Revision Status and Cascade Copy 3.1 Revision Status Flat File Definitions and Flat File Entities are revision-controlled. Figure 8 shows the revision status change cycle. The valid statuses are Design in Progress, Active, and Cancel. The status can be changed from Design in Progress to Active and then to Cancel. Please note that once the revision is in the Active status, it cannot be changed back to Design in Progress. In order to make modifications, it is necessary to cancel the current revision of the Flat File Definition or Flat File Entity and cascade copy it by creating a new revision which will be defaulted to the Design in Progress status. The cascade copy is done as described in 3.2 Cascade Copy. Figure 8 Status transitions diagram 3.2 Cascade Copy The Cascade Copy dialog (Figure 9) is displayed to collect user information before performing a cascade copy operation. The Copy Source section displays the selected Flat File Definition/Entity name, revision, effective date, and discontinue date. The Copy Target section allows for entering new a Flat File Definition/Entity name, revision, and effective and discontinue dates (which are optional). The Continue button proceeds with the Cascade Copy operation while Cancel exits the screen without performing any changes. Performing a cascade copy operation is the only way to return from the Active or Cancelled revision statuses back to Design in Progress (as described in 3.1 Revision Status).
Flat File Decoding DELMIA Apriso 2017 Technical Guide 14 Use of the Cascade Copy dialog is similar for a Flat File Definition and Flat File Entity. The fields are described respectively in 2.2.1 Flat File Definition Detail Tab and 2.3.1 Flat File Entity Detail Tab. Figure 9 Cascade Copy dialog (Flat File Definition example)
Flat File Decoding DELMIA Apriso 2017 Technical Guide 15 4 References The document referenced below is available from the DELMIA Apriso Start page, which can be accessed on your DELMIA Apriso server (<server name>/apriso/start). The newest version of the document is available from the 3DS Support. 1 Dassault Systèmes, Sequencing Technical Guide This document gives an overview of DELMIA Apriso Sequencing and provides the background information need in order to effectively configure and use the functionality.