Add Server Configurations

1. To begin adding Server Configurations, select List Manager → Edit → Server Integration Configs. The Server Integration Configs window will appear.

   To create a Server Configuration, either:

   • Select the type of configuration within List Manager and then choose Insert → Add Configuration, or

   • Right-click the type of configuration within list Manager and choose Add Configuration.

     

     An unconfigured, new Server Configuration appears.

2. Click its icon to select it and display the Server Configuration Details.

   

3. First, enter a Server Name that best fits your needs.

   • Server Name: The name of the server as it will appear in components of Procedure Builder. This option appears for all integrations.

     Then, refer to the appropriate section below and configure the remaining options.

Server Integration Options - SAP Asset Importer

• Top Asset Node: A semicolon-separated list of valid root asset nodes. Any nodes imported that are not children of a valid root node will be ignored. By default, this field is blank, causing import of the entire list of assets within the XML.

• Custom Manifest Directory: The directory containing the manifest and transformation files. By default, this field is blank, which will use the "Extensions" directory (by default, "C:\Program Files\AVEVA\Mobile Operator\Server\Extensions").

• Manifest File Name: Specifies the file name of the manifest. By default, this value is "Manifest.xml."

• Manifest Section: The name of the section within the manifest that contains the asset input files and required transforms. By default, this value is "SAP Assets."

• Missing Input File: Determines the behavior of the importer if required input files are missing. By default, this value is "Log as Warning."

  • Ignore: Continues the import without logging the missing files.

  • Log as Warning: Continues the import, logging the missing files as a warning.

  • Log as Error: Continues the import, logging the missing files as an error.

  • Fatal Error - Halt Processing: Aborts the import and logs an error.

• File Processing: Specifies how asset files are processed. Set to "All" to process all asset files as one large import, or "Single" to process the files individually without combining them. By default, this value is "All."

  Note: When a large asset import is in progress, the Management Center will display the warning message. This process is finished once the ArchestrA Logger displays "AssetManager.Execute: Finished Import with success: True" the asset import has finished and the Management Center is again available."

• Asset Directory: The directory containing the asset input files specified in the manifest. This directory location must be accessible by the Synchronization Server on which the iDTS Server is installed.

• Debug Directory: The directory to which debug files are saved (if "Enable Debug" is set to "Yes").

• Enable Debug: Enables the creation of XML logging files to the directory specified by the "Debug Directory" setting.

• Import Summary Report: The file to which the Import Summary Report is written. If this field is left blank, the Import Summary report is written to the directory specified by the "Debug Directory" setting.

• Enable Summary Report: If set "Yes," a detailed Import Summary Report is generated in the Debug Directory to assist debugging.

• Verbose Summary Report: If set "Yes," the Import Summary Report contains detailed information on each imported record.

  Note: iDTS Asset import acquires lock at the tenant level. While large import is in progress, sync may timeout and certain features will not be available globally, like saving a procedure, opening assets or response lists in edit mode, and viewing reports.

Server Integration Options - SAP Response List Importer

• Custom Manifest Directory: The directory containing the manifest and transformation files. If this field is left blank, the server EXTENSION directory is used.

• Manifest File Name: Specifies the file name of the manifest.

• Manifest Section: The name of the section within the manifest that contains the asset input files and required transforms.

• Response List Directory: The location containing the list input files specified in the manifest. If this field is empty, the server EXTENSION directory is used.

• Debug Directory: The directory to which debug files are saved (if "Enable Debug" is set to "Yes").

• Enable Debug: Enables the creation of XML logging files to the directory specified by the "Debug Directory" setting.

• Import Summary Report: The file to which the Import Summary Report is written. If this field is left blank, the Import Summary report is written to the directory specified by the "Debug Directory" setting.

• Enable Summary Report: If set "Yes," a detailed Import Summary Report is generated in the Debug Directory to assist debugging.

• Verbose Summary Report:*If set "Yes," the Import Summary Report contains detailed information on each imported record.

  Note: Response list import acquires lock at the tenant level. While large import is in progress, sync may timeout and certain features will not be available globally, like saving a procedure, opening assets or response lists in edit mode, and viewing reports.

Server Integration Options - SAP Work Order Request

• Custom Manifest Directory: The directory containing the manifest and transformation files. If this field is left blank, the server EXTENSION directory is used.

• Manifest File Name: Specifies the file name of the manifest.

• Manifest Section: The name of the section within the manifest that contains the asset input files and required transforms.

• Import From SAP Path: The directory containing the import files.

• Days to Keep: The number of days to keep a work request on the mobile device before it is deleted.

  • Work Order Requests older than this number of days will not be processed.

  • Requests in the system are purged after this many days (a value of zero (or less) will prevent purging).

• Delete With Status (comma delimited): WORs on the mobile device with any one of the listed statuses (e.g., Completed, Rejected, Denied) will be deleted immediately irrespective of the “Days To Keep” setting.

• Work Request Number Tag: Specifies the Tag in the input (and output) files representing the work request ID.

• Created On Tag: Specifies the Tag in the input (and output) files representing the work request creation date.

• Date Format string: The format string used to parse dates, based on .NET ParseExact:

  • yy - two-digit year, e.g. "12" for 2012.

  • yyyy - four digit year, e.g. "2012" for 2012.

  • MM - two digit month.

  • dd - two digit day.

  • mm - minute

  • hh - hour.

• Short Description Tag: The Tag in the input (and output) files representing the work request short description.

• Input File Transform file(xslt): The name of the Manifest .XSLT file found in the Custom Manifest Directory.

