LogoLogo
TPI.devCommunityGithub
  • Overview
    • Introduction
      • Future Features
    • License & Disclaimer
    • APIM Architecture
      • Production Deployments and Capacity
      • Functions
      • Integration
    • Key Concepts
      • API Group
      • API Scope
      • API Client
      • End-to-End Workflow Combining API Group, API Scope, and API Client
        • Scenario: API Management for an E-commerce Platform
    • Support
    • Glossary
    • Scenarios
      • Financial Industry
        • Transforming Financial Services with digiRunner API Management
        • Redefining Financial Data Migration with digiRunner API Management Platform
      • Manufacturing Industry
        • Enabling Smart Manufacturing with Seamless API Integration and Automation via digiRunner
        • Streamlining Global Operations with API Management via digiRunner
      • Medical Industry
        • Enhancing Healthcare Data Integration and Security with digiRunner API Management
        • Revolutionizing Healthcare Interoperability with digiRunner’s Advanced API Framework
      • Insurance Industry
        • Modernizing Insurance Services with digiRunner API Management
        • Modernizing Insurance with digiRunner—Bridging Legacy Systems and Microservices
      • Government and Public Services
        • Empowering Open Government Services with digiRunner: A Mission for Integration and Transformation
        • Streamlining Public Sector Innovation via digiRunner: Driving Citizen-Centric Digital Transformation
  • Get Started
    • Installing digiRunner API Management
      • SMTP Configuration
    • Registering Your First APIs with digiRunner
    • Client Authorization and Calling APIs
    • Rate Limiting
    • Proxy Caching
    • Load Balancing
    • Sandbox Testing
    • VIP Gateway Priority Settings
    • JWE Certificate
  • Configuring IP Whitelisting via IP Binding
  • Most common use cases
    • Obtaining API Keys and Calling APIs
    • API IP Diversion
    • Viewing Real-time API Logs
    • Enabling APIs and No Auth in Batches with API Imported
    • Role-Based Access Management within a Hierarchical Structure
    • Simplified OIDC Login with Predefined Organizational Frameworks
    • Resetting User Password and Confirmation Email for Admin Console User
  • Guide
    • AC User Management
      • Users
      • My Profile
      • Roles
      • Role Mapping
      • Organization
      • Role & txID
      • Delegate AC User
      • AC OAuth 2.0 IdP
      • AC LDAP IdP
      • AC MLDAP IdP
      • AC API IdP
    • Development Mode
      • Function Management
      • Rtn Code Management
      • Embedded Function Management
    • Client Management
      • API Client
      • API Group
      • API Scope
      • Authentications
      • Security Level
      • GTW OAuth 2.0 IdP
      • GTW LDAP IdP
      • GTW API IdP
      • GTW JDBC IdP
      • Client Export/Import
    • API Management
      • API List
      • API Registry
      • API Test
      • API Modify Batch
    • Monitor & Alert
      • digiRunner Server
      • Alert Settings
    • Reports
      • API Calls
      • API RESP distribution
      • API Avg. RESP Time
      • API GTW traffic
      • Bad Attempt Report
    • Certificate Management
      • JWE Cert. List
      • JWE Cert. Management
      • TLS Cert. List
      • TLS Cert. Management
    • Application Forms
      • API Key
      • Applications
      • Approval Flow Settings
    • System Information
      • API Key Approval History
      • Scheduled Tasks
      • Recurring Tasks
      • Mail Log
    • System Configs
      • Setting
      • Items
      • Files
      • Customer Setting
      • Online Console
      • WebSocket Proxy Management
      • Static Webpage Reverse Proxy
      • RDB Connection
      • Mail Template Export/Import
  • API Integration Guide
    • Using Token for Authentication and Authorization
      • OpenID Connect (OIDC) Mode
      • Client Credentials Mode
      • Password Mode
    • Using X API Key for Authentication and Authorization
      • Applying for X API Key
      • Obtaining X API Key
      • Calling APIs Registered in digiRunner with X API Key
    • Using API Key for Authentication and Authorization
      • Applying for API Key
      • Obtaining API Key and Secret Key
      • Calculating the Signature and DGRK
      • Calling APIs Registered in digiRunner with API Key
    • Using HTTP Basic and OAuth for Authentication and Authorization
      • Calling APIs Registered in digiRunner with Basic Auth
      • Calling APIs Registered in digiRunner with No OAuth
    • Token Lifecycle Management Mechanism
      • Applying Refresh Token
      • Token Revocation
      • Token Introspection
    • JWS/JWE Integration
      • JWS Workflow
      • JWE Workflow
      • Exchanging Public Keys
      • Generating Certificate
      • Operating with JWS
      • Operating with JWE
