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 Return Code
  • Search Return Code
  • Import and Export Return Code
  • Update Return Code
  • Delete Return Code

Was this helpful?

Export as PDF
  1. Guide
  2. Development Mode

Rtn Code Management

PreviousFunction ManagementNextEmbedded Function Management

Last updated 5 months ago

Was this helpful?

Path: Development Mode > Rtn Code Management

In order to control the number of the warning message displayed when the system reports errors, corresponding system messages can be searched according to the returned code.

If errors occurred on the system, engineers will compile a return code for this error, and define an error message for the return code on the Rtn Code Management page.

  1. If users made input errors, a warning prompt displaying the message “1298 - No information found” will pop up.

  1. This error message is because the engineer defined the “user input error” operation error as “1298,” and related personnel will go to the Rtn Code Management page and define the “1298” message as “No information found”.

  1. Rtn Code Management is the same as Function Management and will have three of the same return codes, which are the names when the browser language is switched between Chinese and English. Regional language is used to control the switching between Chinese and English.

Create Return Code

Return codes must be created by TPIsoftware personnel. General users cannot define or trigger return code events. Therefore, return codes created by users will not be effective and are only for review purposes. If you need to create a return code, please contact TPIsoftware personnel.

  1. Click Create to access the return code creation page.

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

  • Return code*: Usually a number provided by engineers; custom definitions have no effect.

  • Return Message*: The message that the system prompts to the user when incidents are triggered. Such as: 1298 - No information found.

  • Return Description: Detailed descriptions of the return code.

  1. Click Create to save and exit.

Search Return Code

Enter the keywords to search for the return code to query.

Import and Export Return Code

The rules are as follows: based on FUNC_CODE + LOCALE, if a duplicate exists, it will be updated; if no duplicate exists, a new record will be added.

Update Return Code

Those marked with “*” are required to make changes.

  1. Modify the desired fields, and click Update to save and exit.

Delete Return Code

  1. A warning prompt displaying the message “Confirm Delete?” will pop up. Click Confirm to delete the return code and exit.

Locale*: Refers to the language in which the return code messages are displayed; must match the language of the browser. For more information, refer to .

To modify multiple return codes at once, click Export to export the return codes as an .xlsx file. Modify the desired fields, click on the icon, and then click Import to import the modified file without needing to rename it.

Search for the return code to modify, and click the icon to access the update page.

Search for the return code to delete, and click on the icon to proceed.

Switch and Query Languages