User Access Manager Help >> Operation Guide >> User Access Policy >> Export Task

Export Task

CAMS provides the scheduled task export function to allow for maintenance of system data. With the function, you can schedule a task to export specified data from the database. The data that can be exported includes access details, user bills, account information, and payment records. The exported data is saved to different folders under the same directory of <INC installation folder>/export: uam/detail for access details, cams/bill for user bills, uam/account for account information, and cams/pay for payment records. If INC is installed in distributed deployment, the exported data is saved to their folders on the primary server.

• If the access details export task is configured as a daily task, it is executed at 1:00 every day to export the access details generated during the last day. If the access details export task is configured as an hourly task, it is executed at the fifth minute of every hour to export the access details generated during the last hour.
• A user bill export task is executed at 2:00 am on the first day of each month to export the user bills generated last month.
• An account info export task with the export interval of Monthly is executed at 3:05 am on the first day of each month to export the access user accounts added last month. An account info export task with the export interval of Daily is executed at 3:00 am every day to export the access user accounts added during the last day.
• A payment records export task is executed at 4:00 am on the first day of each month to export the payment records generated last month.

Select the User tab, and from the navigation tree select User Access Policy > Export Task to enter the page listing the export tasks. On the page, you can choose to configure the following four export tasks.

• Access Details

  Operation Procedure

  1. Click the icon of the access detail type to enter the page for configuring export of access details task.
  2. The following describes the configuration items:
  • Enable Automatic Export: Selecting the check box enables the export task. If the check box is not selected, the export task is only saved and will not run.
  • Export Interval: Select an option to specify how often the access details export task runs. Options include Daily and Hourly.
  • File Type: Select a type for the file to which the exported data is saved. Currently, TXT and CSV file types are supported.
  • Prefix of Export File: Type the prefix for the name of the file to which the exported data is saved. It cannot be null and the string is of 1 to 32 characters. Valid characters are lowercase letters a to z, uppercase letters A to Z, digits 0 to 9, hyphens (-), and underscores (_).
  • Separator: Set the separator between the fields in the exported file. Available options include space, tab, comma (,), and semicolon (;) . (The parameter is not available if CSV is selected as the file type.)
  • Include Cancelled Services: If the check box is selected, the data of the cancelled services is also exported. Such data is not exported if the check box is not selected.
  • Export to FTP Server/FTP Server User Name/FTP Server Password/FTP Server IP: Select the Export to FTP Server check box and then you can configure the related FTP server parameters. The FTP server user name is a character string in the length of 1 to 32. Valid characters are lowercase letters a to z, uppercase letters A to Z, digits 0 to 9, hyphens (-), underscores (_), dots (.), and at signs (@). The length of FTP server password is of 1 to 16 characters. The FTP server IP address must be a valid IP address excluding 0.0.0.0 and 255.255.255.255.
  • Customize Output/Output Data: Select the Customize Output check box and then select the fields to be included in the exported data from the available options, and add them to the output data list. The options for the access details include: device IP, port, VLAN ID/inner VLAN ID, outer VLAN ID, and so on. If none of these optional fields are selected, the task exports details of event ID, account name, user name, login name, service name, start time, access duration, user IP address, bonus, user group, and used bonus by default.
  3. Click OK to save your task configuration. The system returns to the task list after the configuration is saved successfully, or a message is displayed if any error is detected.
• User Bill (The configuration item is available only after CAMS is installed.)

  Operation Procedure

  1. Click the icon of the user bill type to enter the page for configuring export of user bill task.
  2. The following describes the configuration items:
  • Enable Automatic Export: Selecting the check box enables the export task. If the check box is not selected, the export task is only saved and will not run.
  • Export Interval: Select an option to specify how often the user bill export task runs. When Monthly is selected, the task runs every month.
  • File Type: Select a type for the file to which the exported data is saved. Currently, TXT and CSV file types are supported.
  • Bill Status: Select an option to specify the bill state type, which can be outstanding or paid. Leaving the option blank specifies to export all bills.
  • Account Type: Select an option to specify the account type, which can be prepaid account or ordinary account. Leaving the option blank specifies to export user bills of all users.
  • Prefix of Export File: Type the prefix for the name of the file to which the exported data is saved. It cannot be null and the string is of 1 to 32 characters. Valid characters are lowercase letters a to z, uppercase letters A to Z, digits 0 to 9, hyphens (-), and underscores (_).
  • Separator: Set the separator between the fields in the exported file. Available options include space, tab, comma (,), and semicolon (;) . (The parameter is not available if CSV is selected as the file type.)
  • Export to FTP Server/FTP Server User Name/FTP Server Password/FTP Server IP: Select the Export to FTP Server check box and then you can configure the related FTP server parameters. The FTP server user name is a character string in the length of 1 to 32. Valid characters are lowercase letters a to z, uppercase letters A to Z, digits 0 to 9, hyphens (-), underscores (_), dots (.), and at signs (@). The length of FTP server password is of 1 to 16 characters. The FTP server IP address must be a valid IP address excluding 0.0.0.0 and 255.255.255.255.
  3. Click OK to save your task configuration. The system returns to the task list after the configuration is saved successfully, or a message is displayed if any error is detected.
