Valid User: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) No edit summary |
John Leavitt (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
{{Template:XFRACAS.XML.Import.Doc.Class|Common Elements|Common Elements}} | {{Template:XFRACAS.XML.Import.Doc.Class|Common Elements|Common Elements}} | ||
The FirstName, MiddleName, LastName, and Login elements can be nested in any element. | The FirstName, MiddleName, LastName, and Login elements can be nested in any element. | ||
:{{Template:XFRACAS.Blue|<!—}}{{APIComment|The FirstName, MiddleName, LastName and Login elements can be nested in any element. The Login element is required and its value must match an existing user’s login.}} | |||
:{{Template:XFRACAS.Blue|<!—}}{{APIComment|The login is typically a “DomainName\Username,” but could also be a single sign-on (SSO) identification number if that is being used.}} | |||
:{{Template:XFRACAS.Blue|<User>}} | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|FirstName must be a String. 80 characters maximum.}} | |||
::<font color=Blue><FirstName></font><font color=black>Pam</font><font color=Blue></FirstName></font> | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|MiddleName must be a String. 80 characters maximum.}} | |||
::<font color=Blue><MiddleName></font><font color=black>Isa</font><font color=Blue></MiddleName></font> | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|LastName must be a String. 80 characters maximum.}} | |||
::<font color=Blue><LastName></font><font color=black>User</font><font color=Blue></LastName></font> | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|Login must be a String. 100 characters maximum.}} | |||
::'''<font color=Blue><Login></font><font color=black>pUser</font><font color=Blue></Login></font>''' | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|EmployeeID must be an integer.}} | |||
::<font color=Blue><FirstName></font><font color=black>398</font><font color=Blue></FirstName></font> | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|Email must be a String. 50 characters maximum.}} | |||
::<font color=Blue><Email></font><font color=black>User</font><font color=Blue></Email></font> | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|DefaultEntity follows [[Valid Entity]] logic.}} | |||
::<font color=Blue><DefaultEntity></font><font color=black>Entity</font><font color=Blue></DefaultEntity></font> | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|If used, CreatedDate must be a [[Valid Date]].}} | |||
::<font color=Blue><CreatedDate/></font> | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|If used, ExpirationDate must be a [[Valid Date]].}} | |||
::<font color=Blue><ExpirationDate/></font> | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|If used, RevokeDate must be a [[Valid Date]].}} | |||
::<font color=Blue><RevokeDate/></font> | |||
::{{Template:XFRACAS.Blue|<!—}}{{APIComment|If used, at least one UserEntity is required.}} | |||
::<font color=Blue><UserEntities></font> | |||
:::'''<font color=Blue><UserEntity></font>''' | |||
::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|If used, must be a [[Valid Entity]].}} | |||
::::<font color=Blue><Entity></font> | |||
:::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|EntityID must be an integer }} | |||
:::::<font color=Blue><EntityID></font><font color=black>1</font><font color=Blue></EntityID></font> | |||
:::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|EntityName must be a String. 50 characters maximum.}} | |||
:::::<font color=Blue><EntityName></font><font color=black>XFRACAS Software</font><font color=Blue></EntityName></font> | |||
::::<font color=Blue></Entity></font> | |||
::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|AccountExpirationDate must be a [[Valid Date.]]}} | |||
::::<font color=Blue><AccountExpirationDate/></font> | |||
::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|CreatedDate must be a [[Valid Date.]]}} | |||
::::<font color=Blue><CreatedDate/></font> | |||
::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|ReportingOrg is optional and, if present, must contain an existing valid issue.}} | |||
::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|In this case IssueTypeID is equal to 56 (Development).}} | |||
::::<font color=Blue><ReportingOrg></font> | |||
:::::'''<font color=Blue><IssueTypeID></font><font color=black>6</font><font color=Blue></IssueTypeID></font>''' | |||
::::::'''{{Template:XFRACAS.Blue|<IssueTypeDescription>}}{{Template:XFRACAS.Black|PRR Status}}{{Template:XFRACAS.Blue|</IssueTypeDescription>}}''' | |||
:::::'''{{Template:XFRACAS.Blue|</IssueType>}}''' | |||
::::<font color=Blue></ReportingOrg></font> | |||
::::<font color=Blue></ParentUser></font> | |||
::::<font color=Blue><Groups></font> | |||
:::::<font color=Blue><Group></font> | |||
:::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|GroupID (Integer).}} | |||
::::::<font color=Blue><GroupID></font>3<font color=Blue><GroupID></font> | |||
:::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|GroupName must match an existing user GroupName. String. 50 characters maximum.(Integer).}} | |||
::::::<font color=Blue><GroupName></font>User<font color=Blue><GroupName></font> | |||
:::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|GroupDescription must be a string. 200 characters maximum.}} | |||
::::::<font color=Blue><GroupDescription></font>Standard End User<font color=Blue><GroupDescription></font> | |||
:::::<font color=Blue><Group></font> | |||
::::<font color=Blue><Groups></font> | |||
::::<font color=Blue><Categories></font> | |||
::::::'''<font color=Blue><Category></font>''' | |||
:::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|CategoryID (Integer) must be a valid CategoryID listed in the chart above.}} | |||
::::::<font color=Blue><CategoryID></font>6<font color=Blue><CategoryID></font> | |||
:::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|String. 20 characters maximum. Must be a valid Category name listed on the chart above.}} | |||
::::::'''<font color=Blue><CategoryName></font>Standard End User<font color=Blue><CategoryName></font>''' | |||
::::::'''<font color=Blue><Category></font>''' | |||
::::<font color=Blue><Categories></font> | |||
::::<font color=Blue><UserPermissions></font> | |||
:::::<font color=Blue><UserPermission></font> | |||
::::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|PermissionID must be an integer.}} | |||
:::::::<font color=Blue><PermissionID></font>87<font color=Blue><PermissionID></font> | |||
::::::{{Template:XFRACAS.Blue|<!—}}{{APIComment|Permission Description must be a String. 100 characters maximum.}} | |||
:::::::<font color=Blue><PermissionDescription></font>Reports - Serialized System Search Enabled<font color=Blue><PermissionDescription></font> | |||
:::::<font color=Blue><UserPermission></font> | |||
::::<font color=Blue><UserPermissions></font> | |||
:::<font color=Blue><UserEntity></font> | |||
::<font color=Blue><UserEntities></font> | |||
:{{Template:XFRACAS.Blue|<User>}} | |||
The Login element is required and its value must match an existing user’s login.<br> | The Login element is required and its value must match an existing user’s login.<br> | ||
* The login is typically a “DomainName\Username”, but could also be an SSO ID if that is being used. | * The login is typically a “DomainName\Username”, but could also be an SSO ID if that is being used. |
Revision as of 20:58, 12 February 2015
The FirstName, MiddleName, LastName, and Login elements can be nested in any element.
- <!— The FirstName, MiddleName, LastName and Login elements can be nested in any element. The Login element is required and its value must match an existing user’s login.
- <!— The login is typically a “DomainName\Username,” but could also be a single sign-on (SSO) identification number if that is being used.
- <User>
- <!— FirstName must be a String. 80 characters maximum.
- <FirstName>Pam</FirstName>
- <!— MiddleName must be a String. 80 characters maximum.
- <MiddleName>Isa</MiddleName>
- <!— LastName must be a String. 80 characters maximum.
- <LastName>User</LastName>
- <!— Login must be a String. 100 characters maximum.
- <Login>pUser</Login>
- <!— EmployeeID must be an integer.
- <FirstName>398</FirstName>
- <!— Email must be a String. 50 characters maximum.
- <Email>User</Email>
- <!— DefaultEntity follows Valid Entity logic.
- <DefaultEntity>Entity</DefaultEntity>
- <!— If used, CreatedDate must be a Valid Date.
- <CreatedDate/>
- <!— If used, ExpirationDate must be a Valid Date.
- <ExpirationDate/>
- <!— If used, RevokeDate must be a Valid Date.
- <RevokeDate/>
- <!— If used, at least one UserEntity is required.
- <UserEntities>
- <UserEntity>
- <!— If used, must be a Valid Entity.
- <Entity>
- <!— EntityID must be an integer
- <EntityID>1</EntityID>
- <!— EntityName must be a String. 50 characters maximum.
- <EntityName>XFRACAS Software</EntityName>
- </Entity>
- <!— AccountExpirationDate must be a Valid Date.
- <AccountExpirationDate/>
- <!— CreatedDate must be a Valid Date.
- <CreatedDate/>
- <!— ReportingOrg is optional and, if present, must contain an existing valid issue.
- <!— In this case IssueTypeID is equal to 56 (Development).
- <ReportingOrg>
- <IssueTypeID>6</IssueTypeID>
- <IssueTypeDescription> PRR Status </IssueTypeDescription>
- </IssueType>
- <IssueTypeID>6</IssueTypeID>
- </ReportingOrg>
- </ParentUser>
- <Groups>
- <Group>
- <!— GroupID (Integer).
- <GroupID>3<GroupID>
- <!— GroupName must match an existing user GroupName. String. 50 characters maximum.(Integer).
- <GroupName>User<GroupName>
- <!— GroupDescription must be a string. 200 characters maximum.
- <GroupDescription>Standard End User<GroupDescription>
- <Group>
- <Groups>
- <Categories>
- <Category>
- <!— CategoryID (Integer) must be a valid CategoryID listed in the chart above.
- <CategoryID>6<CategoryID>
- <!— String. 20 characters maximum. Must be a valid Category name listed on the chart above.
- <CategoryName>Standard End User<CategoryName>
- <Category>
- <Categories>
- <UserPermissions>
- <UserPermission>
- <!— PermissionID must be an integer.
- <PermissionID>87<PermissionID>
- <!— Permission Description must be a String. 100 characters maximum.
- <PermissionDescription>Reports - Serialized System Search Enabled<PermissionDescription>
- <!— PermissionID must be an integer.
- <UserPermission>
- <UserPermission>
- <UserPermissions>
- <UserEntity>
- <UserEntity>
- <UserEntities>
- <User>
The Login element is required and its value must match an existing user’s login.
- The login is typically a “DomainName\Username”, but could also be an SSO ID if that is being used.