Integrate peripheral devices with AVEVA Mobile Operator

Integrating peripheral devices with AVEVA Mobile Operator enables you to use the peripheral devices, based on their search and input capabilities, while creating procedures in the Management Center. For information on creating procedures, see the the AVEVA Management Center User’s Guide.

To integrate a peripheral device with AVEVA Mobile Operator

1. Add a peripheral category in the SAT_Peripheral_Categories table through an insert query with the following values. Skip this step, if the peripheral category already exists.

   PeripheralCategoryPK - ID of the peripheral category.

   PeripheralCategoryName - Name of the peripheral category.

   PeripheralCategoryDesc - Description of the peripheral category.

   For example,

   IF NOT EXISTS (SELECT * FROM SAT_Peripheral_Categories WHERE PeripheralCategoryPK = '892C94B2-8331-4D0C-9C03-D4870655DDF4')

   BEGIN

   INSERT INTO [SAT_Peripheral_Categories] ([PeripheralCategoryPK],

   [PeripheralCategoryName],

   [PeripheralCategoryDesc])

   VALUES

   ('892C94B2-8331-4D0C-9C03-D4870655DDF4', 'NFC', 'NFC')

   END

2. Create a peripheral information bag with the Peripheral Information XML for the peripheral.

   Note: For more information, see Peripheral Information XML.

3. Add the peripheral device in the Peripherals table through an insert query with the following values.

   PeripheralPK - ID of the peripheral device.

   PeripheralId - ID of the peripheral device as set in the Server.

   PeripheralTypeId - ID of the type of the peripheral device. The value in this column will be same as PeripheralPK.

   PeripheralCategoryId - ID of the category of the peripheral as set in the SAT_Peripheral_Categories table.

   PeripheralName - Name of the peripheral device.

   SECURITY_PIN - Bluetooth PIN used for pairing the Bluetooth device.

   PeripheralInformationBag - Peripheral information with technical details.
   Note: This is the peripheral information bag created in step 2.

   IsRegistrationRequired - Device registration requirement in the Management Center. Indicates if the peripheral device is required to be registered in the Management Center.

   IsDeleted - Peripheral deletion status. Set it to greater than 1 for soft deleting the peripheral device.

   For example,

   IF NOT EXISTS (SELECT * FROM PERIPHERALS WHERE PeripheralPK = '66F9F478-C8A4-4634-975F-082AC8106377')

   BEGIN

   INSERT INTO [PERIPHERALS] ([PeripheralPK]

   ,[PeripheralId]

   ,[PeripheralTypeId]

   ,[PeripheralCategoryId]

   ,[PeripheralName]

   ,[SECURITY_PIN]

   ,[PeripheralInformationBag]

   ,[IsRegistrationRequired]

   ,[IsDeleted]

   ,[CreatedOn]

   ,[CreatedBy]

   ,[UpdatedBy]

   ,[UpdatedOn])

   VALUES

   ('66F9F478-C8A4-4634-975F-082AC8106377','C503132D-B1AA-4881-A858-D6D560F43182','66F9F478-C8A4-4634-975F-082AC8106377',

   '892C94B2-8331-4D0C-9C03-D4870655DDF4', 'NFC', 'NULL',

   '<DeviceInformation>

   <CommandResponse>0</CommandResponse>

   <Endianness>1</Endianness>

   <CommunicationResource>NFC</CommunicationResource>

   <Capabilities>

   <SearchCapable>1</SearchCapable>

   <InputCapable>1</InputCapable>

   <CanTrigger>1</CanTrigger>

   </Capabilities>

   <ConfigParameters>

   <SearchEnabled>1</SearchEnabled>

   <InputEnabled>1</InputEnabled>

   <SearchField></SearchField>

   </ConfigParameters>

   </DeviceInformation>',

   0, 0, getdate(),

   '76E6022E-2DE2-485D-8E99-2AA67B3CCEE7',

   '76E6022E-2DE2-485D-8E99-2AA67B3CCEE7',

   getdate())

   END

4. Add the peripheral device in the SAT_Peripheral_CustomFieldConfig table (for adding it in the Management Center) through an insert query with the following values.

   PeripheralCustomConfigID - ID of the peripheral device.

   PeripheralFK - ID of the type of the peripheral device. This must match the PeripheralPK in the Peripherals table.

   PropertyBagDefinition - Information about the custom fields to be displayed in Management Center.

   FieldCustomInformationBag - Information on how the custom fields are formatted on while reading Data from the peripheral Mobile.

   OrganizationEntityFK - This corresponds to Plant/Organization/Tenant ID. This value must match the BASE_FK column in ISMGT_BASE table.

   For example,

   IF NOT EXISTS(SELECT * FROM SAT_Peripheral_CustomFieldConfig WHERE [PeripheralCustomConfigID] = 'EAF70F06-8641-4053-96C4-8A2F72C9B067')

   BEGIN

   declare @TenantId uniqueidentifier,

   @FieldCustomInfo xml, @PropertyBag xml

   SELECT @TenantId = BASE_PK FROM ISMGT_BASE WHERE ParentId IS NULL AND [Type] = 1

   select @FieldCustomInfo = '<Readers>

   <Reader Name="NFC" Class="HF">

   <TagDefinition Name="SimpleNFCTagTag">

   <DataSegment Name="NdefRecord">

   <Field Name="NFC" DataType="MimeTypePlaintext" Format="ASCII" />

   </DataSegment>

   </TagDefinition>

   </Reader>

   </Readers>'

   Select @PropertyBag = '<PropertyBag>

   <Item Label="Integration Type:"

   ControlType="Label"

   MaxLength="25"

   PropertyBagAttributeName="IntegrationType"

   DefaultValue="NFC"/>

   <Item Label="Field Name:"

   ControlType="NameValueComboBox"

   MaxLength="25"

   PropertyBagAttributeName="FieldName"

   DefaultValue="NFC"

   Sort="ascending">

   <DataItem DisplayValue="NFC" Value="NFC"/>

   </Item>

   </PropertyBag>'

   END

   INSERT INTO [SAT_Peripheral_CustomFieldConfig] ([PeripheralCustomConfigID],

   [PeripheralFK],

   [PropertyBagDefinition],

   [FieldCustomInformationBag],

   [CreatedOn],

   [CreatedBy],

   [UpdatedOn],

   [UpdatedBy],

   [OrganizationEntityFK]

   )

   VALUES (

   'EAF70F06-8641-4053-96C4-8A2F72C9B067',

   '66F9F478-C8A4-4634-975F-082AC8106377',

   @PropertyBag, @FieldCustomInfo, SYSDATETIMEOFFSET(), '76E6022E-2DE2-485D-8E99-2AA67B3CCEE7', SYSDATETIMEOFFSET(), '76E6022E-2DE2-485D-8E99-2AA67B3CCEE7', @TenantId

   )

   END