Powered by GitBook
On this page
  • Create Scheduled Tasks
  • Search Scheduled Tasks
  • View Scheduled Tasks
  • Execute and Redo Scheduled Tasks
  • Cancel Scheduled Tasks
  • Restore Factory Settings with Scheduled Task

Was this helpful?

Export as PDF
  1. Guide
  2. System Information

Scheduled Tasks

PreviousAPI Key Approval HistoryNextRecurring Tasks

Was this helpful?

Path: System Information > Scheduled Tasks

You may view and create various system scheduling tasks, such as system housekeeping, email delivery, submission of various application forms for review and effective dates, among other things. Most schedules are automatic schedules running in the background of the system, and do not need human intervention; schedules can also be created manually, executed, cancelled or redone when necessary. Scheduled operations are distributed to various nodes and are executed in the background; the purpose of executing in the background is because some tasks may require longer execution times, such as: generating reports, etc.

Scheduled operations have five statuses, which are ➊W: wait, ➋C: cancel, ➌D: carry out, ➍E: failure, and R: Executing.

  • When the schedule status is ➊W: wait, it can be executed and cancelled.

  • When the schedule status is ➋C: cancel, it can be executed.

  • When the schedule status is ➌D: carry out, ➍E: failure and R: Executing, it can be redone.

Create Scheduled Tasks

Most scheduled tasks are scheduled automatically by the system, but schedules can also be created manually.

  1. Click Create to access the creation page.

  1. Fill in the data or make selections as instructed below. The fields marked with “*” are required.

  • Type*: Type of the scheduled task.

  • Task: Item of the scheduled task. The Type* field must be set before proceeding with the selection in this field.

  • Scheduled Time*: Time to execute the schedule.

  • Parameters: Parameters (have specific formats; the formats must be designed in advance, such as: API specifications).

  • Identify Data: If it was not entered by the creator, when the system executes the schedule, the system will establish the default format, which can also be used for remarks.

If the creator did enter the parameters, the system will not apply the system defaults.

  1. Click Create to save and exit.

Scheduled tasks are built into the system. To add new scheduled tasks, please contact TPIsoftware.

Search Scheduled Tasks

Start and end dates or entering keywords can be used to search scheduled tasks.

View Scheduled Tasks

Execute and Redo Scheduled Tasks

Cancel Scheduled Tasks

Restore Factory Settings with Scheduled Task

This is used to reset the Admin Console client password; the password is recorded in the Setting table and has been encrypted due to information security purposes. The encryption algorithm uses AES and default keys, but the installation in each customer environment should have the AES key changed and have the password reset to ensure security. The key value is string and is set in the boot shell script variable ‘TAEASK’. Its second function is to change the system’s menu according to the license; menu changes should be decided whether the version would be express or enterprise when the system was first installed.

Reset Password with Parameter reset.mima

  1. Search for Tsmp_ac_client in Setting and check the original username and password.

  1. Go to System Information > Scheduled Tasks, and click Create to proceed.

  2. Fill in the data or make selections as instructed below. The fields marked with “*” are required.

    • Type*: select Reset to default settings from the drop-down menu

    • Parameters: enter reset.mima

  1. Click Create to save and exit, and the schedule is successfully created.

  1. Go to Setting and search for Tsmp_ac_client. You will see that the password has now been changed.

  1. Press F12 key and log in to the system again; the API calls the access_token.

Apply License Key with Parameter reset.func

To apply the license key, initiate the Restore factory settings function with the parameter reset.func. Wait for the scheduled execution to complete, log in to the system again, and the Menu List will reflect the available license key.

This action should be performed by installation personnel, and the version (digiRunner Express or Enterprise) must be determined during the initial installation.

  1. Update the value with the applicable user license key.

  1. Go to System Information > Scheduled Tasks, and click Create to proceed.

  2. Fill in the data or make selections as instructed below. The fields marked with “*” are required.

    • Type*: select Reset to default settings from the drop-down menu

    • Parameters: enter reset.func

  1. Click Create to save and exit, and the schedule is successfully created.

  1. Log in to the system again, and it will change to the version that can be used by the user.

Search for the schedule to view details, and click on theicon to access the schedule details page.

You can click on the icon on waiting and cancelled schedules to execute the schedule (as ➊ below). You can also click on the icon on successful and failed schedules to redo the schedule (as ➋ below).

Waiting schedules can be cancelled; click the icon to cancel the schedule.

Search for TSMP_EDITION in Setting. Click the icon to access the page.