0:06 Welcome to this Application Explainer video, part of our Data Adapters topic range.
0:10 In this video, we’ll cover the subject of export Adapters within SLM.
0:15 An export adapter for a software application is a specialized component or plugin that allows data to be extracted from the software in a specific format for using other applications or systems.
0:27 It acts as an intermediary that translates or converts internal data structures into a format suitable for export, ensuring compatibility with external systems or tools.
0:38 Additionally, the exported format may be designed to allow the data to be re imported back into the original system or another compatible system, enabling seamless data transfer and integration.
0:50 In SLM, these adapters are in the Adapters module under the Export Adapters section.
0:55 The following information will be covered in this training.
0:57 Chapter one will be Smart Export Adapter, Chapter 2 will be Export Templates, Chapter 3 will be Export Data, Chapter 4 will be exporting action items, Chapter 5 will be exporting reference tables, and Chapter 6 will be exporting instruments to SBI.
1:22 In Chapter 1, we’ll cover how to use all configurations for the Smart Export Adapter.
1:28 The Smart Export Adapter is used to extract data from SLM in Excel format with predefined headers.
1:35 Users can modify and add data to this file and then import it back into the system if needed.
1:41 Let’s review the parameters available when using the Smart Export Adapter.
1:46 The scope is a list of objects from the enterprise down to the unit, allowing users to choose the scope for exporting data.
1:54 Here we have a selection of options.
1:57 Include Documents generates an Excel file with documents created under each object to be exported.
2:04 Include Checklists generates an Excel file for each type of checklist that are created for the objects to be exported.
2:13 Include Attachments.
2:14 This will include physical documents uploaded to the system related to the SLM objects.
2:22 Include empty Data types Creates an empty Excel file for type of objects with no data.
2:28 This file can also serve as an import template.
2:32 Include Action Items will generate an Excel file with the action items created for all the objects that are going to be exported.
2:41 Include relational Data.
2:42 The Include Relational Data option will export relational data, which is a non parent child relationship in an Excel format.
2:50 For example, it includes relationships between SIS and the SIF for a relational field such as related functions.
3:00 The export name allows users to set a custom name for the export file.
3:04 Otherwise, SLM will generate one automatically and the include file levels option will add a sequential number for each file to be exported, indicating the order in which the files can be re imported back into the system.
3:20 We’ll use the Atlanta site.
3:22 Let’s click on export task.
3:24 Then we can go to Export adapter tasks to check on the status of this task.
3:29 Once the task was finished, let’s go ahead and download the zip file.
3:35 If we now open that file, as we can see we have a specific excel file for each data type in the system that was exported.
3:46 Also we can notice the sequential numbering for each data type.
3:49 For example starting from 01 for the site and then after the site we have a cause conditional modifier.
3:57 So this numbering is used to import the data back into the system.
4:00 Also, if we open one of these files, we’re going to be able to see the specific formatting that SLM generates for each one of the exported files.
4:08 It’s going to be an Excel file with five rows, with the first one being a header.
4:13 The first row, the header, will be the type ID of the data that’s been exported.
4:17 In this scenario, that’s obviously the site.
4:21 The 2nd row will contain the label for each one of the fields for the data that’s been exported.
4:28 The third row will contain the field ID, and then on the 4th row under the object ID, it specifies the parent type for the current object.
4:36 In this scenario, for the site, the parent type will be Enterprise and the template data type.
4:42 As we can see, there’s only one site in this file, which is the one that we exported.
4:47 Additionally, we will find all the related relational data that has been exported.
4:52 For example, the reldat SIF file.
4:55 This is a SIF that is related through the Related functions field with the SIS in the system, and it contains the same format as any other exported Excel file.
5:05 We can also take a look at the checklists.
5:07 These are the checklists that were created under this scope.
5:09 There’s also files for Documents.
5:12 We can see that there’s two documents here.
5:14 They’re actually physical files.
5:16 So since we enabled the attached documents options, it’s going to download the physical files.
5:21 We can find those under the Files folder if we scroll to the top, and inside here we can see the two physical files.
5:30 In Chapter 2, we’ll cover how to export data type templates.
5:35 The Export Template Adapter allows users to download an Excel template designed for entering data in a format compatible with the SLM import Adapter, enabling the adapter to insert or update data in SLM.
5:47 For this tutorial, let’s proceed by downloading one of these templates.
5:51 Let’s filter for a SIF as the data type and then click on Queue Export Task.
5:58 Then we go to the Export Adapter tasks to check on the status.
6:03 Once completed, we can download the file.
6:10 As we can see, this is just going to be an empty file with a specific header structure for the user to enter data for the SIF.
6:17 The first row will specify the data type that we’re dealing with, and in this scenario it’s going to be a SIF.
6:23 The second row will be the label for each one of the fields.
6:25 The 3rd row will be the field ID, and under the 4th row in the Object ID column, we’re specifying the parent data type for the SIF.
6:34 So these templates are going to be used to populate data and use the SLM Import adapter to insert or update data in SLM.
6:44 In Chapter 3, we’ll cover how to export data from a single data type in SLM.
6:51 In order to use the Export data adapter, you just need to select the scope from where they’re going to export the data and the data type that they would like to export.
7:00 For this tutorial, let’s select all sites, all units, and the SIFT data type and click Queue Export Task.
7:09 Now we can go to the Export Adapter tasks to keep track of the status of our task.
7:14 After the task is processing, you can see the percentage that’s complete.
7:19 That task has now been completed so we can click on Download the file.
7:27 Let’s now open that file.
7:30 Now we can see the Excel file with the for row format where the 1st row is going to be the type ID field label field ID.
7:40 The 4th row identifies the data type parents for the SIF and we can see the information for the Sifts exported from the system and all of their fields.
7:53 In Chapter 4, we will cover how to export action items.
7:57 In order for users to download action items data from SLM, the Export Action Items adapter can be used.
8:03 Let’s go ahead and select what type of action item the user would like to download.
8:08 For this tutorial, let’s select standalone action items and click on Queue Export Task.
8:14 Then let’s go to the Export Adapter tasks to check on the status of the process.
8:20 Once the task is completed, let’s go ahead and download the file and we can see a list of all the standalone objects in the system that have been created with its respective data.
8:39 In Chapter 5, we’ll cover how to export reference tables.
8:43 In order to export the data from a reference table, users can use the Export Reference Adapter.
8:50 Then the user needs to select which reference table they would like to export.
8:59 Select the specific table, click on Queue Export task.
9:06 Then we can go to the export task adapters, check on the status of the task.
9:13 Once the task is completed, users can download the file, and this file will contain all the information inside the reference table, with the first row specifying each column of the table.
9:33 In Chapter 6, we’ll cover how to export functions in a format compatible for Smartplant instrumentation software.
9:41 In order to use the export instrument to SPI, users need to select the scope that goes from the enterprise all the way down to the units.
9:48 For this tutorial, let’s select the enterprise and the format in which the user would like the output of this file.
9:55 For this tutorial, let’s select Excel.
9:59 Click on Export.
10:00 Let’s now open this file.
10:02 This file will contain every single unit and input and output associated in a format that the Smart Plant instrumentation software will be able to use.
10:11 As you can see, we can see the plant name, area and unit.
10:16 Then we have the type functions, the function ID, the input and output ID, and the rest of the fields for the functions and inputs and outputs.
