File Format for Importing Messages
You can import messages to your application by creating separate text files containing messages and message tokens. You can then upload these files to the Oracle WebCenter Content document repository.
- Use a vertical bar or pipe ( | ) as a delimiter between fields for both the header and the value rows.
- According to the Oracle WebCenter Content specification, set the file encoding to UTF-8 without the Byte Order Mark (BOM).
- The first line in the file must be a header line, and the files must look exactly the same as shown in the sample file.
The following sections contain specific details about each file format.
Messages
Header | Data Type | Data Size | Description | Required or Optional |
---|---|---|---|---|
MessageName |
String | 30 | This value displays the name of the message. | Required |
ApplicationId |
long | long | This value determines the application that your message belongs to. | Required |
ModuleType |
String | 60 | This value displays the module type associated with the message type. | Required |
ModuleKey |
String | 60 | This value displays the module key associated with the message type. | Required |
MessageNumber |
long | long | This value displays the message number. | Optional |
MessageType |
String | 30 | This value displays the type name associated with the message. It
must be one of these message types:
|
Required |
ShortText |
String | 240 | This value displays the short text description associated with the message. | Required |
LoggingEnabled |
String | 1 | This value lets you enable or disable the option to sign in.
|
Optional |
MessageSeverity |
String | 30 | This value displays the severity associated with the message. It
must be either empty or one of these severity levels:
|
Optional |
MessageCategory |
String | 30 | This value is the category associated with the message. It must
be either empty or one of these categories:
|
Optional |
MessageUserDetails |
String | 4000 | This value displays details of the user to whom you send the message. | Optional |
MessageAdminDetails |
String | 4000 | This value displays details of the administrator to whom you send the message. | Optional |
MessageCause |
String | 4000 | This value displays the associated reason for initiating the message. | Optional |
MessageUserAction |
String | 4000 | This value indicates the action that the user takes on the message. | Optional |
MessageAdminAction |
String | 4000 | This value indicates the action that the administrator takes on the message. | Optional |
TranslationNotes |
String | 4000 | This value displays the translation notes on the message, if any. | Optional |
Here's a sample file with the header values at the beginning of the file, followed by the line entries of the messages. For importing several messages, add more line entries in a similar format.
MessageName|ApplicationId|ModuleType|ModuleKey|MessageNumber|MessageType|ShortText|LoggingEnabled|MessageSeverity|MessageCategory|MessageUserDetails|MessageAdminDetails|MessageCause|MessageUserAction|MessageAdminAction|TranslationNotes
AA_TEST_D1|10110|APPLICATION|FND|1112223|ERROR|Short text 333|N|HIGH|PRODUCT|User details |admin details1 |cause |user action |admin action 222|ms TR conte
AA_TEST_D2|10110|APPLICATION|FND|111229923|ERROR|Short text 444|N|HIGH|PRODUCT|User details |admin details2 |cause s1|user action |admin 1|ms con 11
Message Tokens
Header | Data Type | Data Size | Description | Required or Optional |
---|---|---|---|---|
MessageName |
String | 30 | This value displays the name of the message token. | Required |
ApplicationId |
Long | Long | This value determines the application that your message token belongs to. | Required |
TokenName |
String | 30 | This value displays the token name associated with the message tokens assignment. | Required |
DataType |
String | 30 | This value is the data type value of the message tokens. It must
be one of these message tokens:
|
Required |
Description |
String | 4000 | This value displays the description of the document sequence code. | Optional |
Here's a sample file with the header values at the beginning of the file, followed by the line entries of the message tokens. For importing several message tokens, add more line entries in a similar format.
MessageName|ApplicationId|TokenName|DataType|Description
AA_TEST_D1|10110|TOKEN1|TEXT|desc demo1
AA_TEST_D1|10110|TOKEN2|TEXT|desc demo2