Include Custom Files
- Last UpdatedJul 18, 2023
- 3 minute read
Custom Files are external or user-created files that can be included in a project when it compiles. These files could include CSV or DBF files associated with tables presented on project pages, or HTML content. It should also include any required ActiveX objects.
To include custom files in a runtime deployment:
-
Determine the name and location of any custom files that you want to include in the project.
Note: The following files cannot be included as custom files as they are used by the compiler when preparing the zip files:
• Changes.dbf
• Custfiles.dbf
• Errlog.dbf
• Custfiles.zip
• Custactivex.zip
• _library.rdb
• _project.rdb -
In the Setup activity, select Custom Files.
-
Add a row to the Grid Editor.
-
Type the required information in each column, or in the fields in the Property Grid.
For a description of the properties, see below.
-
Click Save.
If you are adding an ActiveX object, make sure the Is ActiveX field is set to TRUE.
Note: If an ActiveX object has an associated data source, verify that the data source can be located by the computer hosting the client. See the topic Managing Associated Data Sources under the section on ActiveX objects in the Plant SCADA Help.
Custom Files Properties
General Properties
|
Field |
Description |
|---|---|
|
File Name |
The name of a file you would like to incorporate into to a runtime deployment. For example, a CSV or DBF file associated with a table presented on a project page, an HTML file, or a required ActiveX object. You can use wild cards ('*' or '?') when specifying a file name. To identify a custom file, you need to precede the file name with:
A Windows relative path should navigate from the current project directory. A Plant SCADA directory path can be one of the following:
Note: You will need to manually configure the access control list for a folder location so that it matches the permissions that were applied to the default location during installation. See Configure Directory Security for Modified Folder Locations. |
|
Is ActiveX |
This field specifies if a file is an ActiveX object or not, which determines if it should be included in custActivex.zip or custFiles.zip. If the value you select is False, the file will be added to custFiles.zip; if you select True it will be added to custActiveX.zip. If you leave this field blank, any file with the extension ".ocx", will be automatically added to custActiveX.zip by the compiler. This is because ActiveX objects typically use this file extension. Similarly, any files that don't have this extension will be automatically added to custFiles.zip If you select False in this field where an .ocx file has been identified, it will force the .ocx file to be included in custFiles.zip. |
|
Destination Location |
This field specifies the folder structure that should be used to host the file when it is extracted from the one of the delivered zip files. It should represent a directory path in relation to the location where extraction occurs. For example: \Files\ The base folder for extraction is %PROGRAMDATA%\AVEVA Plant SCADA <VersionNumber>\User\Example |
|
Comment |
Any useful comment (254 characters). |
Project Properties
|
Property |
Description |
|---|---|
|
Project |
The project in which the custom file is configured. |