• Account Information

  Operation Procedure

  1. Click the icon of the account information type to enter the page for configuring export of account information.
  2. The following describes the configuration items:
  • Enable Automatic Export: Selecting the check box enables the automatic export. If the check box is not selected, the export task is only saved and will not run.
  • Export Interval: Select an option to specify how often the account information export task runs. When Daily or Monthly is selected, the task runs every day or every month.
  • File Type: Select a type for the file to which the exported data is saved. Currently, TXT and CSV file types are supported.
  • Min. Balance/Max. Balance: Type a value for each text box to specify the balance range so that the account information within the range is exported. The value must be from -10000000 to 200000000, and they can be null. (The parameter is available only after CAMS is installed.)
  • Billing Term Start Time/End Time: Select the date to define the time period so that the account information within the billing period is exported. It can be null. You can also type the date in the format of yyyy-mm-dd. The end time must be later than the start time. (The parameter is available only after CAMS is installed.)
  • Payment Type: Select an option to specify the account type, which can be prepaid account or ordinary account. Leaving the option blank specifies to export all users. (The parameter is available only after CAMS is installed.)
  • Prefix of Export File: Type the prefix for the name of the file to which the exported data is saved. It cannot be null and the string is of 1 to 32 characters. Valid characters are lowercase letters a to z, uppercase letters A to Z, digits 0 to 9, hyphens (-), and underscores (_).
  • Separator: Set the separator between the fields in the exported file. Available options include space, tab, comma (,), and semicolon (;) . (The parameter is not available if CSV is selected as the file type.)
  • Account Type: Select the type of access user accounts to be exported. Any other types of accounts will be filtered out when UAM exports user accounts.
  • Export All Accounts: Selecting the check box exports all accounts. If the check box is not selected, the newly added accounts since last export are exported.
  • Export to FTP Server/FTP Server User Name/FTP Server Password/FTP Server IP: Select the Export to FTP Server check box and then you can configure the related FTP server parameters. The FTP server user name is a character string in the length of 1 to 32. Valid characters are lowercase letters a to z, uppercase letters A to Z, digits 0 to 9, hyphens (-), underscores (_), dots (.), and at signs (@). The length of FTP server password is of 1 to 16 characters. The FTP server IP address must be a valid IP address excluding 0.0.0.0 and 255.255.255.255.
  • Customize Output/Output Data: Select the Customize Output check box and then select the fields to be included in the exported data from the available options, and add them to the output data list. The available options contain two parts: additional information fields, if any, and system-defined fields. The system-defined fields include password, identity number, account status, access device IP, port, and so on. If none of these optional fields are selected, the task exports account information of account name, user name, user group, start time, and end time by default.
  3. Click OK to save your task configuration. The system returns to the task list after the configuration is saved successfully, or a message is displayed if any error is detected.
• Payment Records (The configuration item is available only after CAMS is installed.)

  Operation Procedure

  1. Click the icon of the payment records type to enter the page for configuring export of payment records task.
  2. The following describes the configuration items:
  • Enable Automatic Export: Selecting the check box enables the export task. If the check box is not selected, the export task is only saved and will not run.
  • Export Interval: Select an option to specify how often the payment records export task runs. When Monthly is selected, the task runs every month.
  • File Type: Select a type for the file to which the exported data is saved. Currently, TXT and CSV file types are supported.
  • Operator: Type an operator to export payment records of the specified operator. Leaving the text box blank will export payment records of all operators.
  • Payment Type: Select a payment type, which can be Initial Payment, Cash Payment, Bank Card Payment, Recharge Card Payment, Third-Party Payment, Auto Charge, Prepayment Refund, Fixed-Fee Refund, Balance to Close Account. If no option is selected, payment records of all payment types are exported.
  • Prefix of Export File: Type the prefix for the name of the file to which the exported data is saved. It cannot be null and the string is of 1 to 32 characters. Valid characters are lowercase letters a to z, uppercase letters A to Z, digits 0 to 9, hyphens (-), and underscores (_).
  • Separator: Set the separator between the fields in the exported file. Available options include space, tab, comma (,), and semicolon (;) . (The parameter is not available if CSV is selected as the file type.)
  • Include Cancelled Users: Selecting this check box will export users including those have been cancelled. Such data is not exported if the check box is not selected.
  • Export to FTP Server/FTP Server User Name/FTP Server Password/FTP Server IP: Select the Export to FTP Server check box and then you can configure the related FTP server parameters. The FTP server user name is a character string in the length of 1 to 32. Valid characters are lowercase letters a to z, uppercase letters A to Z, digits 0 to 9, hyphens (-), underscores (_), dots (.), and at signs (@). The length of FTP server password is of 1 to 16 characters. The FTP server IP address must be a valid IP address excluding 0.0.0.0 and 255.255.255.255.
  3. Click OK to save your task configuration. The system returns to the task list after the configuration is saved successfully, or a message is displayed if any error is detected.

Precautions

• If an old version of FTP software is used, data transmission may fail. As a result, zero-byte files are created.
• Only an operator having the administrator privilege can edit an export task.