Specify Backup Configuration for Custom Devices

After you add a new custom device configuration or import a configuration file, you can specify the
Backup Configuration
 for Custom Devices by specifying the
Command
,
Arguments (<ARG>)
,
Delay
,
Backup Location
, and
Success Return Code
.
To specify the Backup Configuration for Custom Devices
  1. Click in the
    Command
    field and then click browse_button_small. The
    Command Editor - Backup
     dialog box opens.
  2. In the
    Command Editor - Backup
     dialog box, click in the
    Program
    field and then click browse_button_small to navigate to the application which runs backup operations for custom devices.
  3. Use the
    Open
     dialog box to navigate to and select an application file, and click
    Open
    .
    TIP:
    • FactoryTalk AssetCentre supports the following types of application files: *.exe, *.bat, *.vbs, and *.ps1.
    • Make sure that the folder location for the application files is C:\Users\Public\RockwellSoftware\AssetCentre.
  4. In the
    Arguments
    section, select an available argument from the left combo box. Click right arrow, and the selected argument will be added to the right combo box. You can add one or more available arguments from the left combo box to the right combo box. Click
    OK
    to close the
    Command Editor - Backup
     dialog box.
    TIP:
    For the arguments in the right combo box, you can use left arrow to move an argument back to the left combo box, or use up arrow and down arrow to change their sequences.
  5. In the
    Arguments (<ARG>)
     field, enter a text string, or click CustomDeviceArguments to select a mnemonics from the available mnemonic list. Click
    OK
    .
    TIP:
    • If the
      Global Argument <ARG>
      item is not added into the right combo box in the
      Command Editor - Backup
       dialog box, this field is not editable.
    • Make sure that the folder or file location for
      Arguments (<ARG>)
       is C:\Users\Public\RockwellSoftware\AssetCentre.
    To complete the final command line, you also need to specify the
    Arguments (<ARD>)
     for the custom device (if any).
  6. In the
    Delay (seconds)
    field, enter an integer from 0 through 3600 as a maximum time duration in seconds for which a backup operation is completed. The default setting is 180 (seconds).
    TIP:
    If you set the Delay (seconds) to 0, the program delay timeout is disabled, meaning that the FactoryTalk AssetCentre agent will not proceed until the command completes.
  7. In the
    Backup Location
     field, enter the path to the location on your hard drive where you want to store the backup files of custom devices.
    TIP:
    • This backup location is the base path for the backup files to be stored. If you enter a folder name in the
      Backup Location
       field in the
      Add a Custom Device
      dialog box or
      Device Properties
       dialog box, a new subfolder with the specified folder name is created in the base path. In that case, the backup files are stored in the subfolder in the base path.
    • Make sure that the folder location for
      Backup Location
       is C:\Users\Public\RockwellSoftware\AssetCentre.
  8. In the
    Success Return Code
     field, enter one or multiple integers that are defined as success exit codes in the application script. Only if FactoryTalk AssetCentre receives these codes, it means the backup schedule task performed by the application successfully completed. If not, it means the task failed.
    Leaving this field blank will always mean the task successfully completed. The information that a schedule succeeded or failed will be recorded in the event log. Use comma but without space to separate multiple integers.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal