Sequence Provider DELMIA Apriso 2018 Implementation Guide

Size: px

Start display at page:

Download "Sequence Provider DELMIA Apriso 2018 Implementation Guide"

Charity Fleming
5 years ago
Views:

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.

1 Sequence Provider DELMIA Apriso 2018 Implementation Guide 2017 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.

2 Sequence Provider DELMIA Apriso 2018 Implementation Guide 2 Contents 1 Introduction Purpose Scope Intended Audience Sequence Provider Overview 3 2 Configuration Sequence Provider Configuration Changing the Sequence Configuration 6 3 Administration Sequence Provider Administration Runtime 7 4 References 8 Figures Figure 1 Sequences browser 4 Figure 2 Sequence configuration details screen, General tab 6 Tables Table 1 Sequence Provider configuration data 6

3 Sequence Provider DELMIA Apriso 2018 Implementation Guide 3 1 Introduction 1.1 Purpose The purpose of this document is to specify how to configure and operate the Sequence Provider. The Sequence Provider is used as a central provider of Sequences to all DELMIA Apriso applications. 1.2 Scope The scope of this document describes two core areas: configuration of the Sequence Provider s Sequences and what needs to be done to run its host service. 1.3 Intended Audience This guide is intended for persons who administer DELMIA Apriso Sequence Provider and train on its usage in order to aid in the performance of a basic configuration. 1.4 Sequence Provider Overview The Sequence Provider is a Windows service that is used to provide sequenced values to the end user or an application within DELMIA Apriso. This is implemented as a Windows service so that there is only one application providing Sequences, regardless of their destination. This ensures maximum performance with no database locks.

Sequence Provider DELMIA Apriso 2018 Implementation Guide 4 2 Configuration This chapter describes how to set up the required configuration data for Sequence Provider. 2.1 Sequence Provider Configuration The first browser in Sequence Maintenance in the Portal shows a list of all of the valid Sequences within the system (see Figure 1).

4 Sequence Provider DELMIA Apriso 2018 Implementation Guide 4 2 Configuration This chapter describes how to set up the required configuration data for Sequence Provider. 2.1 Sequence Provider Configuration The first browser in Sequence Maintenance in the Portal shows a list of all of the valid Sequences within the system (see Figure 1). To edit a Sequence, simply double-click the row you want to edit, or select a row and press (Properties). Figure 1 Sequences browser Attribute Facility Name Prefix Next Description The Facility that the Sequence is defined for. If this value is not specified, then the Sequence is valid for all Facilities. The name of the Sequence. The prefix of the value returned. This value will be added to the beginning of the next value. The next value for the service to return. Note that this value will not always be what is returned by the provider if the CachedSize is greater than the one that is used.

5 Sequence Provider DELMIA Apriso 2018 Implementation Guide 5 Min Max Start Increment Suffix PaddedLength Format If the next value is not defined, then the minimum (Min) value is used as the first available value. Once the maximum (Max) value has been reached, then the Sequence will either be recycled (if so configured) or return an error. The value used when a Sequence is reset. This value should generally be the same as Min. The increment value between returned values. The suffix of the value returned. This value will be added to the end of the next value. This defines the length of the value returned minus the prefix and suffix. The value will be padded with 0 s until the padded length is met. When a format is not specified, the default format is [Prefix][Value][Suffix]. When the default format is not efficient, the user can customize the format of the Sequence value created by Sequence Provider by using the Format field. The format can consist of a static string with format parameters. The format parameter is embedded with a zero or more format items in the form of {index[,alignment][:formatstring]}, wherein: index A zero-based integer that indicates which element in a list of objects to format. If the object specified by the Index is a null reference, then the format item is replaced by an empty string ( ). alignment An optional integer indicating the minimum width of the region to contain the formatted value. If the length of the formatted value is less than the alignment, then the region is padded with spaces. If the alignment is negative, the formatted value is left justified in the region. If the alignment is positive, the formatted value is right justified. If the alignment is not specified, the length of the region is the length of the formatted value. A comma is required if the alignment is specified. formatstring An optional string of formatting codes. If the formatstring is not specified and the corresponding argument implements the IFormattable interface, then a null reference (Nothing) is used as the IFormattable.ToString format string. Therefore all implementations of the IFormattable.ToString are required to allow a null reference (Nothing) as a format string and return the default formatting of the object representation as a String. A colon is required if the formatstring is specified. For more information, please see Formatting Types in the.net Framework. The leading and trailing brace characters ( { and } ) are required. To specify a single literal brace character in format, specify two leading or trailing brace characters ("{{" or "}}"). There are five predefined format parameters in Sequence Provider that the user can use: 0 - Prefix

Sequence Provider DELMIA Apriso 2018 Implementation Guide 6 1 - Value 2 - Suffix 3 - Current local date time 4 - Current UTC date time Example: The following values are in a Sequence configuration

6 Sequence Provider DELMIA Apriso 2018 Implementation Guide Value 2 - Suffix 3 - Current local date time 4 - Current UTC date time Example: The following values are in a Sequence configuration record: Prefix: XML_ Value: 1 Suffix:.xml The current local date time: " :30:15". The current UTC date time: " :30:15". If the format is {0}{1}_{3:yyyyMMdd_HHmmss}{2}, then the return value will be XML_1_ _ xml If the format is {0}{1}_{4:yyyyMMdd_HHmmss}{2}, then the return value will be XML_1_ _ xml IsCycled CachedSize Determines if the Sequence will be re-cycled when the max value is hit. If the Sequence does not re-cycle and the max value is hit, then an error will occur. Determines if the Sequence is cached in memory to improve performance. Note, any caching greater than one will mean that you can lose values in your Sequence during a server failure Table 1 Sequence Provider configuration data 2.2 Changing the Sequence Configuration You may change any of the Sequence configurations within this screen. Simply change the required value and save the results. Selecting Close will prompt the user to save changes (if any were made). Figure 2 Sequence configuration details screen, General tab To have any change done to a Sequence reflected within the application, you must restart the service within which Sequence Provider is hosted. By default Sequence Provider is hosted within the following service: Apriso Framework Service.

7 Sequence Provider DELMIA Apriso 2018 Implementation Guide 7 3 Administration This chapter describes how to use the Implementation Guide as a system Administrator. 3.1 Sequence Provider Administration The Sequence Provider is nothing more than a Windows service that is automatically run on startup. As such there are small administrative tasks that should be done in order to ensure its health. Which Windows service the Sequence Provider is hosted within is defined using SequenceProviderServices key located in the ServicesLocations section of the Central Configuration file (for details, see Central Configuration Documentation). To ensure the valid behavior of the Sequence Provider, this configuration should always be set to REMOTING. This will ensure that the Sequences are guaranteed to be in sequence. The port number references the Windows service that the Sequence Provider is hosted within, and by default this will reference the Apriso Framework Service. 3.2 Runtime The main mechanism for invoking the Sequence Provider is the GetSequences Business Component. This BC is discussed in more detail within the Business Component documentation. All DELMIA Apriso applications and Business Components that request a new Sequence will invoke the Windows service via remoting to retrieve the next available Sequence.

8 Sequence Provider DELMIA Apriso 2018 Implementation Guide 8 4 References 1 Microsoft Developer Network, Formatting Types in the.net Framework 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). 1 Dassault Systèmes, Central Configuration Documentation This documentation describes in detail all the keys of the Central Configuration (CC) file for DELMIA Apriso. Various sections group the keys for individual modules or distinct functional areas.

Flat File Decoding DELMIA Apriso 2017 Technical Guide

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,