Server Integration Options - SAP Work Order Request (EXPORT)

• Custom Manifest Directory: The directory containing the manifest and transformation files. If this field is left blank, the server EXTENSION directory is used.

• Manifest File Name: Specifies the file name of the manifest.

• Manifest Section: The name of the section within the manifest that contains the asset input files and required transforms.

• Export to SAP Path: The directory to which the export files are written.

• Work Request Number Tag: Specifies the Tag in the input (and output) files representing the work request ID.

• Created On Tag: Specifies the Tag in the input (and output) files representing the work request creation date.

• Date Format string: The format string used to parse dates, based on .NET ParseExact:

  • yy - two-digit year, e.g. "12" for 2012.

  • yyyy - four digit year, e.g. "2012" for 2012.

  • MM - two digit month.

  • dd - two digit day.

  • mm - minute

  • hh - hour.

• Short Description Tag: The Tag in the input (and output) files representing the work request short description.

• Output File Transform file(xslt): The name of the Manifest .XSLT file found in the Custom Manifest Directory.

Server Integration Options - Wonderware Galaxy

Note:
- Only a Tenant administrator with the required System Permissions can create and update the WW Galaxy fields.
- The Wonderware Galaxy Server Integration allows only one instance of server integration configuration.

• Server Name: The name of the server as it will appear in components of Procedure Builder. This option appears for all integrations.

• Send Approved Only: If unchecked, values of Tasks using this integration are sent to the integration server on synchronization. If checked, these values are only sent after the Procedure Instance is marked "Approved" in Auditor Plus (see the "Management Center User’s Guide" for more information regarding Auditor Plus).

• Galaxy Name: The name of the Galaxy to which this Integration will connect. (This name is provided by ArchestrA IDE upon launch.)

• Galaxy Repository Node: The computer name of the machine on which the Galaxy Repository is installed.

• User: The username this Integration will use to login to ArchestrA.

• Password: The password this Integration will use to login to ArchestrA.

• Sleep Seconds: The interval at which the ArchestrA Update Service runs. The recommended value is 15 minutes. Settings of less than five minutes may result in performance degradation.

• MX Read/Write TimeOut Seconds: The number of seconds that must elapse before a read or write to an ArchestrA attribute value fails due to timeout. Failed read operations will return a NULL, whereas failed write operations will log an error.

Server Integration Options - Wonderware Historian

Note: The Wonderware Historian Server Integration allows only one instance of server integration configuration.

• Server Name: The name of the server as it will appear in components of Procedure Builder. This option appears for all integrations.

• Send Approved Only: If unchecked, values of Tasks using this integration are sent to the integration server on synchronization. If checked, these values are only sent after the Procedure Instance is marked "Approved" in Auditor Plus (see Approve and audit completed Procedures).

• Host Name: The Historian server’s name (or IP address) on the network.

• TCP Port: The port specified for Historian access during Wonderware System Platform (WSP) installation. (The default setting is 32568.)

• User Name: The name of the user account specified for off-node communications during WSP installation.

• Password: The password for the specified User Name account.

• Digital State Separator: Defines the character used to separate the Digital State from the value. This setting (most often a semicolon or comma) must be consistent throughout the implementation.

• Digital Type Value Before Separator: Indicates whether the Digital State is located before, or after, the value. Enter Y for "yes" (e.g "1;GOOD") or N for "no (e.g. GOOD;1).

After configuring this Integration Configuration, you can continue either to add additional Integration Configurations, or save the changes by selecting "Save" from the File menu or hitting CTRL+S on your keyboard.

Server Integration Options - Wonderware Online Configurations

Note: The Wonderware Online Configurations Server Integration allows only one instance of server integration configuration.

• Server Name: The name of the server as it will appear in components of Procedure Builder. This option appears for all integrations.

• Connection String: The connection string used to connect to Wonderware Online. Register a data publishing application, using the Historian Publisher, to get the connection string.

  Note: The Sleep Seconds is no longer available for Wonderware Historian and Wonderware Online Configurations. You can set it through the config files, SAT.Integrations.Wonderware.Update.Service.exe.config for Historian and SAT.Integrations.WonderwareOnline.Update.exe.config for Wonderware Online.The default value for the sleep seconds is set to 300 seconds or five minutes and you can change it to your requirement.However, settings of less than five minutes may result in performance degradation.

Server Integration Options - PI System Configurations

Note: The PI System Configurations Server Integration allows only one instance of server integration configuration.

• Server Name: The name of the server as it will appear in components of Procedure Builder. This option appears for all integrations.

• Send Approved Only: If unchecked, values of Tasks using this integration are sent to the integration server on synchronization. If checked, these values are only sent after the Procedure Instance is marked "Approved" in Auditor Plus (see the topic on Auditor Plus)

• Web API URL: URL for PI System Web API

• PI Data Server: Name of the PI Data Server. This PI Data Server is used to process values for PI points.

  Note: If there is only one Data Server, the Mobile Operator PI System Update service will automatically connect to the available PI Data Server.

• Sleep Seconds: The interval at which the PI System Update Service runs. The recommended value is 15 minutes. Settings of less than five minutes may result in performance degradation.

• Digital State Separator: Defines the character used to separate the Digital State from the value. This setting (most often a semicolon or comma) must be consistent throughout the implementation.

• Digital Type Value Before Separator:Indicates whether the Digital State is located before, or after, the value. Enter Y for "yes" (e.g "1;GOOD") or N for "no (e.g. GOOD;1).