-
-
- The user reaches CDS Submit main page.
- 
- |
-
- To add a document type to CDS Submit, you should go to the main page and click on "New Doctype" in the left blue panel.
- Even once created, a document type will not appear automatically on this page. To configure the list of catalogues and document types displayed on this page, the administrator shall go to the edit catalogues page. (see the .php>guide section)
- When the user moves the cursor over the title of one document type, a small descriptive text appears on the right of the screen. To change this text as well as the title of the document type, go to the main page, click on the title of the document type then on the "Edit Document Types Details" button.
- |
-
-
-
- |
-
-
- The user can then click on the document type he is interested in.
- 
- |
-
- The text appearing under the salmon horizontal header is the same as the one appearing on the mouseover (see above). It can also be configured by going to the main page, click on the title of the document type then on the "Edit Document Types Details" button.
- To a document type, you can associate several categories which can be defined by going to the main page, click on the title of the document type then on the "View Categories" button. In order to save the selected value, you must add a field to the first page of the submission form. This field will be a hidden field (for example "categ") which default value should be "<COMBO>". The result of this will be that the selected category will be saved in a file named "categ" in the submission directory.
- To add an action button to this page, first implement this action by going to the main page, click on the title of the document type then on the "Add a new submission" button. If the action is already implemented and the button still does not appear on the submision page, then you should edit the details of this implementation: go to the main page, click on the title of the document type then on the icon in the "Edit Submission" column and in the line of the desired action. There you should set the "Displayed" form field to "YES".
- You can also change the order of the buttons, by going to the main page, click on the title of the document type then on the icon in the "Edit Submission" column and in the line of the desired action. There you can set the "buttonorder" form field.
- |
-
-
-
- |
-
-
- The user now may choose a category, then click on the action button he wishes.
The submission starts, the first page of the web form appears.
- 
- |
-
- This web form is composed of several pages, on each of these pages form fields can be found. To modify the number of pages, add or withdraw form fields and modify the texts before each form field, you shall go to the main page, click on the title of the document type then on the icon in the "Edit Submission Pages" column and in the line of the desired action. (see the .php>guide section)
- |
-
-
-
- |
-
-
- On the last page of the submission, there should be a button like in the following image which will trigger the end script
- 
- |
-
- This button is defined like any other form field. Its definition should include a onclick="finish();" javascript attribute.
- After clicking this button, CDS Submit will apply the end script functions to the gathered data. To modify the ens script, you shall go to the main page, click on the title of the document type then on the icon in the "Edit Functions" column and in the line of the desired action. (see the .php>guide section)
- |
-
-
-
-
+ | CaseEDS |
+ | description |
+
+
+
+ This function may be used if the treatment to be done after a submission depends on a field entered by
+ the user. Typically this is used in an approval interface. If the referee approves then we do this. If he rejects,
+ then we do other thing.
+ More specifically, the function gets the value from the file named [casevariable] and compares it with the
+ values stored in [casevalues]. If a value matches, the function directly goes to the corresponding step stored
+ in [casesteps]. If no value is matched, it goes to step [casedefault].
+
+ |
+
+ | parameters |
+
+ | casevariable |
+
+ This parameters contains the name of the file in which the function will get the chosen value.
+ Eg: "decision"
+ |
+
+
+ | casevalues |
+
+ Contains the list of recognized values to match with the chosen value. Should be a comma separated list of words.
+ Eg: "approve,reject"
+ |
+
+
+ | casesteps |
+
+ Contains the list of steps corresponding to the values matched in [casevalue]. It should be a comma
+ separated list of numbers
+ Eg: "2,3"
+ In this example, if the value stored in the file named "decision" is "approved", then the function launches
+ step 2 of this action. If it is "reject", then step 3 is launched.
+ |
+
+
+ | casedefault |
+
+ Contains the step number to go by default if no match is found.
+ Eg: "4"
+ In this example, if the value stored in the file named "decision" is not "approved" nor "reject", then
+ step 4 is launched.
+ |
+
+
+
+
+
+ | Get_Info |
+ | description |
+
+
+
+ This function tries to retrieve in the "pending" directory or directly in the documents database, some information
+ about the document: title, original submitter's email and author(s).
+ If found, this information is stored in 3 global variables: $emailvalue, $titlevalue, $authorvalue to be used
+ in other functions.
+ If not found, an error message is displayed.
+
+ |
+
+ | parameters |
+
+ | authorFile |
+
+ Name of the file in which the author may be found if the document has not yet been integrated (in this case
+ it is still in the "pending" directory).
+ |
+
+
+ | emailFile |
+
+ Name of the file in which the email of the original submitter may be found if the document has not yet been
+ integrated (in this case it is still in the "pending" directory).
+ |
+
+
+ | titleFile |
+
+ Name of the file in which the title may be found if the document has not yet been integrated (in this case it is
+ still in the "pending" directory).
+ |
+
+
+
+
+
+
+
+ | Mail_Submitter |
+ | description |
+
+ |
+
+ This function send an email to the submitter to warn him the document he has just submitted has been
+ correctly received.
+
+ |
+
+ | parameters |
+
+ | authorfile |
+
+ Name of the file containing the authors of the document
+ |
+
+
+ | titleFile |
+
+ Name of the file containing the title of the document
+ |
+
+
+ | emailFile |
+
+ Name of the file containing the email of the submitter of the document
+ |
+
+
+ | status |
+
+ Depending on the value of this parameter, the function adds an additional text to the email.
+ This parameter can be one of:
+ ADDED: The file has been integrated in the database.
+ APPROVAL: The file has been sent for approval to a referee.
+ or can stay empty.
+ |
+
+
+ | edsrn |
+
+ Name of the file containing the reference of the document
+ |
+
+
+ | newrnin |
+
+ Name of the file containing the 2nd reference of the document (if any)
+ |
+
+
+
+
+
+
+
+ | Report_Number_Generation |
+ | description |
+
+
+
+ This function is used to automatically generate a reference number.
+ After generating the reference, the function saves it into the [newrnin] file and sets the global variable
+ containing this reference.
+
+ |
+
+ | parameters |
+
+ | autorngen |
+
+ If set to "Y": The reference number is generated.
+ If set to "N": The reference number is read from a file ([newrnin])
+ If set to "A": The reference number will be the access number of the submission.
+ |
+
+
+ | counterpath |
+
+ indicates the file in which the program will find the counter for this reference generation.
+ The value of this parameter may contain one of:
+ "<PA>categ</PA>": in this case this string is replaced with the content of the file [altrnin]
+ "<PA>yy</PA>": in this case this string is replaced by the current year (4 digits) if [altyeargen]
+ is set to "AUTO", or by the content of the [altyeargen] file in any other case. (this content should be formatted
+ as a date (dd/mm/yyyy).
+ |
+
+
+ | rnformat |
+
+ This is the format used by the program to create the reference. The program computes the value of the
+ parameter and appends a "-" followed by the current value of the counter increased by 1.
+ The value of this parameter may contain one of:
+ "<PA>categ</PA>": in this case this string is replaced with the content of the file [altrnin]
+ "<PA>yy</PA>": in this case this string is replaced by the current year (4 digits) if [altyeargen]
+ is set to "AUTO", or by the content of the [altyeargen] file in any other case. (this content should be formatted
+ as a date (dd/mm/yyyy).
+ |
+
+
+ | rnin |
+
+ This parameter contains the name of the file in which the program will find the category if needed. The content
+ of thif file will then replace the string <PA>categ</PA> in the reference format or in the counter
+ path.
+ |
+
+
+ | yeargen |
+
+ This parameter can be one of:
+ "AUTO": in this case the program takes the current 4 digit year.
+ "<filename>": in this case the program extract the year from the file which name is
+ <filename>. This file should contain a date (dd/mm/yyyy).
+ |
+
+
+ | edsrn |
+
+ Name of the file in which the created reference will be stored.
+ |
+
+
+
+
+
+
+
+
+
+ | Send_Approval_Request |
+ | description |
+
+
+
+ This function sends an email to the referee in order to start the simple approval process.
+ This function is very CERN-specific and should be changed in case of external use.
+ Must be called after the Get_Report_Number function.
+
+ |
+
+ | parameters |
+
+ | addressesDAM |
+
+ email addresses of the people who will receive this email (comma separated list). this parameter may contain the <CATEG> string. In which case the variable computed from the [categformatDAM] parameter replaces this string.
+ eg.: "<CATEG>-email@cern.ch"
+ |
+
+
+ | categformatDAM |
+
+ contains a regular expression used to compute the category of the document given the reference of the document.
+ eg.: if [categformatAFP]="TEST-<CATEG>-.*" and the reference of the document is "TEST-CATEGORY1-2001-001", then the computed category equals "CATEGORY1"
+ |
+
+
+ | authorfile |
+
+ name of the file in which the authors are stored
+ |
+
+
+ | titlefile |
+
+ name of the file in which the title is stored.
+ |
+
+
+ | directory |
+
+ parameter used to create the URL to access the files.
+ |
+
+
+
+
+
+
+
+
+ 
+ 
+ 
+ 
+ 
