..
/
download
.\"t
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "s1kd-defaults" "5" "2021-04-16" "" "s1kd-tools"
.hy
.SH General
.PP
This document contains an alphabetic index of all valid
\f[C].defaults\f[R] file identifiers, and a description of the values
they may be assigned.
It also contains examples of a \f[C].defaults\f[R] file using all
identifiers in both the XML format and simple text format.
.SH Alphabetic index
.PP
\f[C].defaults\f[R] file - Identifier value descriptions
.TS
tab(@);
l l.
T{
.PP
Identifier
T}@T{
.PP
Value description
T}
_
T{
.PP
\f[C]act\f[R]
T}@T{
.PP
Data module code of ACT data module
T}
T{
.PP
\f[C]assyCode\f[R]
T}@T{
.PP
2 to 4 alphanumeric characters
T}
T{
.PP
\f[C]authorization\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]brex\f[R]
T}@T{
.PP
Data module code of BREX data module
T}
T{
.PP
\f[C]city\f[R]
T}@T{
.PP
string (Sender city)
T}
T{
.PP
\f[C]commentPriorityCode\f[R]
T}@T{
.PP
cp01-cp99
T}
T{
.PP
\f[C]commentType\f[R]
T}@T{
.PP
Q, I, or R
T}
T{
.PP
\f[C]countryIsoCode\f[R]
T}@T{
.PP
ISO 2-character country code
T}
T{
.PP
\f[C]country\f[R]
T}@T{
.PP
string (Sender country)
T}
T{
.PP
\f[C]disassyCodeVariant\f[R]
T}@T{
.PP
1 to 3 alphanumeric characters
T}
T{
.PP
\f[C]disassyCode\f[R]
T}@T{
.PP
2 alphanumeric characters
T}
T{
.PP
\f[C]dmlType\f[R]
T}@T{
.PP
C, P, or S
T}
T{
.PP
\f[C]infoCodeVariant\f[R]
T}@T{
.PP
1 alphanumeric character
T}
T{
.PP
\f[C]infoCode\f[R]
T}@T{
.PP
3 alphanumeric characters
T}
T{
.PP
\f[C]infoName\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]infoNameVariant\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]inWork\f[R]
T}@T{
.PP
2 digits
T}
T{
.PP
\f[C]issueNumber\f[R]
T}@T{
.PP
3 digits
T}
T{
.PP
\f[C]issueType\f[R]
T}@T{
.PP
S1000D issue type (new, changed, ...)
T}
T{
.PP
\f[C]issue\f[R]
T}@T{
.PP
S1000D issue number (5.0, 4.2, 4.1, ...)
T}
T{
.PP
\f[C]itemLocationCode\f[R]
T}@T{
.PP
A, B, C, D, or T
T}
T{
.PP
\f[C]languageIsoCode\f[R]
T}@T{
.PP
2 to 3 character ISO language code
T}
T{
.PP
\f[C]learnCode\f[R]
T}@T{
.PP
3 alphanumeric characters
T}
T{
.PP
\f[C]learnEventCode\f[R]
T}@T{
.PP
A, B, C, D, or E
T}
T{
.PP
\f[C]maintainedSns\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]modelIdentCode\f[R]
T}@T{
.PP
1 to 14 alphanumeric characters
T}
T{
.PP
\f[C]originatorCode\f[R]
T}@T{
.PP
5-character NCAGE code
T}
T{
.PP
\f[C]originator\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]pmIssuer\f[R]
T}@T{
.PP
5-character NCAGE code
T}
T{
.PP
\f[C]pmNumber\f[R]
T}@T{
.PP
5 alphanumeric characters
T}
T{
.PP
\f[C]pmVolume\f[R]
T}@T{
.PP
2 digits
T}
T{
.PP
\f[C]receiver\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]receiverCity\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]receiverCountry\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]receiverIdent\f[R]
T}@T{
.PP
5-character NCAGE code
T}
T{
.PP
\f[C]remarks\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]responsiblePartnerCompanyCode\f[R]
T}@T{
.PP
5-character NCAGE code
T}
T{
.PP
\f[C]responsiblePartnerCompany\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]schema\f[R]
T}@T{
.PP
URI
T}
T{
.PP
\f[C]scormContentPackageIssuer\f[R]
T}@T{
.PP
5-character NCAGE code
T}
T{
.PP
\f[C]scormContentPackageNumber\f[R]
T}@T{
.PP
5 alphanumeric characters
T}
T{
.PP
\f[C]scormContentPackageVolume\f[R]
T}@T{
.PP
2 digits
T}
T{
.PP
\f[C]securityClassification\f[R]
T}@T{
.PP
2 digits
T}
T{
.PP
\f[C]sender\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]senderIdent\f[R]
T}@T{
.PP
5-character NCAGE code
T}
T{
.PP
\f[C]seqNumber\f[R]
T}@T{
.PP
00001-99999
T}
T{
.PP
\f[C]skillLevelCode\f[R]
T}@T{
.PP
sk01-sk99
T}
T{
.PP
\f[C]sns\f[R]
T}@T{
.PP
Data module code of BREX data module
T}
T{
.PP
\f[C]snsLevels\f[R]
T}@T{
.PP
1 thru 4
T}
T{
.PP
\f[C]subSubSystemCode\f[R]
T}@T{
.PP
1 alphanumeric character
T}
T{
.PP
\f[C]subSystemCode\f[R]
T}@T{
.PP
1 alphanumeric character
T}
T{
.PP
\f[C]systemCode\f[R]
T}@T{
.PP
2 to 3 alphanumeric characters
T}
T{
.PP
\f[C]systemDiffCode\f[R]
T}@T{
.PP
1 to 4 alphanumeric characters
T}
T{
.PP
\f[C]techName\f[R]
T}@T{
.PP
string
T}
T{
.PP
\f[C]templates\f[R]
T}@T{
.PP
Path to custom XML templates directory
T}
T{
.PP
\f[C]yearOfDataIssue\f[R]
T}@T{
.PP
4 digits
T}
.TE
.SH Example - XML format
.IP
.nf
\f[C]
<?xml version=\[dq]1.0\[dq]?>
<defaults>
<default ident=\[dq]act\[dq] value=\[dq]MYPRJ-A-00-00-00-00A-00WA-D\[dq]/>
<default ident=\[dq]assyCode\[dq] value=\[dq]00\[dq]/>
<default ident=\[dq]authorization\[dq] value=\[dq]khzae.net\[dq]/>
<default ident=\[dq]brex\[dq] value=\[dq]MYPRJ-A-00-00-00-00A-022A-D\[dq]/>
<default ident=\[dq]city\[dq] value=\[dq]Toronto\[dq]/>
<default ident=\[dq]commentPriorityCode\[dq] value=\[dq]cp01\[dq]/>
<default ident=\[dq]commentType\[dq] value=\[dq]Q\[dq]/>
<default ident=\[dq]countryIsoCode\[dq] value=\[dq]CA\[dq]/>
<default ident=\[dq]country\[dq] value=\[dq]Canada\[dq]/>
<default ident=\[dq]disassyCodeVariant\[dq] value=\[dq]A\[dq]/>
<default ident=\[dq]disassyCode\[dq] value=\[dq]00\[dq]/>
<default ident=\[dq]dmlType\[dq] value=\[dq]C\[dq]/>
<default ident=\[dq]infoCodeVariant\[dq] value=\[dq]A\[dq]/>
<default ident=\[dq]infoCode\[dq] value=\[dq]258\[dq]/>
<default ident=\[dq]infoName\[dq] value=\[dq]Other procedure to clean\[dq]/>
<default ident=\[dq]infoNameVariant\[dq] value=\[dq]Clean with water\[dq]/>
<default ident=\[dq]inWork\[dq] value=\[dq]01\[dq]/>
<default ident=\[dq]issueNumber\[dq] value=\[dq]000\[dq]/>
<default ident=\[dq]issueType\[dq] value=\[dq]new\[dq]/>
<default ident=\[dq]issue\[dq] value=\[dq]5.0\[dq]/>
<default ident=\[dq]itemLocationCode\[dq] value=\[dq]D\[dq]/>
<default ident=\[dq]languageIsoCode\[dq] value=\[dq]en\[dq]/>
<default ident=\[dq]learnCode\[dq] value=\[dq]H10\[dq]/>
<default ident=\[dq]learnEventCode\[dq] value=\[dq]A\[dq]/>
<default ident=\[dq]maintainedSns\[dq] value=\[dq]General sea vehicles\[dq]/>
<default ident=\[dq]modelIdentCode\[dq] value=\[dq]MYPRJ\[dq]/>
<default ident=\[dq]omitIssueInfo\[dq] value=\[dq]true\[dq]/>
<default ident=\[dq]originatorCode\[dq] value=\[dq]12345\[dq]/>
<default ident=\[dq]originator\[dq] value=\[dq]khzae.net\[dq]/>
<default ident=\[dq]pmIssuer\[dq] value=\[dq]12345\[dq]/>
<default ident=\[dq]pmNumber\[dq] value=\[dq]00000\[dq]/>
<default ident=\[dq]pmVolume\[dq] value=\[dq]00\[dq]/>
<default ident=\[dq]receiver\[dq] value=\[dq]khzae.net\[dq]/>
<default ident=\[dq]receiverCity\[dq] value=\[dq]Toronto\[dq]/>
<default ident=\[dq]receiverCountry\[dq] value=\[dq]Canada\[dq]/>
<default ident=\[dq]receiverIdent\[dq] value=\[dq]12345\[dq]/>
<default ident=\[dq]remarks\[dq] value=\[dq]Comments on a data module\[dq]/>
<default ident=\[dq]responsiblePartnerCompanyCode\[dq] value=\[dq]12345\[dq]/>
<default ident=\[dq]responsiblePartnerCompany\[dq] value=\[dq]khzae.net\[dq]/>
<default ident=\[dq]schema\[dq] value=\[dq]descript.xsd\[dq]/>
<default ident=\[dq]securityClassification\[dq] value=\[dq]01\[dq]/>
<default ident=\[dq]senderIdent\[dq] value=\[dq]12345\[dq]/>
<default ident=\[dq]seqNumber\[dq] value=\[dq]00001\[dq]/>
<default ident=\[dq]skillLevelCode\[dq] value=\[dq]sk01\[dq]/>
<default ident=\[dq]sns\[dq] value=\[dq]MYPRJ-A-00-00-00-00A-022A-D\[dq]/>
<default ident=\[dq]snsLevels\[dq] value=\[dq]1\[dq]/>
<default ident=\[dq]subSubSystem\[dq] value=\[dq]0\[dq]/>
<default ident=\[dq]subSystem\[dq] value=\[dq]0\[dq]/>
<default ident=\[dq]systemCode\[dq] value=\[dq]00\[dq]/>
<default ident=\[dq]techName\[dq] value=\[dq]My project\[dq]/>
<default ident=\[dq]templates\[dq] value=\[dq]/usr/share/s1kd-tools/templ\[dq]/>
<default ident=\[dq]yearOfDataIssue\[dq] value=\[dq]2017\[dq]/>
</defaults>
\f[R]
.fi
.SH Example - Simple text format
.IP
.nf
\f[C]
act MYPRJ-A-00-00-00-00A-00WA-D
assyCode 00
authorization khzae.net
brex MYPRJ-A-00-00-00-00A-022A-D
city Toronto
commentPriorityCode cp01
commentType Q
countryIsoCode CA
country Canada
disassyCodeVariant A
disassyCode 00
dmlType C
infoCodeVariant A
infoCode 258
infoName Other procedure to clean
infoNameVariant Clean with water
inWork 01
issueNumber 000
issueType new
issue 5.0
itemLocationCode D
languageIsoCode en
learnCode H10
learnEventCode A
maintainedSns General sea vehicles
modelIdentCode MYPRJ
omitIssueInfo true
originatorCode 12345
originator khzae.net
pmIssuer 12345
pmNumber 00000
pmVolume 00
receiver khzae.net
receiverCity Toronto
receiverCountry Canada
receiverIdent 12345
remarks Comments on a data module
responsiblePartnerCompanyCode 12345
responsiblePartnerCompany khzae.net
schema descript.xsd
securityClassification 01
sender khzae.net
senderIdent 12345
seqNumber 00001
skillLevelCode sk01
sns MYPRJ-A-00-00-00-00A-022A-D
snsLevels 1
subSubSystem 0
subSystem 0
systemCode 00
techName My project
templates /usr/share/s1kd-tools/templ
yearOfDataIssue 2017
\f[R]
.fi
.SH AUTHORS
khzae.net.
gopher://khzae.net/0/s1kd/s1kd-tools/src/doc/s1kd-defaults.5